babylon.module.d.ts 6.6 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970869718697286973869748697586976869778697886979869808698186982869838698486985869868698786988869898699086991869928699386994869958699686997869988699987000870018700287003870048700587006870078700887009870108701187012870138701487015870168701787018870198702087021870228702387024870258702687027870288702987030870318703287033870348703587036870378703887039870408704187042870438704487045870468704787048870498705087051870528705387054870558705687057870588705987060870618706287063870648706587066870678706887069870708707187072870738707487075870768707787078870798708087081870828708387084870858708687087870888708987090870918709287093870948709587096870978709887099871008710187102871038710487105871068710787108871098711087111871128711387114871158711687117871188711987120871218712287123871248712587126871278712887129871308713187132871338713487135871368713787138871398714087141871428714387144871458714687147871488714987150871518715287153871548715587156871578715887159871608716187162871638716487165871668716787168871698717087171871728717387174871758717687177871788717987180871818718287183871848718587186871878718887189871908719187192871938719487195871968719787198871998720087201872028720387204872058720687207872088720987210872118721287213872148721587216872178721887219872208722187222872238722487225872268722787228872298723087231872328723387234872358723687237872388723987240872418724287243872448724587246872478724887249872508725187252872538725487255872568725787258872598726087261872628726387264872658726687267872688726987270872718727287273872748727587276872778727887279872808728187282872838728487285872868728787288872898729087291872928729387294872958729687297872988729987300873018730287303873048730587306873078730887309873108731187312873138731487315873168731787318873198732087321873228732387324873258732687327873288732987330873318733287333873348733587336873378733887339873408734187342873438734487345873468734787348873498735087351873528735387354873558735687357873588735987360873618736287363873648736587366873678736887369873708737187372873738737487375873768737787378873798738087381873828738387384873858738687387873888738987390873918739287393873948739587396873978739887399874008740187402874038740487405874068740787408874098741087411874128741387414874158741687417874188741987420874218742287423874248742587426874278742887429874308743187432874338743487435874368743787438874398744087441874428744387444874458744687447874488744987450874518745287453874548745587456874578745887459874608746187462874638746487465874668746787468874698747087471874728747387474874758747687477874788747987480874818748287483874848748587486874878748887489874908749187492874938749487495874968749787498874998750087501875028750387504875058750687507875088750987510875118751287513875148751587516875178751887519875208752187522875238752487525875268752787528875298753087531875328753387534875358753687537875388753987540875418754287543875448754587546875478754887549875508755187552875538755487555875568755787558875598756087561875628756387564875658756687567875688756987570875718757287573875748757587576875778757887579875808758187582875838758487585875868758787588875898759087591875928759387594875958759687597875988759987600876018760287603876048760587606876078760887609876108761187612876138761487615876168761787618876198762087621876228762387624876258762687627876288762987630876318763287633876348763587636876378763887639876408764187642876438764487645876468764787648876498765087651876528765387654876558765687657876588765987660876618766287663876648766587666876678766887669876708767187672876738767487675876768767787678876798768087681876828768387684876858768687687876888768987690876918769287693876948769587696876978769887699877008770187702877038770487705877068770787708877098771087711877128771387714877158771687717877188771987720877218772287723877248772587726877278772887729877308773187732877338773487735877368773787738877398774087741877428774387744877458774687747877488774987750877518775287753877548775587756877578775887759877608776187762877638776487765877668776787768877698777087771877728777387774877758777687777877788777987780877818778287783877848778587786877878778887789877908779187792877938779487795877968779787798877998780087801878028780387804878058780687807878088780987810878118781287813878148781587816878178781887819878208782187822878238782487825878268782787828878298783087831878328783387834878358783687837878388783987840878418784287843878448784587846878478784887849878508785187852878538785487855878568785787858878598786087861878628786387864878658786687867878688786987870878718787287873878748787587876878778787887879878808788187882878838788487885878868788787888878898789087891878928789387894878958789687897878988789987900879018790287903879048790587906879078790887909879108791187912879138791487915879168791787918879198792087921879228792387924879258792687927879288792987930879318793287933879348793587936879378793887939879408794187942879438794487945879468794787948879498795087951879528795387954879558795687957879588795987960879618796287963879648796587966879678796887969879708797187972879738797487975879768797787978879798798087981879828798387984879858798687987879888798987990879918799287993879948799587996879978799887999880008800188002880038800488005880068800788008880098801088011880128801388014880158801688017880188801988020880218802288023880248802588026880278802888029880308803188032880338803488035880368803788038880398804088041880428804388044880458804688047880488804988050880518805288053880548805588056880578805888059880608806188062880638806488065880668806788068880698807088071880728807388074880758807688077880788807988080880818808288083880848808588086880878808888089880908809188092880938809488095880968809788098880998810088101881028810388104881058810688107881088810988110881118811288113881148811588116881178811888119881208812188122881238812488125881268812788128881298813088131881328813388134881358813688137881388813988140881418814288143881448814588146881478814888149881508815188152881538815488155881568815788158881598816088161881628816388164881658816688167881688816988170881718817288173881748817588176881778817888179881808818188182881838818488185881868818788188881898819088191881928819388194881958819688197881988819988200882018820288203882048820588206882078820888209882108821188212882138821488215882168821788218882198822088221882228822388224882258822688227882288822988230882318823288233882348823588236882378823888239882408824188242882438824488245882468824788248882498825088251882528825388254882558825688257882588825988260882618826288263882648826588266882678826888269882708827188272882738827488275882768827788278882798828088281882828828388284882858828688287882888828988290882918829288293882948829588296882978829888299883008830188302883038830488305883068830788308883098831088311883128831388314883158831688317883188831988320883218832288323883248832588326883278832888329883308833188332883338833488335883368833788338883398834088341883428834388344883458834688347883488834988350883518835288353883548835588356883578835888359883608836188362883638836488365883668836788368883698837088371883728837388374883758837688377883788837988380883818838288383883848838588386883878838888389883908839188392883938839488395883968839788398883998840088401884028840388404884058840688407884088840988410884118841288413884148841588416884178841888419884208842188422884238842488425884268842788428884298843088431884328843388434884358843688437884388843988440884418844288443884448844588446884478844888449884508845188452884538845488455884568845788458884598846088461884628846388464884658846688467884688846988470884718847288473884748847588476884778847888479884808848188482884838848488485884868848788488884898849088491884928849388494884958849688497884988849988500885018850288503885048850588506885078850888509885108851188512885138851488515885168851788518885198852088521885228852388524885258852688527885288852988530885318853288533885348853588536885378853888539885408854188542885438854488545885468854788548885498855088551885528855388554885558855688557885588855988560885618856288563885648856588566885678856888569885708857188572885738857488575885768857788578885798858088581885828858388584885858858688587885888858988590885918859288593885948859588596885978859888599886008860188602886038860488605886068860788608886098861088611886128861388614886158861688617886188861988620886218862288623886248862588626886278862888629886308863188632886338863488635886368863788638886398864088641886428864388644886458864688647886488864988650886518865288653886548865588656886578865888659886608866188662886638866488665886668866788668886698867088671886728867388674886758867688677886788867988680886818868288683886848868588686886878868888689886908869188692886938869488695886968869788698886998870088701887028870388704887058870688707887088870988710887118871288713887148871588716887178871888719887208872188722887238872488725887268872788728887298873088731887328873388734887358873688737887388873988740887418874288743887448874588746887478874888749887508875188752887538875488755887568875788758887598876088761887628876388764887658876688767887688876988770887718877288773887748877588776887778877888779887808878188782887838878488785887868878788788887898879088791887928879388794887958879688797887988879988800888018880288803888048880588806888078880888809888108881188812888138881488815888168881788818888198882088821888228882388824888258882688827888288882988830888318883288833888348883588836888378883888839888408884188842888438884488845888468884788848888498885088851888528885388854888558885688857888588885988860888618886288863888648886588866888678886888869888708887188872888738887488875888768887788878888798888088881888828888388884888858888688887888888888988890888918889288893888948889588896888978889888899889008890188902889038890488905889068890788908889098891088911889128891388914889158891688917889188891988920889218892288923889248892588926889278892888929889308893188932889338893488935889368893788938889398894088941889428894388944889458894688947889488894988950889518895288953889548895588956889578895888959889608896188962889638896488965889668896788968889698897088971889728897388974889758897688977889788897988980889818898288983889848898588986889878898888989889908899188992889938899488995889968899788998889998900089001890028900389004890058900689007890088900989010890118901289013890148901589016890178901889019890208902189022890238902489025890268902789028890298903089031890328903389034890358903689037890388903989040890418904289043890448904589046890478904889049890508905189052890538905489055890568905789058890598906089061890628906389064890658906689067890688906989070890718907289073890748907589076890778907889079890808908189082890838908489085890868908789088890898909089091890928909389094890958909689097890988909989100891018910289103891048910589106891078910889109891108911189112891138911489115891168911789118891198912089121891228912389124891258912689127891288912989130891318913289133891348913589136891378913889139891408914189142891438914489145891468914789148891498915089151891528915389154891558915689157891588915989160891618916289163891648916589166891678916889169891708917189172891738917489175891768917789178891798918089181891828918389184891858918689187891888918989190891918919289193891948919589196891978919889199892008920189202892038920489205892068920789208892098921089211892128921389214892158921689217892188921989220892218922289223892248922589226892278922889229892308923189232892338923489235892368923789238892398924089241892428924389244892458924689247892488924989250892518925289253892548925589256892578925889259892608926189262892638926489265892668926789268892698927089271892728927389274892758927689277892788927989280892818928289283892848928589286892878928889289892908929189292892938929489295892968929789298892998930089301893028930389304893058930689307893088930989310893118931289313893148931589316893178931889319893208932189322893238932489325893268932789328893298933089331893328933389334893358933689337893388933989340893418934289343893448934589346893478934889349893508935189352893538935489355893568935789358893598936089361893628936389364893658936689367893688936989370893718937289373893748937589376893778937889379893808938189382893838938489385893868938789388893898939089391893928939389394893958939689397893988939989400894018940289403894048940589406894078940889409894108941189412894138941489415894168941789418894198942089421894228942389424894258942689427894288942989430894318943289433894348943589436894378943889439894408944189442894438944489445894468944789448894498945089451894528945389454894558945689457894588945989460894618946289463894648946589466894678946889469894708947189472894738947489475894768947789478894798948089481894828948389484894858948689487894888948989490894918949289493894948949589496894978949889499895008950189502895038950489505895068950789508895098951089511895128951389514895158951689517895188951989520895218952289523895248952589526895278952889529895308953189532895338953489535895368953789538895398954089541895428954389544895458954689547895488954989550895518955289553895548955589556895578955889559895608956189562895638956489565895668956789568895698957089571895728957389574895758957689577895788957989580895818958289583895848958589586895878958889589895908959189592895938959489595895968959789598895998960089601896028960389604896058960689607896088960989610896118961289613896148961589616896178961889619896208962189622896238962489625896268962789628896298963089631896328963389634896358963689637896388963989640896418964289643896448964589646896478964889649896508965189652896538965489655896568965789658896598966089661896628966389664896658966689667896688966989670896718967289673896748967589676896778967889679896808968189682896838968489685896868968789688896898969089691896928969389694896958969689697896988969989700897018970289703897048970589706897078970889709897108971189712897138971489715897168971789718897198972089721897228972389724897258972689727897288972989730897318973289733897348973589736897378973889739897408974189742897438974489745897468974789748897498975089751897528975389754897558975689757897588975989760897618976289763897648976589766897678976889769897708977189772897738977489775897768977789778897798978089781897828978389784897858978689787897888978989790897918979289793897948979589796897978979889799898008980189802898038980489805898068980789808898098981089811898128981389814898158981689817898188981989820898218982289823898248982589826898278982889829898308983189832898338983489835898368983789838898398984089841898428984389844898458984689847898488984989850898518985289853898548985589856898578985889859898608986189862898638986489865898668986789868898698987089871898728987389874898758987689877898788987989880898818988289883898848988589886898878988889889898908989189892898938989489895898968989789898898998990089901899028990389904899058990689907899088990989910899118991289913899148991589916899178991889919899208992189922899238992489925899268992789928899298993089931899328993389934899358993689937899388993989940899418994289943899448994589946899478994889949899508995189952899538995489955899568995789958899598996089961899628996389964899658996689967899688996989970899718997289973899748997589976899778997889979899808998189982899838998489985899868998789988899898999089991899928999389994899958999689997899988999990000900019000290003900049000590006900079000890009900109001190012900139001490015900169001790018900199002090021900229002390024900259002690027900289002990030900319003290033900349003590036900379003890039900409004190042900439004490045900469004790048900499005090051900529005390054900559005690057900589005990060900619006290063900649006590066900679006890069900709007190072900739007490075900769007790078900799008090081900829008390084900859008690087900889008990090900919009290093900949009590096900979009890099901009010190102901039010490105901069010790108901099011090111901129011390114901159011690117901189011990120901219012290123901249012590126901279012890129901309013190132901339013490135901369013790138901399014090141901429014390144901459014690147901489014990150901519015290153901549015590156901579015890159901609016190162901639016490165901669016790168901699017090171901729017390174901759017690177901789017990180901819018290183901849018590186901879018890189901909019190192901939019490195901969019790198901999020090201902029020390204902059020690207902089020990210902119021290213902149021590216902179021890219902209022190222902239022490225902269022790228902299023090231902329023390234902359023690237902389023990240902419024290243902449024590246902479024890249902509025190252902539025490255902569025790258902599026090261902629026390264902659026690267902689026990270902719027290273902749027590276902779027890279902809028190282902839028490285902869028790288902899029090291902929029390294902959029690297902989029990300903019030290303903049030590306903079030890309903109031190312903139031490315903169031790318903199032090321903229032390324903259032690327903289032990330903319033290333903349033590336903379033890339903409034190342903439034490345903469034790348903499035090351903529035390354903559035690357903589035990360903619036290363903649036590366903679036890369903709037190372903739037490375903769037790378903799038090381903829038390384903859038690387903889038990390903919039290393903949039590396903979039890399904009040190402904039040490405904069040790408904099041090411904129041390414904159041690417904189041990420904219042290423904249042590426904279042890429904309043190432904339043490435904369043790438904399044090441904429044390444904459044690447904489044990450904519045290453904549045590456904579045890459904609046190462904639046490465904669046790468904699047090471904729047390474904759047690477904789047990480904819048290483904849048590486904879048890489904909049190492904939049490495904969049790498904999050090501905029050390504905059050690507905089050990510905119051290513905149051590516905179051890519905209052190522905239052490525905269052790528905299053090531905329053390534905359053690537905389053990540905419054290543905449054590546905479054890549905509055190552905539055490555905569055790558905599056090561905629056390564905659056690567905689056990570905719057290573905749057590576905779057890579905809058190582905839058490585905869058790588905899059090591905929059390594905959059690597905989059990600906019060290603906049060590606906079060890609906109061190612906139061490615906169061790618906199062090621906229062390624906259062690627906289062990630906319063290633906349063590636906379063890639906409064190642906439064490645906469064790648906499065090651906529065390654906559065690657906589065990660906619066290663906649066590666906679066890669906709067190672906739067490675906769067790678906799068090681906829068390684906859068690687906889068990690906919069290693906949069590696906979069890699907009070190702907039070490705907069070790708907099071090711907129071390714907159071690717907189071990720907219072290723907249072590726907279072890729907309073190732907339073490735907369073790738907399074090741907429074390744907459074690747907489074990750907519075290753907549075590756907579075890759907609076190762907639076490765907669076790768907699077090771907729077390774907759077690777907789077990780907819078290783907849078590786907879078890789907909079190792907939079490795907969079790798907999080090801908029080390804908059080690807908089080990810908119081290813908149081590816908179081890819908209082190822908239082490825908269082790828908299083090831908329083390834908359083690837908389083990840908419084290843908449084590846908479084890849908509085190852908539085490855908569085790858908599086090861908629086390864908659086690867908689086990870908719087290873908749087590876908779087890879908809088190882908839088490885908869088790888908899089090891908929089390894908959089690897908989089990900909019090290903909049090590906909079090890909909109091190912909139091490915909169091790918909199092090921909229092390924909259092690927909289092990930909319093290933909349093590936909379093890939909409094190942909439094490945909469094790948909499095090951909529095390954909559095690957909589095990960909619096290963909649096590966909679096890969909709097190972909739097490975909769097790978909799098090981909829098390984909859098690987909889098990990909919099290993909949099590996909979099890999910009100191002910039100491005910069100791008910099101091011910129101391014910159101691017910189101991020910219102291023910249102591026910279102891029910309103191032910339103491035910369103791038910399104091041910429104391044910459104691047910489104991050910519105291053910549105591056910579105891059910609106191062910639106491065910669106791068910699107091071910729107391074910759107691077910789107991080910819108291083910849108591086910879108891089910909109191092910939109491095910969109791098910999110091101911029110391104911059110691107911089110991110911119111291113911149111591116911179111891119911209112191122911239112491125911269112791128911299113091131911329113391134911359113691137911389113991140911419114291143911449114591146911479114891149911509115191152911539115491155911569115791158911599116091161911629116391164911659116691167911689116991170911719117291173911749117591176911779117891179911809118191182911839118491185911869118791188911899119091191911929119391194911959119691197911989119991200912019120291203912049120591206912079120891209912109121191212912139121491215912169121791218912199122091221912229122391224912259122691227912289122991230912319123291233912349123591236912379123891239912409124191242912439124491245912469124791248912499125091251912529125391254912559125691257912589125991260912619126291263912649126591266912679126891269912709127191272912739127491275912769127791278912799128091281912829128391284912859128691287912889128991290912919129291293912949129591296912979129891299913009130191302913039130491305913069130791308913099131091311913129131391314913159131691317913189131991320913219132291323913249132591326913279132891329913309133191332913339133491335913369133791338913399134091341913429134391344913459134691347913489134991350913519135291353913549135591356913579135891359913609136191362913639136491365913669136791368913699137091371913729137391374913759137691377913789137991380913819138291383913849138591386913879138891389913909139191392913939139491395913969139791398913999140091401914029140391404914059140691407914089140991410914119141291413914149141591416914179141891419914209142191422914239142491425914269142791428914299143091431914329143391434914359143691437914389143991440914419144291443914449144591446914479144891449914509145191452914539145491455914569145791458914599146091461914629146391464914659146691467914689146991470914719147291473914749147591476914779147891479914809148191482914839148491485914869148791488914899149091491914929149391494914959149691497914989149991500915019150291503915049150591506915079150891509915109151191512915139151491515915169151791518915199152091521915229152391524915259152691527915289152991530915319153291533915349153591536915379153891539915409154191542915439154491545915469154791548915499155091551915529155391554915559155691557915589155991560915619156291563915649156591566915679156891569915709157191572915739157491575915769157791578915799158091581915829158391584915859158691587915889158991590915919159291593915949159591596915979159891599916009160191602916039160491605916069160791608916099161091611916129161391614916159161691617916189161991620916219162291623916249162591626916279162891629916309163191632916339163491635916369163791638916399164091641916429164391644916459164691647916489164991650916519165291653916549165591656916579165891659916609166191662916639166491665916669166791668916699167091671916729167391674916759167691677916789167991680916819168291683916849168591686916879168891689916909169191692916939169491695916969169791698916999170091701917029170391704917059170691707917089170991710917119171291713917149171591716917179171891719917209172191722917239172491725917269172791728917299173091731917329173391734917359173691737917389173991740917419174291743917449174591746917479174891749917509175191752917539175491755917569175791758917599176091761917629176391764917659176691767917689176991770917719177291773917749177591776917779177891779917809178191782917839178491785917869178791788917899179091791917929179391794917959179691797917989179991800918019180291803918049180591806918079180891809918109181191812918139181491815918169181791818918199182091821918229182391824918259182691827918289182991830918319183291833918349183591836918379183891839918409184191842918439184491845918469184791848918499185091851918529185391854918559185691857918589185991860918619186291863918649186591866918679186891869918709187191872918739187491875918769187791878918799188091881918829188391884918859188691887918889188991890918919189291893918949189591896918979189891899919009190191902919039190491905919069190791908919099191091911919129191391914919159191691917919189191991920919219192291923919249192591926919279192891929919309193191932919339193491935919369193791938919399194091941919429194391944919459194691947919489194991950919519195291953919549195591956919579195891959919609196191962919639196491965919669196791968919699197091971919729197391974919759197691977919789197991980919819198291983919849198591986919879198891989919909199191992919939199491995919969199791998919999200092001920029200392004920059200692007920089200992010920119201292013920149201592016920179201892019920209202192022920239202492025920269202792028920299203092031920329203392034920359203692037920389203992040920419204292043920449204592046920479204892049920509205192052920539205492055920569205792058920599206092061920629206392064920659206692067920689206992070920719207292073920749207592076920779207892079920809208192082920839208492085920869208792088920899209092091920929209392094920959209692097920989209992100921019210292103921049210592106921079210892109921109211192112921139211492115921169211792118921199212092121921229212392124921259212692127921289212992130921319213292133921349213592136921379213892139921409214192142921439214492145921469214792148921499215092151921529215392154921559215692157921589215992160921619216292163921649216592166921679216892169921709217192172921739217492175921769217792178921799218092181921829218392184921859218692187921889218992190921919219292193921949219592196921979219892199922009220192202922039220492205922069220792208922099221092211922129221392214922159221692217922189221992220922219222292223922249222592226922279222892229922309223192232922339223492235922369223792238922399224092241922429224392244922459224692247922489224992250922519225292253922549225592256922579225892259922609226192262922639226492265922669226792268922699227092271922729227392274922759227692277922789227992280922819228292283922849228592286922879228892289922909229192292922939229492295922969229792298922999230092301923029230392304923059230692307923089230992310923119231292313923149231592316923179231892319923209232192322923239232492325923269232792328923299233092331923329233392334923359233692337923389233992340923419234292343923449234592346923479234892349923509235192352923539235492355923569235792358923599236092361923629236392364923659236692367923689236992370923719237292373923749237592376923779237892379923809238192382923839238492385923869238792388923899239092391923929239392394923959239692397923989239992400924019240292403924049240592406924079240892409924109241192412924139241492415924169241792418924199242092421924229242392424924259242692427924289242992430924319243292433924349243592436924379243892439924409244192442924439244492445924469244792448924499245092451924529245392454924559245692457924589245992460924619246292463924649246592466924679246892469924709247192472924739247492475924769247792478924799248092481924829248392484924859248692487924889248992490924919249292493924949249592496924979249892499925009250192502925039250492505925069250792508925099251092511925129251392514925159251692517925189251992520925219252292523925249252592526925279252892529925309253192532925339253492535925369253792538925399254092541925429254392544925459254692547925489254992550925519255292553925549255592556925579255892559925609256192562925639256492565925669256792568925699257092571925729257392574925759257692577925789257992580925819258292583925849258592586925879258892589925909259192592925939259492595925969259792598925999260092601926029260392604926059260692607926089260992610926119261292613926149261592616926179261892619926209262192622926239262492625926269262792628926299263092631926329263392634926359263692637926389263992640926419264292643926449264592646926479264892649926509265192652926539265492655926569265792658926599266092661926629266392664926659266692667926689266992670926719267292673926749267592676926779267892679926809268192682926839268492685926869268792688926899269092691926929269392694926959269692697926989269992700927019270292703927049270592706927079270892709927109271192712927139271492715927169271792718927199272092721927229272392724927259272692727927289272992730927319273292733927349273592736927379273892739927409274192742927439274492745927469274792748927499275092751927529275392754927559275692757927589275992760927619276292763927649276592766927679276892769927709277192772927739277492775927769277792778927799278092781927829278392784927859278692787927889278992790927919279292793927949279592796927979279892799928009280192802928039280492805928069280792808928099281092811928129281392814928159281692817928189281992820928219282292823928249282592826928279282892829928309283192832928339283492835928369283792838928399284092841928429284392844928459284692847928489284992850928519285292853928549285592856928579285892859928609286192862928639286492865928669286792868928699287092871928729287392874928759287692877928789287992880928819288292883928849288592886928879288892889928909289192892928939289492895928969289792898928999290092901929029290392904929059290692907929089290992910929119291292913929149291592916929179291892919929209292192922929239292492925929269292792928929299293092931929329293392934929359293692937929389293992940929419294292943929449294592946929479294892949929509295192952929539295492955929569295792958929599296092961929629296392964929659296692967929689296992970929719297292973929749297592976929779297892979929809298192982929839298492985929869298792988929899299092991929929299392994929959299692997929989299993000930019300293003930049300593006930079300893009930109301193012930139301493015930169301793018930199302093021930229302393024930259302693027930289302993030930319303293033930349303593036930379303893039930409304193042930439304493045930469304793048930499305093051930529305393054930559305693057930589305993060930619306293063930649306593066930679306893069930709307193072930739307493075930769307793078930799308093081930829308393084930859308693087930889308993090930919309293093930949309593096930979309893099931009310193102931039310493105931069310793108931099311093111931129311393114931159311693117931189311993120931219312293123931249312593126931279312893129931309313193132931339313493135931369313793138931399314093141931429314393144931459314693147931489314993150931519315293153931549315593156931579315893159931609316193162931639316493165931669316793168931699317093171931729317393174931759317693177931789317993180931819318293183931849318593186931879318893189931909319193192931939319493195931969319793198931999320093201932029320393204932059320693207932089320993210932119321293213932149321593216932179321893219932209322193222932239322493225932269322793228932299323093231932329323393234932359323693237932389323993240932419324293243932449324593246932479324893249932509325193252932539325493255932569325793258932599326093261932629326393264932659326693267932689326993270932719327293273932749327593276932779327893279932809328193282932839328493285932869328793288932899329093291932929329393294932959329693297932989329993300933019330293303933049330593306933079330893309933109331193312933139331493315933169331793318933199332093321933229332393324933259332693327933289332993330933319333293333933349333593336933379333893339933409334193342933439334493345933469334793348933499335093351933529335393354933559335693357933589335993360933619336293363933649336593366933679336893369933709337193372933739337493375933769337793378933799338093381933829338393384933859338693387933889338993390933919339293393933949339593396933979339893399934009340193402934039340493405934069340793408934099341093411934129341393414934159341693417934189341993420934219342293423934249342593426934279342893429934309343193432934339343493435934369343793438934399344093441934429344393444934459344693447934489344993450934519345293453934549345593456934579345893459934609346193462934639346493465934669346793468934699347093471934729347393474934759347693477934789347993480934819348293483934849348593486934879348893489934909349193492934939349493495934969349793498934999350093501935029350393504935059350693507935089350993510935119351293513935149351593516935179351893519935209352193522935239352493525935269352793528935299353093531935329353393534935359353693537935389353993540935419354293543935449354593546935479354893549935509355193552935539355493555935569355793558935599356093561935629356393564935659356693567935689356993570935719357293573935749357593576935779357893579935809358193582935839358493585935869358793588935899359093591935929359393594935959359693597935989359993600936019360293603936049360593606936079360893609936109361193612936139361493615936169361793618936199362093621936229362393624936259362693627936289362993630936319363293633936349363593636936379363893639936409364193642936439364493645936469364793648936499365093651936529365393654936559365693657936589365993660936619366293663936649366593666936679366893669936709367193672936739367493675936769367793678936799368093681936829368393684936859368693687936889368993690936919369293693936949369593696936979369893699937009370193702937039370493705937069370793708937099371093711937129371393714937159371693717937189371993720937219372293723937249372593726937279372893729937309373193732937339373493735937369373793738937399374093741937429374393744937459374693747937489374993750937519375293753937549375593756937579375893759937609376193762937639376493765937669376793768937699377093771937729377393774937759377693777937789377993780937819378293783937849378593786937879378893789937909379193792937939379493795937969379793798937999380093801938029380393804938059380693807938089380993810938119381293813938149381593816938179381893819938209382193822938239382493825938269382793828938299383093831938329383393834938359383693837938389383993840938419384293843938449384593846938479384893849938509385193852938539385493855938569385793858938599386093861938629386393864938659386693867938689386993870938719387293873938749387593876938779387893879938809388193882938839388493885938869388793888938899389093891938929389393894938959389693897938989389993900939019390293903939049390593906939079390893909939109391193912939139391493915939169391793918939199392093921939229392393924939259392693927939289392993930939319393293933939349393593936939379393893939939409394193942939439394493945939469394793948939499395093951939529395393954939559395693957939589395993960939619396293963939649396593966939679396893969939709397193972939739397493975939769397793978939799398093981939829398393984939859398693987939889398993990939919399293993939949399593996939979399893999940009400194002940039400494005940069400794008940099401094011940129401394014940159401694017940189401994020940219402294023940249402594026940279402894029940309403194032940339403494035940369403794038940399404094041940429404394044940459404694047940489404994050940519405294053940549405594056940579405894059940609406194062940639406494065940669406794068940699407094071940729407394074940759407694077940789407994080940819408294083940849408594086940879408894089940909409194092940939409494095940969409794098940999410094101941029410394104941059410694107941089410994110941119411294113941149411594116941179411894119941209412194122941239412494125941269412794128941299413094131941329413394134941359413694137941389413994140941419414294143941449414594146941479414894149941509415194152941539415494155941569415794158941599416094161941629416394164941659416694167941689416994170941719417294173941749417594176941779417894179941809418194182941839418494185941869418794188941899419094191941929419394194941959419694197941989419994200942019420294203942049420594206942079420894209942109421194212942139421494215942169421794218942199422094221942229422394224942259422694227942289422994230942319423294233942349423594236942379423894239942409424194242942439424494245942469424794248942499425094251942529425394254942559425694257942589425994260942619426294263942649426594266942679426894269942709427194272942739427494275942769427794278942799428094281942829428394284942859428694287942889428994290942919429294293942949429594296942979429894299943009430194302943039430494305943069430794308943099431094311943129431394314943159431694317943189431994320943219432294323943249432594326943279432894329943309433194332943339433494335943369433794338943399434094341943429434394344943459434694347943489434994350943519435294353943549435594356943579435894359943609436194362943639436494365943669436794368943699437094371943729437394374943759437694377943789437994380943819438294383943849438594386943879438894389943909439194392943939439494395943969439794398943999440094401944029440394404944059440694407944089440994410944119441294413944149441594416944179441894419944209442194422944239442494425944269442794428944299443094431944329443394434944359443694437944389443994440944419444294443944449444594446944479444894449944509445194452944539445494455944569445794458944599446094461944629446394464944659446694467944689446994470944719447294473944749447594476944779447894479944809448194482944839448494485944869448794488944899449094491944929449394494944959449694497944989449994500945019450294503945049450594506945079450894509945109451194512945139451494515945169451794518945199452094521945229452394524945259452694527945289452994530945319453294533945349453594536945379453894539945409454194542945439454494545945469454794548945499455094551945529455394554945559455694557945589455994560945619456294563945649456594566945679456894569945709457194572945739457494575945769457794578945799458094581945829458394584945859458694587945889458994590945919459294593945949459594596945979459894599946009460194602946039460494605946069460794608946099461094611946129461394614946159461694617946189461994620946219462294623946249462594626946279462894629946309463194632946339463494635946369463794638946399464094641946429464394644946459464694647946489464994650946519465294653946549465594656946579465894659946609466194662946639466494665946669466794668946699467094671946729467394674946759467694677946789467994680946819468294683946849468594686946879468894689946909469194692946939469494695946969469794698946999470094701947029470394704947059470694707947089470994710947119471294713947149471594716947179471894719947209472194722947239472494725947269472794728947299473094731947329473394734947359473694737947389473994740947419474294743947449474594746947479474894749947509475194752947539475494755947569475794758947599476094761947629476394764947659476694767947689476994770947719477294773947749477594776947779477894779947809478194782947839478494785947869478794788947899479094791947929479394794947959479694797947989479994800948019480294803948049480594806948079480894809948109481194812948139481494815948169481794818948199482094821948229482394824948259482694827948289482994830948319483294833948349483594836948379483894839948409484194842948439484494845948469484794848948499485094851948529485394854948559485694857948589485994860948619486294863948649486594866948679486894869948709487194872948739487494875948769487794878948799488094881948829488394884948859488694887948889488994890948919489294893948949489594896948979489894899949009490194902949039490494905949069490794908949099491094911949129491394914949159491694917949189491994920949219492294923949249492594926949279492894929949309493194932949339493494935949369493794938949399494094941949429494394944949459494694947949489494994950949519495294953949549495594956949579495894959949609496194962949639496494965949669496794968949699497094971949729497394974949759497694977949789497994980949819498294983949849498594986949879498894989949909499194992949939499494995949969499794998949999500095001950029500395004950059500695007950089500995010950119501295013950149501595016950179501895019950209502195022950239502495025950269502795028950299503095031950329503395034950359503695037950389503995040950419504295043950449504595046950479504895049950509505195052950539505495055950569505795058950599506095061950629506395064950659506695067950689506995070950719507295073950749507595076950779507895079950809508195082950839508495085950869508795088950899509095091950929509395094950959509695097950989509995100951019510295103951049510595106951079510895109951109511195112951139511495115951169511795118951199512095121951229512395124951259512695127951289512995130951319513295133951349513595136951379513895139951409514195142951439514495145951469514795148951499515095151951529515395154951559515695157951589515995160951619516295163951649516595166951679516895169951709517195172951739517495175951769517795178951799518095181951829518395184951859518695187951889518995190951919519295193951949519595196951979519895199952009520195202952039520495205952069520795208952099521095211952129521395214952159521695217952189521995220952219522295223952249522595226952279522895229952309523195232952339523495235952369523795238952399524095241952429524395244952459524695247952489524995250952519525295253952549525595256952579525895259952609526195262952639526495265952669526795268952699527095271952729527395274952759527695277952789527995280952819528295283952849528595286952879528895289952909529195292952939529495295952969529795298952999530095301953029530395304953059530695307953089530995310953119531295313953149531595316953179531895319953209532195322953239532495325953269532795328953299533095331953329533395334953359533695337953389533995340953419534295343953449534595346953479534895349953509535195352953539535495355953569535795358953599536095361953629536395364953659536695367953689536995370953719537295373953749537595376953779537895379953809538195382953839538495385953869538795388953899539095391953929539395394953959539695397953989539995400954019540295403954049540595406954079540895409954109541195412954139541495415954169541795418954199542095421954229542395424954259542695427954289542995430954319543295433954349543595436954379543895439954409544195442954439544495445954469544795448954499545095451954529545395454954559545695457954589545995460954619546295463954649546595466954679546895469954709547195472954739547495475954769547795478954799548095481954829548395484954859548695487954889548995490954919549295493954949549595496954979549895499955009550195502955039550495505955069550795508955099551095511955129551395514955159551695517955189551995520955219552295523955249552595526955279552895529955309553195532955339553495535955369553795538955399554095541955429554395544955459554695547955489554995550955519555295553955549555595556955579555895559955609556195562955639556495565955669556795568955699557095571955729557395574955759557695577955789557995580955819558295583955849558595586955879558895589955909559195592955939559495595955969559795598955999560095601956029560395604956059560695607956089560995610956119561295613956149561595616956179561895619956209562195622956239562495625956269562795628956299563095631956329563395634956359563695637956389563995640956419564295643956449564595646956479564895649956509565195652956539565495655956569565795658956599566095661956629566395664956659566695667956689566995670956719567295673956749567595676956779567895679956809568195682956839568495685956869568795688956899569095691956929569395694956959569695697956989569995700957019570295703957049570595706957079570895709957109571195712957139571495715957169571795718957199572095721957229572395724957259572695727957289572995730957319573295733957349573595736957379573895739957409574195742957439574495745957469574795748957499575095751957529575395754957559575695757957589575995760957619576295763957649576595766957679576895769957709577195772957739577495775957769577795778957799578095781957829578395784957859578695787957889578995790957919579295793957949579595796957979579895799958009580195802958039580495805958069580795808958099581095811958129581395814958159581695817958189581995820958219582295823958249582595826958279582895829958309583195832958339583495835958369583795838958399584095841958429584395844958459584695847958489584995850958519585295853958549585595856958579585895859958609586195862958639586495865958669586795868958699587095871958729587395874958759587695877958789587995880958819588295883958849588595886958879588895889958909589195892958939589495895958969589795898958999590095901959029590395904959059590695907959089590995910959119591295913959149591595916959179591895919959209592195922959239592495925959269592795928959299593095931959329593395934959359593695937959389593995940959419594295943959449594595946959479594895949959509595195952959539595495955959569595795958959599596095961959629596395964959659596695967959689596995970959719597295973959749597595976959779597895979959809598195982959839598495985959869598795988959899599095991959929599395994959959599695997959989599996000960019600296003960049600596006960079600896009960109601196012960139601496015960169601796018960199602096021960229602396024960259602696027960289602996030960319603296033960349603596036960379603896039960409604196042960439604496045960469604796048960499605096051960529605396054960559605696057960589605996060960619606296063960649606596066960679606896069960709607196072960739607496075960769607796078960799608096081960829608396084960859608696087960889608996090960919609296093960949609596096960979609896099961009610196102961039610496105961069610796108961099611096111961129611396114961159611696117961189611996120961219612296123961249612596126961279612896129961309613196132961339613496135961369613796138961399614096141961429614396144961459614696147961489614996150961519615296153961549615596156961579615896159961609616196162961639616496165961669616796168961699617096171961729617396174961759617696177961789617996180961819618296183961849618596186961879618896189961909619196192961939619496195961969619796198961999620096201962029620396204962059620696207962089620996210962119621296213962149621596216962179621896219962209622196222962239622496225962269622796228962299623096231962329623396234962359623696237962389623996240962419624296243962449624596246962479624896249962509625196252962539625496255962569625796258962599626096261962629626396264962659626696267962689626996270962719627296273962749627596276962779627896279962809628196282962839628496285962869628796288962899629096291962929629396294962959629696297962989629996300963019630296303963049630596306963079630896309963109631196312963139631496315963169631796318963199632096321963229632396324963259632696327963289632996330963319633296333963349633596336963379633896339963409634196342963439634496345963469634796348963499635096351963529635396354963559635696357963589635996360963619636296363963649636596366963679636896369963709637196372963739637496375963769637796378963799638096381963829638396384963859638696387963889638996390963919639296393963949639596396963979639896399964009640196402964039640496405964069640796408964099641096411964129641396414964159641696417964189641996420964219642296423964249642596426964279642896429964309643196432964339643496435964369643796438964399644096441964429644396444964459644696447964489644996450964519645296453964549645596456964579645896459964609646196462964639646496465964669646796468964699647096471964729647396474964759647696477964789647996480964819648296483964849648596486964879648896489964909649196492964939649496495964969649796498964999650096501965029650396504965059650696507965089650996510965119651296513965149651596516965179651896519965209652196522965239652496525965269652796528965299653096531965329653396534965359653696537965389653996540965419654296543965449654596546965479654896549965509655196552965539655496555965569655796558965599656096561965629656396564965659656696567965689656996570965719657296573965749657596576965779657896579965809658196582965839658496585965869658796588965899659096591965929659396594965959659696597965989659996600966019660296603966049660596606966079660896609966109661196612966139661496615966169661796618966199662096621966229662396624966259662696627966289662996630966319663296633966349663596636966379663896639966409664196642966439664496645966469664796648966499665096651966529665396654966559665696657966589665996660966619666296663966649666596666966679666896669966709667196672966739667496675966769667796678966799668096681966829668396684966859668696687966889668996690966919669296693966949669596696966979669896699967009670196702967039670496705967069670796708967099671096711967129671396714967159671696717967189671996720967219672296723967249672596726967279672896729967309673196732967339673496735967369673796738967399674096741967429674396744967459674696747967489674996750967519675296753967549675596756967579675896759967609676196762967639676496765967669676796768967699677096771967729677396774967759677696777967789677996780967819678296783967849678596786967879678896789967909679196792967939679496795967969679796798967999680096801968029680396804968059680696807968089680996810968119681296813968149681596816968179681896819968209682196822968239682496825968269682796828968299683096831968329683396834968359683696837968389683996840968419684296843968449684596846968479684896849968509685196852968539685496855968569685796858968599686096861968629686396864968659686696867968689686996870968719687296873968749687596876968779687896879968809688196882968839688496885968869688796888968899689096891968929689396894968959689696897968989689996900969019690296903969049690596906969079690896909969109691196912969139691496915969169691796918969199692096921969229692396924969259692696927969289692996930969319693296933969349693596936969379693896939969409694196942969439694496945969469694796948969499695096951969529695396954969559695696957969589695996960969619696296963969649696596966969679696896969969709697196972969739697496975969769697796978969799698096981969829698396984969859698696987969889698996990969919699296993969949699596996969979699896999970009700197002970039700497005970069700797008970099701097011970129701397014970159701697017970189701997020970219702297023970249702597026970279702897029970309703197032970339703497035970369703797038970399704097041970429704397044970459704697047970489704997050970519705297053970549705597056970579705897059970609706197062970639706497065970669706797068970699707097071970729707397074970759707697077970789707997080970819708297083970849708597086970879708897089970909709197092970939709497095970969709797098970999710097101971029710397104971059710697107971089710997110971119711297113971149711597116971179711897119971209712197122971239712497125971269712797128971299713097131971329713397134971359713697137971389713997140971419714297143971449714597146971479714897149971509715197152971539715497155971569715797158971599716097161971629716397164971659716697167971689716997170971719717297173971749717597176971779717897179971809718197182971839718497185971869718797188971899719097191971929719397194971959719697197971989719997200972019720297203972049720597206972079720897209972109721197212972139721497215972169721797218972199722097221972229722397224972259722697227972289722997230972319723297233972349723597236972379723897239972409724197242972439724497245972469724797248972499725097251972529725397254972559725697257972589725997260972619726297263972649726597266972679726897269972709727197272972739727497275972769727797278972799728097281972829728397284972859728697287972889728997290972919729297293972949729597296972979729897299973009730197302973039730497305973069730797308973099731097311973129731397314973159731697317973189731997320973219732297323973249732597326973279732897329973309733197332973339733497335973369733797338973399734097341973429734397344973459734697347973489734997350973519735297353973549735597356973579735897359973609736197362973639736497365973669736797368973699737097371973729737397374973759737697377973789737997380973819738297383973849738597386973879738897389973909739197392973939739497395973969739797398973999740097401974029740397404974059740697407974089740997410974119741297413974149741597416974179741897419974209742197422974239742497425974269742797428974299743097431974329743397434974359743697437974389743997440974419744297443974449744597446974479744897449974509745197452974539745497455974569745797458974599746097461974629746397464974659746697467974689746997470974719747297473974749747597476974779747897479974809748197482974839748497485974869748797488974899749097491974929749397494974959749697497974989749997500975019750297503975049750597506975079750897509975109751197512975139751497515975169751797518975199752097521975229752397524975259752697527975289752997530975319753297533975349753597536975379753897539975409754197542975439754497545975469754797548975499755097551975529755397554975559755697557975589755997560975619756297563975649756597566975679756897569975709757197572975739757497575975769757797578975799758097581975829758397584975859758697587975889758997590975919759297593975949759597596975979759897599976009760197602976039760497605976069760797608976099761097611976129761397614976159761697617976189761997620976219762297623976249762597626976279762897629976309763197632976339763497635976369763797638976399764097641976429764397644976459764697647976489764997650976519765297653976549765597656976579765897659976609766197662976639766497665976669766797668976699767097671976729767397674976759767697677976789767997680976819768297683976849768597686976879768897689976909769197692976939769497695976969769797698976999770097701977029770397704977059770697707977089770997710977119771297713977149771597716977179771897719977209772197722977239772497725977269772797728977299773097731977329773397734977359773697737977389773997740977419774297743977449774597746977479774897749977509775197752977539775497755977569775797758977599776097761977629776397764977659776697767977689776997770977719777297773977749777597776977779777897779977809778197782977839778497785977869778797788977899779097791977929779397794977959779697797977989779997800978019780297803978049780597806978079780897809978109781197812978139781497815978169781797818978199782097821978229782397824978259782697827978289782997830978319783297833978349783597836978379783897839978409784197842978439784497845978469784797848978499785097851978529785397854978559785697857978589785997860978619786297863978649786597866978679786897869978709787197872978739787497875978769787797878978799788097881978829788397884978859788697887978889788997890978919789297893978949789597896978979789897899979009790197902979039790497905979069790797908979099791097911979129791397914979159791697917979189791997920979219792297923979249792597926979279792897929979309793197932979339793497935979369793797938979399794097941979429794397944979459794697947979489794997950979519795297953979549795597956979579795897959979609796197962979639796497965979669796797968979699797097971979729797397974979759797697977979789797997980979819798297983979849798597986979879798897989979909799197992979939799497995979969799797998979999800098001980029800398004980059800698007980089800998010980119801298013980149801598016980179801898019980209802198022980239802498025980269802798028980299803098031980329803398034980359803698037980389803998040980419804298043980449804598046980479804898049980509805198052980539805498055980569805798058980599806098061980629806398064980659806698067980689806998070980719807298073980749807598076980779807898079980809808198082980839808498085980869808798088980899809098091980929809398094980959809698097980989809998100981019810298103981049810598106981079810898109981109811198112981139811498115981169811798118981199812098121981229812398124981259812698127981289812998130981319813298133981349813598136981379813898139981409814198142981439814498145981469814798148981499815098151981529815398154981559815698157981589815998160981619816298163981649816598166981679816898169981709817198172981739817498175981769817798178981799818098181981829818398184981859818698187981889818998190981919819298193981949819598196981979819898199982009820198202982039820498205982069820798208982099821098211982129821398214982159821698217982189821998220982219822298223982249822598226982279822898229982309823198232982339823498235982369823798238982399824098241982429824398244982459824698247982489824998250982519825298253982549825598256982579825898259982609826198262982639826498265982669826798268982699827098271982729827398274982759827698277982789827998280982819828298283982849828598286982879828898289982909829198292982939829498295982969829798298982999830098301983029830398304983059830698307983089830998310983119831298313983149831598316983179831898319983209832198322983239832498325983269832798328983299833098331983329833398334983359833698337983389833998340983419834298343983449834598346983479834898349983509835198352983539835498355983569835798358983599836098361983629836398364983659836698367983689836998370983719837298373983749837598376983779837898379983809838198382983839838498385983869838798388983899839098391983929839398394983959839698397983989839998400984019840298403984049840598406984079840898409984109841198412984139841498415984169841798418984199842098421984229842398424984259842698427984289842998430984319843298433984349843598436984379843898439984409844198442984439844498445984469844798448984499845098451984529845398454984559845698457984589845998460984619846298463984649846598466984679846898469984709847198472984739847498475984769847798478984799848098481984829848398484984859848698487984889848998490984919849298493984949849598496984979849898499985009850198502985039850498505985069850798508985099851098511985129851398514985159851698517985189851998520985219852298523985249852598526985279852898529985309853198532985339853498535985369853798538985399854098541985429854398544985459854698547985489854998550985519855298553985549855598556985579855898559985609856198562985639856498565985669856798568985699857098571985729857398574985759857698577985789857998580985819858298583985849858598586985879858898589985909859198592985939859498595985969859798598985999860098601986029860398604986059860698607986089860998610986119861298613986149861598616986179861898619986209862198622986239862498625986269862798628986299863098631986329863398634986359863698637986389863998640986419864298643986449864598646986479864898649986509865198652986539865498655986569865798658986599866098661986629866398664986659866698667986689866998670986719867298673986749867598676986779867898679986809868198682986839868498685986869868798688986899869098691986929869398694986959869698697986989869998700987019870298703987049870598706987079870898709987109871198712987139871498715987169871798718987199872098721987229872398724987259872698727987289872998730987319873298733987349873598736987379873898739987409874198742987439874498745987469874798748987499875098751987529875398754987559875698757987589875998760987619876298763987649876598766987679876898769987709877198772987739877498775987769877798778987799878098781987829878398784987859878698787987889878998790987919879298793987949879598796987979879898799988009880198802988039880498805988069880798808988099881098811988129881398814988159881698817988189881998820988219882298823988249882598826988279882898829988309883198832988339883498835988369883798838988399884098841988429884398844988459884698847988489884998850988519885298853988549885598856988579885898859988609886198862988639886498865988669886798868988699887098871988729887398874988759887698877988789887998880988819888298883988849888598886988879888898889988909889198892988939889498895988969889798898988999890098901989029890398904989059890698907989089890998910989119891298913989149891598916989179891898919989209892198922989239892498925989269892798928989299893098931989329893398934989359893698937989389893998940989419894298943989449894598946989479894898949989509895198952989539895498955989569895798958989599896098961989629896398964989659896698967989689896998970989719897298973989749897598976989779897898979989809898198982989839898498985989869898798988989899899098991989929899398994989959899698997989989899999000990019900299003990049900599006990079900899009990109901199012990139901499015990169901799018990199902099021990229902399024990259902699027990289902999030990319903299033990349903599036990379903899039990409904199042990439904499045990469904799048990499905099051990529905399054990559905699057990589905999060990619906299063990649906599066990679906899069990709907199072990739907499075990769907799078990799908099081990829908399084990859908699087990889908999090990919909299093990949909599096990979909899099991009910199102991039910499105991069910799108991099911099111991129911399114991159911699117991189911999120991219912299123991249912599126991279912899129991309913199132991339913499135991369913799138991399914099141991429914399144991459914699147991489914999150991519915299153991549915599156991579915899159991609916199162991639916499165991669916799168991699917099171991729917399174991759917699177991789917999180991819918299183991849918599186991879918899189991909919199192991939919499195991969919799198991999920099201992029920399204992059920699207992089920999210992119921299213992149921599216992179921899219992209922199222992239922499225992269922799228992299923099231992329923399234992359923699237992389923999240992419924299243992449924599246992479924899249992509925199252992539925499255992569925799258992599926099261992629926399264992659926699267992689926999270992719927299273992749927599276992779927899279992809928199282992839928499285992869928799288992899929099291992929929399294992959929699297992989929999300993019930299303993049930599306993079930899309993109931199312993139931499315993169931799318993199932099321993229932399324993259932699327993289932999330993319933299333993349933599336993379933899339993409934199342993439934499345993469934799348993499935099351993529935399354993559935699357993589935999360993619936299363993649936599366993679936899369993709937199372993739937499375993769937799378993799938099381993829938399384993859938699387993889938999390993919939299393993949939599396993979939899399994009940199402994039940499405994069940799408994099941099411994129941399414994159941699417994189941999420994219942299423994249942599426994279942899429994309943199432994339943499435994369943799438994399944099441994429944399444994459944699447994489944999450994519945299453994549945599456994579945899459994609946199462994639946499465994669946799468994699947099471994729947399474994759947699477994789947999480994819948299483994849948599486994879948899489994909949199492994939949499495994969949799498994999950099501995029950399504995059950699507995089950999510995119951299513995149951599516995179951899519995209952199522995239952499525995269952799528995299953099531995329953399534995359953699537995389953999540995419954299543995449954599546995479954899549995509955199552995539955499555995569955799558995599956099561995629956399564995659956699567995689956999570995719957299573995749957599576995779957899579995809958199582995839958499585995869958799588995899959099591995929959399594995959959699597995989959999600996019960299603996049960599606996079960899609996109961199612996139961499615996169961799618996199962099621996229962399624996259962699627996289962999630996319963299633996349963599636996379963899639996409964199642996439964499645996469964799648996499965099651996529965399654996559965699657996589965999660996619966299663996649966599666996679966899669996709967199672996739967499675996769967799678996799968099681996829968399684996859968699687996889968999690996919969299693996949969599696996979969899699997009970199702997039970499705997069970799708997099971099711997129971399714997159971699717997189971999720997219972299723997249972599726997279972899729997309973199732997339973499735997369973799738997399974099741997429974399744997459974699747997489974999750997519975299753997549975599756997579975899759997609976199762997639976499765997669976799768997699977099771997729977399774997759977699777997789977999780997819978299783997849978599786997879978899789997909979199792997939979499795997969979799798997999980099801998029980399804998059980699807998089980999810998119981299813998149981599816998179981899819998209982199822998239982499825998269982799828998299983099831998329983399834998359983699837998389983999840998419984299843998449984599846998479984899849998509985199852998539985499855998569985799858998599986099861998629986399864998659986699867998689986999870998719987299873998749987599876998779987899879998809988199882998839988499885998869988799888998899989099891998929989399894998959989699897998989989999900999019990299903999049990599906999079990899909999109991199912999139991499915999169991799918999199992099921999229992399924999259992699927999289992999930999319993299933999349993599936999379993899939999409994199942999439994499945999469994799948999499995099951999529995399954999559995699957999589995999960999619996299963999649996599966999679996899969999709997199972999739997499975999769997799978999799998099981999829998399984999859998699987999889998999990999919999299993999949999599996999979999899999100000100001100002100003100004100005100006100007100008100009100010100011100012100013100014100015100016100017100018100019100020100021100022100023100024100025100026100027100028100029100030100031100032100033100034100035100036100037100038100039100040100041100042100043100044100045100046100047100048100049100050100051100052100053100054100055100056100057100058100059100060100061100062100063100064100065100066100067100068100069100070100071100072100073100074100075100076100077100078100079100080100081100082100083100084100085100086100087100088100089100090100091100092100093100094100095100096100097100098100099100100100101100102100103100104100105100106100107100108100109100110100111100112100113100114100115100116100117100118100119100120100121100122100123100124100125100126100127100128100129100130100131100132100133100134100135100136100137100138100139100140100141100142100143100144100145100146100147100148100149100150100151100152100153100154100155100156100157100158100159100160100161100162100163100164100165100166100167100168100169100170100171100172100173100174100175100176100177100178100179100180100181100182100183100184100185100186100187100188100189100190100191100192100193100194100195100196100197100198100199100200100201100202100203100204100205100206100207100208100209100210100211100212100213100214100215100216100217100218100219100220100221100222100223100224100225100226100227100228100229100230100231100232100233100234100235100236100237100238100239100240100241100242100243100244100245100246100247100248100249100250100251100252100253100254100255100256100257100258100259100260100261100262100263100264100265100266100267100268100269100270100271100272100273100274100275100276100277100278100279100280100281100282100283100284100285100286100287100288100289100290100291100292100293100294100295100296100297100298100299100300100301100302100303100304100305100306100307100308100309100310100311100312100313100314100315100316100317100318100319100320100321100322100323100324100325100326100327100328100329100330100331100332100333100334100335100336100337100338100339100340100341100342100343100344100345100346100347100348100349100350100351100352100353100354100355100356100357100358100359100360100361100362100363100364100365100366100367100368100369100370100371100372100373100374100375100376100377100378100379100380100381100382100383100384100385100386100387100388100389100390100391100392100393100394100395100396100397100398100399100400100401100402100403100404100405100406100407100408100409100410100411100412100413100414100415100416100417100418100419100420100421100422100423100424100425100426100427100428100429100430100431100432100433100434100435100436100437100438100439100440100441100442100443100444100445100446100447100448100449100450100451100452100453100454100455100456100457100458100459100460100461100462100463100464100465100466100467100468100469100470100471100472100473100474100475100476100477100478100479100480100481100482100483100484100485100486100487100488100489100490100491100492100493100494100495100496100497100498100499100500100501100502100503100504100505100506100507100508100509100510100511100512100513100514100515100516100517100518100519100520100521100522100523100524100525100526100527100528100529100530100531100532100533100534100535100536100537100538100539100540100541100542100543100544100545100546100547100548100549100550100551100552100553100554100555100556100557100558100559100560100561100562100563100564100565100566100567100568100569100570100571100572100573100574100575100576100577100578100579100580100581100582100583100584100585100586100587100588100589100590100591100592100593100594100595100596100597100598100599100600100601100602100603100604100605100606100607100608100609100610100611100612100613100614100615100616100617100618100619100620100621100622100623100624100625100626100627100628100629100630100631100632100633100634100635100636100637100638100639100640100641100642100643100644100645100646100647100648100649100650100651100652100653100654100655100656100657100658100659100660100661100662100663100664100665100666100667100668100669100670100671100672100673100674100675100676100677100678100679100680100681100682100683100684100685100686100687100688100689100690100691100692100693100694100695100696100697100698100699100700100701100702100703100704100705100706100707100708100709100710100711100712100713100714100715100716100717100718100719100720100721100722100723100724100725100726100727100728100729100730100731100732100733100734100735100736100737100738100739100740100741100742100743100744100745100746100747100748100749100750100751100752100753100754100755100756100757100758100759100760100761100762100763100764100765100766100767100768100769100770100771100772100773100774100775100776100777100778100779100780100781100782100783100784100785100786100787100788100789100790100791100792100793100794100795100796100797100798100799100800100801100802100803100804100805100806100807100808100809100810100811100812100813100814100815100816100817100818100819100820100821100822100823100824100825100826100827100828100829100830100831100832100833100834100835100836100837100838100839100840100841100842100843100844100845100846100847100848100849100850100851100852100853100854100855100856100857100858100859100860100861100862100863100864100865100866100867100868100869100870100871100872100873100874100875100876100877100878100879100880100881100882100883100884100885100886100887100888100889100890100891100892100893100894100895100896100897100898100899100900100901100902100903100904100905100906100907100908100909100910100911100912100913100914100915100916100917100918100919100920100921100922100923100924100925100926100927100928100929100930100931100932100933100934100935100936100937100938100939100940100941100942100943100944100945100946100947100948100949100950100951100952100953100954100955100956100957100958100959100960100961100962100963100964100965100966100967100968100969100970100971100972100973100974100975100976100977100978100979100980100981100982100983100984100985100986100987100988100989100990100991100992100993100994100995100996100997100998100999101000101001101002101003101004101005101006101007101008101009101010101011101012101013101014101015101016101017101018101019101020101021101022101023101024101025101026101027101028101029101030101031101032101033101034101035101036101037101038101039101040101041101042101043101044101045101046101047101048101049101050101051101052101053101054101055101056101057101058101059101060101061101062101063101064101065101066101067101068101069101070101071101072101073101074101075101076101077101078101079101080101081101082101083101084101085101086101087101088101089101090101091101092101093101094101095101096101097101098101099101100101101101102101103101104101105101106101107101108101109101110101111101112101113101114101115101116101117101118101119101120101121101122101123101124101125101126101127101128101129101130101131101132101133101134101135101136101137101138101139101140101141101142101143101144101145101146101147101148101149101150101151101152101153101154101155101156101157101158101159101160101161101162101163101164101165101166101167101168101169101170101171101172101173101174101175101176101177101178101179101180101181101182101183101184101185101186101187101188101189101190101191101192101193101194101195101196101197101198101199101200101201101202101203101204101205101206101207101208101209101210101211101212101213101214101215101216101217101218101219101220101221101222101223101224101225101226101227101228101229101230101231101232101233101234101235101236101237101238101239101240101241101242101243101244101245101246101247101248101249101250101251101252101253101254101255101256101257101258101259101260101261101262101263101264101265101266101267101268101269101270101271101272101273101274101275101276101277101278101279101280101281101282101283101284101285101286101287101288101289101290101291101292101293101294101295101296101297101298101299101300101301101302101303101304101305101306101307101308101309101310101311101312101313101314101315101316101317101318101319101320101321101322101323101324101325101326101327101328101329101330101331101332101333101334101335101336101337101338101339101340101341101342101343101344101345101346101347101348101349101350101351101352101353101354101355101356101357101358101359101360101361101362101363101364101365101366101367101368101369101370101371101372101373101374101375101376101377101378101379101380101381101382101383101384101385101386101387101388101389101390101391101392101393101394101395101396101397101398101399101400101401101402101403101404101405101406101407101408101409101410101411101412101413101414101415101416101417101418101419101420101421101422101423101424101425101426101427101428101429101430101431101432101433101434101435101436101437101438101439101440101441101442101443101444101445101446101447101448101449101450101451101452101453101454101455101456101457101458101459101460101461101462101463101464101465101466101467101468101469101470101471101472101473101474101475101476101477101478101479101480101481101482101483101484101485101486101487101488101489101490101491101492101493101494101495101496101497101498101499101500101501101502101503101504101505101506101507101508101509101510101511101512101513101514101515101516101517101518101519101520101521101522101523101524101525101526101527101528101529101530101531101532101533101534101535101536101537101538101539101540101541101542101543101544101545101546101547101548101549101550101551101552101553101554101555101556101557101558101559101560101561101562101563101564101565101566101567101568101569101570101571101572101573101574101575101576101577101578101579101580101581101582101583101584101585101586101587101588101589101590101591101592101593101594101595101596101597101598101599101600101601101602101603101604101605101606101607101608101609101610101611101612101613101614101615101616101617101618101619101620101621101622101623101624101625101626101627101628101629101630101631101632101633101634101635101636101637101638101639101640101641101642101643101644101645101646101647101648101649101650101651101652101653101654101655101656101657101658101659101660101661101662101663101664101665101666101667101668101669101670101671101672101673101674101675101676101677101678101679101680101681101682101683101684101685101686101687101688101689101690101691101692101693101694101695101696101697101698101699101700101701101702101703101704101705101706101707101708101709101710101711101712101713101714101715101716101717101718101719101720101721101722101723101724101725101726101727101728101729101730101731101732101733101734101735101736101737101738101739101740101741101742101743101744101745101746101747101748101749101750101751101752101753101754101755101756101757101758101759101760101761101762101763101764101765101766101767101768101769101770101771101772101773101774101775101776101777101778101779101780101781101782101783101784101785101786101787101788101789101790101791101792101793101794101795101796101797101798101799101800101801101802101803101804101805101806101807101808101809101810101811101812101813101814101815101816101817101818101819101820101821101822101823101824101825101826101827101828101829101830101831101832101833101834101835101836101837101838101839101840101841101842101843101844101845101846101847101848101849101850101851101852101853101854101855101856101857101858101859101860101861101862101863101864101865101866101867101868101869101870101871101872101873101874101875101876101877101878101879101880101881101882101883101884101885101886101887101888101889101890101891101892101893101894101895101896101897101898101899101900101901101902101903101904101905101906101907101908101909101910101911101912101913101914101915101916101917101918101919101920101921101922101923101924101925101926101927101928101929101930101931101932101933101934101935101936101937101938101939101940101941101942101943101944101945101946101947101948101949101950101951101952101953101954101955101956101957101958101959101960101961101962101963101964101965101966101967101968101969101970101971101972101973101974101975101976101977101978101979101980101981101982101983101984101985101986101987101988101989101990101991101992101993101994101995101996101997101998101999102000102001102002102003102004102005102006102007102008102009102010102011102012102013102014102015102016102017102018102019102020102021102022102023102024102025102026102027102028102029102030102031102032102033102034102035102036102037102038102039102040102041102042102043102044102045102046102047102048102049102050102051102052102053102054102055102056102057102058102059102060102061102062102063102064102065102066102067102068102069102070102071102072102073102074102075102076102077102078102079102080102081102082102083102084102085102086102087102088102089102090102091102092102093102094102095102096102097102098102099102100102101102102102103102104102105102106102107102108102109102110102111102112102113102114102115102116102117102118102119102120102121102122102123102124102125102126102127102128102129102130102131102132102133102134102135102136102137102138102139102140102141102142102143102144102145102146102147102148102149102150102151102152102153102154102155102156102157102158102159102160102161102162102163102164102165102166102167102168102169102170102171102172102173102174102175102176102177102178102179102180102181102182102183102184102185102186102187102188102189102190102191102192102193102194102195102196102197102198102199102200102201102202102203102204102205102206102207102208102209102210102211102212102213102214102215102216102217102218102219102220102221102222102223102224102225102226102227102228102229102230102231102232102233102234102235102236102237102238102239102240102241102242102243102244102245102246102247102248102249102250102251102252102253102254102255102256102257102258102259102260102261102262102263102264102265102266102267102268102269102270102271102272102273102274102275102276102277102278102279102280102281102282102283102284102285102286102287102288102289102290102291102292102293102294102295102296102297102298102299102300102301102302102303102304102305102306102307102308102309102310102311102312102313102314102315102316102317102318102319102320102321102322102323102324102325102326102327102328102329102330102331102332102333102334102335102336102337102338102339102340102341102342102343102344102345102346102347102348102349102350102351102352102353102354102355102356102357102358102359102360102361102362102363102364102365102366102367102368102369102370102371102372102373102374102375102376102377102378102379102380102381102382102383102384102385102386102387102388102389102390102391102392102393102394102395102396102397102398102399102400102401102402102403102404102405102406102407102408102409102410102411102412102413102414102415102416102417102418102419102420102421102422102423102424102425102426102427102428102429102430102431102432102433102434102435102436102437102438102439102440102441102442102443102444102445102446102447102448102449102450102451102452102453102454102455102456102457102458102459102460102461102462102463102464102465102466102467102468102469102470102471102472102473102474102475102476102477102478102479102480102481102482102483102484102485102486102487102488102489102490102491102492102493102494102495102496102497102498102499102500102501102502102503102504102505102506102507102508102509102510102511102512102513102514102515102516102517102518102519102520102521102522102523102524102525102526102527102528102529102530102531102532102533102534102535102536102537102538102539102540102541102542102543102544102545102546102547102548102549102550102551102552102553102554102555102556102557102558102559102560102561102562102563102564102565102566102567102568102569102570102571102572102573102574102575102576102577102578102579102580102581102582102583102584102585102586102587102588102589102590102591102592102593102594102595102596102597102598102599102600102601102602102603102604102605102606102607102608102609102610102611102612102613102614102615102616102617102618102619102620102621102622102623102624102625102626102627102628102629102630102631102632102633102634102635102636102637102638102639102640102641102642102643102644102645102646102647102648102649102650102651102652102653102654102655102656102657102658102659102660102661102662102663102664102665102666102667102668102669102670102671102672102673102674102675102676102677102678102679102680102681102682102683102684102685102686102687102688102689102690102691102692102693102694102695102696102697102698102699102700102701102702102703102704102705102706102707102708102709102710102711102712102713102714102715102716102717102718102719102720102721102722102723102724102725102726102727102728102729102730102731102732102733102734102735102736102737102738102739102740102741102742102743102744102745102746102747102748102749102750102751102752102753102754102755102756102757102758102759102760102761102762102763102764102765102766102767102768102769102770102771102772102773102774102775102776102777102778102779102780102781102782102783102784102785102786102787102788102789102790102791102792102793102794102795102796102797102798102799102800102801102802102803102804102805102806102807102808102809102810102811102812102813102814102815102816102817102818102819102820102821102822102823102824102825102826102827102828102829102830102831102832102833102834102835102836102837102838102839102840102841102842102843102844102845102846102847102848102849102850102851102852102853102854102855102856102857102858102859102860102861102862102863102864102865102866102867102868102869102870102871102872102873102874102875102876102877102878102879102880102881102882102883102884102885102886102887102888102889102890102891102892102893102894102895102896102897102898102899102900102901102902102903102904102905102906102907102908102909102910102911102912102913102914102915102916102917102918102919102920102921102922102923102924102925102926102927102928102929102930102931102932102933102934102935102936102937102938102939102940102941102942102943102944102945102946102947102948102949102950102951102952102953102954102955102956102957102958102959102960102961102962102963102964102965102966102967102968102969102970102971102972102973102974102975102976102977102978102979102980102981102982102983102984102985102986102987102988102989102990102991102992102993102994102995102996102997102998102999103000103001103002103003103004103005103006103007103008103009103010103011103012103013103014103015103016103017103018103019103020103021103022103023103024103025103026103027103028103029103030103031103032103033103034103035103036103037103038103039103040103041103042103043103044103045103046103047103048103049103050103051103052103053103054103055103056103057103058103059103060103061103062103063103064103065103066103067103068103069103070103071103072103073103074103075103076103077103078103079103080103081103082103083103084103085103086103087103088103089103090103091103092103093103094103095103096103097103098103099103100103101103102103103103104103105103106103107103108103109103110103111103112103113103114103115103116103117103118103119103120103121103122103123103124103125103126103127103128103129103130103131103132103133103134103135103136103137103138103139103140103141103142103143103144103145103146103147103148103149103150103151103152103153103154103155103156103157103158103159103160103161103162103163103164103165103166103167103168103169103170103171103172103173103174103175103176103177103178103179103180103181103182103183103184103185103186103187103188103189103190103191103192103193103194103195103196103197103198103199103200103201103202103203103204103205103206103207103208103209103210103211103212103213103214103215103216103217103218103219103220103221103222103223103224103225103226103227103228103229103230103231103232103233103234103235103236103237103238103239103240103241103242103243103244103245103246103247103248103249103250103251103252103253103254103255103256103257103258103259103260103261103262103263103264103265103266103267103268103269103270103271103272103273103274103275103276103277103278103279103280103281103282103283103284103285103286103287103288103289103290103291103292103293103294103295103296103297103298103299103300103301103302103303103304103305103306103307103308103309103310103311103312103313103314103315103316103317103318103319103320103321103322103323103324103325103326103327103328103329103330103331103332103333103334103335103336103337103338103339103340103341103342103343103344103345103346103347103348103349103350103351103352103353103354103355103356103357103358103359103360103361103362103363103364103365103366103367103368103369103370103371103372103373103374103375103376103377103378103379103380103381103382103383103384103385103386103387103388103389103390103391103392103393103394103395103396103397103398103399103400103401103402103403103404103405103406103407103408103409103410103411103412103413103414103415103416103417103418103419103420103421103422103423103424103425103426103427103428103429103430103431103432103433103434103435103436103437103438103439103440103441103442103443103444103445103446103447103448103449103450103451103452103453103454103455103456103457103458103459103460103461103462103463103464103465103466103467103468103469103470103471103472103473103474103475103476103477103478103479103480103481103482103483103484103485103486103487103488103489103490103491103492103493103494103495103496103497103498103499103500103501103502103503103504103505103506103507103508103509103510103511103512103513103514103515103516103517103518103519103520103521103522103523103524103525103526103527103528103529103530103531103532103533103534103535103536103537103538103539103540103541103542103543103544103545103546103547103548103549103550103551103552103553103554103555103556103557103558103559103560103561103562103563103564103565103566103567103568103569103570103571103572103573103574103575103576103577103578103579103580103581103582103583103584103585103586103587103588103589103590103591103592103593103594103595103596103597103598103599103600103601103602103603103604103605103606103607103608103609103610103611103612103613103614103615103616103617103618103619103620103621103622103623103624103625103626103627103628103629103630103631103632103633103634103635103636103637103638103639103640103641103642103643103644103645103646103647103648103649103650103651103652103653103654103655103656103657103658103659103660103661103662103663103664103665103666103667103668103669103670103671103672103673103674103675103676103677103678103679103680103681103682103683103684103685103686103687103688103689103690103691103692103693103694103695103696103697103698103699103700103701103702103703103704103705103706103707103708103709103710103711103712103713103714103715103716103717103718103719103720103721103722103723103724103725103726103727103728103729103730103731103732103733103734103735103736103737103738103739103740103741103742103743103744103745103746103747103748103749103750103751103752103753103754103755103756103757103758103759103760103761103762103763103764103765103766103767103768103769103770103771103772103773103774103775103776103777103778103779103780103781103782103783103784103785103786103787103788103789103790103791103792103793103794103795103796103797103798103799103800103801103802103803103804103805103806103807103808103809103810103811103812103813103814103815103816103817103818103819103820103821103822103823103824103825103826103827103828103829103830103831103832103833103834103835103836103837103838103839103840103841103842103843103844103845103846103847103848103849103850103851103852103853103854103855103856103857103858103859103860103861103862103863103864103865103866103867103868103869103870103871103872103873103874103875103876103877103878103879103880103881103882103883103884103885103886103887103888103889103890103891103892103893103894103895103896103897103898103899103900103901103902103903103904103905103906103907103908103909103910103911103912103913103914103915103916103917103918103919103920103921103922103923103924103925103926103927103928103929103930103931103932103933103934103935103936103937103938103939103940103941103942103943103944103945103946103947103948103949103950103951103952103953103954103955103956103957103958103959103960103961103962103963103964103965103966103967103968103969103970103971103972103973103974103975103976103977103978103979103980103981103982103983103984103985103986103987103988103989103990103991103992103993103994103995103996103997103998103999104000104001104002104003104004104005104006104007104008104009104010104011104012104013104014104015104016104017104018104019104020104021104022104023104024104025104026104027104028104029104030104031104032104033104034104035104036104037104038104039104040104041104042104043104044104045104046104047104048104049104050104051104052104053104054104055104056104057104058104059104060104061104062104063104064104065104066104067104068104069104070104071104072104073104074104075104076104077104078104079104080104081104082104083104084104085104086104087104088104089104090104091104092104093104094104095104096104097104098104099104100104101104102104103104104104105104106104107104108104109104110104111104112104113104114104115104116104117104118104119104120104121104122104123104124104125104126104127104128104129104130104131104132104133104134104135104136104137104138104139104140104141104142104143104144104145104146104147104148104149104150104151104152104153104154104155104156104157104158104159104160104161104162104163104164104165104166104167104168104169104170104171104172104173104174104175104176104177104178104179104180104181104182104183104184104185104186104187104188104189104190104191104192104193104194104195104196104197104198104199104200104201104202104203104204104205104206104207104208104209104210104211104212104213104214104215104216104217104218104219104220104221104222104223104224104225104226104227104228104229104230104231104232104233104234104235104236104237104238104239104240104241104242104243104244104245104246104247104248104249104250104251104252104253104254104255104256104257104258104259104260104261104262104263104264104265104266104267104268104269104270104271104272104273104274104275104276104277104278104279104280104281104282104283104284104285104286104287104288104289104290104291104292104293104294104295104296104297104298104299104300104301104302104303104304104305104306104307104308104309104310104311104312104313104314104315104316104317104318104319104320104321104322104323104324104325104326104327104328104329104330104331104332104333104334104335104336104337104338104339104340104341104342104343104344104345104346104347104348104349104350104351104352104353104354104355104356104357104358104359104360104361104362104363104364104365104366104367104368104369104370104371104372104373104374104375104376104377104378104379104380104381104382104383104384104385104386104387104388104389104390104391104392104393104394104395104396104397104398104399104400104401104402104403104404104405104406104407104408104409104410104411104412104413104414104415104416104417104418104419104420104421104422104423104424104425104426104427104428104429104430104431104432104433104434104435104436104437104438104439104440104441104442104443104444104445104446104447104448104449104450104451104452104453104454104455104456104457104458104459104460104461104462104463104464104465104466104467104468104469104470104471104472104473104474104475104476104477104478104479104480104481104482104483104484104485104486104487104488104489104490104491104492104493104494104495104496104497104498104499104500104501104502104503104504104505104506104507104508104509104510104511104512104513104514104515104516104517104518104519104520104521104522104523104524104525104526104527104528104529104530104531104532104533104534104535104536104537104538104539104540104541104542104543104544104545104546104547104548104549104550104551104552104553104554104555104556104557104558104559104560104561104562104563104564104565104566104567104568104569104570104571104572104573104574104575104576104577104578104579104580104581104582104583104584104585104586104587104588104589104590104591104592104593104594104595104596104597104598104599104600104601104602104603104604104605104606104607104608104609104610104611104612104613104614104615104616104617104618104619104620104621104622104623104624104625104626104627104628104629104630104631104632104633104634104635104636104637104638104639104640104641104642104643104644104645104646104647104648104649104650104651104652104653104654104655104656104657104658104659104660104661104662104663104664104665104666104667104668104669104670104671104672104673104674104675104676104677104678104679104680104681104682104683104684104685104686104687104688104689104690104691104692104693104694104695104696104697104698104699104700104701104702104703104704104705104706104707104708104709104710104711104712104713104714104715104716104717104718104719104720104721104722104723104724104725104726104727104728104729104730104731104732104733104734104735104736104737104738104739104740104741104742104743104744104745104746104747104748104749104750104751104752104753104754104755104756104757104758104759104760104761104762104763104764104765104766104767104768104769104770104771104772104773104774104775104776104777104778104779104780104781104782104783104784104785104786104787104788104789104790104791104792104793104794104795104796104797104798104799104800104801104802104803104804104805104806104807104808104809104810104811104812104813104814104815104816104817104818104819104820104821104822104823104824104825104826104827104828104829104830104831104832104833104834104835104836104837104838104839104840104841104842104843104844104845104846104847104848104849104850104851104852104853104854104855104856104857104858104859104860104861104862104863104864104865104866104867104868104869104870104871104872104873104874104875104876104877104878104879104880104881104882104883104884104885104886104887104888104889104890104891104892104893104894104895104896104897104898104899104900104901104902104903104904104905104906104907104908104909104910104911104912104913104914104915104916104917104918104919104920104921104922104923104924104925104926104927104928104929104930104931104932104933104934104935104936104937104938104939104940104941104942104943104944104945104946104947104948104949104950104951104952104953104954104955104956104957104958104959104960104961104962104963104964104965104966104967104968104969104970104971104972104973104974104975104976104977104978104979104980104981104982104983104984104985104986104987104988104989104990104991104992104993104994104995104996104997104998104999105000105001105002105003105004105005105006105007105008105009105010105011105012105013105014105015105016105017105018105019105020105021105022105023105024105025105026105027105028105029105030105031105032105033105034105035105036105037105038105039105040105041105042105043105044105045105046105047105048105049105050105051105052105053105054105055105056105057105058105059105060105061105062105063105064105065105066105067105068105069105070105071105072105073105074105075105076105077105078105079105080105081105082105083105084105085105086105087105088105089105090105091105092105093105094105095105096105097105098105099105100105101105102105103105104105105105106105107105108105109105110105111105112105113105114105115105116105117105118105119105120105121105122105123105124105125105126105127105128105129105130105131105132105133105134105135105136105137105138105139105140105141105142105143105144105145105146105147105148105149105150105151105152105153105154105155105156105157105158105159105160105161105162105163105164105165105166105167105168105169105170105171105172105173105174105175105176105177105178105179105180105181105182105183105184105185105186105187105188105189105190105191105192105193105194105195105196105197105198105199105200105201105202105203105204105205105206105207105208105209105210105211105212105213105214105215105216105217105218105219105220105221105222105223105224105225105226105227105228105229105230105231105232105233105234105235105236105237105238105239105240105241105242105243105244105245105246105247105248105249105250105251105252105253105254105255105256105257105258105259105260105261105262105263105264105265105266105267105268105269105270105271105272105273105274105275105276105277105278105279105280105281105282105283105284105285105286105287105288105289105290105291105292105293105294105295105296105297105298105299105300105301105302105303105304105305105306105307105308105309105310105311105312105313105314105315105316105317105318105319105320105321105322105323105324105325105326105327105328105329105330105331105332105333105334105335105336105337105338105339105340105341105342105343105344105345105346105347105348105349105350105351105352105353105354105355105356105357105358105359105360105361105362105363105364105365105366105367105368105369105370105371105372105373105374105375105376105377105378105379105380105381105382105383105384105385105386105387105388105389105390105391105392105393105394105395105396105397105398105399105400105401105402105403105404105405105406105407105408105409105410105411105412105413105414105415105416105417105418105419105420105421105422105423105424105425105426105427105428105429105430105431105432105433105434105435105436105437105438105439105440105441105442105443105444105445105446105447105448105449105450105451105452105453105454105455105456105457105458105459105460105461105462105463105464105465105466105467105468105469105470105471105472105473105474105475105476105477105478105479105480105481105482105483105484105485105486105487105488105489105490105491105492105493105494105495105496105497105498105499105500105501105502105503105504105505105506105507105508105509105510105511105512105513105514105515105516105517105518105519105520105521105522105523105524105525105526105527105528105529105530105531105532105533105534105535105536105537105538105539105540105541105542105543105544105545105546105547105548105549105550105551105552105553105554105555105556105557105558105559105560105561105562105563105564105565105566105567105568105569105570105571105572105573105574105575105576105577105578105579105580105581105582105583105584105585105586105587105588105589105590105591105592105593105594105595105596105597105598105599105600105601105602105603105604105605105606105607105608105609105610105611105612105613105614105615105616105617105618105619105620105621105622105623105624105625105626105627105628105629105630105631105632105633105634105635105636105637105638105639105640105641105642105643105644105645105646105647105648105649105650105651105652105653105654105655105656105657105658105659105660105661105662105663105664105665105666105667105668105669105670105671105672105673105674105675105676105677105678105679105680105681105682105683105684105685105686105687105688105689105690105691105692105693105694105695105696105697105698105699105700105701105702105703105704105705105706105707105708105709105710105711105712105713105714105715105716105717105718105719105720105721105722105723105724105725105726105727105728105729105730105731105732105733105734105735105736105737105738105739105740105741105742105743105744105745105746105747105748105749105750105751105752105753105754105755105756105757105758105759105760105761105762105763105764105765105766105767105768105769105770105771105772105773105774105775105776105777105778105779105780105781105782105783105784105785105786105787105788105789105790105791105792105793105794105795105796105797105798105799105800105801105802105803105804105805105806105807105808105809105810105811105812105813105814105815105816105817105818105819105820105821105822105823105824105825105826105827105828105829105830105831105832105833105834105835105836105837105838105839105840105841105842105843105844105845105846105847105848105849105850105851105852105853105854105855105856105857105858105859105860105861105862105863105864105865105866105867105868105869105870105871105872105873105874105875105876105877105878105879105880105881105882105883105884105885105886105887105888105889105890105891105892105893105894105895105896105897105898105899105900105901105902105903105904105905105906105907105908105909105910105911105912105913105914105915105916105917105918105919105920105921105922105923105924105925105926105927105928105929105930105931105932105933105934105935105936105937105938105939105940105941105942105943105944105945105946105947105948105949105950105951105952105953105954105955105956105957105958105959105960105961105962105963105964105965105966105967105968105969105970105971105972105973105974105975105976105977105978105979105980105981105982105983105984105985105986105987105988105989105990105991105992105993105994105995105996105997105998105999106000106001106002106003106004106005106006106007106008106009106010106011106012106013106014106015106016106017106018106019106020106021106022106023106024106025106026106027106028106029106030106031106032106033106034106035106036106037106038106039106040106041106042106043106044106045106046106047106048106049106050106051106052106053106054106055106056106057106058106059106060106061106062106063106064106065106066106067106068106069106070106071106072106073106074106075106076106077106078106079106080106081106082106083106084106085106086106087106088106089106090106091106092106093106094106095106096106097106098106099106100106101106102106103106104106105106106106107106108106109106110106111106112106113106114106115106116106117106118106119106120106121106122106123106124106125106126106127106128106129106130106131106132106133106134106135106136106137106138106139106140106141106142106143106144106145106146106147106148106149106150106151106152106153106154106155106156106157106158106159106160106161106162106163106164106165106166106167106168106169106170106171106172106173106174106175106176106177106178106179106180106181106182106183106184106185106186106187106188106189106190106191106192106193106194106195106196106197106198106199106200106201106202106203106204106205106206106207106208106209106210106211106212106213106214106215106216106217106218106219106220106221106222106223106224106225106226106227106228106229106230106231106232106233106234106235106236106237106238106239106240106241106242106243106244106245106246106247106248106249106250106251106252106253106254106255106256106257106258106259106260106261106262106263106264106265106266106267106268106269106270106271106272106273106274106275106276106277106278106279106280106281106282106283106284106285106286106287106288106289106290106291106292106293106294106295106296106297106298106299106300106301106302106303106304106305106306106307106308106309106310106311106312106313106314106315106316106317106318106319106320106321106322106323106324106325106326106327106328106329106330106331106332106333106334106335106336106337106338106339106340106341106342106343106344106345106346106347106348106349106350106351106352106353106354106355106356106357106358106359106360106361106362106363106364106365106366106367106368106369106370106371106372106373106374106375106376106377106378106379106380106381106382106383106384106385106386106387106388106389106390106391106392106393106394106395106396106397106398106399106400106401106402106403106404106405106406106407106408106409106410106411106412106413106414106415106416106417106418106419106420106421106422106423106424106425106426106427106428106429106430106431106432106433106434106435106436106437106438106439106440106441106442106443106444106445106446106447106448106449106450106451106452106453106454106455106456106457106458106459106460106461106462106463106464106465106466106467106468106469106470106471106472106473106474106475106476106477106478106479106480106481106482106483106484106485106486106487106488106489106490106491106492106493106494106495106496106497106498106499106500106501106502106503106504106505106506106507106508106509106510106511106512106513106514106515106516106517106518106519106520106521106522106523106524106525106526106527106528106529106530106531106532106533106534106535106536106537106538106539106540106541106542106543106544106545106546106547106548106549106550106551106552106553106554106555106556106557106558106559106560106561106562106563106564106565106566106567106568106569106570106571106572106573106574106575106576106577106578106579106580106581106582106583106584106585106586106587106588106589106590106591106592106593106594106595106596106597106598106599106600106601106602106603106604106605106606106607106608106609106610106611106612106613106614106615106616106617106618106619106620106621106622106623106624106625106626106627106628106629106630106631106632106633106634106635106636106637106638106639106640106641106642106643106644106645106646106647106648106649106650106651106652106653106654106655106656106657106658106659106660106661106662106663106664106665106666106667106668106669106670106671106672106673106674106675106676106677106678106679106680106681106682106683106684106685106686106687106688106689106690106691106692106693106694106695106696106697106698106699106700106701106702106703106704106705106706106707106708106709106710106711106712106713106714106715106716106717106718106719106720106721106722106723106724106725106726106727106728106729106730106731106732106733106734106735106736106737106738106739106740106741106742106743106744106745106746106747106748106749106750106751106752106753106754106755106756106757106758106759106760106761106762106763106764106765106766106767106768106769106770106771106772106773106774106775106776106777106778106779106780106781106782106783106784106785106786106787106788106789106790106791106792106793106794106795106796106797106798106799106800106801106802106803106804106805106806106807106808106809106810106811106812106813106814106815106816106817106818106819106820106821106822106823106824106825106826106827106828106829106830106831106832106833106834106835106836106837106838106839106840106841106842106843106844106845106846106847106848106849106850106851106852106853106854106855106856106857106858106859106860106861106862106863106864106865106866106867106868106869106870106871106872106873106874106875106876106877106878106879106880106881106882106883106884106885106886106887106888106889106890106891106892106893106894106895106896106897106898106899106900106901106902106903106904106905106906106907106908106909106910106911106912106913106914106915106916106917106918106919106920106921106922106923106924106925106926106927106928106929106930106931106932106933106934106935106936106937106938106939106940106941106942106943106944106945106946106947106948106949106950106951106952106953106954106955106956106957106958106959106960106961106962106963106964106965106966106967106968106969106970106971106972106973106974106975106976106977106978106979106980106981106982106983106984106985106986106987106988106989106990106991106992106993106994106995106996106997106998106999107000107001107002107003107004107005107006107007107008107009107010107011107012107013107014107015107016107017107018107019107020107021107022107023107024107025107026107027107028107029107030107031107032107033107034107035107036107037107038107039107040107041107042107043107044107045107046107047107048107049107050107051107052107053107054107055107056107057107058107059107060107061107062107063107064107065107066107067107068107069107070107071107072107073107074107075107076107077107078107079107080107081107082107083107084107085107086107087107088107089107090107091107092107093107094107095107096107097107098107099107100107101107102107103107104107105107106107107107108107109107110107111107112107113107114107115107116107117107118107119107120107121107122107123107124107125107126107127107128107129107130107131107132107133107134107135107136107137107138107139107140107141107142107143107144107145107146107147107148107149107150107151107152107153107154107155107156107157107158107159107160107161107162107163107164107165107166107167107168107169107170107171107172107173107174107175107176107177107178107179107180107181107182107183107184107185107186107187107188107189107190107191107192107193107194107195107196107197107198107199107200107201107202107203107204107205107206107207107208107209107210107211107212107213107214107215107216107217107218107219107220107221107222107223107224107225107226107227107228107229107230107231107232107233107234107235107236107237107238107239107240107241107242107243107244107245107246107247107248107249107250107251107252107253107254107255107256107257107258107259107260107261107262107263107264107265107266107267107268107269107270107271107272107273107274107275107276107277107278107279107280107281107282107283107284107285107286107287107288107289107290107291107292107293107294107295107296107297107298107299107300107301107302107303107304107305107306107307107308107309107310107311107312107313107314107315107316107317107318107319107320107321107322107323107324107325107326107327107328107329107330107331107332107333107334107335107336107337107338107339107340107341107342107343107344107345107346107347107348107349107350107351107352107353107354107355107356107357107358107359107360107361107362107363107364107365107366107367107368107369107370107371107372107373107374107375107376107377107378107379107380107381107382107383107384107385107386107387107388107389107390107391107392107393107394107395107396107397107398107399107400107401107402107403107404107405107406107407107408107409107410107411107412107413107414107415107416107417107418107419107420107421107422107423107424107425107426107427107428107429107430107431107432107433107434107435107436107437107438107439107440107441107442107443107444107445107446107447107448107449107450107451107452107453107454107455107456107457107458107459107460107461107462107463107464107465107466107467107468107469107470107471107472107473107474107475107476107477107478107479107480107481107482107483107484107485107486107487107488107489107490107491107492107493107494107495107496107497107498107499107500107501107502107503107504107505107506107507107508107509107510107511107512107513107514107515107516107517107518107519107520107521107522107523107524107525107526107527107528107529107530107531107532107533107534107535107536107537107538107539107540107541107542107543107544107545107546107547107548107549107550107551107552107553107554107555107556107557107558107559107560107561107562107563107564107565107566107567107568107569107570107571107572107573107574107575107576107577107578107579107580107581107582107583107584107585107586107587107588107589107590107591107592107593107594107595107596107597107598107599107600107601107602107603107604107605107606107607107608107609107610107611107612107613107614107615107616107617107618107619107620107621107622107623107624107625107626107627107628107629107630107631107632107633107634107635107636107637107638107639107640107641107642107643107644107645107646107647107648107649107650107651107652107653107654107655107656107657107658107659107660107661107662107663107664107665107666107667107668107669107670107671107672107673107674107675107676107677107678107679107680107681107682107683107684107685107686107687107688107689107690107691107692107693107694107695107696107697107698107699107700107701107702107703107704107705107706107707107708107709107710107711107712107713107714107715107716107717107718107719107720107721107722107723107724107725107726107727107728107729107730107731107732107733107734107735107736107737107738107739107740107741107742107743107744107745107746107747107748107749107750107751107752107753107754107755107756107757107758107759107760107761107762107763107764107765107766107767107768107769107770107771107772107773107774107775107776107777107778107779107780107781107782107783107784107785107786107787107788107789107790107791107792107793107794107795107796107797107798107799107800107801107802107803107804107805107806107807107808107809107810107811107812107813107814107815107816107817107818107819107820107821107822107823107824107825107826107827107828107829107830107831107832107833107834107835107836107837107838107839107840107841107842107843107844107845107846107847107848107849107850107851107852107853107854107855107856107857107858107859107860107861107862107863107864107865107866107867107868107869107870107871107872107873107874107875107876107877107878107879107880107881107882107883107884107885107886107887107888107889107890107891107892107893107894107895107896107897107898107899107900107901107902107903107904107905107906107907107908107909107910107911107912107913107914107915107916107917107918107919107920107921107922107923107924107925107926107927107928107929107930107931107932107933107934107935107936107937107938107939107940107941107942107943107944107945107946107947107948107949107950107951107952107953107954107955107956107957107958107959107960107961107962107963107964107965107966107967107968107969107970107971107972107973107974107975107976107977107978107979107980107981107982107983107984107985107986107987107988107989107990107991107992107993107994107995107996107997107998107999108000108001108002108003108004108005108006108007108008108009108010108011108012108013108014108015108016108017108018108019108020108021108022108023108024108025108026108027108028108029108030108031108032108033108034108035108036108037108038108039108040108041108042108043108044108045108046108047108048108049108050108051108052108053108054108055108056108057108058108059108060108061108062108063108064108065108066108067108068108069108070108071108072108073108074108075108076108077108078108079108080108081108082108083108084108085108086108087108088108089108090108091108092108093108094108095108096108097108098108099108100108101108102108103108104108105108106108107108108108109108110108111108112108113108114108115108116108117108118108119108120108121108122108123108124108125108126108127108128108129108130108131108132108133108134108135108136108137108138108139108140108141108142108143108144108145108146108147108148108149108150108151108152108153108154108155108156108157108158108159108160108161108162108163108164108165108166108167108168108169108170108171108172108173108174108175108176108177108178108179108180108181108182108183108184108185108186108187108188108189108190108191108192108193108194108195108196108197108198108199108200108201108202108203108204108205108206108207108208108209108210108211108212108213108214108215108216108217108218108219108220108221108222108223108224108225108226108227108228108229108230108231108232108233108234108235108236108237108238108239108240108241108242108243108244108245108246108247108248108249108250108251108252108253108254108255108256108257108258108259108260108261108262108263108264108265108266108267108268108269108270108271108272108273108274108275108276108277108278108279108280108281108282108283108284108285108286108287108288108289108290108291108292108293108294108295108296108297108298108299108300108301108302108303108304108305108306108307108308108309108310108311108312108313108314108315108316108317108318108319108320108321108322108323108324108325108326108327108328108329108330108331108332108333108334108335108336108337108338108339108340108341108342108343108344108345108346108347108348108349108350108351108352108353108354108355108356108357108358108359108360108361108362108363108364108365108366108367108368108369108370108371108372108373108374108375108376108377108378108379108380108381108382108383108384108385108386108387108388108389108390108391108392108393108394108395108396108397108398108399108400108401108402108403108404108405108406108407108408108409108410108411108412108413108414108415108416108417108418108419108420108421108422108423108424108425108426108427108428108429108430108431108432108433108434108435108436108437108438108439108440108441108442108443108444108445108446108447108448108449108450108451108452108453108454108455108456108457108458108459108460108461108462108463108464108465108466108467108468108469108470108471108472108473108474108475108476108477108478108479108480108481108482108483108484108485108486108487108488108489108490108491108492108493108494108495108496108497108498108499108500108501108502108503108504108505108506108507108508108509108510108511108512108513108514108515108516108517108518108519108520108521108522108523108524108525108526108527108528108529108530108531108532108533108534108535108536108537108538108539108540108541108542108543108544108545108546108547108548108549108550108551108552108553108554108555108556108557108558108559108560108561108562108563108564108565108566108567108568108569108570108571108572108573108574108575108576108577108578108579108580108581108582108583108584108585108586108587108588108589108590108591108592108593108594108595108596108597108598108599108600108601108602108603108604108605108606108607108608108609108610108611108612108613108614108615108616108617108618108619108620108621108622108623108624108625108626108627108628108629108630108631108632108633108634108635108636108637108638108639108640108641108642108643108644108645108646108647108648108649108650108651108652108653108654108655108656108657108658108659108660108661108662108663108664108665108666108667108668108669108670108671108672108673108674108675108676108677108678108679108680108681108682108683108684108685108686108687108688108689108690108691108692108693108694108695108696108697108698108699108700108701108702108703108704108705108706108707108708108709108710108711108712108713108714108715108716108717108718108719108720108721108722108723108724108725108726108727108728108729108730108731108732108733108734108735108736108737108738108739108740108741108742108743108744108745108746108747108748108749108750108751108752108753108754108755108756108757108758108759108760108761108762108763108764108765108766108767108768108769108770108771108772108773108774108775108776108777108778108779108780108781108782108783108784108785108786108787108788108789108790108791108792108793108794108795108796108797108798108799108800108801108802108803108804108805108806108807108808108809108810108811108812108813108814108815108816108817108818108819108820108821108822108823108824108825108826108827108828108829108830108831108832108833108834108835108836108837108838108839108840108841108842108843108844108845108846108847108848108849108850108851108852108853108854108855108856108857108858108859108860108861108862108863108864108865108866108867108868108869108870108871108872108873108874108875108876108877108878108879108880108881108882108883108884108885108886108887108888108889108890108891108892108893108894108895108896108897108898108899108900108901108902108903108904108905108906108907108908108909108910108911108912108913108914108915108916108917108918108919108920108921108922108923108924108925108926108927108928108929108930108931108932108933108934108935108936108937108938108939108940108941108942108943108944108945108946108947108948108949108950108951108952108953108954108955108956108957108958108959108960108961108962108963108964108965108966108967108968108969108970108971108972108973108974108975108976108977108978108979108980108981108982108983108984108985108986108987108988108989108990108991108992108993108994108995108996108997108998108999109000109001109002109003109004109005109006109007109008109009109010109011109012109013109014109015109016109017109018109019109020109021109022109023109024109025109026109027109028109029109030109031109032109033109034109035109036109037109038109039109040109041109042109043109044109045109046109047109048109049109050109051109052109053109054109055109056109057109058109059109060109061109062109063109064109065109066109067109068109069109070109071109072109073109074109075109076109077109078109079109080109081109082109083109084109085109086109087109088109089109090109091109092109093109094109095109096109097109098109099109100109101109102109103109104109105109106109107109108109109109110109111109112109113109114109115109116109117109118109119109120109121109122109123109124109125109126109127109128109129109130109131109132109133109134109135109136109137109138109139109140109141109142109143109144109145109146109147109148109149109150109151109152109153109154109155109156109157109158109159109160109161109162109163109164109165109166109167109168109169109170109171109172109173109174109175109176109177109178109179109180109181109182109183109184109185109186109187109188109189109190109191109192109193109194109195109196109197109198109199109200109201109202109203109204109205109206109207109208109209109210109211109212109213109214109215109216109217109218109219109220109221109222109223109224109225109226109227109228109229109230109231109232109233109234109235109236109237109238109239109240109241109242109243109244109245109246109247109248109249109250109251109252109253109254109255109256109257109258109259109260109261109262109263109264109265109266109267109268109269109270109271109272109273109274109275109276109277109278109279109280109281109282109283109284109285109286109287109288109289109290109291109292109293109294109295109296109297109298109299109300109301109302109303109304109305109306109307109308109309109310109311109312109313109314109315109316109317109318109319109320109321109322109323109324109325109326109327109328109329109330109331109332109333109334109335109336109337109338109339109340109341109342109343109344109345109346109347109348109349109350109351109352109353109354109355109356109357109358109359109360109361109362109363109364109365109366109367109368109369109370109371109372109373109374109375109376109377109378109379109380109381109382109383109384109385109386109387109388109389109390109391109392109393109394109395109396109397109398109399109400109401109402109403109404109405109406109407109408109409109410109411109412109413109414109415109416109417109418109419109420109421109422109423109424109425109426109427109428109429109430109431109432109433109434109435109436109437109438109439109440109441109442109443109444109445109446109447109448109449109450109451109452109453109454109455109456109457109458109459109460109461109462109463109464109465109466109467109468109469109470109471109472109473109474109475109476109477109478109479109480109481109482109483109484109485109486109487109488109489109490109491109492109493109494109495109496109497109498109499109500109501109502109503109504109505109506109507109508109509109510109511109512109513109514109515109516109517109518109519109520109521109522109523109524109525109526109527109528109529109530109531109532109533109534109535109536109537109538109539109540109541109542109543109544109545109546109547109548109549109550109551109552109553109554109555109556109557109558109559109560109561109562109563109564109565109566109567109568109569109570109571109572109573109574109575109576109577109578109579109580109581109582109583109584109585109586109587109588109589109590109591109592109593109594109595109596109597109598109599109600109601109602109603109604109605109606109607109608109609109610109611109612109613109614109615109616109617109618109619109620109621109622109623109624109625109626109627109628109629109630109631109632109633109634109635109636109637109638109639109640109641109642109643109644109645109646109647109648109649109650109651109652109653109654109655109656109657109658109659109660109661109662109663109664109665109666109667109668109669109670109671109672109673109674109675109676109677109678109679109680109681109682109683109684109685109686109687109688109689109690109691109692109693109694109695109696109697109698109699109700109701109702109703109704109705109706109707109708109709109710109711109712109713109714109715109716109717109718109719109720109721109722109723109724109725109726109727109728109729109730109731109732109733109734109735109736109737109738109739109740109741109742109743109744109745109746109747109748109749109750109751109752109753109754109755109756109757109758109759109760109761109762109763109764109765109766109767109768109769109770109771109772109773109774109775109776109777109778109779109780109781109782109783109784109785109786109787109788109789109790109791109792109793109794109795109796109797109798109799109800109801109802109803109804109805109806109807109808109809109810109811109812109813109814109815109816109817109818109819109820109821109822109823109824109825109826109827109828109829109830109831109832109833109834109835109836109837109838109839109840109841109842109843109844109845109846109847109848109849109850109851109852109853109854109855109856109857109858109859109860109861109862109863109864109865109866109867109868109869109870109871109872109873109874109875109876109877109878109879109880109881109882109883109884109885109886109887109888109889109890109891109892109893109894109895109896109897109898109899109900109901109902109903109904109905109906109907109908109909109910109911109912109913109914109915109916109917109918109919109920109921109922109923109924109925109926109927109928109929109930109931109932109933109934109935109936109937109938109939109940109941109942109943109944109945109946109947109948109949109950109951109952109953109954109955109956109957109958109959109960109961109962109963109964109965109966109967109968109969109970109971109972109973109974109975109976109977109978109979109980109981109982109983109984109985109986109987109988109989109990109991109992109993109994109995109996109997109998109999110000110001110002110003110004110005110006110007110008110009110010110011110012110013110014110015110016110017110018110019110020110021110022110023110024110025110026110027110028110029110030110031110032110033110034110035110036110037110038110039110040110041110042110043110044110045110046110047110048110049110050110051110052110053110054110055110056110057110058110059110060110061110062110063110064110065110066110067110068110069110070110071110072110073110074110075110076110077110078110079110080110081110082110083110084110085110086110087110088110089110090110091110092110093110094110095110096110097110098110099110100110101110102110103110104110105110106110107110108110109110110110111110112110113110114110115110116110117110118110119110120110121110122110123110124110125110126110127110128110129110130110131110132110133110134110135110136110137110138110139110140110141110142110143110144110145110146110147110148110149110150110151110152110153110154110155110156110157110158110159110160110161110162110163110164110165110166110167110168110169110170110171110172110173110174110175110176110177110178110179110180110181110182110183110184110185110186110187110188110189110190110191110192110193110194110195110196110197110198110199110200110201110202110203110204110205110206110207110208110209110210110211110212110213110214110215110216110217110218110219110220110221110222110223110224110225110226110227110228110229110230110231110232110233110234110235110236110237110238110239110240110241110242110243110244110245110246110247110248110249110250110251110252110253110254110255110256110257110258110259110260110261110262110263110264110265110266110267110268110269110270110271110272110273110274110275110276110277110278110279110280110281110282110283110284110285110286110287110288110289110290110291110292110293110294110295110296110297110298110299110300110301110302110303110304110305110306110307110308110309110310110311110312110313110314110315110316110317110318110319110320110321110322110323110324110325110326110327110328110329110330110331110332110333110334110335110336110337110338110339110340110341110342110343110344110345110346110347110348110349110350110351110352110353110354110355110356110357110358110359110360110361110362110363110364110365110366110367110368110369110370110371110372110373110374110375110376110377110378110379110380110381110382110383110384110385110386110387110388110389110390110391110392110393110394110395110396110397110398110399110400110401110402110403110404110405110406110407110408110409110410110411110412110413110414110415110416110417110418110419110420110421110422110423110424110425110426110427110428110429110430110431110432110433110434110435110436110437110438110439110440110441110442110443110444110445110446110447110448110449110450110451110452110453110454110455110456110457110458110459110460110461110462110463110464110465110466110467110468110469110470110471110472110473110474110475110476110477110478110479110480110481110482110483110484110485110486110487110488110489110490110491110492110493110494110495110496110497110498110499110500110501110502110503110504110505110506110507110508110509110510110511110512110513110514110515110516110517110518110519110520110521110522110523110524110525110526110527110528110529110530110531110532110533110534110535110536110537110538110539110540110541110542110543110544110545110546110547110548110549110550110551110552110553110554110555110556110557110558110559110560110561110562110563110564110565110566110567110568110569110570110571110572110573110574110575110576110577110578110579110580110581110582110583110584110585110586110587110588110589110590110591110592110593110594110595110596110597110598110599110600110601110602110603110604110605110606110607110608110609110610110611110612110613110614110615110616110617110618110619110620110621110622110623110624110625110626110627110628110629110630110631110632110633110634110635110636110637110638110639110640110641110642110643110644110645110646110647110648110649110650110651110652110653110654110655110656110657110658110659110660110661110662110663110664110665110666110667110668110669110670110671110672110673110674110675110676110677110678110679110680110681110682110683110684110685110686110687110688110689110690110691110692110693110694110695110696110697110698110699110700110701110702110703110704110705110706110707110708110709110710110711110712110713110714110715110716110717110718110719110720110721110722110723110724110725110726110727110728110729110730110731110732110733110734110735110736110737110738110739110740110741110742110743110744110745110746110747110748110749110750110751110752110753110754110755110756110757110758110759110760110761110762110763110764110765110766110767110768110769110770110771110772110773110774110775110776110777110778110779110780110781110782110783110784110785110786110787110788110789110790110791110792110793110794110795110796110797110798110799110800110801110802110803110804110805110806110807110808110809110810110811110812110813110814110815110816110817110818110819110820110821110822110823110824110825110826110827110828110829110830110831110832110833110834110835110836110837110838110839110840110841110842110843110844110845110846110847110848110849110850110851110852110853110854110855110856110857110858110859110860110861110862110863110864110865110866110867110868110869110870110871110872110873110874110875110876110877110878110879110880110881110882110883110884110885110886110887110888110889110890110891110892110893110894110895110896110897110898110899110900110901110902110903110904110905110906110907110908110909110910110911110912110913110914110915110916110917110918110919110920110921110922110923110924110925110926110927110928110929110930110931110932110933110934110935110936110937110938110939110940110941110942110943110944110945110946110947110948110949110950110951110952110953110954110955110956110957110958110959110960110961110962110963110964110965110966110967110968110969110970110971110972110973110974110975110976110977110978110979110980110981110982110983110984110985110986110987110988110989110990110991110992110993110994110995110996110997110998110999111000111001111002111003111004111005111006111007111008111009111010111011111012111013111014111015111016111017111018111019111020111021111022111023111024111025111026111027111028111029111030111031111032111033111034111035111036111037111038111039111040111041111042111043111044111045111046111047111048111049111050111051111052111053111054111055111056111057111058111059111060111061111062111063111064111065111066111067111068111069111070111071111072111073111074111075111076111077111078111079111080111081111082111083111084111085111086111087111088111089111090111091111092111093111094111095111096111097111098111099111100111101111102111103111104111105111106111107111108111109111110111111111112111113111114111115111116111117111118111119111120111121111122111123111124111125111126111127111128111129111130111131111132111133111134111135111136111137111138111139111140111141111142111143111144111145111146111147111148111149111150111151111152111153111154111155111156111157111158111159111160111161111162111163111164111165111166111167111168111169111170111171111172111173111174111175111176111177111178111179111180111181111182111183111184111185111186111187111188111189111190111191111192111193111194111195111196111197111198111199111200111201111202111203111204111205111206111207111208111209111210111211111212111213111214111215111216111217111218111219111220111221111222111223111224111225111226111227111228111229111230111231111232111233111234111235111236111237111238111239111240111241111242111243111244111245111246111247111248111249111250111251111252111253111254111255111256111257111258111259111260111261111262111263111264111265111266111267111268111269111270111271111272111273111274111275111276111277111278111279111280111281111282111283111284111285111286111287111288111289111290111291111292111293111294111295111296111297111298111299111300111301111302111303111304111305111306111307111308111309111310111311111312111313111314111315111316111317111318111319111320111321111322111323111324111325111326111327111328111329111330111331111332111333111334111335111336111337111338111339111340111341111342111343111344111345111346111347111348111349111350111351111352111353111354111355111356111357111358111359111360111361111362111363111364111365111366111367111368111369111370111371111372111373111374111375111376111377111378111379111380111381111382111383111384111385111386111387111388111389111390111391111392111393111394111395111396111397111398111399111400111401111402111403111404111405111406111407111408111409111410111411111412111413111414111415111416111417111418111419111420111421111422111423111424111425111426111427111428111429111430111431111432111433111434111435111436111437111438111439111440111441111442111443111444111445111446111447111448111449111450111451111452111453111454111455111456111457111458111459111460111461111462111463111464111465111466111467111468111469111470111471111472111473111474111475111476111477111478111479111480111481111482111483111484111485111486111487111488111489111490111491111492111493111494111495111496111497111498111499111500111501111502111503111504111505111506111507111508111509111510111511111512111513111514111515111516111517111518111519111520111521111522111523111524111525111526111527111528111529111530111531111532111533111534111535111536111537111538111539111540111541111542111543111544111545111546111547111548111549111550111551111552111553111554111555111556111557111558111559111560111561111562111563111564111565111566111567111568111569111570111571111572111573111574111575111576111577111578111579111580111581111582111583111584111585111586111587111588111589111590111591111592111593111594111595111596111597111598111599111600111601111602111603111604111605111606111607111608111609111610111611111612111613111614111615111616111617111618111619111620111621111622111623111624111625111626111627111628111629111630111631111632111633111634111635111636111637111638111639111640111641111642111643111644111645111646111647111648111649111650111651111652111653111654111655111656111657111658111659111660111661111662111663111664111665111666111667111668111669111670111671111672111673111674111675111676111677111678111679111680111681111682111683111684111685111686111687111688111689111690111691111692111693111694111695111696111697111698111699111700111701111702111703111704111705111706111707111708111709111710111711111712111713111714111715111716111717111718111719111720111721111722111723111724111725111726111727111728111729111730111731111732111733111734111735111736111737111738111739111740111741111742111743111744111745111746111747111748111749111750111751111752111753111754111755111756111757111758111759111760111761111762111763111764111765111766111767111768111769111770111771111772111773111774111775111776111777111778111779111780111781111782111783111784111785111786111787111788111789111790111791111792111793111794111795111796111797111798111799111800111801111802111803111804111805111806111807111808111809111810111811111812111813111814111815111816111817111818111819111820111821111822111823111824111825111826111827111828111829111830111831111832111833111834111835111836111837111838111839111840111841111842111843111844111845111846111847111848111849111850111851111852111853111854111855111856111857111858111859111860111861111862111863111864111865111866111867111868111869111870111871111872111873111874111875111876111877111878111879111880111881111882111883111884111885111886111887111888111889111890111891111892111893111894111895111896111897111898111899111900111901111902111903111904111905111906111907111908111909111910111911111912111913111914111915111916111917111918111919111920111921111922111923111924111925111926111927111928111929111930111931111932111933111934111935111936111937111938111939111940111941111942111943111944111945111946111947111948111949111950111951111952111953111954111955111956111957111958111959111960111961111962111963111964111965111966111967111968111969111970111971111972111973111974111975111976111977111978111979111980111981111982111983111984111985111986111987111988111989111990111991111992111993111994111995111996111997111998111999112000112001112002112003112004112005112006112007112008112009112010112011112012112013112014112015112016112017112018112019112020112021112022112023112024112025112026112027112028112029112030112031112032112033112034112035112036112037112038112039112040112041112042112043112044112045112046112047112048112049112050112051112052112053112054112055112056112057112058112059112060112061112062112063112064112065112066112067112068112069112070112071112072112073112074112075112076112077112078112079112080112081112082112083112084112085112086112087112088112089112090112091112092112093112094112095112096112097112098112099112100112101112102112103112104112105112106112107112108112109112110112111112112112113112114112115112116112117112118112119112120112121112122112123112124112125112126112127112128112129112130112131112132112133112134112135112136112137112138112139112140112141112142112143112144112145112146112147112148112149112150112151112152112153112154112155112156112157112158112159112160112161112162112163112164112165112166112167112168112169112170112171112172112173112174112175112176112177112178112179112180112181112182112183112184112185112186112187112188112189112190112191112192112193112194112195112196112197112198112199112200112201112202112203112204112205112206112207112208112209112210112211112212112213112214112215112216112217112218112219112220112221112222112223112224112225112226112227112228112229112230112231112232112233112234112235112236112237112238112239112240112241112242112243112244112245112246112247112248112249112250112251112252112253112254112255112256112257112258112259112260112261112262112263112264112265112266112267112268112269112270112271112272112273112274112275112276112277112278112279112280112281112282112283112284112285112286112287112288112289112290112291112292112293112294112295112296112297112298112299112300112301112302112303112304112305112306112307112308112309112310112311112312112313112314112315112316112317112318112319112320112321112322112323112324112325112326112327112328112329112330112331112332112333112334112335112336112337112338112339112340112341112342112343112344112345112346112347112348112349112350112351112352112353112354112355112356112357112358112359112360112361112362112363112364112365112366112367112368112369112370112371112372112373112374112375112376112377112378112379112380112381112382112383112384112385112386112387112388112389112390112391112392112393112394112395112396112397112398112399112400112401112402112403112404112405112406112407112408112409112410112411112412112413112414112415112416112417112418112419112420112421112422112423112424112425112426112427112428112429112430112431112432112433112434112435112436112437112438112439112440112441112442112443112444112445112446112447112448112449112450112451112452112453112454112455112456112457112458112459112460112461112462112463112464112465112466112467112468112469112470112471112472112473112474112475112476112477112478112479112480112481112482112483112484112485112486112487112488112489112490112491112492112493112494112495112496112497112498112499112500112501112502112503112504112505112506112507112508112509112510112511112512112513112514112515112516112517112518112519112520112521112522112523112524112525112526112527112528112529112530112531112532112533112534112535112536112537112538112539112540112541112542112543112544112545112546112547112548112549112550112551112552112553112554112555112556112557112558112559112560112561112562112563112564112565112566112567112568112569112570112571112572112573112574112575112576112577112578112579112580112581112582112583112584112585112586112587112588112589112590112591112592112593112594112595112596112597112598112599112600112601112602112603112604112605112606112607112608112609112610112611112612112613112614112615112616112617112618112619112620112621112622112623112624112625112626112627112628112629112630112631112632112633112634112635112636112637112638112639112640112641112642112643112644112645112646112647112648112649112650112651112652112653112654112655112656112657112658112659112660112661112662112663112664112665112666112667112668112669112670112671112672112673112674112675112676112677112678112679112680112681112682112683112684112685112686112687112688112689112690112691112692112693112694112695112696112697112698112699112700112701112702112703112704112705112706112707112708112709112710112711112712112713112714112715112716112717112718112719112720112721112722112723112724112725112726112727112728112729112730112731112732112733112734112735112736112737112738112739112740112741112742112743112744112745112746112747112748112749112750112751112752112753112754112755112756112757112758112759112760112761112762112763112764112765112766112767112768112769112770112771112772112773112774112775112776112777112778112779112780112781112782112783112784112785112786112787112788112789112790112791112792112793112794112795112796112797112798112799112800112801112802112803112804112805112806112807112808112809112810112811112812112813112814112815112816112817112818112819112820112821112822112823112824112825112826112827112828112829112830112831112832112833112834112835112836112837112838112839112840112841112842112843112844112845112846112847112848112849112850112851112852112853112854112855112856112857112858112859112860112861112862112863112864112865112866112867112868112869112870112871112872112873112874112875112876112877112878112879112880112881112882112883112884112885112886112887112888112889112890112891112892112893112894112895112896112897112898112899112900112901112902112903112904112905112906112907112908112909112910112911112912112913112914112915112916112917112918112919112920112921112922112923112924112925112926112927112928112929112930112931112932112933112934112935112936112937112938112939112940112941112942112943112944112945112946112947112948112949112950112951112952112953112954112955112956112957112958112959112960112961112962112963112964112965112966112967112968112969112970112971112972112973112974112975112976112977112978112979112980112981112982112983112984112985112986112987112988112989112990112991112992112993112994112995112996112997112998112999113000113001113002113003113004113005113006113007113008113009113010113011113012113013113014113015113016113017113018113019113020113021113022113023113024113025113026113027113028113029113030113031113032113033113034113035113036113037113038113039113040113041113042113043113044113045113046113047113048113049113050113051113052113053113054113055113056113057113058113059113060113061113062113063113064113065113066113067113068113069113070113071113072113073113074113075113076113077113078113079113080113081113082113083113084113085113086113087113088113089113090113091113092113093113094113095113096113097113098113099113100113101113102113103113104113105113106113107113108113109113110113111113112113113113114113115113116113117113118113119113120113121113122113123113124113125113126113127113128113129113130113131113132113133113134113135113136113137113138113139113140113141113142113143113144113145113146113147113148113149113150113151113152113153113154113155113156113157113158113159113160113161113162113163113164113165113166113167113168113169113170113171113172113173113174113175113176113177113178113179113180113181113182113183113184113185113186113187113188113189113190113191113192113193113194113195113196113197113198113199113200113201113202113203113204113205113206113207113208113209113210113211113212113213113214113215113216113217113218113219113220113221113222113223113224113225113226113227113228113229113230113231113232113233113234113235113236113237113238113239113240113241113242113243113244113245113246113247113248113249113250113251113252113253113254113255113256113257113258113259113260113261113262113263113264113265113266113267113268113269113270113271113272113273113274113275113276113277113278113279113280113281113282113283113284113285113286113287113288113289113290113291113292113293113294113295113296113297113298113299113300113301113302113303113304113305113306113307113308113309113310113311113312113313113314113315113316113317113318113319113320113321113322113323113324113325113326113327113328113329113330113331113332113333113334113335113336113337113338113339113340113341113342113343113344113345113346113347113348113349113350113351113352113353113354113355113356113357113358113359113360113361113362113363113364113365113366113367113368113369113370113371113372113373113374113375113376113377113378113379113380113381113382113383113384113385113386113387113388113389113390113391113392113393113394113395113396113397113398113399113400113401113402113403113404113405113406113407113408113409113410113411113412113413113414113415113416113417113418113419113420113421113422113423113424113425113426113427113428113429113430113431113432113433113434113435113436113437113438113439113440113441113442113443113444113445113446113447113448113449113450113451113452113453113454113455113456113457113458113459113460113461113462113463113464113465113466113467113468113469113470113471113472113473113474113475113476113477113478113479113480113481113482113483113484113485113486113487113488113489113490113491113492113493113494113495113496113497113498113499113500113501113502113503113504113505113506113507113508113509113510113511113512113513113514113515113516113517113518113519113520113521113522113523113524113525113526113527113528113529113530113531113532113533113534113535113536113537113538113539113540113541113542113543113544113545113546113547113548113549113550113551113552113553113554113555113556113557113558113559113560113561113562113563113564113565113566113567113568113569113570113571113572113573113574113575113576113577113578113579113580113581113582113583113584113585113586113587113588113589113590113591113592113593113594113595113596113597113598113599113600113601113602113603113604113605113606113607113608113609113610113611113612113613113614113615113616113617113618113619113620113621113622113623113624113625113626113627113628113629113630113631113632113633113634113635113636113637113638113639113640113641113642113643113644113645113646113647113648113649113650113651113652113653113654113655113656113657113658113659113660113661113662113663113664113665113666113667113668113669113670113671113672113673113674113675113676113677113678113679113680113681113682113683113684113685113686113687113688113689113690113691113692113693113694113695113696113697113698113699113700113701113702113703113704113705113706113707113708113709113710113711113712113713113714113715113716113717113718113719113720113721113722113723113724113725113726113727113728113729113730113731113732113733113734113735113736113737113738113739113740113741113742113743113744113745113746113747113748113749113750113751113752113753113754113755113756113757113758113759113760113761113762113763113764113765113766113767113768113769113770113771113772113773113774113775113776113777113778113779113780113781113782113783113784113785113786113787113788113789113790113791113792113793113794113795113796113797113798113799113800113801113802113803113804113805113806113807113808113809113810113811113812113813113814113815113816113817113818113819113820113821113822113823113824113825113826113827113828113829113830113831113832113833113834113835113836113837113838113839113840113841113842113843113844113845113846113847113848113849113850113851113852113853113854113855113856113857113858113859113860113861113862113863113864113865113866113867113868113869113870113871113872113873113874113875113876113877113878113879113880113881113882113883113884113885113886113887113888113889113890113891113892113893113894113895113896113897113898113899113900113901113902113903113904113905113906113907113908113909113910113911113912113913113914113915113916113917113918113919113920113921113922113923113924113925113926113927113928113929113930113931113932113933113934113935113936113937113938113939113940113941113942113943113944113945113946113947113948113949113950113951113952113953113954113955113956113957113958113959113960113961113962113963113964113965113966113967113968113969113970113971113972113973113974113975113976113977113978113979113980113981113982113983113984113985113986113987113988113989113990113991113992113993113994113995113996113997113998113999114000114001114002114003114004114005114006114007114008114009114010114011114012114013114014114015114016114017114018114019114020114021114022114023114024114025114026114027114028114029114030114031114032114033114034114035114036114037114038114039114040114041114042114043114044114045114046114047114048114049114050114051114052114053114054114055114056114057114058114059114060114061114062114063114064114065114066114067114068114069114070114071114072114073114074114075114076114077114078114079114080114081114082114083114084114085114086114087114088114089114090114091114092114093114094114095114096114097114098114099114100114101114102114103114104114105114106114107114108114109114110114111114112114113114114114115114116114117114118114119114120114121114122114123114124114125114126114127114128114129114130114131114132114133114134114135114136114137114138114139114140114141114142114143114144114145114146114147114148114149114150114151114152114153114154114155114156114157114158114159114160114161114162114163114164114165114166114167114168114169114170114171114172114173114174114175114176114177114178114179114180114181114182114183114184114185114186114187114188114189114190114191114192114193114194114195114196114197114198114199114200114201114202114203114204114205114206114207114208114209114210114211114212114213114214114215114216114217114218114219114220114221114222114223114224114225114226114227114228114229114230114231114232114233114234114235114236114237114238114239114240114241114242114243114244114245114246114247114248114249114250114251114252114253114254114255114256114257114258114259114260114261114262114263114264114265114266114267114268114269114270114271114272114273114274114275114276114277114278114279114280114281114282114283114284114285114286114287114288114289114290114291114292114293114294114295114296114297114298114299114300114301114302114303114304114305114306114307114308114309114310114311114312114313114314114315114316114317114318114319114320114321114322114323114324114325114326114327114328114329114330114331114332114333114334114335114336114337114338114339114340114341114342114343114344114345114346114347114348114349114350114351114352114353114354114355114356114357114358114359114360114361114362114363114364114365114366114367114368114369114370114371114372114373114374114375114376114377114378114379114380114381114382114383114384114385114386114387114388114389114390114391114392114393114394114395114396114397114398114399114400114401114402114403114404114405114406114407114408114409114410114411114412114413114414114415114416114417114418114419114420114421114422114423114424114425114426114427114428114429114430114431114432114433114434114435114436114437114438114439114440114441114442114443114444114445114446114447114448114449114450114451114452114453114454114455114456114457114458114459114460114461114462114463114464114465114466114467114468114469114470114471114472114473114474114475114476114477114478114479114480114481114482114483114484114485114486114487114488114489114490114491114492114493114494114495114496114497114498114499114500114501114502114503114504114505114506114507114508114509114510114511114512114513114514114515114516114517114518114519114520114521114522114523114524114525114526114527114528114529114530114531114532114533114534114535114536114537114538114539114540114541114542114543114544114545114546114547114548114549114550114551114552114553114554114555114556114557114558114559114560114561114562114563114564114565114566114567114568114569114570114571114572114573114574114575114576114577114578114579114580114581114582114583114584114585114586114587114588114589114590114591114592114593114594114595114596114597114598114599114600114601114602114603114604114605114606114607114608114609114610114611114612114613114614114615114616114617114618114619114620114621114622114623114624114625114626114627114628114629114630114631114632114633114634114635114636114637114638114639114640114641114642114643114644114645114646114647114648114649114650114651114652114653114654114655114656114657114658114659114660114661114662114663114664114665114666114667114668114669114670114671114672114673114674114675114676114677114678114679114680114681114682114683114684114685114686114687114688114689114690114691114692114693114694114695114696114697114698114699114700114701114702114703114704114705114706114707114708114709114710114711114712114713114714114715114716114717114718114719114720114721114722114723114724114725114726114727114728114729114730114731114732114733114734114735114736114737114738114739114740114741114742114743114744114745114746114747114748114749114750114751114752114753114754114755114756114757114758114759114760114761114762114763114764114765114766114767114768114769114770114771114772114773114774114775114776114777114778114779114780114781114782114783114784114785114786114787114788114789114790114791114792114793114794114795114796114797114798114799114800114801114802114803114804114805114806114807114808114809114810114811114812114813114814114815114816114817114818114819114820114821114822114823114824114825114826114827114828114829114830114831114832114833114834114835114836114837114838114839114840114841114842114843114844114845114846114847114848114849114850114851114852114853114854114855114856114857114858114859114860114861114862114863114864114865114866114867114868114869114870114871114872114873114874114875114876114877114878114879114880114881114882114883114884114885114886114887114888114889114890114891114892114893114894114895114896114897114898114899114900114901114902114903114904114905114906114907114908114909114910114911114912114913114914114915114916114917114918114919114920114921114922114923114924114925114926114927114928114929114930114931114932114933114934114935114936114937114938114939114940114941114942114943114944114945114946114947114948114949114950114951114952114953114954114955114956114957114958114959114960114961114962114963114964114965114966114967114968114969114970114971114972114973114974114975114976114977114978114979114980114981114982114983114984114985114986114987114988114989114990114991114992114993114994114995114996114997114998114999115000115001115002115003115004115005115006115007115008115009115010115011115012115013115014115015115016115017115018115019115020115021115022115023115024115025115026115027115028115029115030115031115032115033115034115035115036115037115038115039115040115041115042115043115044115045115046115047115048115049115050115051115052115053115054115055115056115057115058115059115060115061115062115063115064115065115066115067115068115069115070115071115072115073115074115075115076115077115078115079115080115081115082115083115084115085115086115087115088115089115090115091115092115093115094115095115096115097115098115099115100115101115102115103115104115105115106115107115108115109115110115111115112115113115114115115115116115117115118115119115120115121115122115123115124115125115126115127115128115129115130115131115132115133115134115135115136115137115138115139115140115141115142115143115144115145115146115147115148115149115150115151115152115153115154115155115156115157115158115159115160115161115162115163115164115165115166115167115168115169115170115171115172115173115174115175115176115177115178115179115180115181115182115183115184115185115186115187115188115189115190115191115192115193115194115195115196115197115198115199115200115201115202115203115204115205115206115207115208115209115210115211115212115213115214115215115216115217115218115219115220115221115222115223115224115225115226115227115228115229115230115231115232115233115234115235115236115237115238115239115240115241115242115243115244115245115246115247115248115249115250115251115252115253115254115255115256115257115258115259115260115261115262115263115264115265115266115267115268115269115270115271115272115273115274115275115276115277115278115279115280115281115282115283115284115285115286115287115288115289115290115291115292115293115294115295115296115297115298115299115300115301115302115303115304115305115306115307115308115309115310115311115312115313115314115315115316115317115318115319115320115321115322115323115324115325115326115327115328115329115330115331115332115333115334115335115336115337115338115339115340115341115342115343115344115345115346115347115348115349115350115351115352115353115354115355115356115357115358115359115360115361115362115363115364115365115366115367115368115369115370115371115372115373115374115375115376115377115378115379115380115381115382115383115384115385115386115387115388115389115390115391115392115393115394115395115396115397115398115399115400115401115402115403115404115405115406115407115408115409115410115411115412115413115414115415115416115417115418115419115420115421115422115423115424115425115426115427115428115429115430115431115432115433115434115435115436115437115438115439115440115441115442115443115444115445115446115447115448115449115450115451115452115453115454115455115456115457115458115459115460115461115462115463115464115465115466115467115468115469115470115471115472115473115474115475115476115477115478115479115480115481115482115483115484115485115486115487115488115489115490115491115492115493115494115495115496115497115498115499115500115501115502115503115504115505115506115507115508115509115510115511115512115513115514115515115516115517115518115519115520115521115522115523115524115525115526115527115528115529115530115531115532115533115534115535115536115537115538115539115540115541115542115543115544115545115546115547115548115549115550115551115552115553115554115555115556115557115558115559115560115561115562115563115564115565115566115567115568115569115570115571115572115573115574115575115576115577115578115579115580115581115582115583115584115585115586115587115588115589115590115591115592115593115594115595115596115597115598115599115600115601115602115603115604115605115606115607115608115609115610115611115612115613115614115615115616115617115618115619115620115621115622115623115624115625115626115627115628115629115630115631115632115633115634115635115636115637115638115639115640115641115642115643115644115645115646115647115648115649115650115651115652115653115654115655115656115657115658115659115660115661115662115663115664115665115666115667115668115669115670115671115672115673115674115675115676115677115678115679115680115681115682115683115684115685115686115687115688115689115690115691115692115693115694115695115696115697115698115699115700115701115702115703115704115705115706115707115708115709115710115711115712115713115714115715115716115717115718115719115720115721115722115723115724115725115726115727115728115729115730115731115732115733115734115735115736115737115738115739115740115741115742115743115744115745115746115747115748115749115750115751115752115753115754115755115756115757115758115759115760115761115762115763115764115765115766115767115768115769115770115771115772115773115774115775115776115777115778115779115780115781115782115783115784115785115786115787115788115789115790115791115792115793115794115795115796115797115798115799115800115801115802115803115804115805115806115807115808115809115810115811115812115813115814115815115816115817115818115819115820115821115822115823115824115825115826115827115828115829115830115831115832115833115834115835115836115837115838115839115840115841115842115843115844115845115846115847115848115849115850115851115852115853115854115855115856115857115858115859115860115861115862115863115864115865115866115867115868115869115870115871115872115873115874115875115876115877115878115879115880115881115882115883115884115885115886115887115888115889115890115891115892115893115894115895115896115897115898115899115900115901115902115903115904115905115906115907115908115909115910115911115912115913115914115915115916115917115918115919115920115921115922115923115924115925115926115927115928115929115930115931115932115933115934115935115936115937115938115939115940115941115942115943115944115945115946115947115948115949115950115951115952115953115954115955115956115957115958115959115960115961115962115963115964115965115966115967115968115969115970115971115972115973115974115975115976115977115978115979115980115981115982115983115984115985115986115987115988115989115990115991115992115993115994115995115996115997115998115999116000116001116002116003116004116005116006116007116008116009116010116011116012116013116014116015116016116017116018116019116020116021116022116023116024116025116026116027116028116029116030116031116032116033116034116035116036116037116038116039116040116041116042116043116044116045116046116047116048116049116050116051116052116053116054116055116056116057116058116059116060116061116062116063116064116065116066116067116068116069116070116071116072116073116074116075116076116077116078116079116080116081116082116083116084116085116086116087116088116089116090116091116092116093116094116095116096116097116098116099116100116101116102116103116104116105116106116107116108116109116110116111116112116113116114116115116116116117116118116119116120116121116122116123116124116125116126116127116128116129116130116131116132116133116134116135116136116137116138116139116140116141116142116143116144116145116146116147116148116149116150116151116152116153116154116155116156116157116158116159116160116161116162116163116164116165116166116167116168116169116170116171116172116173116174116175116176116177116178116179116180116181116182116183116184116185116186116187116188116189116190116191116192116193116194116195116196116197116198116199116200116201116202116203116204116205116206116207116208116209116210116211116212116213116214116215116216116217116218116219116220116221116222116223116224116225116226116227116228116229116230116231116232116233116234116235116236116237116238116239116240116241116242116243116244116245116246116247116248116249116250116251116252116253116254116255116256116257116258116259116260116261116262116263116264116265116266116267116268116269116270116271116272116273116274116275116276116277116278116279116280116281116282116283116284116285116286116287116288116289116290116291116292116293116294116295116296116297116298116299116300116301116302116303116304116305116306116307116308116309116310116311116312116313116314116315116316116317116318116319116320116321116322116323116324116325116326116327116328116329116330116331116332116333116334116335116336116337116338116339116340116341116342116343116344116345116346116347116348116349116350116351116352116353116354116355116356116357116358116359116360116361116362116363116364116365116366116367116368116369116370116371116372116373116374116375116376116377116378116379116380116381116382116383116384116385116386116387116388116389116390116391116392116393116394116395116396116397116398116399116400116401116402116403116404116405116406116407116408116409116410116411116412116413116414116415116416116417116418116419116420116421116422116423116424116425116426116427116428116429116430116431116432116433116434116435116436116437116438116439116440116441116442116443116444116445116446116447116448116449116450116451116452116453116454116455116456116457116458116459116460116461116462116463116464116465116466116467116468116469116470116471116472116473116474116475116476116477116478116479116480116481116482116483116484116485116486116487116488116489116490116491116492116493116494116495116496116497116498116499116500116501116502116503116504116505116506116507116508116509116510116511116512116513116514116515116516116517116518116519116520116521116522116523116524116525116526116527116528116529116530116531116532116533116534116535116536116537116538116539116540116541116542116543116544116545116546116547116548116549116550116551116552116553116554116555116556116557116558116559116560116561116562116563116564116565116566116567116568116569116570116571116572116573116574116575116576116577116578116579116580116581116582116583116584116585116586116587116588116589116590116591116592116593116594116595116596116597116598116599116600116601116602116603116604116605116606116607116608116609116610116611116612116613116614116615116616116617116618116619116620116621116622116623116624116625116626116627116628116629116630116631116632116633116634116635116636116637116638116639116640116641116642116643116644116645116646116647116648116649116650116651116652116653116654116655116656116657116658116659116660116661116662116663116664116665116666116667116668116669116670116671116672116673116674116675116676116677116678116679116680116681116682116683116684116685116686116687116688116689116690116691116692116693116694116695116696116697116698116699116700116701116702116703116704116705116706116707116708116709116710116711116712116713116714116715116716116717116718116719116720116721116722116723116724116725116726116727116728116729116730116731116732116733116734116735116736116737116738116739116740116741116742116743116744116745116746116747116748116749116750116751116752116753116754116755116756116757116758116759116760116761116762116763116764116765116766116767116768116769116770116771116772116773116774116775116776116777116778116779116780116781116782116783116784116785116786116787116788116789116790116791116792116793116794116795116796116797116798116799116800116801116802116803116804116805116806116807116808116809116810116811116812116813116814116815116816116817116818116819116820116821116822116823116824116825116826116827116828116829116830116831116832116833116834116835116836116837116838116839116840116841116842116843116844116845116846116847116848116849116850116851116852116853116854116855116856116857116858116859116860116861116862116863116864116865116866116867116868116869116870116871116872116873116874116875116876116877116878116879116880116881116882116883116884116885116886116887116888116889116890116891116892116893116894116895116896116897116898116899116900116901116902116903116904116905116906116907116908116909116910116911116912116913116914116915116916116917116918116919116920116921116922116923116924116925116926116927116928116929116930116931116932116933116934116935116936116937116938116939116940116941116942116943116944116945116946116947116948116949116950116951116952116953116954116955116956116957116958116959116960116961116962116963116964116965116966116967116968116969116970116971116972116973116974116975116976116977116978116979116980116981116982116983116984116985116986116987116988116989116990116991116992116993116994116995116996116997116998116999117000117001117002117003117004117005117006117007117008117009117010117011117012117013117014117015117016117017117018117019117020117021117022117023117024117025117026117027117028117029117030117031117032117033117034117035117036117037117038117039117040117041117042117043117044117045117046117047117048117049117050117051117052117053117054117055117056117057117058117059117060117061117062117063117064117065117066117067117068117069117070117071117072117073117074117075117076117077117078117079117080117081117082117083117084117085117086117087117088117089117090117091117092117093117094117095117096117097117098117099117100117101117102117103117104117105117106117107117108117109117110117111117112117113117114117115117116117117117118117119117120117121117122117123117124117125117126117127117128117129117130117131117132117133117134117135117136117137117138117139117140117141117142117143117144117145117146117147117148117149117150117151117152117153117154117155117156117157117158117159117160117161117162117163117164117165117166117167117168117169117170117171117172117173117174117175117176117177117178117179117180117181117182117183117184117185117186117187117188117189117190117191117192117193117194117195117196117197117198117199117200117201117202117203117204117205117206117207117208117209117210117211117212117213117214117215117216117217117218117219117220117221117222117223117224117225117226117227117228117229117230117231117232117233117234117235117236117237117238117239117240117241117242117243117244117245117246117247117248117249117250117251117252117253117254117255117256117257117258117259117260117261117262117263117264117265117266117267117268117269117270117271117272117273117274117275117276117277117278117279117280117281117282117283117284117285117286117287117288117289117290117291117292117293117294117295117296117297117298117299117300117301117302117303117304117305117306117307117308117309117310117311117312117313117314117315117316117317117318117319117320117321117322117323117324117325117326117327117328117329117330117331117332117333117334117335117336117337117338117339117340117341117342117343117344117345117346117347117348117349117350117351117352117353117354117355117356117357117358117359117360117361117362117363117364117365117366117367117368117369117370117371117372117373117374117375117376117377117378117379117380117381117382117383117384117385117386117387117388117389117390117391117392117393117394117395117396117397117398117399117400117401117402117403117404117405117406117407117408117409117410117411117412117413117414117415117416117417117418117419117420117421117422117423117424117425117426117427117428117429117430117431117432117433117434117435117436117437117438117439117440117441117442117443117444117445117446117447117448117449117450117451117452117453117454117455117456117457117458117459117460117461117462117463117464117465117466117467117468117469117470117471117472117473117474117475117476117477117478117479117480117481117482117483117484117485117486117487117488117489117490117491117492117493117494117495117496117497117498117499117500117501117502117503117504117505117506117507117508117509117510117511117512117513117514117515117516117517117518117519117520117521117522117523117524117525117526117527117528117529117530117531117532117533117534117535117536117537117538117539117540117541117542117543117544117545117546117547117548117549117550117551117552117553117554117555117556117557117558117559117560117561117562117563117564117565117566117567117568117569117570117571117572117573117574117575117576117577117578117579117580117581117582117583117584117585117586117587117588117589117590117591117592117593117594117595117596117597117598117599117600117601117602117603117604117605117606117607117608117609117610117611117612117613117614117615117616117617117618117619117620117621117622117623117624117625117626117627117628117629117630117631117632117633117634117635117636117637117638117639117640117641117642117643117644117645117646117647117648117649117650117651117652117653117654117655117656117657117658117659117660117661117662117663117664117665117666117667117668117669117670117671117672117673117674117675117676117677117678117679117680117681117682117683117684117685117686117687117688117689117690117691117692117693117694117695117696117697117698117699117700117701117702117703117704117705117706117707117708117709117710117711117712117713117714117715117716117717117718117719117720117721117722117723117724117725117726117727117728117729117730117731117732117733117734117735117736117737117738117739117740117741117742117743117744117745117746117747117748117749117750117751117752117753117754117755117756117757117758117759117760117761117762117763117764117765117766117767117768117769117770117771117772117773117774117775117776117777117778117779117780117781117782117783117784117785117786117787117788117789117790117791117792117793117794117795117796117797117798117799117800117801117802117803117804117805117806117807117808117809117810117811117812117813117814117815117816117817117818117819117820117821117822117823117824117825117826117827117828117829117830117831117832117833117834117835117836117837117838117839117840117841117842117843117844117845117846117847117848117849117850117851117852117853117854117855117856117857117858117859117860117861117862117863117864117865117866117867117868117869117870117871117872117873117874117875117876117877117878117879117880117881117882117883117884117885117886117887117888117889117890117891117892117893117894117895117896117897117898117899117900117901117902117903117904117905117906117907117908117909117910117911117912117913117914117915117916117917117918117919117920117921117922117923117924117925117926117927117928117929117930117931117932117933117934117935117936117937117938117939117940117941117942117943117944117945117946117947117948117949117950117951117952117953117954117955117956117957117958117959117960117961117962117963117964117965117966117967117968117969117970117971117972117973117974117975117976117977117978117979117980117981117982117983117984117985117986117987117988117989117990117991117992117993117994117995117996117997117998117999118000118001118002118003118004118005118006118007118008118009118010118011118012118013118014118015118016118017118018118019118020118021118022118023118024118025118026118027118028118029118030118031118032118033118034118035118036118037118038118039118040118041118042118043118044118045118046118047118048118049118050118051118052118053118054118055118056118057118058118059118060118061118062118063118064118065118066118067118068118069118070118071118072118073118074118075118076118077118078118079118080118081118082118083118084118085118086118087118088118089118090118091118092118093118094118095118096118097118098118099118100118101118102118103118104118105118106118107118108118109118110118111118112118113118114118115118116118117118118118119118120118121118122118123118124118125118126118127118128118129118130118131118132118133118134118135118136118137118138118139118140118141118142118143118144118145118146118147118148118149118150118151118152118153118154118155118156118157118158118159118160118161118162118163118164118165118166118167118168118169118170118171118172118173118174118175118176118177118178118179118180118181118182118183118184118185118186118187118188118189118190118191118192118193118194118195118196118197118198118199118200118201118202118203118204118205118206118207118208118209118210118211118212118213118214118215118216118217118218118219118220118221118222118223118224118225118226118227118228118229118230118231118232118233118234118235118236118237118238118239118240118241118242118243118244118245118246118247118248118249118250118251118252118253118254118255118256118257118258118259118260118261118262118263118264118265118266118267118268118269118270118271118272118273118274118275118276118277118278118279118280118281118282118283118284118285118286118287118288118289118290118291118292118293118294118295118296118297118298118299118300118301118302118303118304118305118306118307118308118309118310118311118312118313118314118315118316118317118318118319118320118321118322118323118324118325118326118327118328118329118330118331118332118333118334118335118336118337118338118339118340118341118342118343118344118345118346118347118348118349118350118351118352118353118354118355118356118357118358118359118360118361118362118363118364118365118366118367118368118369118370118371118372118373118374118375118376118377118378118379118380118381118382118383118384118385118386118387118388118389118390118391118392118393118394118395118396118397118398118399118400118401118402118403118404118405118406118407118408118409118410118411118412118413118414118415118416118417118418118419118420118421118422118423118424118425118426118427118428118429118430118431118432118433118434118435118436118437118438118439118440118441118442118443118444118445118446118447118448118449118450118451118452118453118454118455118456118457118458118459118460118461118462118463118464118465118466118467118468118469118470118471118472118473118474118475118476118477118478118479118480118481118482118483118484118485118486118487118488118489118490118491118492118493118494118495118496118497118498118499118500118501118502118503118504118505118506118507118508118509118510118511118512118513118514118515118516118517118518118519118520118521118522118523118524118525118526118527118528118529118530118531118532118533118534118535118536118537118538118539118540118541118542118543118544118545118546118547118548118549118550118551118552118553118554118555118556118557118558118559118560118561118562118563118564118565118566118567118568118569118570118571118572118573118574118575118576118577118578118579118580118581118582118583118584118585118586118587118588118589118590118591118592118593118594118595118596118597118598118599118600118601118602118603118604118605118606118607118608118609118610118611118612118613118614118615118616118617118618118619118620118621118622118623118624118625118626118627118628118629118630118631118632118633118634118635118636118637118638118639118640118641118642118643118644118645118646118647118648118649118650118651118652118653118654118655118656118657118658118659118660118661118662118663118664118665118666118667118668118669118670118671118672118673118674118675118676118677118678118679118680118681118682118683118684118685118686118687118688118689118690118691118692118693118694118695118696118697118698118699118700118701118702118703118704118705118706118707118708118709118710118711118712118713118714118715118716118717118718118719118720118721118722118723118724118725118726118727118728118729118730118731118732118733118734118735118736118737118738118739118740118741118742118743118744118745118746118747118748118749118750118751118752118753118754118755118756118757118758118759118760118761118762118763118764118765118766118767118768118769118770118771118772118773118774118775118776118777118778118779118780118781118782118783118784118785118786118787118788118789118790118791118792118793118794118795118796118797118798118799118800118801118802118803118804118805118806118807118808118809118810118811118812118813118814118815118816118817118818118819118820118821118822118823118824118825118826118827118828118829118830118831118832118833118834118835118836118837118838118839118840118841118842118843118844118845118846118847118848118849118850118851118852118853118854118855118856118857118858118859118860118861118862118863118864118865118866118867118868118869118870118871118872118873118874118875118876118877118878118879118880118881118882118883118884118885118886118887118888118889118890118891118892118893118894118895118896118897118898118899118900118901118902118903118904118905118906118907118908118909118910118911118912118913118914118915118916118917118918118919118920118921118922118923118924118925118926118927118928118929118930118931118932118933118934118935118936118937118938118939118940118941118942118943118944118945118946118947118948118949118950118951118952118953118954118955118956118957118958118959118960118961118962118963118964118965118966118967118968118969118970118971118972118973118974118975118976118977118978118979118980118981118982118983118984118985118986118987118988118989118990118991118992118993118994118995118996118997118998118999119000119001119002119003119004119005119006119007119008119009119010119011119012119013119014119015119016119017119018119019119020119021119022119023119024119025119026119027119028119029119030119031119032119033119034119035119036119037119038119039119040119041119042119043119044119045119046119047119048119049119050119051119052119053119054119055119056119057119058119059119060119061119062119063119064119065119066119067119068119069119070119071119072119073119074119075119076119077119078119079119080119081119082119083119084119085119086119087119088119089119090119091119092119093119094119095119096119097119098119099119100119101119102119103119104119105119106119107119108119109119110119111119112119113119114119115119116119117119118119119119120119121119122119123119124119125119126119127119128119129119130119131119132119133119134119135119136119137119138119139119140119141119142119143119144119145119146119147119148119149119150119151119152119153119154119155119156119157119158119159119160119161119162119163119164119165119166119167119168119169119170119171119172119173119174119175119176119177119178119179119180119181119182119183119184119185119186119187119188119189119190119191119192119193119194119195119196119197119198119199119200119201119202119203119204119205119206119207119208119209119210119211119212119213119214119215119216119217119218119219119220119221119222119223119224119225119226119227119228119229119230119231119232119233119234119235119236119237119238119239119240119241119242119243119244119245119246119247119248119249119250119251119252119253119254119255119256119257119258119259119260119261119262119263119264119265119266119267119268119269119270119271119272119273119274119275119276119277119278119279119280119281119282119283119284119285119286119287119288119289119290119291119292119293119294119295119296119297119298119299119300119301119302119303119304119305119306119307119308119309119310119311119312119313119314119315119316119317119318119319119320119321119322119323119324119325119326119327119328119329119330119331119332119333119334119335119336119337119338119339119340119341119342119343119344119345119346119347119348119349119350119351119352119353119354119355119356119357119358119359119360119361119362119363119364119365119366119367119368119369119370119371119372119373119374119375119376119377119378119379119380119381119382119383119384119385119386119387119388119389119390119391119392119393119394119395119396119397119398119399119400119401119402119403119404119405119406119407119408119409119410119411119412119413119414119415119416119417119418119419119420119421119422119423119424119425119426119427119428119429119430119431119432119433119434119435119436119437119438119439119440119441119442119443119444119445119446119447119448119449119450119451119452119453119454119455119456119457119458119459119460119461119462119463119464119465119466119467119468119469119470119471119472119473119474119475119476119477119478119479119480119481119482119483119484119485119486119487119488119489119490119491119492119493119494119495119496119497119498119499119500119501119502119503119504119505119506119507119508119509119510119511119512119513119514119515119516119517119518119519119520119521119522119523119524119525119526119527119528119529119530119531119532119533119534119535119536119537119538119539119540119541119542119543119544119545119546119547119548119549119550119551119552119553119554119555119556119557119558119559119560119561119562119563119564119565119566119567119568119569119570119571119572119573119574119575119576119577119578119579119580119581119582119583119584119585119586119587119588119589119590119591119592119593119594119595119596119597119598119599119600119601119602119603119604119605119606119607119608119609119610119611119612119613119614119615119616119617119618119619119620119621119622119623119624119625119626119627119628119629119630119631119632119633119634119635119636119637119638119639119640119641119642119643119644119645119646119647119648119649119650119651119652119653119654119655119656119657119658119659119660119661119662119663119664119665119666119667119668119669119670119671119672119673119674119675119676119677119678119679119680119681119682119683119684119685119686119687119688119689119690119691119692119693119694119695119696119697119698119699119700119701119702119703119704119705119706119707119708119709119710119711119712119713119714119715119716119717119718119719119720119721119722119723119724119725119726119727119728119729119730119731119732119733119734119735119736119737119738119739119740119741119742119743119744119745119746119747119748119749119750119751119752119753119754119755119756119757119758119759119760119761119762119763119764119765119766119767119768119769119770119771119772119773119774119775119776119777119778119779119780119781119782119783119784119785119786119787119788119789119790119791119792119793119794119795119796119797119798119799119800119801119802119803119804119805119806119807119808119809119810119811119812119813119814119815119816119817119818119819119820119821119822119823119824119825119826119827119828119829119830119831119832119833119834119835119836119837119838119839119840119841119842119843119844119845119846119847119848119849119850119851119852119853119854119855119856119857119858119859119860119861119862119863119864119865119866119867119868119869119870119871119872119873119874119875119876119877119878119879119880119881119882119883119884119885119886119887119888119889119890119891119892119893119894119895119896119897119898119899119900119901119902119903119904119905119906119907119908119909119910119911119912119913119914119915119916119917119918119919119920119921119922119923119924119925119926119927119928119929119930119931119932119933119934119935119936119937119938119939119940119941119942119943119944119945119946119947119948119949119950119951119952119953119954119955119956119957119958119959119960119961119962119963119964119965119966119967119968119969119970119971119972119973119974119975119976119977119978119979119980119981119982119983119984119985119986119987119988119989119990119991119992119993119994119995119996119997119998119999120000120001120002120003120004120005120006120007120008120009120010120011120012120013120014120015120016120017120018120019120020120021120022120023120024120025120026120027120028120029120030120031120032120033120034120035120036120037120038120039120040120041120042120043120044120045120046120047120048120049120050120051120052120053120054120055120056120057120058120059120060120061120062120063120064120065120066120067120068120069120070120071120072120073120074120075120076120077120078120079120080120081120082120083120084120085120086120087120088120089120090120091120092120093120094120095120096120097120098120099120100120101120102120103120104120105120106120107120108120109120110120111120112120113120114120115120116120117120118120119120120120121120122120123120124120125120126120127120128120129120130120131120132120133120134120135120136120137120138120139120140120141120142120143120144120145120146120147120148120149120150120151120152120153120154120155120156120157120158120159120160120161120162120163120164120165120166120167120168120169120170120171120172120173120174120175120176120177120178120179120180120181120182120183120184120185120186120187120188120189120190120191120192120193120194120195120196120197120198120199120200120201120202120203120204120205120206120207120208120209120210120211120212120213120214120215120216120217120218120219120220120221120222120223120224120225120226120227120228120229120230120231120232120233120234120235120236120237120238120239120240120241120242120243120244120245120246120247120248120249120250120251120252120253120254120255120256120257120258120259120260120261120262120263120264120265120266120267120268120269120270120271120272120273120274120275120276120277120278120279120280120281120282120283120284120285120286120287120288120289120290120291120292120293120294120295120296120297120298120299120300120301120302120303120304120305120306120307120308120309120310120311120312120313120314120315120316120317120318120319120320120321120322120323120324120325120326120327120328120329120330120331120332120333120334120335120336120337120338120339120340120341120342120343120344120345120346120347120348120349120350120351120352120353120354120355120356120357120358120359120360120361120362120363120364120365120366120367120368120369120370120371120372120373120374120375120376120377120378120379120380120381120382120383120384120385120386120387120388120389120390120391120392120393120394120395120396120397120398120399120400120401120402120403120404120405120406120407120408120409120410120411120412120413120414120415120416120417120418120419120420120421120422120423120424120425120426120427120428120429120430120431120432120433120434120435120436120437120438120439120440120441120442120443120444120445120446120447120448120449120450120451120452120453120454120455120456120457120458120459120460120461120462120463120464120465120466120467120468120469120470120471120472120473120474120475120476120477120478120479120480120481120482120483120484120485120486120487120488120489120490120491120492120493120494120495120496120497120498120499120500120501120502120503120504120505120506120507120508120509120510120511120512120513120514120515120516120517120518120519120520120521120522120523120524120525120526120527120528120529120530120531120532120533120534120535120536120537120538120539120540120541120542120543120544120545120546120547120548120549120550120551120552120553120554120555120556120557120558120559120560120561120562120563120564120565120566120567120568120569120570120571120572120573120574120575120576120577120578120579120580120581120582120583120584120585120586120587120588120589120590120591120592120593120594120595120596120597120598120599120600120601120602120603120604120605120606120607120608120609120610120611120612120613120614120615120616120617120618120619120620120621120622120623120624120625120626120627120628120629120630120631120632120633120634120635120636120637120638120639120640120641120642120643120644120645120646120647120648120649120650120651120652120653120654120655120656120657120658120659120660120661120662120663120664120665120666120667120668120669120670120671120672120673120674120675120676120677120678120679120680120681120682120683120684120685120686120687120688120689120690120691120692120693120694120695120696120697120698120699120700120701120702120703120704120705120706120707120708120709120710120711120712120713120714120715120716120717120718120719120720120721120722120723120724120725120726120727120728120729120730120731120732120733120734120735120736120737120738120739120740120741120742120743120744120745120746120747120748120749120750120751120752120753120754120755120756120757120758120759120760120761120762120763120764120765120766120767120768120769120770120771120772120773120774120775120776120777120778120779120780120781120782120783120784120785120786120787120788120789120790120791120792120793120794120795120796120797120798120799120800120801120802120803120804120805120806120807120808120809120810120811120812120813120814120815120816120817120818120819120820120821120822120823120824120825120826120827120828120829120830120831120832120833120834120835120836120837120838120839120840120841120842120843120844120845120846120847120848120849120850120851120852120853120854120855120856120857120858120859120860120861120862120863120864120865120866120867120868120869120870120871120872120873120874120875120876120877120878120879120880120881120882120883120884120885120886120887120888120889120890120891120892120893120894120895120896120897120898120899120900120901120902120903120904120905120906120907120908120909120910120911120912120913120914120915120916120917120918120919120920120921120922120923120924120925120926120927120928120929120930120931120932120933120934120935120936120937120938120939120940120941120942120943120944120945120946120947120948120949120950120951120952120953120954120955120956120957120958120959120960120961120962120963120964120965120966120967120968120969120970120971120972120973120974120975120976120977120978120979120980120981120982120983120984120985120986120987120988120989120990120991120992120993120994120995120996120997120998120999121000121001121002121003121004121005121006121007121008121009121010121011121012121013121014121015121016121017121018121019121020121021121022121023121024121025121026121027121028121029121030121031121032121033121034121035121036121037121038121039121040121041121042121043121044121045121046121047121048121049121050121051121052121053121054121055121056121057121058121059121060121061121062121063121064121065121066121067121068121069121070121071121072121073121074121075121076121077121078121079121080121081121082121083121084121085121086121087121088121089121090121091121092121093121094121095121096121097121098121099121100121101121102121103121104121105121106121107121108121109121110121111121112121113121114121115121116121117121118121119121120121121121122121123121124121125121126121127121128121129121130121131121132121133121134121135121136121137121138121139121140121141121142121143121144121145121146121147121148121149121150121151121152121153121154121155121156121157121158121159121160121161121162121163121164121165121166121167121168121169121170121171121172121173121174121175121176121177121178121179121180121181121182121183121184121185121186121187121188121189121190121191121192121193121194121195121196121197121198121199121200121201121202121203121204121205121206121207121208121209121210121211121212121213121214121215121216121217121218121219121220121221121222121223121224121225121226121227121228121229121230121231121232121233121234121235121236121237121238121239121240121241121242121243121244121245121246121247121248121249121250121251121252121253121254121255121256121257121258121259121260121261121262121263121264121265121266121267121268121269121270121271121272121273121274121275121276121277121278121279121280121281121282121283121284121285121286121287121288121289121290121291121292121293121294121295121296121297121298121299121300121301121302121303121304121305121306121307121308121309121310121311121312121313121314121315121316121317121318121319121320121321121322121323121324121325121326121327121328121329121330121331121332121333121334121335121336121337121338121339121340121341121342121343121344121345121346121347121348121349121350121351121352121353121354121355121356121357121358121359121360121361121362121363121364121365121366121367121368121369121370121371121372121373121374121375121376121377121378121379121380121381121382121383121384121385121386121387121388121389121390121391121392121393121394121395121396121397121398121399121400121401121402121403121404121405121406121407121408121409121410121411121412121413121414121415121416121417121418121419121420121421121422121423121424121425121426121427121428121429121430121431121432121433121434121435121436121437121438121439121440121441121442121443121444121445121446121447121448121449121450121451121452121453121454121455121456121457121458121459121460121461121462121463121464121465121466121467121468121469121470121471121472121473121474121475121476121477121478121479121480121481121482121483121484121485121486121487121488121489121490121491121492121493121494121495121496121497121498121499121500121501121502121503121504121505121506121507121508121509121510121511121512121513121514121515121516121517121518121519121520121521121522121523121524121525121526121527121528121529121530121531121532121533121534121535121536121537121538121539121540121541121542121543121544121545121546121547121548121549121550121551121552121553121554121555121556121557121558121559121560121561121562121563121564121565121566121567121568121569121570121571121572121573121574121575121576121577121578121579121580121581121582121583121584121585121586121587121588121589121590121591121592121593121594121595121596121597121598121599121600121601121602121603121604121605121606121607121608121609121610121611121612121613121614121615121616121617121618121619121620121621121622121623121624121625121626121627121628121629121630121631121632121633121634121635121636121637121638121639121640121641121642121643121644121645121646121647121648121649121650121651121652121653121654121655121656121657121658121659121660121661121662121663121664121665121666121667121668121669121670121671121672121673121674121675121676121677121678121679121680121681121682121683121684121685121686121687121688121689121690121691121692121693121694121695121696121697121698121699121700121701121702121703121704121705121706121707121708121709121710121711121712121713121714121715121716121717121718121719121720121721121722121723121724121725121726121727121728121729121730121731121732121733121734121735121736121737121738121739121740121741121742121743121744121745121746121747121748121749121750121751121752121753121754121755121756121757121758121759121760121761121762121763121764121765121766121767121768121769121770121771121772121773121774121775121776121777121778121779121780121781121782121783121784121785121786121787121788121789121790121791121792121793121794121795121796121797121798121799121800121801121802121803121804121805121806121807121808121809121810121811121812121813121814121815121816121817121818121819121820121821121822121823121824121825121826121827121828121829121830121831121832121833121834121835121836121837121838121839121840121841121842121843121844121845121846121847121848121849121850121851121852121853121854121855121856121857121858121859121860121861121862121863121864121865121866121867121868121869121870121871121872121873121874121875121876121877121878121879121880121881121882121883121884121885121886121887121888121889121890121891121892121893121894121895121896121897121898121899121900121901121902121903121904121905121906121907121908121909121910121911121912121913121914121915121916121917121918121919121920121921121922121923121924121925121926121927121928121929121930121931121932121933121934121935121936121937121938121939121940121941121942121943121944121945121946121947121948121949121950121951121952121953121954121955121956121957121958121959121960121961121962121963121964121965121966121967121968121969121970121971121972121973121974121975121976121977121978121979121980121981121982121983121984121985121986121987121988121989121990121991121992121993121994121995121996121997121998121999122000122001122002122003122004122005122006122007122008122009122010122011122012122013122014122015122016122017122018122019122020122021122022122023122024122025122026122027122028122029122030122031122032122033122034122035122036122037122038122039122040122041122042122043122044122045122046122047122048122049122050122051122052122053122054122055122056122057122058122059122060122061122062122063122064122065122066122067122068122069122070122071122072122073122074122075122076122077122078122079122080122081122082122083122084122085122086122087122088122089122090122091122092122093122094122095122096122097122098122099122100122101122102122103122104122105122106122107122108122109122110122111122112122113122114122115122116122117122118122119122120122121122122122123122124122125122126122127122128122129122130122131122132122133122134122135122136122137122138122139122140122141122142122143122144122145122146122147122148122149122150122151122152122153122154122155122156122157122158122159122160122161122162122163122164122165122166122167122168122169122170122171122172122173122174122175122176122177122178122179122180122181122182122183122184122185122186122187122188122189122190122191122192122193122194122195122196122197122198122199122200122201122202122203122204122205122206122207122208122209122210122211122212122213122214122215122216122217122218122219122220122221122222122223122224122225122226122227122228122229122230122231122232122233122234122235122236122237122238122239122240122241122242122243122244122245122246122247122248122249122250122251122252122253122254122255122256122257122258122259122260122261122262122263122264122265122266122267122268122269122270122271122272122273122274122275122276122277122278122279122280122281122282122283122284122285122286122287122288122289122290122291122292122293122294122295122296122297122298122299122300122301122302122303122304122305122306122307122308122309122310122311122312122313122314122315122316122317122318122319122320122321122322122323122324122325122326122327122328122329122330122331122332122333122334122335122336122337122338122339122340122341122342122343122344122345122346122347122348122349122350122351122352122353122354122355122356122357122358122359122360122361122362122363122364122365122366122367122368122369122370122371122372122373122374122375122376122377122378122379122380122381122382122383122384122385122386122387122388122389122390122391122392122393122394122395122396122397122398122399122400122401122402122403122404122405122406122407122408122409122410122411122412122413122414122415122416122417122418122419122420122421122422122423122424122425122426122427122428122429122430122431122432122433122434122435122436122437122438122439122440122441122442122443122444122445122446122447122448122449122450122451122452122453122454122455122456122457122458122459122460122461122462122463122464122465122466122467122468122469122470122471122472122473122474122475122476122477122478122479122480122481122482122483122484122485122486122487122488122489122490122491122492122493122494122495122496122497122498122499122500122501122502122503122504122505122506122507122508122509122510122511122512122513122514122515122516122517122518122519122520122521122522122523122524122525122526122527122528122529122530122531122532122533122534122535122536122537122538122539122540122541122542122543122544122545122546122547122548122549122550122551122552122553122554122555122556122557122558122559122560122561122562122563122564122565122566122567122568122569122570122571122572122573122574122575122576122577122578122579122580122581122582122583122584122585122586122587122588122589122590122591122592122593122594122595122596122597122598122599122600122601122602122603122604122605122606122607122608122609122610122611122612122613122614122615122616122617122618122619122620122621122622122623122624122625122626122627122628122629122630122631122632122633122634122635122636122637122638122639122640122641122642122643122644122645122646122647122648122649122650122651122652122653122654122655122656122657122658122659122660122661122662122663122664122665122666122667122668122669122670122671122672122673122674122675122676122677122678122679122680122681122682122683122684122685122686122687122688122689122690122691122692122693122694122695122696122697122698122699122700122701122702122703122704122705122706122707122708122709122710122711122712122713122714122715122716122717122718122719122720122721122722122723122724122725122726122727122728122729122730122731122732122733122734122735122736122737122738122739122740122741122742122743122744122745122746122747122748122749122750122751122752122753122754122755122756122757122758122759122760122761122762122763122764122765122766122767122768122769122770122771122772122773122774122775122776122777122778122779122780122781122782122783122784122785122786122787122788122789122790122791122792122793122794122795122796122797122798122799122800122801122802122803122804122805122806122807122808122809122810122811122812122813122814122815122816122817122818122819122820122821122822122823122824122825122826122827122828122829122830122831122832122833122834122835122836122837122838122839122840122841122842122843122844122845122846122847122848122849122850122851122852122853122854122855122856122857122858122859122860122861122862122863122864122865122866122867122868122869122870122871122872122873122874122875122876122877122878122879122880122881122882122883122884122885122886122887122888122889122890122891122892122893122894122895122896122897122898122899122900122901122902122903122904122905122906122907122908122909122910122911122912122913122914122915122916122917122918122919122920122921122922122923122924122925122926122927122928122929122930122931122932122933122934122935122936122937122938122939122940122941122942122943122944122945122946122947122948122949122950122951122952122953122954122955122956122957122958122959122960122961122962122963122964122965122966122967122968122969122970122971122972122973122974122975122976122977122978122979122980122981122982122983122984122985122986122987122988122989122990122991122992122993122994122995122996122997122998122999123000123001123002123003123004123005123006123007123008123009123010123011123012123013123014123015123016123017123018123019123020123021123022123023123024123025123026123027123028123029123030123031123032123033123034123035123036123037123038123039123040123041123042123043123044123045123046123047123048123049123050123051123052123053123054123055123056123057123058123059123060123061123062123063123064123065123066123067123068123069123070123071123072123073123074123075123076123077123078123079123080123081123082123083123084123085123086123087123088123089123090123091123092123093123094123095123096123097123098123099123100123101123102123103123104123105123106123107123108123109123110123111123112123113123114123115123116123117123118123119123120123121123122123123123124123125123126123127123128123129123130123131123132123133123134123135123136123137123138123139123140123141123142123143123144123145123146123147123148123149123150123151123152123153123154123155123156123157123158123159123160123161123162123163123164123165123166123167123168123169123170123171123172123173123174123175123176123177123178123179123180123181123182123183123184123185123186123187123188123189123190123191123192123193123194123195123196123197123198123199123200123201123202123203123204123205123206123207123208123209123210123211123212123213123214123215123216123217123218123219123220123221123222123223123224123225123226123227123228123229123230123231123232123233123234123235123236123237123238123239123240123241123242123243123244123245123246123247123248123249123250123251123252123253123254123255123256123257123258123259123260123261123262123263123264123265123266123267123268123269123270123271123272123273123274123275123276123277123278123279123280123281123282123283123284123285123286123287123288123289123290123291123292123293123294123295123296123297123298123299123300123301123302123303123304123305123306123307123308123309123310123311123312123313123314123315123316123317123318123319123320123321123322123323123324123325123326123327123328123329123330123331123332123333123334123335123336123337123338123339123340123341123342123343123344123345123346123347123348123349123350123351123352123353123354123355123356123357123358123359123360123361123362123363123364123365123366123367123368123369123370123371123372123373123374123375123376123377123378123379123380123381123382123383123384123385123386123387123388123389123390123391123392123393123394123395123396123397123398123399123400123401123402123403123404123405123406123407123408123409123410123411123412123413123414123415123416123417123418123419123420123421123422123423123424123425123426123427123428123429123430123431123432123433123434123435123436123437123438123439123440123441123442123443123444123445123446123447123448123449123450123451123452123453123454123455123456123457123458123459123460123461123462123463123464123465123466123467123468123469123470123471123472123473123474123475123476123477123478123479123480123481123482123483123484123485123486123487123488123489123490123491123492123493123494123495123496123497123498123499123500123501123502123503123504123505123506123507123508123509123510123511123512123513123514123515123516123517123518123519123520123521123522123523123524123525123526123527123528123529123530123531123532123533123534123535123536123537123538123539123540123541123542123543123544123545123546123547123548123549123550123551123552123553123554123555123556123557123558123559123560123561123562123563123564123565123566123567123568123569123570123571123572123573123574123575123576123577123578123579123580123581123582123583123584123585123586123587123588123589123590123591123592123593123594123595123596123597123598123599123600123601123602123603123604123605123606123607123608123609123610123611123612123613123614123615123616123617123618123619123620123621123622123623123624123625123626123627123628123629123630123631123632123633123634123635123636123637123638123639123640123641123642123643123644123645123646123647123648123649123650123651123652123653123654123655123656123657123658123659123660123661123662123663123664123665123666123667123668123669123670123671123672123673123674123675123676123677123678123679123680123681123682123683123684123685123686123687123688123689123690123691123692123693123694123695123696123697123698123699123700123701123702123703123704123705123706123707123708123709123710123711123712123713123714123715123716123717123718123719123720123721123722123723123724123725123726123727123728123729123730123731123732123733123734123735123736123737123738123739123740123741123742123743123744123745123746123747123748123749123750123751123752123753123754123755123756123757123758123759123760123761123762123763123764123765123766123767123768123769123770123771123772123773123774123775123776123777123778123779123780123781123782123783123784123785123786123787123788123789123790123791123792123793123794123795123796123797123798123799123800123801123802123803123804123805123806123807123808123809123810123811123812123813123814123815123816123817123818123819123820123821123822123823123824123825123826123827123828123829123830123831123832123833123834123835123836123837123838123839123840123841123842123843123844123845123846123847123848123849123850123851123852123853123854123855123856123857123858123859123860123861123862123863123864123865123866123867123868123869123870123871123872123873123874123875123876123877123878123879123880123881123882123883123884123885123886123887123888123889123890123891123892123893123894123895123896123897123898123899123900123901123902123903123904123905123906123907123908123909123910123911123912123913123914123915123916123917123918123919123920123921123922123923123924123925123926123927123928123929123930123931123932123933123934123935123936123937123938123939123940123941123942123943123944123945123946123947123948123949123950123951123952123953123954123955123956123957123958123959123960123961123962123963123964123965123966123967123968123969123970123971123972123973123974123975123976123977123978123979123980123981123982123983123984123985123986123987123988123989123990123991123992123993123994123995123996123997123998123999124000124001124002124003124004124005124006124007124008124009124010124011124012124013124014124015124016124017124018124019124020124021124022124023124024124025124026124027124028124029124030124031124032124033124034124035124036124037124038124039124040124041124042124043124044124045124046124047124048124049124050124051124052124053124054124055124056124057124058124059124060124061124062124063124064124065124066124067124068124069124070124071124072124073124074124075124076124077124078124079124080124081124082124083124084124085124086124087124088124089124090124091124092124093124094124095124096124097124098124099124100124101124102124103124104124105124106124107124108124109124110124111124112124113124114124115124116124117124118124119124120124121124122124123124124124125124126124127124128124129124130124131124132124133124134124135124136124137124138124139124140124141124142124143124144124145124146124147124148124149124150124151124152124153124154124155124156124157124158124159124160124161124162124163124164124165124166124167124168124169124170124171124172124173124174124175124176124177124178124179124180124181124182124183124184124185124186124187124188124189124190124191124192124193124194124195124196124197124198124199124200124201124202124203124204124205124206124207124208124209124210124211124212124213124214124215124216124217124218124219124220124221124222124223124224124225124226124227124228124229124230124231124232124233124234124235124236124237124238124239124240124241124242124243124244124245124246124247124248124249124250124251124252124253124254124255124256124257124258124259124260124261124262124263124264124265124266124267124268124269124270124271124272124273124274124275124276124277124278124279124280124281124282124283124284124285124286124287124288124289124290124291124292124293124294124295124296124297124298124299124300124301124302124303124304124305124306124307124308124309124310124311124312124313124314124315124316124317124318124319124320124321124322124323124324124325124326124327124328124329124330124331124332124333124334124335124336124337124338124339124340124341124342124343124344124345124346124347124348124349124350124351124352124353124354124355124356124357124358124359124360124361124362124363124364124365124366124367124368124369124370124371124372124373124374124375124376124377124378124379124380124381124382124383124384124385124386124387124388124389124390124391124392124393124394124395124396124397124398124399124400124401124402124403124404124405124406124407124408124409124410124411124412124413124414124415124416124417124418124419124420124421124422124423124424124425124426124427124428124429124430124431124432124433124434124435124436124437124438124439124440124441124442124443124444124445124446124447124448124449124450124451124452124453124454124455124456124457124458124459124460124461124462124463124464124465124466124467124468124469124470124471124472124473124474124475124476124477124478124479124480124481124482124483124484124485124486124487124488124489124490124491124492124493124494124495124496124497124498124499124500124501124502124503124504124505124506124507124508124509124510124511124512124513124514124515124516124517124518124519124520124521124522124523124524124525124526124527124528124529124530124531124532124533124534124535124536124537124538124539124540124541124542124543124544124545124546124547124548124549124550124551124552124553124554124555124556124557124558124559124560124561124562124563124564124565124566124567124568124569124570124571124572124573124574124575124576124577124578124579124580124581124582124583124584124585124586124587124588124589124590124591124592124593124594124595124596124597124598124599124600124601124602124603124604124605124606124607124608124609124610124611124612124613124614124615124616124617124618124619124620124621124622124623124624124625124626124627124628124629124630124631124632124633124634124635124636124637124638124639124640124641124642124643124644124645124646124647124648124649124650124651124652124653124654124655124656124657124658124659124660124661124662124663124664124665124666124667124668124669124670124671124672124673124674124675124676124677124678124679124680124681124682124683124684124685124686124687124688124689124690124691124692124693124694124695124696124697124698124699124700124701124702124703124704124705124706124707124708124709124710124711124712124713124714124715124716124717124718124719124720124721124722124723124724124725124726124727124728124729124730124731124732124733124734124735124736124737124738124739124740124741124742124743124744124745124746124747124748124749124750124751124752124753124754124755124756124757124758124759124760124761124762124763124764124765124766124767124768124769124770124771124772124773124774124775124776124777124778124779124780124781124782124783124784124785124786124787124788124789124790124791124792124793124794124795124796124797124798124799124800124801124802124803124804124805124806124807124808124809124810124811124812124813124814124815124816124817124818124819124820124821124822124823124824124825124826124827124828124829124830124831124832124833124834124835124836124837124838124839124840124841124842124843124844124845124846124847124848124849124850124851124852124853124854124855124856124857124858124859124860124861124862124863124864124865124866124867124868124869124870124871124872124873124874124875124876124877124878124879124880124881124882124883124884124885124886124887124888124889124890124891124892124893124894124895124896124897124898124899124900124901124902124903124904124905124906124907124908124909124910124911124912124913124914124915124916124917124918124919124920124921124922124923124924124925124926124927124928124929124930124931124932124933124934124935124936124937124938124939124940124941124942124943124944124945124946124947124948124949124950124951124952124953124954124955124956124957124958124959124960124961124962124963124964124965124966124967124968124969124970124971124972124973124974124975124976124977124978124979124980124981124982124983124984124985124986124987124988124989124990124991124992124993124994124995124996124997124998124999125000125001125002125003125004125005125006125007125008125009125010125011125012125013125014125015125016125017125018125019125020125021125022125023125024125025125026125027125028125029125030125031125032125033125034125035125036125037125038125039125040125041125042125043125044125045125046125047125048125049125050125051125052125053125054125055125056125057125058125059125060125061125062125063125064125065125066125067125068125069125070125071125072125073125074125075125076125077125078125079125080125081125082125083125084125085125086125087125088125089125090125091125092125093125094125095125096125097125098125099125100125101125102125103125104125105125106125107125108125109125110125111125112125113125114125115125116125117125118125119125120125121125122125123125124125125125126125127125128125129125130125131125132125133125134125135125136125137125138125139125140125141125142125143125144125145125146125147125148125149125150125151125152125153125154125155125156125157125158125159125160125161125162125163125164125165125166125167125168125169125170125171125172125173125174125175125176125177125178125179125180125181125182125183125184125185125186125187125188125189125190125191125192125193125194125195125196125197125198125199125200125201125202125203125204125205125206125207125208125209125210125211125212125213125214125215125216125217125218125219125220125221125222125223125224125225125226125227125228125229125230125231125232125233125234125235125236125237125238125239125240125241125242125243125244125245125246125247125248125249125250125251125252125253125254125255125256125257125258125259125260125261125262125263125264125265125266125267125268125269125270125271125272125273125274125275125276125277125278125279125280125281125282125283125284125285125286125287125288125289125290125291125292125293125294125295125296125297125298125299125300125301125302125303125304125305125306125307125308125309125310125311125312125313125314125315125316125317125318125319125320125321125322125323125324125325125326125327125328125329125330125331125332125333125334125335125336125337125338125339125340125341125342125343125344125345125346125347125348125349125350125351125352125353125354125355125356125357125358125359125360125361125362125363125364125365125366125367125368125369125370125371125372125373125374125375125376125377125378125379125380125381125382125383125384125385125386125387125388125389125390125391125392125393125394125395125396125397125398125399125400125401125402125403125404125405125406125407125408125409125410125411125412125413125414125415125416125417125418125419125420125421125422125423125424125425125426125427125428125429125430125431125432125433125434125435125436125437125438125439125440125441125442125443125444125445125446125447125448125449125450125451125452125453125454125455125456125457125458125459125460125461125462125463125464125465125466125467125468125469125470125471125472125473125474125475125476125477125478125479125480125481125482125483125484125485125486125487125488125489125490125491125492125493125494125495125496125497125498125499125500125501125502125503125504125505125506125507125508125509125510125511125512125513125514125515125516125517125518125519125520125521125522125523125524125525125526125527125528125529125530125531125532125533125534125535125536125537125538125539125540125541125542125543125544125545125546125547125548125549125550125551125552125553125554125555125556125557125558125559125560125561125562125563125564125565125566125567125568125569125570125571125572125573125574125575125576125577125578125579125580125581125582125583125584125585125586125587125588125589125590125591125592125593125594125595125596125597125598125599125600125601125602125603125604125605125606125607125608125609125610125611125612125613125614125615125616125617125618125619125620125621125622125623125624125625125626125627125628125629125630125631125632125633125634125635125636125637125638125639125640125641125642125643125644125645125646125647125648125649125650125651125652125653125654125655125656125657125658125659125660125661125662125663125664125665125666125667125668125669125670125671125672125673125674125675125676125677125678125679125680125681125682125683125684125685125686125687125688125689125690125691125692125693125694125695125696125697125698125699125700125701125702125703125704125705125706125707125708125709125710125711125712125713125714125715125716125717125718125719125720125721125722125723125724125725125726125727125728125729125730125731125732125733125734125735125736125737125738125739125740125741125742125743125744125745125746125747125748125749125750125751125752125753125754125755125756125757125758125759125760125761125762125763125764125765125766125767125768125769125770125771125772125773125774125775125776125777125778125779125780125781125782125783125784125785125786125787125788125789125790125791125792125793125794125795125796125797125798125799125800125801125802125803125804125805125806125807125808125809125810125811125812125813125814125815125816125817125818125819125820125821125822125823125824125825125826125827125828125829125830125831125832125833125834125835125836125837125838125839125840125841125842125843125844125845125846125847125848125849125850125851125852125853125854125855125856125857125858125859125860125861125862125863125864125865125866125867125868125869125870125871125872125873125874125875125876125877125878125879125880125881125882125883125884125885125886125887125888125889125890125891125892125893125894125895125896125897125898125899125900125901125902125903125904125905125906125907125908125909125910125911125912125913125914125915125916125917125918125919125920125921125922125923125924125925125926125927125928125929125930125931125932125933125934125935125936125937125938125939125940125941125942125943125944125945125946125947125948125949125950125951125952125953125954125955125956125957125958125959125960125961125962125963125964125965125966125967125968125969125970125971125972125973125974125975125976125977125978125979125980125981125982125983125984125985125986125987125988125989125990125991125992125993125994125995125996125997125998125999126000126001126002126003126004126005126006126007126008126009126010126011126012126013126014126015126016126017126018126019126020126021126022126023126024126025126026126027126028126029126030126031126032126033126034126035126036126037126038126039126040126041126042126043126044126045126046126047126048126049126050126051126052126053126054126055126056126057126058126059126060126061126062126063126064126065126066126067126068126069126070126071126072126073126074126075126076126077126078126079126080126081126082126083126084126085126086126087126088126089126090126091126092126093126094126095126096126097126098126099126100126101126102126103126104126105126106126107126108126109126110126111126112126113126114126115126116126117126118126119126120126121126122126123126124126125126126126127126128126129126130126131126132126133126134126135126136126137126138126139126140126141126142126143126144126145126146126147126148126149126150126151126152126153126154126155126156126157126158126159126160126161126162126163126164126165126166126167126168126169126170126171126172126173126174126175126176126177126178126179126180126181126182126183126184126185126186126187126188126189126190126191126192126193126194126195126196126197126198126199126200126201126202126203126204126205126206126207126208126209126210126211126212126213126214126215126216126217126218126219126220126221126222126223126224126225126226126227126228126229126230126231126232126233126234126235126236126237126238126239126240126241126242126243126244126245126246126247126248126249126250126251126252126253126254126255126256126257126258126259126260126261126262126263126264126265126266126267126268126269126270126271126272126273126274126275126276126277126278126279126280126281126282126283126284126285126286126287126288126289126290126291126292126293126294126295126296126297126298126299126300126301126302126303126304126305126306126307126308126309126310126311126312126313126314126315126316126317126318126319126320126321126322126323126324126325126326126327126328126329126330126331126332126333126334126335126336126337126338126339126340126341126342126343126344126345126346126347126348126349126350126351126352126353126354126355126356126357126358126359126360126361126362126363126364126365126366126367126368126369126370126371126372126373126374126375126376126377126378126379126380126381126382126383126384126385126386126387126388126389126390126391126392126393126394126395126396126397126398126399126400126401126402126403126404126405126406126407126408126409126410126411126412126413126414126415126416126417126418126419126420126421126422126423126424126425126426126427126428126429126430126431126432126433126434126435126436126437126438126439126440126441126442126443126444126445126446126447126448126449126450126451126452126453126454126455126456126457126458126459126460126461126462126463126464126465126466126467126468126469126470126471126472126473126474126475126476126477126478126479126480126481126482126483126484126485126486126487126488126489126490126491126492126493126494126495126496126497126498126499126500126501126502126503126504126505126506126507126508126509126510126511126512126513126514126515126516126517126518126519126520126521126522126523126524126525126526126527126528126529126530126531126532126533126534126535126536126537126538126539126540126541126542126543126544126545126546126547126548126549126550126551126552126553126554126555126556126557126558126559126560126561126562126563126564126565126566126567126568126569126570126571126572126573126574126575126576126577126578126579126580126581126582126583126584126585126586126587126588126589126590126591126592126593126594126595126596126597126598126599126600126601126602126603126604126605126606126607126608126609126610126611126612126613126614126615126616126617126618126619126620126621126622126623126624126625126626126627126628126629126630126631126632126633126634126635126636126637126638126639126640126641126642126643126644126645126646126647126648126649126650126651126652126653126654126655126656126657126658126659126660126661126662126663126664126665126666126667126668126669126670126671126672126673126674126675126676126677126678126679126680126681126682126683126684126685126686126687126688126689126690126691126692126693126694126695126696126697126698126699126700126701126702126703126704126705126706126707126708126709126710126711126712126713126714126715126716126717126718126719126720126721126722126723126724126725126726126727126728126729126730126731126732126733126734126735126736126737126738126739126740126741126742126743126744126745126746126747126748126749126750126751126752126753126754126755126756126757126758126759126760126761126762126763126764126765126766126767126768126769126770126771126772126773126774126775126776126777126778126779126780126781126782126783126784126785126786126787126788126789126790126791126792126793126794126795126796126797126798126799126800126801126802126803126804126805126806126807126808126809126810126811126812126813126814126815126816126817126818126819126820126821126822126823126824126825126826126827126828126829126830126831126832126833126834126835126836126837126838126839126840126841126842126843126844126845126846126847126848126849126850126851126852126853126854126855126856126857126858126859126860126861126862126863126864126865126866126867126868126869126870126871126872126873126874126875126876126877126878126879126880126881126882126883126884126885126886126887126888126889126890126891126892126893126894126895126896126897126898126899126900126901126902126903126904126905126906126907126908126909126910126911126912126913126914126915126916126917126918126919126920126921126922126923126924126925126926126927126928126929126930126931126932126933126934126935126936126937126938126939126940126941126942126943126944126945126946126947126948126949126950126951126952126953126954126955126956126957126958126959126960126961126962126963126964126965126966126967126968126969126970126971126972126973126974126975126976126977126978126979126980126981126982126983126984126985126986126987126988126989126990126991126992126993126994126995126996126997126998126999127000127001127002127003127004127005127006127007127008127009127010127011127012127013127014127015127016127017127018127019127020127021127022127023127024127025127026127027127028127029127030127031127032127033127034127035127036127037127038127039127040127041127042127043127044127045127046127047127048127049127050127051127052127053127054127055127056127057127058127059127060127061127062127063127064127065127066127067127068127069127070127071127072127073127074127075127076127077127078127079127080127081127082127083127084127085127086127087127088127089127090127091127092127093127094127095127096127097127098127099127100127101127102127103127104127105127106127107127108127109127110127111127112127113127114127115127116127117127118127119127120127121127122127123127124127125127126127127127128127129127130127131127132127133127134127135127136127137127138127139127140127141127142127143127144127145127146127147127148127149127150127151127152127153127154127155127156127157127158127159127160127161127162127163127164127165127166127167127168127169127170127171127172127173127174127175127176127177127178127179127180127181127182127183127184127185127186127187127188127189127190127191127192127193127194127195127196127197127198127199127200127201127202127203127204127205127206127207127208127209127210127211127212127213127214127215127216127217127218127219127220127221127222127223127224127225127226127227127228127229127230127231127232127233127234127235127236127237127238127239127240127241127242127243127244127245127246127247127248127249127250127251127252127253127254127255127256127257127258127259127260127261127262127263127264127265127266127267127268127269127270127271127272127273127274127275127276127277127278127279127280127281127282127283127284127285127286127287127288127289127290127291127292127293127294127295127296127297127298127299127300127301127302127303127304127305127306127307127308127309127310127311127312127313127314127315127316127317127318127319127320127321127322127323127324127325127326127327127328127329127330127331127332127333127334127335127336127337127338127339127340127341127342127343127344127345127346127347127348127349127350127351127352127353127354127355127356127357127358127359127360127361127362127363127364127365127366127367127368127369127370127371127372127373127374127375127376127377127378127379127380127381127382127383127384127385127386127387127388127389127390127391127392127393127394127395127396127397127398127399127400127401127402127403127404127405127406127407127408127409127410127411127412127413127414127415127416127417127418127419127420127421127422127423127424127425127426127427127428127429127430127431127432127433127434127435127436127437127438127439127440127441127442127443127444127445127446127447127448127449127450127451127452127453127454127455127456127457127458127459127460127461127462127463127464127465127466127467127468127469127470127471127472127473127474127475127476127477127478127479127480127481127482127483127484127485127486127487127488127489127490127491127492127493127494127495127496127497127498127499127500127501127502127503127504127505127506127507127508127509127510127511127512127513127514127515127516127517127518127519127520127521127522127523127524127525127526127527127528127529127530127531127532127533127534127535127536127537127538127539127540127541127542127543127544127545127546127547127548127549127550127551127552127553127554127555127556127557127558127559127560127561127562127563127564127565127566127567127568127569127570127571127572127573127574127575127576127577127578127579127580127581127582127583127584127585127586127587127588127589127590127591127592127593127594127595127596127597127598127599127600127601127602127603127604127605127606127607127608127609127610127611127612127613127614127615127616127617127618127619127620127621127622127623127624127625127626127627127628127629127630127631127632127633127634127635127636127637127638127639127640127641127642127643127644127645127646127647127648127649127650127651127652127653127654127655127656127657127658127659127660127661127662127663127664127665127666127667127668127669127670127671127672127673127674127675127676127677127678127679127680127681127682127683127684127685127686127687127688127689127690127691127692127693127694127695127696127697127698127699127700127701127702127703127704127705127706127707127708127709127710127711127712127713127714127715127716127717127718127719127720127721127722127723127724127725127726127727127728127729127730127731127732127733127734127735127736127737127738127739127740127741127742127743127744127745127746127747127748127749127750127751127752127753127754127755127756127757127758127759127760127761127762127763127764127765127766127767127768127769127770127771127772127773127774127775127776127777127778127779127780127781127782127783127784127785127786127787127788127789127790127791127792127793127794127795127796127797127798127799127800127801127802127803127804127805127806127807127808127809127810127811127812127813127814127815127816127817127818127819127820127821127822127823127824127825127826127827127828127829127830127831127832127833127834127835127836127837127838127839127840127841127842127843127844127845127846127847127848127849127850127851127852127853127854127855127856127857127858127859127860127861127862127863127864127865127866127867127868127869127870127871127872127873127874127875127876127877127878127879127880127881127882127883127884127885127886127887127888127889127890127891127892127893127894127895127896127897127898127899127900127901127902127903127904127905127906127907127908127909127910127911127912127913127914127915127916127917127918127919127920127921127922127923127924127925127926127927127928127929127930127931127932127933127934127935127936127937127938127939127940127941127942127943127944127945127946127947127948127949127950127951127952127953127954127955127956127957127958127959127960127961127962127963127964127965127966127967127968127969127970127971127972127973127974127975127976127977127978127979127980127981127982127983127984127985127986127987127988127989127990127991127992127993127994127995127996127997127998127999128000128001128002128003128004128005128006128007128008128009128010128011128012128013128014128015128016128017128018128019128020128021128022128023128024128025128026128027128028128029128030128031128032128033128034128035128036128037128038128039128040128041128042128043128044128045128046128047128048128049128050128051128052128053128054128055128056128057128058128059128060128061128062128063128064128065128066128067128068128069128070128071128072128073128074128075128076128077128078128079128080128081128082128083128084128085128086128087128088128089128090128091128092128093128094128095128096128097128098128099128100128101128102128103128104128105128106128107128108128109128110128111128112128113128114128115128116128117128118128119128120128121128122128123128124128125128126128127128128128129128130128131128132128133128134128135128136128137128138128139128140128141128142128143128144128145128146128147128148128149128150128151128152128153128154128155128156128157128158128159128160128161128162128163128164128165128166128167128168128169128170128171128172128173128174128175128176128177128178128179128180128181128182128183128184128185128186128187128188128189128190128191128192128193128194128195128196128197128198128199128200128201128202128203128204128205128206128207128208128209128210128211128212128213128214128215128216128217128218128219128220128221128222128223128224128225128226128227128228128229128230128231128232128233128234128235128236128237128238128239128240128241128242128243128244128245128246128247128248128249128250128251128252128253128254128255128256128257128258128259128260128261128262128263128264128265128266128267128268128269128270128271128272128273128274128275128276128277128278128279128280128281128282128283128284128285128286128287128288128289128290128291128292128293128294128295128296128297128298128299128300128301128302128303128304128305128306128307128308128309128310128311128312128313128314128315128316128317128318128319128320128321128322128323128324128325128326128327128328128329128330128331128332128333128334128335128336128337128338128339128340128341128342128343128344128345128346128347128348128349128350128351128352128353128354128355128356128357128358128359128360128361128362128363128364128365128366128367128368128369128370128371128372128373128374128375128376128377128378128379128380128381128382128383128384128385128386128387128388128389128390128391128392128393128394128395128396128397128398128399128400128401128402128403128404128405128406128407128408128409128410128411128412128413128414128415128416128417128418128419128420128421128422128423128424128425128426128427128428128429128430128431128432128433128434128435128436128437128438128439128440128441128442128443128444128445128446128447128448128449128450128451128452128453128454128455128456128457128458128459128460128461128462128463128464128465128466128467128468128469128470128471128472128473128474128475128476128477128478128479128480128481128482128483128484128485128486128487128488128489128490128491128492128493128494128495128496128497128498128499128500128501128502128503128504128505128506128507128508128509128510128511128512128513128514128515128516128517128518128519128520128521128522128523128524128525128526128527128528128529128530128531128532128533128534128535128536128537128538128539128540128541128542128543128544128545128546128547128548128549128550128551128552128553128554128555128556128557128558128559128560128561128562128563128564128565128566128567128568128569128570128571128572128573128574128575128576128577128578128579128580128581128582128583128584128585128586128587128588128589128590128591128592128593128594128595128596128597128598128599128600128601128602128603128604128605128606128607128608128609128610128611128612128613128614128615128616128617128618128619128620128621128622128623128624128625128626128627128628128629128630128631128632128633128634128635128636128637128638128639128640128641128642128643128644128645128646128647128648128649128650128651128652128653128654128655128656128657128658128659128660128661128662128663128664128665128666128667128668128669128670128671128672128673128674128675128676128677128678128679128680128681128682128683128684128685128686128687128688128689128690128691128692128693128694128695128696128697128698128699128700128701128702128703128704128705128706128707128708128709128710128711128712128713128714128715128716128717128718128719128720128721128722128723128724128725128726128727128728128729128730128731128732128733128734128735128736128737128738128739128740128741128742128743128744128745128746128747128748128749128750128751128752128753128754128755128756128757128758128759128760128761128762128763128764128765128766128767128768128769128770128771128772128773128774128775128776128777128778128779128780128781128782128783128784128785128786128787128788128789128790128791128792128793128794128795128796128797128798128799128800128801128802128803128804128805128806128807128808128809128810128811128812128813128814128815128816128817128818128819128820128821128822128823128824128825128826128827128828128829128830128831128832128833128834128835128836128837128838128839128840128841128842128843128844128845128846128847128848128849128850128851128852128853128854128855128856128857128858128859128860128861128862128863128864128865128866128867128868128869128870128871128872128873128874128875128876128877128878128879128880128881128882128883128884128885128886128887128888128889128890128891128892128893128894128895128896128897128898128899128900128901128902128903128904128905128906128907128908128909128910128911128912128913128914128915128916128917128918128919128920128921128922128923128924128925128926128927128928128929128930128931128932128933128934128935128936128937128938128939128940128941128942128943128944128945128946128947128948128949128950128951128952128953128954128955128956128957128958128959128960128961128962128963128964128965128966128967128968128969128970128971128972128973128974128975128976128977128978128979128980128981128982128983128984128985128986128987128988128989128990128991128992128993128994128995128996128997128998128999129000129001129002129003129004129005129006129007129008129009129010129011129012129013129014129015129016129017129018129019129020129021129022129023129024129025129026129027129028129029129030129031129032129033129034129035129036129037129038129039129040129041129042129043129044129045129046129047129048129049129050129051129052129053129054129055129056129057129058129059129060129061129062129063129064129065129066129067129068129069129070129071129072129073129074129075129076129077129078129079129080129081129082129083129084129085129086129087129088129089129090129091129092129093129094129095129096129097129098129099129100129101129102129103129104129105129106129107129108129109129110129111129112129113129114129115129116129117129118129119129120129121129122129123129124129125129126129127129128129129129130129131129132129133129134129135129136129137129138129139129140129141129142129143129144129145129146129147129148129149129150129151129152129153129154129155129156129157129158129159129160129161129162129163129164129165129166129167129168129169129170129171129172129173129174129175129176129177129178129179129180129181129182129183129184129185129186129187129188129189129190129191129192129193129194129195129196129197129198129199129200129201129202129203129204129205129206129207129208129209129210129211129212129213129214129215129216129217129218129219129220129221129222129223129224129225129226129227129228129229129230129231129232129233129234129235129236129237129238129239129240129241129242129243129244129245129246129247129248129249129250129251129252129253129254129255129256129257129258129259129260129261129262129263129264129265129266129267129268129269129270129271129272129273129274129275129276129277129278129279129280129281129282129283129284129285129286129287129288129289129290129291129292129293129294129295129296129297129298129299129300129301129302129303129304129305129306129307129308129309129310129311129312129313129314129315129316129317129318129319129320129321129322129323129324129325129326129327129328129329129330129331129332129333129334129335129336129337129338129339129340129341129342129343129344129345129346129347129348129349129350129351129352129353129354129355129356129357129358129359129360129361129362129363129364129365129366129367129368129369129370129371129372129373129374129375129376129377129378129379129380129381129382129383129384129385129386129387129388129389129390129391129392129393129394129395129396129397129398129399129400129401129402129403129404129405129406129407129408129409129410129411129412129413129414129415129416129417129418129419129420129421129422129423129424129425129426129427129428129429129430129431129432129433129434129435129436129437129438129439129440129441129442129443129444129445129446129447129448129449129450129451129452129453129454129455129456129457129458129459129460129461129462129463129464129465129466129467129468129469129470129471129472129473129474129475129476129477129478129479129480129481129482129483129484129485129486129487129488129489129490129491129492129493129494129495129496129497129498129499129500129501129502129503129504129505129506129507129508129509129510129511129512129513129514129515129516129517129518129519129520129521129522129523129524129525129526129527129528129529129530129531129532129533129534129535129536129537129538129539129540129541129542129543129544129545129546129547129548129549129550129551129552129553129554129555129556129557129558129559129560129561129562129563129564129565129566129567129568129569129570129571129572129573129574129575129576129577129578129579129580129581129582129583129584129585129586129587129588129589129590129591129592129593129594129595129596129597129598129599129600129601129602129603129604129605129606129607129608129609129610129611129612129613129614129615129616129617129618129619129620129621129622129623129624129625129626129627129628129629129630129631129632129633129634129635129636129637129638129639129640129641129642129643129644129645129646129647129648129649129650129651129652129653129654129655129656129657129658129659129660129661129662129663129664129665129666129667129668129669129670129671129672129673129674129675129676129677129678129679129680129681129682129683129684129685129686129687129688129689129690129691129692129693129694129695129696129697129698129699129700129701129702129703129704129705129706129707129708129709129710129711129712129713129714129715129716129717129718129719129720129721129722129723129724129725129726129727129728129729129730129731129732129733129734129735129736129737129738129739129740129741129742129743129744129745129746129747129748129749129750129751129752129753129754129755129756129757129758129759129760129761129762129763129764129765129766129767129768129769129770129771129772129773129774129775129776129777129778129779129780129781129782129783129784129785129786129787129788129789129790129791129792129793129794129795129796129797129798129799129800129801129802129803129804129805129806129807129808129809129810129811129812129813129814129815129816129817129818129819129820129821129822129823129824129825129826129827129828129829129830129831129832129833129834129835129836129837129838129839129840129841129842129843129844129845129846129847129848129849129850129851129852129853129854129855129856129857129858129859129860129861129862129863129864129865129866129867129868129869129870129871129872129873129874129875129876129877129878129879129880129881129882129883129884129885129886129887129888129889129890129891129892129893129894129895129896129897129898129899129900129901129902129903129904129905129906129907129908129909129910129911129912129913129914129915129916129917129918129919129920129921129922129923129924129925129926129927129928129929129930129931129932129933129934129935129936129937129938129939129940129941129942129943129944129945129946129947129948129949129950129951129952129953129954129955129956129957129958129959129960129961129962129963129964129965129966129967129968129969129970129971129972129973129974129975129976129977129978129979129980129981129982129983129984129985129986129987129988129989129990129991129992129993129994129995129996129997129998129999130000130001130002130003130004130005130006130007130008130009130010130011130012130013130014130015130016130017130018130019130020130021130022130023130024130025130026130027130028130029130030130031130032130033130034130035130036130037130038130039130040130041130042130043130044130045130046130047130048130049130050130051130052130053130054130055130056130057130058130059130060130061130062130063130064130065130066130067130068130069130070130071130072130073130074130075130076130077130078130079130080130081130082130083130084130085130086130087130088130089130090130091130092130093130094130095130096130097130098130099130100130101130102130103130104130105130106130107130108130109130110130111130112130113130114130115130116130117130118130119130120130121130122130123130124130125130126130127130128130129130130130131130132130133130134130135130136130137130138130139130140130141130142130143130144130145130146130147130148130149130150130151130152130153130154130155130156130157130158130159130160130161130162130163130164130165130166130167130168130169130170130171130172130173130174130175130176130177130178130179130180130181130182130183130184130185130186130187130188130189130190130191130192130193130194130195130196130197130198130199130200130201130202130203130204130205130206130207130208130209130210130211130212130213130214130215130216130217130218130219130220130221130222130223130224130225130226130227130228130229130230130231130232130233130234130235130236130237130238130239130240130241130242130243130244130245130246130247130248130249130250130251130252130253130254130255130256130257130258130259130260130261130262130263130264130265130266130267130268130269130270130271130272130273130274130275130276130277130278130279130280130281130282130283130284130285130286130287130288130289130290130291130292130293130294130295130296130297130298130299130300130301130302130303130304130305130306130307130308130309130310130311130312130313130314130315130316130317130318130319130320130321130322130323130324130325130326130327130328130329130330130331130332130333130334130335130336130337130338130339130340130341130342130343130344130345130346130347130348130349130350130351130352130353130354130355130356130357130358130359130360130361130362130363130364130365130366130367130368130369130370130371130372130373130374130375130376130377130378130379130380130381130382130383130384130385130386130387130388130389130390130391130392130393130394130395130396130397130398130399130400130401130402130403130404130405130406130407130408130409130410130411130412130413130414130415130416130417130418130419130420130421130422130423130424130425130426130427130428130429130430130431130432130433130434130435130436130437130438130439130440130441130442130443130444130445130446130447130448130449130450130451130452130453130454130455130456130457130458130459130460130461130462130463130464130465130466130467130468130469130470130471130472130473130474130475130476130477130478130479130480130481130482130483130484130485130486130487130488130489130490130491130492130493130494130495130496130497130498130499130500130501130502130503130504130505130506130507130508130509130510130511130512130513130514130515130516130517130518130519130520130521130522130523130524130525130526130527130528130529130530130531130532130533130534130535130536130537130538130539130540130541130542130543130544130545130546130547130548130549130550130551130552130553130554130555130556130557130558130559130560130561130562130563130564130565130566130567130568130569130570130571130572130573130574130575130576130577130578130579130580130581130582130583130584130585130586130587130588130589130590130591130592130593130594130595130596130597130598130599130600130601130602130603130604130605130606130607130608130609130610130611130612130613130614130615130616130617130618130619130620130621130622130623130624130625130626130627130628130629130630130631130632130633130634130635130636130637130638130639130640130641130642130643130644130645130646130647130648130649130650130651130652130653130654130655130656130657130658130659130660130661130662130663130664130665130666130667130668130669130670130671130672130673130674130675130676130677130678130679130680130681130682130683130684130685130686130687130688130689130690130691130692130693130694130695130696130697130698130699130700130701130702130703130704130705130706130707130708130709130710130711130712130713130714130715130716130717130718130719130720130721130722130723130724130725130726130727130728130729130730130731130732130733130734130735130736130737130738130739130740130741130742130743130744130745130746130747130748130749130750130751130752130753130754130755130756130757130758130759130760130761130762130763130764130765130766130767130768130769130770130771130772130773130774130775130776130777130778130779130780130781130782130783130784130785130786130787130788130789130790130791130792130793130794130795130796130797130798130799130800130801130802130803130804130805130806130807130808130809130810130811130812130813130814130815130816130817130818130819130820130821130822130823130824130825130826130827130828130829130830130831130832130833130834130835130836130837130838130839130840130841130842130843130844130845130846130847130848130849130850130851130852130853130854130855130856130857130858130859130860130861130862130863130864130865130866130867130868130869130870130871130872130873130874130875130876130877130878130879130880130881130882130883130884130885130886130887130888130889130890130891130892130893130894130895130896130897130898130899130900130901130902130903130904130905130906130907130908130909130910130911130912130913130914130915130916130917130918130919130920130921130922130923130924130925130926130927130928130929130930130931130932130933130934130935130936130937130938130939130940130941130942130943130944130945130946130947130948130949130950130951130952130953130954130955130956130957130958130959130960130961130962130963130964130965130966130967130968130969130970130971130972130973130974130975130976130977130978130979130980130981130982130983130984130985130986130987130988130989130990130991130992130993130994130995130996130997130998130999131000131001131002131003131004131005131006131007131008131009131010131011131012131013131014131015131016131017131018131019131020131021131022131023131024131025131026131027131028131029131030131031131032131033131034131035131036131037131038131039131040131041131042131043131044131045131046131047131048131049131050131051131052131053131054131055131056131057131058131059131060131061131062131063131064131065131066131067131068131069131070131071131072131073131074131075131076131077131078131079131080131081131082131083131084131085131086131087131088131089131090131091131092131093131094131095131096131097131098131099131100131101131102131103131104131105131106131107131108131109131110131111131112131113131114131115131116131117131118131119131120131121131122131123131124131125131126131127131128131129131130131131131132131133131134131135131136131137131138131139131140131141131142131143131144131145131146131147131148131149131150131151131152131153131154131155131156131157131158131159131160131161131162131163131164131165131166131167131168131169131170131171131172131173131174131175131176131177131178131179131180131181131182131183131184131185131186131187131188131189131190131191131192131193131194131195131196131197131198131199131200131201131202131203131204131205131206131207131208131209131210131211131212131213131214131215131216131217131218131219131220131221131222131223131224131225131226131227131228131229131230131231131232131233131234131235131236131237131238131239131240131241131242131243131244131245131246131247131248131249131250131251131252131253131254131255131256131257131258131259131260131261131262131263131264131265131266131267131268131269131270131271131272131273131274131275131276131277131278131279131280131281131282131283131284131285131286131287131288131289131290131291131292131293131294131295131296131297131298131299131300131301131302131303131304131305131306131307131308131309131310131311131312131313131314131315131316131317131318131319131320131321131322131323131324131325131326131327131328131329131330131331131332131333131334131335131336131337131338131339131340131341131342131343131344131345131346131347131348131349131350131351131352131353131354131355131356131357131358131359131360131361131362131363131364131365131366131367131368131369131370131371131372131373131374131375131376131377131378131379131380131381131382131383131384131385131386131387131388131389131390131391131392131393131394131395131396131397131398131399131400131401131402131403131404131405131406131407131408131409131410131411131412131413131414131415131416131417131418131419131420131421131422131423131424131425131426131427131428131429131430131431131432131433131434131435131436131437131438131439131440131441131442131443131444131445131446131447131448131449131450131451131452131453131454131455131456131457131458131459131460131461131462131463131464131465131466131467131468131469131470131471131472131473131474131475131476131477131478131479131480131481131482131483131484131485131486131487131488131489131490131491131492131493131494131495131496131497131498131499131500131501131502131503131504131505131506131507131508131509131510131511131512131513131514131515131516131517131518131519131520131521131522131523131524131525131526131527131528131529131530131531131532131533131534131535131536131537131538131539131540131541131542131543131544131545131546131547131548131549131550131551131552131553131554131555131556131557131558131559131560131561131562131563131564131565131566131567131568131569131570131571131572131573131574131575131576131577131578131579131580131581131582131583131584131585131586131587131588131589131590131591131592131593131594131595131596131597131598131599131600131601131602131603131604131605131606131607131608131609131610131611131612131613131614131615131616131617131618131619131620131621131622131623131624131625131626131627131628131629131630131631131632131633131634131635131636131637131638131639131640131641131642131643131644131645131646131647131648131649131650131651131652131653131654131655131656131657131658131659131660131661131662131663131664131665131666131667131668131669131670131671131672131673131674131675131676131677131678131679131680131681131682131683131684131685131686131687131688131689131690131691131692131693131694131695131696131697131698131699131700131701131702131703131704131705131706131707131708131709131710131711131712131713131714131715131716131717131718131719131720131721131722131723131724131725131726131727131728131729131730131731131732131733131734131735131736131737131738131739131740131741131742131743131744131745131746131747131748131749131750131751131752131753131754131755131756131757131758131759131760131761131762131763131764131765131766131767131768131769131770131771131772131773131774131775131776131777131778131779131780131781131782131783131784131785131786131787131788131789131790131791131792131793131794131795131796131797131798131799131800131801131802131803131804131805131806131807131808131809131810131811131812131813131814131815131816131817131818131819131820131821131822131823131824131825131826131827131828131829131830131831131832131833131834131835131836131837131838131839131840131841131842131843131844131845131846131847131848131849131850131851131852131853131854131855131856131857131858131859131860131861131862131863131864131865131866131867131868131869131870131871131872131873131874131875131876131877131878131879131880131881131882131883131884131885131886131887131888131889131890131891131892131893131894131895131896131897131898131899131900131901131902131903131904131905131906131907131908131909131910131911131912131913131914131915131916131917131918131919131920131921131922131923131924131925131926131927131928131929131930131931131932131933131934131935131936131937131938131939131940131941131942131943131944131945131946131947131948131949131950131951131952131953131954131955131956131957131958131959131960131961131962131963131964131965131966131967131968131969131970131971131972131973131974131975131976131977131978131979131980131981131982131983131984131985131986131987131988131989131990131991131992131993131994131995131996131997131998131999132000132001132002132003132004132005132006132007132008132009132010132011132012132013132014132015132016132017132018132019132020132021132022132023132024132025132026132027132028132029132030132031132032132033132034132035132036132037132038132039132040132041132042132043132044132045132046132047132048132049132050132051132052132053132054132055132056132057132058132059132060132061132062132063132064132065132066132067132068132069132070132071132072132073132074132075132076132077132078132079132080132081132082132083132084132085132086132087132088132089132090132091132092132093132094132095132096132097132098132099132100132101132102132103132104132105132106132107132108132109132110132111132112132113132114132115132116132117132118132119132120132121132122132123132124132125132126132127132128132129132130132131132132132133132134132135132136132137132138132139132140132141132142132143132144132145132146132147132148132149132150132151132152132153132154132155132156132157132158132159132160132161132162132163132164132165132166132167132168132169132170132171132172132173132174132175132176132177132178132179132180132181132182132183132184132185132186132187132188132189132190132191132192132193132194132195132196132197132198132199132200132201132202132203132204132205132206132207132208132209132210132211132212132213132214132215132216132217132218132219132220132221132222132223132224132225132226132227132228132229132230132231132232132233132234132235132236132237132238132239132240132241132242132243132244132245132246132247132248132249132250132251132252132253132254132255132256132257132258132259132260132261132262132263132264132265132266132267132268132269132270132271132272132273132274132275132276132277132278132279132280132281132282132283132284132285132286132287132288132289132290132291132292132293132294132295132296132297132298132299132300132301132302132303132304132305132306132307132308132309132310132311132312132313132314132315132316132317132318132319132320132321132322132323132324132325132326132327132328132329132330132331132332132333132334132335132336132337132338132339132340132341132342132343132344132345132346132347132348132349132350132351132352132353132354132355132356132357132358132359132360132361132362132363132364132365132366132367132368132369132370132371132372132373132374132375132376132377132378132379132380132381132382132383132384132385132386132387132388132389132390132391132392132393132394132395132396132397132398132399132400132401132402132403132404132405132406132407132408132409132410132411132412132413132414132415132416132417132418132419132420132421132422132423132424132425132426132427132428132429132430132431132432132433132434132435132436132437132438132439132440132441132442132443132444132445132446132447132448132449132450132451132452132453132454132455132456132457132458132459132460132461132462132463132464132465132466132467132468132469132470132471132472132473132474132475132476132477132478132479132480132481132482132483132484132485132486132487132488132489132490132491132492132493132494132495132496132497132498132499132500132501132502132503132504132505132506132507132508132509132510132511132512132513132514132515132516132517132518132519132520132521132522132523132524132525132526132527132528132529132530132531132532132533132534132535132536132537132538132539132540132541132542132543132544132545132546132547132548132549132550132551132552132553132554132555132556132557132558132559132560132561132562132563132564132565132566132567132568132569132570132571132572132573132574132575132576132577132578132579132580132581132582132583132584132585132586132587132588132589132590132591132592132593132594132595132596132597132598132599132600132601132602132603132604132605132606132607132608132609132610132611132612132613132614132615132616132617132618132619132620132621132622132623132624132625132626132627132628132629132630132631132632132633132634132635132636132637132638132639132640132641132642132643132644132645132646132647132648132649132650132651132652132653132654132655132656132657132658132659132660132661132662132663132664132665132666132667132668132669132670132671132672132673132674132675132676132677132678132679132680132681132682132683132684132685132686132687132688132689132690132691132692132693132694132695132696132697132698132699132700132701132702132703132704132705132706132707132708132709132710132711132712132713132714132715132716132717132718132719132720132721132722132723132724132725132726132727132728132729132730132731132732132733132734132735132736132737132738132739132740132741132742132743132744132745132746132747132748132749132750132751132752132753132754132755132756132757132758132759132760132761132762132763132764132765132766132767132768132769132770132771132772132773132774132775132776132777132778132779132780132781132782132783132784132785132786132787132788132789132790132791132792132793132794132795132796132797132798132799132800132801132802132803132804132805132806132807132808132809132810132811132812132813132814132815132816132817132818132819132820132821132822132823132824132825132826132827132828132829132830132831132832132833132834132835132836132837132838132839132840132841132842132843132844132845132846132847132848132849132850132851132852132853132854132855132856132857132858132859132860132861132862132863132864132865132866132867132868132869132870132871132872132873132874132875132876132877132878132879132880132881132882132883132884132885132886132887132888132889132890132891132892132893132894132895132896132897132898132899132900132901132902132903132904132905132906132907132908132909132910132911132912132913132914132915132916132917132918132919132920132921132922132923132924132925132926132927132928132929132930132931132932132933132934132935132936132937132938132939132940132941132942132943132944132945132946132947132948132949132950132951132952132953132954132955132956132957132958132959132960132961132962132963132964132965132966132967132968132969132970132971132972132973132974132975132976132977132978132979132980132981132982132983132984132985132986132987132988132989132990132991132992132993132994132995132996132997132998132999133000133001133002133003133004133005133006133007133008133009133010133011133012133013133014133015133016133017133018133019133020133021133022133023133024133025133026133027133028133029133030133031133032133033133034133035133036133037133038133039133040133041133042133043133044133045133046133047133048133049133050133051133052133053133054133055133056133057133058133059133060133061133062133063133064133065133066133067133068133069133070133071133072133073133074133075133076133077133078133079133080133081133082133083133084133085133086133087133088133089133090133091133092133093133094133095133096133097133098133099133100133101133102133103133104133105133106133107133108133109133110133111133112133113133114133115133116133117133118133119133120133121133122133123133124133125133126133127133128133129133130133131133132133133133134133135133136133137133138133139133140133141133142133143133144133145133146133147133148133149133150133151133152133153133154133155133156133157133158133159133160133161133162133163133164133165133166133167133168133169133170133171133172133173133174133175133176133177133178133179133180133181133182133183133184133185133186133187133188133189133190133191133192133193133194133195133196133197133198133199133200133201133202133203133204133205133206133207133208133209133210133211133212133213133214133215133216133217133218133219133220133221133222133223133224133225133226133227133228133229133230133231133232133233133234133235133236133237133238133239133240133241133242133243133244133245133246133247133248133249133250133251133252133253133254133255133256133257133258133259133260133261133262133263133264133265133266133267133268133269133270133271133272133273133274133275133276133277133278133279133280133281133282133283133284133285133286133287133288133289133290133291133292133293133294133295133296133297133298133299133300133301133302133303133304133305133306133307133308133309133310133311133312133313133314133315133316133317133318133319133320133321133322133323133324133325133326133327133328133329133330133331133332133333133334133335133336133337133338133339133340133341133342133343133344133345133346133347133348133349133350133351133352133353133354133355133356133357133358133359133360133361133362133363133364133365133366133367133368133369133370133371133372133373133374133375133376133377133378133379133380133381133382133383133384133385133386133387133388133389133390133391133392133393133394133395133396133397133398133399133400133401133402133403133404133405133406133407133408133409133410133411133412133413133414133415133416133417133418133419133420133421133422133423133424133425133426133427133428133429133430133431133432133433133434133435133436133437133438133439133440133441133442133443133444133445133446133447133448133449133450133451133452133453133454133455133456133457133458133459133460133461133462133463133464133465133466133467133468133469133470133471133472133473133474133475133476133477133478133479133480133481133482133483133484133485133486133487133488133489133490133491133492133493133494133495133496133497133498133499133500133501133502133503133504133505133506133507133508133509133510133511133512133513133514133515133516133517133518133519133520133521133522133523133524133525133526133527133528133529133530133531133532133533133534133535133536133537133538133539133540133541133542133543133544133545133546133547133548133549133550133551133552133553133554133555133556133557133558133559133560133561133562133563133564133565133566133567133568133569133570133571133572133573133574133575133576133577133578133579133580133581133582133583133584133585133586133587133588133589133590133591133592133593133594133595133596133597133598133599133600133601133602133603133604133605133606133607133608133609133610133611133612133613133614133615133616133617133618133619133620133621133622133623133624133625133626133627133628133629133630133631133632133633133634133635133636133637133638133639133640133641133642133643133644133645133646133647133648133649133650133651133652133653133654133655133656133657133658133659133660133661133662133663133664133665133666133667133668133669133670133671133672133673133674133675133676133677133678133679133680133681133682133683133684133685133686133687133688133689133690133691133692133693133694133695133696133697133698133699133700133701133702133703133704133705133706133707133708133709133710133711133712133713133714133715133716133717133718133719133720133721133722133723133724133725133726133727133728133729133730133731133732133733133734133735133736133737133738133739133740133741133742133743133744133745133746133747133748133749133750133751133752133753133754133755133756133757133758133759133760133761133762133763133764133765133766133767133768133769133770133771133772133773133774133775133776133777133778133779133780133781133782133783133784133785133786133787133788133789133790133791133792133793133794133795133796133797133798133799133800133801133802133803133804133805133806133807133808133809133810133811133812133813133814133815133816133817133818133819133820133821133822133823133824133825133826133827133828133829133830133831133832133833133834133835133836133837133838133839133840133841133842133843133844133845133846133847133848133849133850133851133852133853133854133855133856133857133858133859133860133861133862133863133864133865133866133867133868133869133870133871133872133873133874133875133876133877133878133879133880133881133882133883133884133885133886133887133888133889133890133891133892133893133894133895133896133897133898133899133900133901133902133903133904133905133906133907133908133909133910133911133912133913133914133915133916133917133918133919133920133921133922133923133924133925133926133927133928133929133930133931133932133933133934133935133936133937133938133939133940133941133942133943133944133945133946133947133948133949133950133951133952133953133954133955133956133957133958133959133960133961133962133963133964133965133966133967133968133969133970133971133972133973133974133975133976133977133978133979133980133981133982133983133984133985133986133987133988133989133990133991133992133993133994133995133996133997133998133999134000134001134002134003134004134005134006134007134008134009134010134011134012134013134014134015134016134017134018134019134020134021134022134023134024134025134026134027134028134029134030134031134032134033134034134035134036134037134038134039134040134041134042134043134044134045134046134047134048134049134050134051134052134053134054134055134056134057134058134059134060134061134062134063134064134065134066134067134068134069134070134071134072134073134074134075134076134077134078134079134080134081134082134083134084134085134086134087134088134089134090134091134092134093134094134095134096134097134098134099134100134101134102134103134104134105134106134107134108134109134110134111134112134113134114134115134116134117134118134119134120134121134122134123134124134125134126134127134128134129134130134131134132134133134134134135134136134137134138134139134140134141134142134143134144134145134146134147134148134149134150134151134152134153134154134155134156134157134158134159134160134161134162134163134164134165134166134167134168134169134170134171134172134173134174134175134176134177134178134179134180134181134182134183134184134185134186134187134188134189134190134191134192134193134194134195134196134197134198134199134200134201134202134203134204134205134206134207134208134209134210134211134212134213134214134215134216134217134218134219134220134221134222134223134224134225134226134227134228134229134230134231134232134233134234134235134236134237134238134239134240134241134242134243134244134245134246134247134248134249134250134251134252134253134254134255134256134257134258134259134260134261134262134263134264134265134266134267134268134269134270134271134272134273134274134275134276134277134278134279134280134281134282134283134284134285134286134287134288134289134290134291134292134293134294134295134296134297134298134299134300134301134302134303134304134305134306134307134308134309134310134311134312134313134314134315134316134317134318134319134320134321134322134323134324134325134326134327134328134329134330134331134332134333134334134335134336134337134338134339134340134341134342134343134344134345134346134347134348134349134350134351134352134353134354134355134356134357134358134359134360134361134362134363134364134365134366134367134368134369134370134371134372134373134374134375134376134377134378134379134380134381134382134383134384134385134386134387134388134389134390134391134392134393134394134395134396134397134398134399134400134401134402134403134404134405134406134407134408134409134410134411134412134413134414134415134416134417134418134419134420134421134422134423134424134425134426134427134428134429134430134431134432134433134434134435134436134437134438134439134440134441134442134443134444134445134446134447134448134449134450134451134452134453134454134455134456134457134458134459134460134461134462134463134464134465134466134467134468134469134470134471134472134473134474134475134476134477134478134479134480134481134482134483134484134485134486134487134488134489134490134491134492134493134494134495134496134497134498134499134500134501134502134503134504134505134506134507134508134509134510134511134512134513134514134515134516134517134518134519134520134521134522134523134524134525134526134527134528134529134530134531134532134533134534134535134536134537134538134539134540134541134542134543134544134545134546134547134548134549134550134551134552134553134554134555134556134557134558134559134560134561134562134563134564134565134566134567134568134569134570134571134572134573134574134575134576134577134578134579134580134581134582134583134584134585134586134587134588134589134590134591134592134593134594134595134596134597134598134599134600134601134602134603134604134605134606134607134608134609134610134611134612134613134614134615134616134617134618134619134620134621134622134623134624134625134626134627134628134629134630134631134632134633134634134635134636134637134638134639134640134641134642134643134644134645134646134647134648134649134650134651134652134653134654134655134656134657134658134659134660134661134662134663134664134665134666134667134668134669134670134671134672134673134674134675134676134677134678134679134680134681134682134683134684134685134686134687134688134689134690134691134692134693134694134695134696134697134698134699134700134701134702134703134704134705134706134707134708134709134710134711134712134713134714134715134716134717134718134719134720134721134722134723134724134725134726134727134728134729134730134731134732134733134734134735134736134737134738134739134740134741134742134743134744134745134746134747134748134749134750134751134752134753134754134755134756134757134758134759134760134761134762134763134764134765134766134767134768134769134770134771134772134773134774134775134776134777134778134779134780134781134782134783134784134785134786134787134788134789134790134791134792134793134794134795134796134797134798134799134800134801134802134803134804134805134806134807134808134809134810134811134812134813134814134815134816134817134818134819134820134821134822134823134824134825134826134827134828134829134830134831134832134833134834134835134836134837134838134839134840134841134842134843134844134845134846134847134848134849134850134851134852134853134854134855134856134857134858134859134860134861134862134863134864134865134866134867134868134869134870134871134872134873134874134875134876134877134878134879134880134881134882134883134884134885134886134887134888134889134890134891134892134893134894134895134896134897134898134899134900134901134902134903134904134905134906134907134908134909134910134911134912134913134914134915134916134917134918134919134920134921134922134923134924134925134926134927134928134929134930134931134932134933134934134935134936134937134938134939134940134941134942134943134944134945134946134947134948134949134950134951134952134953134954134955134956134957134958134959134960134961134962134963134964134965134966134967134968134969134970134971134972134973134974134975134976134977134978134979134980134981134982134983134984134985134986134987134988134989134990134991134992134993134994134995134996134997134998134999135000135001135002135003135004135005135006135007135008135009135010135011135012135013135014135015135016135017135018135019135020135021135022135023135024135025135026135027135028135029135030135031135032135033135034135035135036135037135038135039135040135041135042135043135044135045135046135047135048135049135050135051135052135053135054135055135056135057135058135059135060135061135062135063135064135065135066135067135068135069135070135071135072135073135074135075135076135077135078135079135080135081135082135083135084135085135086135087135088135089135090135091135092135093135094135095135096135097135098135099135100135101135102135103135104135105135106135107135108135109135110135111135112135113135114135115135116135117135118135119135120135121135122135123135124135125135126135127135128135129135130135131135132135133135134135135135136135137135138135139135140135141135142135143135144135145135146135147135148135149135150135151135152135153135154135155135156135157135158135159135160135161135162135163135164135165135166135167135168135169135170135171135172135173135174135175135176135177135178135179135180135181135182135183135184135185135186135187135188135189135190135191135192135193135194135195135196135197135198135199135200135201135202135203135204135205135206135207135208135209135210135211135212135213135214135215135216135217135218135219135220135221135222135223135224135225135226135227135228135229135230135231135232135233135234135235135236135237135238135239135240135241135242135243135244135245135246135247135248135249135250135251135252135253135254135255135256135257135258135259135260135261135262135263135264135265135266135267135268135269135270135271135272135273135274135275135276135277135278135279135280135281135282135283135284135285135286135287135288135289135290135291135292135293135294135295135296135297135298135299135300135301135302135303135304135305135306135307135308135309135310135311135312135313135314135315135316135317135318135319135320135321135322135323135324135325135326135327135328135329135330135331135332135333135334135335135336135337135338135339135340135341135342135343135344135345135346135347135348135349135350135351135352135353135354135355135356135357135358135359135360135361135362135363135364135365135366135367135368135369135370135371135372135373135374135375135376135377135378135379135380135381135382135383135384135385135386135387135388135389135390135391135392135393135394135395135396135397135398135399135400135401135402135403135404135405135406135407135408135409135410135411135412135413135414135415135416135417135418135419135420135421135422135423135424135425135426135427135428135429135430135431135432135433135434135435135436135437135438135439135440135441135442135443135444135445135446135447135448135449135450135451135452135453135454135455135456135457135458135459135460135461135462135463135464135465135466135467135468135469135470135471135472135473135474135475135476135477135478135479135480135481135482135483135484135485135486135487135488135489135490135491135492135493135494135495135496135497135498135499135500135501135502135503135504135505135506135507135508135509135510135511135512135513135514135515135516135517135518135519135520135521135522135523135524135525135526135527135528135529135530135531135532135533135534135535135536135537135538135539135540135541135542135543135544135545135546135547135548135549135550135551135552135553135554135555135556135557135558135559135560135561135562135563135564135565135566135567135568135569135570135571135572135573135574135575135576135577135578135579135580135581135582135583135584135585135586135587135588135589135590135591135592135593135594135595135596135597135598135599135600135601135602135603135604135605135606135607135608135609135610135611135612135613135614135615135616135617135618135619135620135621135622135623135624135625135626135627135628135629135630135631135632135633135634135635135636135637135638135639135640135641135642135643135644135645135646135647135648135649135650135651135652135653135654135655135656135657135658135659135660135661135662135663135664135665135666135667135668135669135670135671135672135673135674135675135676135677135678135679135680135681135682135683135684135685135686135687135688135689135690135691135692135693135694135695135696135697135698135699135700135701135702135703135704135705135706135707135708135709135710135711135712135713135714135715135716135717135718135719135720135721135722135723135724135725135726135727135728135729135730135731135732135733135734135735135736135737135738135739135740135741135742135743135744135745135746135747135748135749135750135751135752135753135754135755135756135757135758135759135760135761135762135763135764135765135766135767135768135769135770135771135772135773135774135775135776135777135778135779135780135781135782135783135784135785135786135787135788135789135790135791135792135793135794135795135796135797135798135799135800135801135802135803135804135805135806135807135808135809135810135811135812135813135814135815135816135817135818135819135820135821135822135823135824135825135826135827135828135829135830135831135832135833135834135835135836135837135838135839135840135841135842135843135844135845135846135847135848135849135850135851135852135853135854135855135856135857135858135859135860135861135862135863135864135865135866135867135868135869135870135871135872135873135874135875135876135877135878135879135880135881135882135883135884135885135886135887135888135889135890135891135892135893135894135895135896135897135898135899135900135901135902135903135904135905135906135907135908135909135910135911135912135913135914135915135916135917135918135919135920135921135922135923135924135925135926135927135928135929135930135931135932135933135934135935135936135937135938135939135940135941135942135943135944135945135946135947135948135949135950135951135952135953135954135955135956135957135958135959135960135961135962135963135964135965135966135967135968135969135970135971135972135973135974135975135976135977135978135979135980135981135982135983135984135985135986135987135988135989135990135991135992135993135994135995135996135997135998135999136000136001136002136003136004136005136006136007136008136009136010136011136012136013136014136015136016136017136018136019136020136021136022136023136024136025136026136027136028136029136030136031136032136033136034136035136036136037136038136039136040136041136042136043136044136045136046136047136048136049136050136051136052136053136054136055136056136057136058136059136060136061136062136063136064136065136066136067136068136069136070136071136072136073136074136075136076136077136078136079136080136081136082136083136084136085136086136087136088136089136090136091136092136093136094136095136096136097136098136099136100136101136102136103136104136105136106136107136108136109136110136111136112136113136114136115136116136117136118136119136120136121136122136123136124136125136126136127136128136129136130136131136132136133136134136135136136136137136138136139136140136141136142136143136144136145136146136147136148136149136150136151136152136153136154136155136156136157136158136159136160136161136162136163136164136165136166136167136168136169136170136171136172136173136174136175136176136177136178136179136180136181136182136183136184136185136186136187136188136189136190136191136192136193136194136195136196136197136198136199136200136201136202136203136204136205136206136207136208136209136210136211136212136213136214136215136216136217136218136219136220136221136222136223136224136225136226136227136228136229136230136231136232136233136234136235136236136237136238136239136240136241136242136243136244136245136246136247136248136249136250136251136252136253136254136255136256136257136258136259136260136261136262136263136264136265136266136267136268136269136270136271136272136273136274136275136276136277136278136279136280136281136282136283136284136285136286136287136288136289136290136291136292136293136294136295136296136297136298136299136300136301136302136303136304136305136306136307136308136309136310136311136312136313136314136315136316136317136318136319136320136321136322136323136324136325136326136327136328136329136330136331136332136333136334136335136336136337136338136339136340136341136342136343136344136345136346136347136348136349136350136351136352136353136354136355136356136357136358136359136360136361136362136363136364136365136366136367136368136369136370136371136372136373136374136375136376136377136378136379136380136381136382136383136384136385136386136387136388136389136390136391136392136393136394136395136396136397136398136399136400136401136402136403136404136405136406136407136408136409136410136411136412136413136414136415136416136417136418136419136420136421136422136423136424136425136426136427136428136429136430136431136432136433136434136435136436136437136438136439136440136441136442136443136444136445136446136447136448136449136450136451136452136453136454136455136456136457136458136459136460136461136462136463136464136465136466136467136468136469136470136471136472136473136474136475136476136477136478136479136480136481136482136483136484136485136486136487136488136489136490136491136492136493136494136495136496136497136498136499136500136501136502136503136504136505136506136507136508136509136510136511136512136513136514136515136516136517136518136519136520136521136522136523136524136525136526136527136528136529136530136531136532136533136534136535136536136537136538136539136540136541136542136543136544136545136546136547136548136549136550136551136552136553136554136555136556136557136558136559136560136561136562136563136564136565136566136567136568136569136570136571136572136573136574136575136576136577136578136579136580136581136582136583136584136585136586136587136588136589136590136591136592136593136594136595136596136597136598136599136600136601136602136603136604136605136606136607136608136609136610136611136612136613136614136615136616136617136618136619136620136621136622136623136624136625136626136627136628136629136630136631136632136633136634136635136636136637136638136639136640136641136642136643136644136645136646136647136648136649136650136651136652136653136654136655136656136657136658136659136660136661136662136663136664136665136666136667136668136669136670136671136672136673136674136675136676136677136678136679136680136681136682136683136684136685136686136687136688136689136690136691136692136693136694136695136696136697136698136699136700136701136702136703136704136705136706136707136708136709136710136711136712136713136714136715136716136717136718136719136720136721136722136723136724136725136726136727136728136729136730136731136732136733136734136735136736136737136738136739136740136741136742136743136744136745136746136747136748136749136750136751136752136753136754136755136756136757136758136759136760136761136762136763136764136765136766136767136768136769136770136771136772136773136774136775136776136777136778136779136780136781136782136783136784136785136786136787136788136789136790136791136792136793136794136795136796136797136798136799136800136801136802136803136804136805136806136807136808136809136810136811136812136813136814136815136816136817136818136819136820136821136822136823136824136825136826136827136828136829136830136831136832136833136834136835136836136837136838136839136840136841136842136843136844136845136846136847136848136849136850136851136852136853136854136855136856136857136858136859136860136861136862136863136864136865136866136867136868136869136870136871136872136873136874136875136876136877136878136879136880136881136882136883136884136885136886136887136888136889136890136891136892136893136894136895136896136897136898136899136900136901136902136903136904136905136906136907136908136909136910136911136912136913136914136915136916136917136918136919136920136921136922136923136924136925136926136927136928136929136930136931136932136933136934136935136936136937136938136939136940136941136942136943136944136945136946136947136948136949136950136951136952136953136954136955136956136957136958136959136960136961136962136963136964136965136966136967136968136969136970136971136972136973136974136975136976136977136978136979136980136981136982136983136984136985136986136987136988136989136990136991136992136993136994136995136996136997136998136999137000137001137002137003137004137005137006137007137008137009137010137011137012137013137014137015137016137017137018137019137020137021137022137023137024137025137026137027137028137029137030137031137032137033137034137035137036137037137038137039137040137041137042137043137044137045137046137047137048137049137050137051137052137053137054137055137056137057137058137059137060137061137062137063137064137065137066137067137068137069137070137071137072137073137074137075137076137077137078137079137080137081137082137083137084137085137086137087137088137089137090137091137092137093137094137095137096137097137098137099137100137101137102137103137104137105137106137107137108137109137110137111137112137113137114137115137116137117137118137119137120137121137122137123137124137125137126137127137128137129137130137131137132137133137134137135137136137137137138137139137140137141137142137143137144137145137146137147137148137149137150137151137152137153137154137155137156137157137158137159137160137161137162137163137164137165137166137167137168137169137170137171137172137173137174137175137176137177137178137179137180137181137182137183137184137185137186137187137188137189137190137191137192137193137194137195137196137197137198137199137200137201137202137203137204137205137206137207137208137209137210137211137212137213137214137215137216137217137218137219137220137221137222137223137224137225137226137227137228137229137230137231137232137233137234137235137236137237137238137239137240137241137242137243137244137245137246137247137248137249137250137251137252137253137254137255137256137257137258137259137260137261137262137263137264137265137266137267137268137269137270137271137272137273137274137275137276137277137278137279137280137281137282137283137284137285137286137287137288137289137290137291137292137293137294137295137296137297137298137299137300137301137302137303137304137305137306137307137308137309137310137311137312137313137314137315137316137317137318137319137320137321137322137323137324137325137326137327137328137329137330137331137332137333137334137335137336137337137338137339137340137341137342137343137344137345137346137347137348137349137350137351137352137353137354137355137356137357137358137359137360137361137362137363137364137365137366137367137368137369137370137371137372137373137374137375137376137377137378137379137380137381137382137383137384137385137386137387137388137389137390137391137392137393137394137395137396137397137398137399137400137401137402137403137404137405137406137407137408137409137410137411137412137413137414137415137416137417137418137419137420137421137422137423137424137425137426137427137428137429137430137431137432137433137434137435137436137437137438137439137440137441137442137443137444137445137446137447137448137449137450137451137452137453137454137455137456137457137458137459137460137461137462137463137464137465137466137467137468137469137470137471137472137473137474137475137476137477137478137479137480137481137482137483137484137485137486137487137488137489137490137491137492137493137494137495137496137497137498137499137500137501137502137503137504137505137506137507137508137509137510137511137512137513137514137515137516137517137518137519137520137521137522137523137524137525137526137527137528137529137530137531137532137533137534137535137536137537137538137539137540137541137542137543137544137545137546137547137548137549137550137551137552137553137554137555137556137557137558137559137560137561137562137563137564137565137566137567137568137569137570137571137572137573137574137575137576137577137578137579137580137581137582137583137584137585137586137587137588137589137590137591137592137593137594137595137596137597137598137599137600137601137602137603137604137605137606137607137608137609137610137611137612137613137614137615137616137617137618137619137620137621137622137623137624137625137626137627137628137629137630137631137632137633137634137635137636137637137638137639137640137641137642137643137644137645137646137647137648137649137650137651137652137653137654137655137656137657137658137659137660137661137662137663137664137665137666137667137668137669137670137671137672137673137674137675137676137677137678137679137680137681137682137683137684137685137686137687137688137689137690137691137692137693137694137695137696137697137698137699137700137701137702137703137704137705137706137707137708137709137710137711137712137713137714137715137716137717137718137719137720137721137722137723137724137725137726137727137728137729137730137731137732137733137734137735137736137737137738137739137740137741137742137743137744137745137746137747137748137749137750137751137752137753137754137755137756137757137758137759137760137761137762137763137764137765137766137767137768137769137770137771137772137773137774137775137776137777137778137779137780137781137782137783137784137785137786137787137788137789137790137791137792137793137794137795137796137797137798137799137800137801137802137803137804137805137806137807137808137809137810137811137812137813137814137815137816137817137818137819137820137821137822137823137824137825137826137827137828137829137830137831137832137833137834137835137836137837137838137839137840137841137842137843137844137845137846137847137848137849137850137851137852137853137854137855137856137857137858137859137860137861137862137863137864137865137866137867137868137869137870137871137872137873137874137875137876137877137878137879137880137881137882137883137884137885137886137887137888137889137890137891137892137893137894137895137896137897137898137899137900137901137902137903137904137905137906137907137908137909137910137911137912137913137914137915137916137917137918137919137920137921137922137923137924137925137926137927137928137929137930137931137932137933137934137935137936137937137938137939137940137941137942137943137944137945137946137947137948137949137950137951137952137953137954137955137956137957137958137959137960137961137962137963137964137965137966137967137968137969137970137971137972137973137974137975137976137977137978137979137980137981137982137983137984137985137986137987137988137989137990137991137992137993137994137995137996137997137998137999138000138001138002138003138004138005138006138007138008138009138010138011138012138013138014138015138016138017138018138019138020138021138022138023138024138025138026138027138028138029138030138031138032138033138034138035138036138037138038138039138040138041138042138043138044138045138046138047138048138049138050138051138052138053138054138055138056138057138058138059138060138061138062138063138064138065138066138067138068138069138070138071138072138073138074138075138076138077138078138079138080138081138082138083138084138085138086138087138088138089138090138091138092138093138094138095138096138097138098138099138100138101138102138103138104138105138106138107138108138109138110138111138112138113138114138115138116138117138118138119138120138121138122138123138124138125138126138127138128138129138130138131138132138133138134138135138136138137138138138139138140138141138142138143138144138145138146138147138148138149138150138151138152138153138154138155138156138157138158138159138160138161138162138163138164138165138166138167138168138169138170138171138172138173138174138175138176138177138178138179138180138181138182138183138184138185138186138187138188138189138190138191138192138193138194138195138196138197138198138199138200138201138202138203138204138205138206138207138208138209138210138211138212138213138214138215138216138217138218138219138220138221138222138223138224138225138226138227138228138229138230138231138232138233138234138235138236138237138238138239138240138241138242138243138244138245138246138247138248138249138250138251138252138253138254138255138256138257138258138259138260138261138262138263138264138265138266138267138268138269138270138271138272138273138274138275138276138277138278138279138280138281138282138283138284138285138286138287138288138289138290138291138292138293138294138295138296138297138298138299138300138301138302138303138304138305138306138307138308138309138310138311138312138313138314138315138316138317138318138319138320138321138322138323138324138325138326138327138328138329138330138331138332138333138334138335138336138337138338138339138340138341138342138343138344138345138346138347138348138349138350138351138352138353138354138355138356138357138358138359138360138361138362138363138364138365138366138367138368138369138370138371138372138373138374138375138376138377138378138379138380138381138382138383138384138385138386138387138388138389138390138391138392138393138394138395138396138397138398138399138400138401138402138403138404138405138406138407138408138409138410138411138412138413138414138415138416138417138418138419138420138421138422138423138424138425138426138427138428138429138430138431138432138433138434138435138436138437138438138439138440138441138442138443138444138445138446138447138448138449138450138451138452138453138454138455138456138457138458138459138460138461138462138463138464138465138466138467138468138469138470138471138472138473138474138475138476138477138478138479138480138481138482138483138484138485138486138487138488138489138490138491138492138493138494138495138496138497138498138499138500138501138502138503138504138505138506138507138508138509138510138511138512138513138514138515138516138517138518138519138520138521138522138523138524138525138526138527138528138529138530138531138532138533138534138535138536138537138538138539138540138541138542138543138544138545138546138547138548138549138550138551138552138553138554138555138556138557138558138559138560138561138562138563138564138565138566138567138568138569138570138571138572138573138574138575138576138577138578138579138580138581138582138583138584138585138586138587138588138589138590138591138592138593138594138595138596138597138598138599138600138601138602138603138604138605138606138607138608138609138610138611138612138613138614138615138616138617138618138619138620138621138622138623138624138625138626138627138628138629138630138631138632138633138634138635138636138637138638138639138640138641138642138643138644138645138646138647138648138649138650138651138652138653138654138655138656138657138658138659138660138661138662138663138664138665138666138667138668138669138670138671138672138673138674138675138676138677138678138679138680138681138682138683138684138685138686138687138688138689138690138691138692138693138694138695138696138697138698138699138700138701138702138703138704138705138706138707138708138709138710138711138712138713138714138715138716138717138718138719138720138721138722138723138724138725138726138727138728138729138730138731138732138733138734138735138736138737138738138739138740138741138742138743138744138745138746138747138748138749138750138751138752138753138754138755138756138757138758138759138760138761138762138763138764138765138766138767138768138769138770138771138772138773138774138775138776138777138778138779138780138781138782138783138784138785138786138787138788138789138790138791138792138793138794138795138796138797138798138799138800138801138802138803138804138805138806138807138808138809138810138811138812138813138814138815138816138817138818138819138820138821138822138823138824138825138826138827138828138829138830138831138832138833138834138835138836138837138838138839138840138841138842138843138844138845138846138847138848138849138850138851138852138853138854138855138856138857138858138859138860138861138862138863138864138865138866138867138868138869138870138871138872138873138874138875138876138877138878138879138880138881138882138883138884138885138886138887138888138889138890138891138892138893138894138895138896138897138898138899138900138901138902138903138904138905138906138907138908138909138910138911138912138913138914138915138916138917138918138919138920138921138922138923138924138925138926138927138928138929138930138931138932138933138934138935138936138937138938138939138940138941138942138943138944138945138946138947138948138949138950138951138952138953138954138955138956138957138958138959138960138961138962138963138964138965138966138967138968138969138970138971138972138973138974138975138976138977138978138979138980138981138982138983138984138985138986138987138988138989138990138991138992138993138994138995138996138997138998138999139000139001139002139003139004139005139006139007139008139009139010139011139012139013139014139015139016139017139018139019139020139021139022139023139024139025139026139027139028139029139030139031139032139033139034139035139036139037139038139039139040139041139042139043139044139045139046139047139048139049139050139051139052139053139054139055139056139057139058139059139060139061139062139063139064139065139066139067139068139069139070139071139072139073139074139075139076139077139078139079139080139081139082139083139084139085139086139087139088139089139090139091139092139093139094139095139096139097139098139099139100139101139102139103139104139105139106139107139108139109139110139111139112139113139114139115139116139117139118139119139120139121139122139123139124139125139126139127139128139129139130139131139132139133139134139135139136139137139138139139139140139141139142139143139144139145139146139147139148139149139150139151139152139153139154139155139156139157139158139159139160139161139162139163139164139165139166139167139168139169139170139171139172139173139174139175139176139177139178139179139180139181139182139183139184139185139186139187139188139189139190139191139192139193139194139195139196139197139198139199139200139201139202139203139204139205139206139207139208139209139210139211139212139213139214139215139216139217139218139219139220139221139222139223139224139225139226139227139228139229139230139231139232139233139234139235139236139237139238139239139240139241139242139243139244139245139246139247139248139249139250139251139252139253139254139255139256139257139258139259139260139261139262139263139264139265139266139267139268139269139270139271139272139273139274139275139276139277139278139279139280139281139282139283139284139285139286139287139288139289139290139291139292139293139294139295139296139297139298139299139300139301139302139303139304139305139306139307139308139309139310139311139312139313139314139315139316139317139318139319139320139321139322139323139324139325139326139327139328139329139330139331139332139333139334139335139336139337139338139339139340139341139342139343139344139345139346139347139348139349139350139351139352139353139354139355139356139357139358139359139360139361139362139363139364139365139366139367139368139369139370139371139372139373139374139375139376139377139378139379139380139381139382139383139384139385139386139387139388139389139390139391139392139393139394139395139396139397139398139399139400139401139402139403139404139405139406139407139408139409139410139411139412139413139414139415139416139417139418139419139420139421139422139423139424139425139426139427139428139429139430139431139432139433139434139435139436139437139438139439139440139441139442139443139444139445139446139447139448139449139450139451139452139453139454139455139456139457139458139459139460139461139462139463139464139465139466139467139468139469139470139471139472139473139474139475139476139477139478139479139480139481139482139483139484139485139486139487139488139489139490139491139492139493139494139495139496139497139498139499139500139501139502139503139504139505139506139507139508139509139510139511139512139513139514139515139516139517139518139519139520139521139522139523139524139525139526139527139528139529139530139531139532139533139534139535139536139537139538139539139540139541139542139543139544139545139546139547139548139549139550139551139552139553139554139555139556139557139558139559139560139561139562139563139564139565139566139567139568139569139570139571139572139573139574139575139576139577139578139579139580139581139582139583139584139585139586139587139588139589139590139591139592139593139594139595139596139597139598139599139600139601139602139603139604139605139606139607139608139609139610139611139612139613139614139615139616139617139618139619139620139621139622139623139624139625139626139627139628139629139630139631139632139633139634139635139636139637139638139639139640139641139642139643139644139645139646139647139648139649139650139651139652139653139654139655139656139657139658139659139660139661139662139663139664139665139666139667139668139669139670139671139672139673139674139675139676139677139678139679139680139681139682139683139684139685139686139687139688139689139690139691139692139693139694139695139696139697139698139699139700139701139702139703139704139705139706139707139708139709139710139711139712139713139714139715139716139717139718139719139720139721139722139723139724139725139726139727139728139729139730139731139732139733139734139735139736139737139738139739139740139741139742139743139744139745139746139747139748139749139750139751139752139753139754139755139756139757139758139759139760139761139762139763139764139765139766139767139768139769139770139771139772139773139774139775139776139777139778139779139780139781139782139783139784139785139786139787139788139789139790139791139792139793139794139795139796139797139798139799139800139801139802139803139804139805139806139807139808139809139810139811139812139813139814139815139816139817139818139819139820139821139822139823139824139825139826139827139828139829139830139831139832139833139834139835139836139837139838139839139840139841139842139843139844139845139846139847139848139849139850139851139852139853139854139855139856139857139858139859139860139861139862139863139864139865139866139867139868139869139870139871139872139873139874139875139876139877139878139879139880139881139882139883139884139885139886139887139888139889139890139891139892139893139894139895139896139897139898139899139900139901139902139903139904139905139906139907139908139909139910139911139912139913139914139915139916139917139918139919139920139921139922139923139924139925139926139927139928139929139930139931139932139933139934139935139936139937139938139939139940139941139942139943139944139945139946139947139948139949139950139951139952139953139954139955139956139957139958139959139960139961139962139963139964139965139966139967139968139969139970139971139972139973139974139975139976139977139978139979139980139981139982139983139984139985139986139987139988139989139990139991139992139993139994139995139996139997139998139999140000140001140002140003140004140005140006140007140008140009140010140011140012140013140014140015140016140017140018140019140020140021140022140023140024140025140026140027140028140029140030140031140032140033140034140035140036140037140038140039140040140041140042140043140044140045140046140047140048140049140050140051140052140053140054140055140056140057140058140059140060140061140062140063140064140065140066140067140068140069140070140071140072140073140074140075140076140077140078140079140080140081140082140083140084140085140086140087140088140089140090140091140092140093140094140095140096140097140098140099140100140101140102140103140104140105140106140107140108140109140110140111140112140113140114140115140116140117140118140119140120140121140122140123140124140125140126140127140128140129140130140131140132140133140134140135140136140137140138140139140140140141140142140143140144140145140146140147140148140149140150140151140152140153140154140155140156140157140158140159140160140161140162140163140164140165140166140167140168140169140170140171140172140173140174140175140176140177140178140179140180140181140182140183140184140185140186140187140188140189140190140191140192140193140194140195140196140197140198140199140200140201140202140203140204140205140206140207140208140209140210140211140212140213140214140215140216140217140218140219140220140221140222140223140224140225140226140227140228140229140230140231140232140233140234140235140236140237140238140239140240140241140242140243140244140245140246140247140248140249140250140251140252140253140254140255140256140257140258140259140260140261140262140263140264140265140266140267140268140269140270140271140272140273140274140275140276140277140278140279140280140281140282140283140284140285140286140287140288140289140290140291140292140293140294140295140296140297140298140299140300140301140302140303140304140305140306140307140308140309140310140311140312140313140314140315140316140317140318140319140320140321140322140323140324140325140326140327140328140329140330140331140332140333140334140335140336140337140338140339140340140341140342140343140344140345140346140347140348140349140350140351140352140353140354140355140356140357140358140359140360140361140362140363140364140365140366140367140368140369140370140371140372140373140374140375140376140377140378140379140380140381140382140383140384140385140386140387140388140389140390140391140392140393140394140395140396140397140398140399140400140401140402140403140404140405140406140407140408140409140410140411140412140413140414140415140416140417140418140419140420140421140422140423140424140425140426140427140428140429140430140431140432140433140434140435140436140437140438140439140440140441140442140443140444140445140446140447140448140449140450140451140452140453140454140455140456140457140458140459140460140461140462140463140464140465140466140467140468140469140470140471140472140473140474140475140476140477140478140479140480140481140482140483140484140485140486140487140488140489140490140491140492140493140494140495140496140497140498140499140500140501140502140503140504140505140506140507140508140509140510140511140512140513140514140515140516140517140518140519140520140521140522140523140524140525140526140527140528140529140530140531140532140533140534140535140536140537140538140539140540140541140542140543140544140545140546140547140548140549140550140551140552140553140554140555140556140557140558140559140560140561140562140563140564140565140566140567140568140569140570140571140572140573140574140575140576140577140578140579140580140581140582140583140584140585140586140587140588140589140590140591140592140593140594140595140596140597140598140599140600140601140602140603140604140605140606140607140608140609140610140611140612140613140614140615140616140617140618140619140620140621140622140623140624140625140626140627140628140629140630140631140632140633140634140635140636140637140638140639140640140641140642140643140644140645140646140647140648140649140650140651140652140653140654140655140656140657140658140659140660140661140662140663140664140665140666140667140668140669140670140671140672140673140674140675140676140677140678140679140680140681140682140683140684140685140686140687140688140689140690140691140692140693140694140695140696140697140698140699140700140701140702140703140704140705140706140707140708140709140710140711140712140713140714140715140716140717140718140719140720140721140722140723140724140725140726140727140728140729140730140731140732140733140734140735140736140737140738140739140740140741140742140743140744140745140746140747140748140749140750140751140752140753140754140755140756140757140758140759140760140761140762140763140764140765140766140767140768140769140770140771140772140773140774140775140776140777140778140779140780140781140782140783140784140785140786140787140788140789140790140791140792140793140794140795140796140797140798140799140800140801140802140803140804140805140806140807140808140809140810140811140812140813140814140815140816140817140818140819140820140821140822140823140824140825140826140827140828140829140830140831140832140833140834140835140836140837140838140839140840140841140842140843140844140845140846140847140848140849140850140851140852140853140854140855140856140857140858140859140860140861140862140863140864140865140866140867140868140869140870140871140872140873140874140875140876140877140878140879140880140881140882140883140884140885140886140887140888140889140890140891140892140893140894140895140896140897140898140899140900140901140902140903140904140905140906140907140908140909140910140911140912140913140914140915140916140917140918140919140920140921140922140923140924140925140926140927140928140929140930140931140932140933140934140935140936140937140938140939140940140941140942140943140944140945140946140947140948140949140950140951140952140953140954140955140956140957140958140959140960140961140962140963140964140965140966140967140968140969140970140971140972140973140974140975140976140977140978140979140980140981140982140983140984140985140986140987140988140989140990140991140992140993140994140995140996140997140998140999141000141001141002141003141004141005141006141007141008141009141010141011141012141013141014141015141016141017141018141019141020141021141022141023141024141025141026141027141028141029141030141031141032141033141034141035141036141037141038141039141040141041141042141043141044141045141046141047141048141049141050141051141052141053141054141055141056141057141058141059141060141061141062141063141064141065141066141067141068141069141070141071141072141073141074141075141076141077141078141079141080141081141082141083141084141085141086141087141088141089141090141091141092141093141094141095141096141097141098141099141100141101141102141103141104141105141106141107141108141109141110141111141112141113141114141115141116141117141118141119141120141121141122141123141124141125141126141127141128141129141130141131141132141133141134141135141136141137141138141139141140141141141142141143141144141145141146141147141148141149141150141151141152141153141154141155141156141157141158141159141160141161141162141163141164141165141166141167141168141169141170141171141172141173141174141175141176141177141178141179141180141181141182141183141184141185141186141187141188141189141190141191141192141193141194141195141196141197141198141199141200141201141202141203141204141205141206141207141208141209141210141211141212141213141214141215141216141217141218141219141220141221141222141223141224141225141226141227141228141229141230141231141232141233141234141235141236141237141238141239141240141241141242141243141244141245141246141247141248141249141250141251141252141253141254141255141256141257141258141259141260141261141262141263141264141265141266141267141268141269141270141271141272141273141274141275141276141277141278141279141280141281141282141283141284141285141286141287141288141289141290141291141292141293141294141295141296141297141298141299141300141301141302141303141304141305141306141307141308141309141310141311141312141313141314141315141316141317141318141319141320141321141322141323141324141325141326141327141328141329141330141331141332141333141334141335141336141337141338141339141340141341141342141343141344141345141346141347141348141349141350141351141352141353141354141355141356141357141358141359141360141361141362141363141364141365141366141367141368141369141370141371141372141373141374141375141376141377141378141379141380141381141382141383141384141385141386141387141388141389141390141391141392141393141394141395141396141397141398141399141400141401141402141403141404141405141406141407141408141409141410141411141412141413141414141415141416141417141418141419141420141421141422141423141424141425141426141427141428141429141430141431141432141433141434141435141436141437141438141439141440141441141442141443141444141445141446141447141448141449141450141451141452141453141454141455141456141457141458141459141460141461141462141463141464141465141466141467141468141469141470141471141472141473141474141475141476141477141478141479141480141481141482141483141484141485141486141487141488141489141490141491141492141493141494141495141496141497141498141499141500141501141502141503141504141505141506141507141508141509141510141511141512141513141514141515141516141517141518141519141520141521141522141523141524141525141526141527141528141529141530141531141532141533141534141535141536141537141538141539141540141541141542141543141544141545141546141547141548141549141550141551141552141553141554141555141556141557141558141559141560141561141562141563141564141565141566141567141568141569141570141571141572141573141574141575141576141577141578141579141580141581141582141583141584141585141586141587141588141589141590141591141592141593141594141595141596141597141598141599141600141601141602141603141604141605141606141607141608141609141610141611141612141613141614141615141616141617141618141619141620141621141622141623141624141625141626141627141628141629141630141631141632141633141634141635141636141637141638141639141640141641141642141643141644141645141646141647141648141649141650141651141652141653141654141655141656141657141658141659141660141661141662141663141664141665141666141667141668141669141670141671141672141673141674141675141676141677141678141679141680141681141682141683141684141685141686141687141688141689141690141691141692141693141694141695141696141697141698141699141700141701141702141703141704141705141706141707141708141709141710141711141712141713141714141715141716141717141718141719141720141721141722141723141724141725141726141727141728141729141730141731141732141733141734141735141736141737141738141739141740141741141742141743141744141745141746141747141748141749141750141751141752141753141754141755141756141757141758141759141760141761141762141763141764141765141766141767141768141769141770141771141772141773141774141775141776141777141778141779141780141781141782141783141784141785141786141787141788141789141790141791141792141793141794141795141796141797141798141799141800141801141802141803141804141805141806141807141808141809141810141811141812141813141814141815141816141817141818141819141820141821141822141823141824141825141826141827141828141829141830141831141832141833141834141835141836141837141838141839141840141841141842141843141844141845141846141847141848141849141850141851141852141853141854141855141856141857141858141859141860141861141862141863141864141865141866141867141868141869141870141871141872141873141874141875141876141877141878141879141880141881141882141883141884141885141886141887141888141889141890141891141892141893141894141895141896141897141898141899141900141901141902141903141904141905141906141907141908141909141910141911141912141913141914141915141916141917141918141919141920141921141922141923141924141925141926141927141928141929141930141931141932141933141934141935141936141937141938141939141940141941141942141943141944141945141946141947141948141949141950141951141952141953141954141955141956141957141958141959141960141961141962141963141964141965141966141967141968141969141970141971141972141973141974141975141976141977141978141979141980141981141982141983141984141985141986141987141988141989141990141991141992141993141994141995141996141997141998141999142000142001142002142003142004142005142006142007142008142009142010142011142012142013142014142015142016142017142018142019142020142021142022142023142024142025142026142027142028142029142030142031142032142033142034142035142036142037142038142039142040142041142042142043142044142045142046142047142048142049142050142051142052142053142054142055142056142057142058142059142060142061142062142063142064142065142066142067142068142069142070142071142072142073142074142075142076142077142078142079142080142081142082142083142084142085142086142087142088142089142090142091142092142093142094142095142096142097142098142099142100142101142102142103142104142105142106142107142108142109142110142111142112142113142114142115142116142117142118142119142120142121142122142123142124142125142126142127142128142129142130142131142132142133142134142135142136142137142138142139142140142141142142142143142144142145142146142147142148142149142150142151142152142153142154142155142156142157142158142159142160142161142162142163142164142165142166142167142168142169142170142171142172142173142174142175142176142177142178142179142180142181142182142183142184142185142186142187142188142189142190142191142192142193142194142195142196142197142198142199142200142201142202142203142204142205142206142207142208142209142210142211142212142213142214142215142216142217142218142219142220142221142222142223142224142225142226142227142228142229142230142231142232142233142234142235142236142237142238142239142240142241142242142243142244142245142246142247142248142249142250142251142252142253142254142255142256142257142258142259142260142261142262142263142264142265142266142267142268142269142270142271142272142273142274142275142276142277142278142279142280142281142282142283142284142285142286142287142288142289142290142291142292142293142294142295142296142297142298142299142300142301142302142303142304142305142306142307142308142309142310142311142312142313142314142315142316142317142318142319142320142321142322142323142324142325142326142327142328142329142330142331142332142333142334142335142336142337142338142339142340142341142342142343142344142345142346142347142348142349142350142351142352142353142354142355142356142357142358142359142360142361142362142363142364142365142366142367142368142369142370142371142372142373142374142375142376142377142378142379142380142381142382142383142384142385142386142387142388142389142390142391142392142393142394142395142396142397142398142399142400142401142402142403142404142405142406142407142408142409142410142411142412142413142414142415142416142417142418142419142420142421142422142423142424142425142426142427142428142429142430142431142432142433142434142435142436142437142438142439142440142441142442142443142444142445142446142447142448142449142450142451142452142453142454142455142456142457142458142459142460142461142462142463142464142465142466142467142468142469142470142471142472142473142474142475142476142477142478142479142480142481142482142483142484142485142486142487142488142489142490142491142492142493142494142495142496142497142498142499142500142501142502142503142504142505142506142507142508142509142510142511142512142513142514142515142516142517142518142519142520142521142522142523142524142525142526142527142528142529142530142531142532142533142534142535142536142537142538142539142540142541142542142543142544142545142546142547142548142549142550142551142552142553142554142555142556142557142558142559142560142561142562142563142564142565142566142567142568142569142570142571142572142573142574142575142576142577142578142579142580142581142582142583142584142585142586142587142588142589142590142591142592142593142594142595142596142597142598142599142600142601142602142603142604142605142606142607142608142609142610142611142612142613142614142615142616142617142618142619142620142621142622142623142624142625142626142627142628142629142630142631142632142633142634142635142636142637142638142639142640142641142642142643142644142645142646142647142648142649142650142651142652142653142654142655142656142657142658142659142660142661142662142663142664142665142666142667142668142669142670142671142672142673142674142675142676142677142678142679142680142681142682142683142684142685142686142687142688142689142690142691142692142693142694142695142696142697142698142699142700142701142702142703142704142705142706142707142708142709142710142711142712142713142714142715142716142717142718142719142720142721142722142723142724142725142726142727142728142729142730142731142732142733142734142735142736142737142738142739142740142741142742142743142744142745142746142747142748142749142750142751142752142753142754142755142756142757142758142759142760142761142762142763142764142765142766142767142768142769142770142771142772142773142774142775142776142777142778142779142780142781142782142783142784142785142786142787142788142789142790142791142792142793142794142795142796142797142798142799142800142801142802142803142804142805142806142807142808142809142810142811142812142813142814142815142816142817142818142819142820142821142822142823142824142825142826142827142828142829142830142831142832142833142834142835142836142837142838142839142840142841142842142843142844142845142846142847142848142849142850142851142852142853142854142855142856142857142858142859142860142861142862142863142864142865142866142867142868142869142870142871142872142873142874142875142876142877142878142879142880142881142882142883142884142885142886142887142888142889142890142891142892142893142894142895142896142897142898142899142900142901142902142903142904142905142906142907142908142909142910142911142912142913142914142915142916142917142918142919142920142921142922142923142924142925142926142927142928142929142930142931142932142933142934142935142936142937142938142939142940142941142942142943142944142945142946142947142948142949142950142951142952142953142954142955142956142957142958142959142960142961142962142963142964142965142966142967142968142969142970142971142972142973142974142975142976142977142978142979142980142981142982142983142984142985142986142987142988142989142990142991142992142993142994142995142996142997142998142999143000143001143002143003143004143005143006143007143008143009143010143011143012143013143014143015143016143017143018143019143020143021143022143023143024143025143026143027143028143029143030143031143032143033143034143035143036143037143038143039143040143041143042143043143044143045143046143047143048143049143050143051143052143053143054143055143056143057143058143059143060143061143062143063143064143065143066143067143068143069143070143071143072143073143074143075143076143077143078143079143080143081143082143083143084143085143086143087143088143089143090143091143092143093143094143095143096143097143098143099143100143101143102143103143104143105143106143107143108143109143110143111143112143113143114143115143116143117143118143119143120143121143122143123143124143125143126143127143128143129143130143131143132143133143134143135143136143137143138143139143140143141143142143143143144143145143146143147143148143149143150143151143152143153143154143155143156143157143158143159143160143161143162143163143164143165143166143167143168143169143170143171143172143173143174143175143176143177143178143179143180143181143182143183143184143185143186143187143188143189143190143191143192143193143194143195143196143197143198143199143200143201143202143203143204143205143206143207143208143209143210143211143212143213143214143215143216143217143218143219143220143221143222143223143224143225143226143227143228143229143230143231143232143233143234143235143236143237143238143239143240143241143242143243143244143245143246143247143248143249143250143251143252143253143254143255143256143257143258143259143260143261143262143263143264143265143266143267143268143269143270143271143272143273143274143275143276143277143278143279143280143281143282143283143284143285143286143287143288143289143290143291143292143293143294143295143296143297143298143299143300143301143302143303143304143305143306143307143308143309143310143311143312143313143314143315143316143317143318143319143320143321143322143323143324143325143326143327143328143329143330143331143332143333143334143335143336143337143338143339143340143341143342143343143344143345143346143347143348143349143350143351143352143353143354143355143356143357143358143359143360143361143362143363143364143365143366143367143368143369143370143371143372143373143374143375143376143377143378143379143380143381143382143383143384143385143386143387143388143389143390143391143392143393143394143395143396143397143398143399143400143401143402143403143404143405143406143407143408143409143410143411143412143413143414143415143416143417143418143419143420143421143422143423143424143425143426143427143428143429143430143431143432143433143434143435143436143437143438143439143440143441143442143443143444143445143446143447143448143449143450143451143452143453143454143455143456143457143458143459143460143461143462143463143464143465143466143467143468143469143470143471143472143473143474143475143476143477143478143479143480143481143482143483143484143485143486143487143488143489143490143491143492143493143494143495143496143497143498143499143500143501143502143503143504143505143506143507143508143509143510143511143512143513143514143515143516143517143518143519143520143521143522143523143524143525143526143527143528143529143530143531143532143533143534143535143536143537143538143539143540143541143542143543143544143545143546143547143548143549143550143551143552143553143554143555143556143557143558143559143560143561143562143563143564143565143566143567143568143569143570143571143572143573143574143575143576143577143578143579143580143581143582143583143584143585143586143587143588143589143590143591143592143593143594143595143596143597143598143599143600143601143602143603143604143605143606143607143608143609143610143611143612143613143614143615143616143617143618143619143620143621143622143623143624143625143626143627143628143629143630143631143632143633143634143635143636143637143638143639143640143641143642143643143644143645143646143647143648143649143650143651143652143653143654143655143656143657143658143659143660143661143662143663143664143665143666143667143668143669143670143671143672143673143674143675143676143677143678143679143680143681143682143683143684143685143686143687143688143689143690143691143692143693143694143695143696143697143698143699143700143701143702143703143704143705143706143707143708143709143710143711143712143713143714143715143716143717143718143719143720143721143722143723143724143725143726143727143728143729143730143731143732143733143734143735143736143737143738143739143740143741143742143743143744143745143746143747143748143749143750143751143752143753143754143755143756143757143758143759143760143761143762143763143764143765143766143767143768143769143770143771143772143773143774143775143776143777143778143779143780143781143782143783143784143785143786143787143788143789143790143791143792143793143794143795143796143797143798143799143800143801143802143803143804143805143806143807143808143809143810143811143812143813143814143815143816143817143818143819143820143821143822143823143824143825143826143827143828143829143830143831143832143833143834143835143836143837143838143839143840143841143842143843143844143845143846143847143848143849143850143851143852143853143854143855143856143857143858143859143860143861143862143863143864143865143866143867143868143869143870143871143872143873143874143875143876143877143878143879143880143881143882143883143884143885143886143887143888143889143890143891143892143893143894143895143896143897143898143899143900143901143902143903143904143905143906143907143908143909143910143911143912143913143914143915143916143917143918143919143920143921143922143923143924143925143926143927143928143929143930143931143932143933143934143935143936143937143938143939143940143941143942143943143944143945143946143947143948143949143950143951143952143953143954143955143956143957143958143959143960143961143962143963143964143965143966143967143968143969143970143971143972143973143974143975143976143977143978143979143980143981143982143983143984143985143986143987143988143989143990143991143992143993143994143995143996143997143998143999144000144001144002144003144004144005144006144007144008144009144010144011144012144013144014144015144016144017144018144019144020144021144022144023144024144025144026144027144028144029144030144031144032144033144034144035144036144037144038144039144040144041144042144043144044144045144046144047144048144049144050144051144052144053144054144055144056144057144058144059144060144061144062144063144064144065144066144067144068144069144070144071144072144073144074144075144076144077144078144079144080144081144082144083144084144085144086144087144088144089144090144091144092144093144094144095144096144097144098144099144100144101144102144103144104144105144106144107144108144109144110144111144112144113144114144115144116144117144118144119144120144121144122144123144124144125144126144127144128144129144130144131144132144133144134144135144136144137144138144139144140144141144142144143144144144145144146144147144148144149144150144151144152144153144154144155144156144157144158144159144160144161144162144163144164144165144166144167144168144169144170144171144172144173144174144175144176144177144178144179144180144181144182144183144184144185144186144187144188144189144190144191144192144193144194144195144196144197144198144199144200144201144202144203144204144205144206144207144208144209144210144211144212144213144214144215144216144217144218144219144220144221144222144223144224144225144226144227144228144229144230144231144232144233144234144235144236144237144238144239144240144241144242144243144244144245144246144247144248144249144250144251144252144253144254144255144256144257144258144259144260144261144262144263144264144265144266144267144268144269144270144271144272144273144274144275144276144277144278144279144280144281144282144283144284144285144286144287144288144289144290144291144292144293144294144295144296144297144298144299144300144301144302144303144304144305144306144307144308144309144310144311144312144313144314144315144316144317144318144319144320144321144322144323144324144325144326144327144328144329144330144331144332144333144334144335144336144337144338144339144340144341144342144343144344144345144346144347144348144349144350144351144352144353144354144355144356144357144358144359144360144361144362144363144364144365144366144367144368144369144370144371144372144373144374144375144376144377144378144379144380144381144382144383144384144385144386144387144388144389144390144391144392144393144394144395144396144397144398144399144400144401144402144403144404144405144406144407144408144409144410144411144412144413144414144415144416144417144418144419144420144421144422144423144424144425144426144427144428144429144430144431144432144433144434144435144436144437144438144439144440144441144442144443144444144445144446144447144448144449144450144451144452144453144454144455144456144457144458144459144460144461144462144463144464144465144466144467144468144469144470144471144472144473144474144475144476144477144478144479144480144481144482144483144484144485144486144487144488144489144490144491144492144493144494144495144496144497144498144499144500144501144502144503144504144505144506144507144508144509144510144511144512144513144514144515144516144517144518144519144520144521144522144523144524144525144526144527144528144529144530144531144532144533144534144535144536144537144538144539144540144541144542144543144544144545144546144547144548144549144550144551144552144553144554144555144556144557144558144559144560144561144562144563144564144565144566144567144568144569144570144571144572144573144574144575144576144577144578144579144580144581144582144583144584144585144586144587144588144589144590144591144592144593144594144595144596144597144598144599144600144601144602144603144604144605144606144607144608144609144610144611144612144613144614144615144616144617144618144619144620144621144622144623144624144625144626144627144628144629144630144631144632144633144634144635144636144637144638144639144640144641144642144643144644144645144646144647144648144649144650144651144652144653144654144655144656144657144658144659144660144661144662144663144664144665144666144667144668144669144670144671144672144673144674144675144676144677144678144679144680144681144682144683144684144685144686144687144688144689144690144691144692144693144694144695144696144697144698144699144700144701144702144703144704144705144706144707144708144709144710144711144712144713144714144715144716144717144718144719144720144721144722144723144724144725144726144727144728144729144730144731144732144733144734144735144736144737144738144739144740144741144742144743144744144745144746144747144748144749144750144751144752144753144754144755144756144757144758144759144760144761144762144763144764144765144766144767144768144769144770144771144772144773144774144775144776144777144778144779144780144781144782144783144784144785144786144787144788144789144790144791144792144793144794144795144796144797144798144799144800144801144802144803144804144805144806144807144808144809144810144811144812144813144814144815144816144817144818144819144820144821144822144823144824144825144826144827144828144829144830144831144832144833144834144835144836144837144838144839144840144841144842144843144844144845144846144847144848144849144850144851144852144853144854144855144856144857144858144859144860144861144862144863144864144865144866144867144868144869144870144871144872144873144874144875144876144877144878144879144880144881144882144883144884144885144886144887144888144889144890144891144892144893144894144895144896144897144898144899144900144901144902144903144904144905144906144907144908144909144910144911144912144913144914144915144916144917144918144919144920144921144922144923144924144925144926144927144928144929144930144931144932144933144934144935144936144937144938144939144940144941144942144943144944144945144946144947144948144949144950144951144952144953144954144955144956144957144958144959144960144961144962144963144964144965144966144967144968144969144970144971144972144973144974144975144976144977144978144979144980144981144982144983144984144985144986144987144988144989144990144991144992144993144994144995144996144997144998144999145000145001145002145003145004145005145006145007145008145009145010145011145012145013145014145015145016145017145018145019145020145021145022145023145024145025145026145027145028145029145030145031145032145033145034145035145036145037145038145039145040145041145042145043145044145045145046145047145048145049145050145051145052145053145054145055145056145057145058145059145060145061145062145063145064145065145066145067145068145069145070145071145072145073145074145075145076145077145078145079145080145081145082145083145084145085145086145087145088145089145090145091145092145093145094145095145096145097145098145099145100145101145102145103145104145105145106145107145108145109145110145111145112145113145114145115145116145117145118145119145120145121145122145123145124145125145126145127145128145129145130145131145132145133145134145135145136145137145138145139145140145141145142145143145144145145145146145147145148145149145150145151145152145153145154145155145156145157145158145159145160145161145162145163145164145165145166145167145168145169145170145171145172145173145174145175145176145177145178145179145180145181145182145183145184145185145186145187145188145189145190145191145192145193145194145195145196145197145198145199145200145201145202145203145204145205145206145207145208145209145210145211145212145213145214145215145216145217145218145219145220145221145222145223145224145225145226145227145228145229145230145231145232145233145234145235145236145237145238145239145240145241145242145243145244145245145246145247145248145249145250145251145252145253145254145255145256145257145258145259145260145261145262145263145264145265145266145267145268145269145270145271145272145273145274145275145276145277145278145279145280145281145282145283145284145285145286145287145288145289145290145291145292145293145294145295145296145297145298145299145300145301145302145303145304145305145306145307145308145309145310145311145312145313145314145315145316145317145318145319145320145321145322145323145324145325145326145327145328145329145330145331145332145333145334145335145336145337145338145339145340145341145342145343145344145345145346145347145348145349145350145351145352145353145354145355145356145357145358145359145360145361145362145363145364145365145366145367145368145369145370145371145372145373145374145375145376145377145378145379145380145381145382145383145384145385145386145387145388145389145390145391145392145393145394145395145396145397145398145399145400145401145402145403145404145405145406145407145408145409145410145411145412145413145414145415145416145417145418145419145420145421145422145423145424145425145426145427145428145429145430145431145432145433145434145435145436145437145438145439145440145441145442145443145444145445145446145447145448145449145450145451145452145453145454145455145456145457145458145459145460145461145462145463145464145465145466145467145468145469145470145471145472145473145474145475145476145477145478145479145480145481145482145483145484145485145486145487145488145489145490145491145492145493145494145495145496145497145498145499145500145501145502145503145504145505145506145507145508145509145510145511145512145513145514145515145516145517145518145519145520145521145522145523145524145525145526145527145528145529145530145531145532145533145534145535145536145537145538145539145540145541145542145543145544145545145546145547145548145549145550145551145552145553145554145555145556145557145558145559145560145561145562145563145564145565145566145567145568145569145570145571145572145573145574145575145576145577145578145579145580145581145582145583145584145585145586145587145588145589145590145591145592145593145594145595145596145597145598145599145600145601145602145603145604145605145606145607145608145609145610145611145612145613145614145615145616145617145618145619145620145621145622145623145624145625145626145627145628145629145630145631145632145633145634145635145636145637145638145639145640145641145642145643145644145645145646145647145648145649145650145651145652145653145654145655145656145657145658145659145660145661145662145663145664145665145666145667145668145669145670145671145672145673145674145675145676145677145678145679145680145681145682145683145684145685145686145687145688145689145690145691145692145693145694145695145696145697145698145699145700145701145702145703145704145705145706145707145708145709145710145711145712145713145714145715145716145717145718145719145720145721145722145723145724145725145726145727145728145729145730145731145732145733145734145735145736145737145738145739145740145741145742145743145744145745145746145747145748145749145750145751145752145753145754145755145756145757145758145759145760145761145762145763145764145765145766145767145768145769145770145771145772145773145774145775145776145777145778145779145780145781145782145783145784145785145786145787145788145789145790145791145792145793145794145795145796145797145798145799145800145801145802145803145804145805145806145807145808145809145810145811145812145813145814145815145816145817145818145819145820145821145822145823145824145825145826145827145828145829145830145831145832145833145834145835145836145837145838145839145840145841145842145843145844145845145846145847145848145849145850145851145852145853145854145855145856145857145858145859145860145861145862145863145864145865145866145867145868145869145870145871145872145873145874145875145876145877145878145879145880145881145882145883145884145885145886145887145888145889145890145891145892145893145894145895145896145897145898145899145900145901145902145903145904145905145906145907145908145909145910145911145912145913145914145915145916145917145918145919145920145921145922145923145924145925145926145927145928145929145930145931145932145933145934145935145936145937145938145939145940145941145942145943145944145945145946145947145948145949145950145951145952145953145954145955145956145957145958145959145960145961145962145963145964145965145966145967145968145969145970145971145972145973145974145975145976145977145978145979145980145981145982145983145984145985145986145987145988145989145990145991145992145993145994145995145996145997145998145999146000146001146002146003146004146005146006146007146008146009146010146011146012146013146014146015146016146017146018146019146020146021146022146023146024146025146026146027146028146029146030146031146032146033146034146035146036146037146038146039146040146041146042146043146044146045146046146047146048146049146050146051146052146053146054146055146056146057146058146059146060146061146062146063146064146065146066146067146068146069146070146071146072146073146074146075146076146077146078146079146080146081146082146083146084146085146086146087146088146089146090146091146092146093146094146095146096146097146098146099146100146101146102146103146104146105146106146107146108146109146110146111146112146113146114146115146116146117146118146119146120146121146122146123146124146125146126146127146128146129146130146131146132146133146134146135146136146137146138146139146140146141146142146143146144146145146146146147146148146149146150146151146152146153146154146155146156146157146158146159146160146161146162146163146164146165146166146167146168146169146170146171146172146173146174146175146176146177146178146179146180146181146182146183146184146185146186146187146188146189146190146191146192146193146194146195146196146197146198146199146200146201146202146203146204146205146206146207146208146209146210146211146212146213146214146215146216146217146218146219146220146221146222146223146224146225146226146227146228146229146230146231146232146233146234146235146236146237146238146239146240146241146242146243146244146245146246146247146248146249146250146251146252146253146254146255146256146257146258146259146260146261146262146263146264146265146266146267146268146269146270146271146272146273146274146275146276146277146278146279146280146281146282146283146284146285146286146287146288146289146290146291146292146293146294146295146296146297146298146299146300146301146302146303146304146305146306146307146308146309146310146311146312146313146314146315146316146317146318146319146320146321146322146323146324146325146326146327146328146329146330146331146332146333146334146335146336146337146338146339146340146341146342146343146344146345146346146347146348146349146350146351146352146353146354146355146356146357146358146359146360146361146362146363146364146365146366146367146368146369146370146371146372146373146374146375146376146377146378146379146380146381146382146383146384146385146386146387146388146389146390146391146392146393146394146395146396146397146398146399146400146401146402146403146404146405146406146407146408146409146410146411146412146413146414146415146416146417146418146419146420146421146422146423146424146425146426146427146428146429146430146431146432146433146434146435146436146437146438146439146440146441146442146443146444146445146446146447146448146449146450146451146452146453146454146455146456146457146458146459146460146461146462146463146464146465146466146467146468146469146470146471146472146473146474146475146476146477146478146479146480146481146482146483146484146485146486146487146488146489146490146491146492146493146494146495146496146497146498146499146500146501146502146503146504146505146506146507146508146509146510146511146512146513146514146515146516146517146518146519146520146521146522146523146524146525146526146527146528146529146530146531146532146533146534146535146536146537146538146539146540146541146542146543146544146545146546146547146548146549146550146551146552146553146554146555146556146557146558146559146560146561146562146563146564146565146566146567146568146569146570146571146572146573146574146575146576146577146578146579146580146581146582146583146584146585146586146587146588146589146590146591146592146593146594146595146596146597146598146599146600146601146602146603146604146605146606146607146608146609146610146611146612146613146614146615146616146617146618146619146620146621146622146623146624146625146626146627146628146629146630146631146632146633146634146635146636146637146638146639146640146641146642146643146644146645146646146647146648146649146650146651146652146653146654146655146656146657146658146659146660146661146662146663146664146665146666146667146668146669146670146671146672146673146674146675146676146677146678146679146680146681146682146683146684146685146686146687146688146689146690146691146692146693146694146695146696146697146698146699146700146701146702146703146704146705146706146707146708146709146710146711146712146713146714146715146716146717146718146719146720146721146722146723146724146725146726146727146728146729146730146731146732146733146734146735146736146737146738146739146740146741146742146743146744146745146746146747146748146749146750146751146752146753146754146755146756146757146758146759146760146761146762146763146764146765146766146767146768146769146770146771146772146773146774146775146776146777146778146779146780146781146782146783146784146785146786146787146788146789146790146791146792146793146794146795146796146797146798146799146800146801146802146803146804146805146806146807146808146809146810146811146812146813146814146815146816146817146818146819146820146821146822146823146824146825146826146827146828146829146830146831146832146833146834146835146836146837146838146839146840146841146842146843146844146845146846146847146848146849146850146851146852146853146854146855146856146857146858146859146860146861146862146863146864146865146866146867146868146869146870146871146872146873146874146875146876146877146878146879146880146881146882146883146884146885146886146887146888146889146890146891146892146893146894146895146896146897146898146899146900146901146902146903146904146905146906146907146908146909146910146911146912146913146914146915146916146917146918146919146920146921146922146923146924146925146926146927146928146929146930146931146932146933146934146935146936146937146938146939146940146941146942146943146944146945146946146947146948146949146950146951146952146953146954146955146956146957146958146959146960146961146962146963146964146965146966146967146968146969146970146971146972146973146974146975146976146977146978146979146980146981146982146983146984146985146986146987146988146989146990146991146992146993146994146995146996146997146998146999147000147001147002147003147004147005147006147007147008147009147010147011147012147013147014147015147016147017147018147019147020147021147022147023147024147025147026147027147028147029147030147031147032147033147034147035147036147037147038147039147040147041147042147043147044147045147046147047147048147049147050147051147052147053147054147055147056147057147058147059147060147061147062147063147064147065147066147067147068147069147070147071147072147073147074147075147076147077147078147079147080147081147082147083147084147085147086147087147088147089147090147091147092147093147094147095147096147097147098147099147100147101147102147103147104147105147106147107147108147109147110147111147112147113147114147115147116147117147118147119147120147121147122147123147124147125147126147127147128147129147130147131147132147133147134147135147136147137147138147139147140147141147142147143147144147145147146147147147148147149147150147151147152147153147154147155147156147157147158147159147160147161147162147163147164147165147166147167147168147169147170147171147172147173147174147175147176147177147178147179147180147181147182147183147184147185147186147187147188147189147190147191147192147193147194147195147196147197147198147199147200147201147202147203147204147205147206147207147208147209147210147211147212147213147214147215147216147217147218147219147220147221147222147223147224147225147226147227147228147229147230147231147232147233147234147235147236147237147238147239147240147241147242147243147244147245147246147247147248147249147250147251147252147253147254147255147256147257147258147259147260147261147262147263147264147265147266147267147268147269147270147271147272147273147274147275147276147277147278147279147280147281147282147283147284147285147286147287147288147289147290147291147292147293147294147295147296147297147298147299147300147301147302147303147304147305147306147307147308147309147310147311147312147313147314147315147316147317147318147319147320147321147322147323147324147325147326147327147328147329147330147331147332147333147334147335147336147337147338147339147340147341147342147343147344147345147346147347147348147349147350147351147352147353147354147355147356147357147358147359147360147361147362147363147364147365147366147367147368147369147370147371147372147373147374147375147376147377147378147379147380147381147382147383147384147385147386147387147388147389147390147391147392147393147394147395147396147397147398147399147400147401147402147403147404147405147406147407147408147409147410147411147412147413147414147415147416147417147418147419147420147421147422147423147424147425147426147427147428147429147430147431147432147433147434147435147436147437147438147439147440147441147442147443147444147445147446147447147448147449147450147451147452147453147454147455147456147457147458147459147460147461147462147463147464147465147466147467147468147469147470147471147472147473147474147475147476147477147478147479147480147481147482147483147484147485147486147487147488147489147490147491147492147493147494147495147496147497147498147499147500147501147502147503147504147505147506147507147508147509147510147511147512147513147514147515147516147517147518147519147520147521147522147523147524147525147526147527147528147529147530147531147532147533147534147535147536147537147538147539147540147541147542147543147544147545147546147547147548147549147550147551147552147553147554147555147556147557147558147559147560147561147562147563147564147565147566147567147568147569147570147571147572147573147574147575147576147577147578147579147580147581147582147583147584147585147586147587147588147589147590147591147592147593147594147595147596147597147598147599147600147601147602147603147604147605147606147607147608147609147610147611147612147613147614147615147616147617147618147619147620147621147622147623147624147625147626147627147628147629147630147631147632147633147634147635147636147637147638147639147640147641147642147643147644147645147646147647147648147649147650147651147652147653147654147655147656147657147658147659147660147661147662147663147664147665147666147667147668147669147670147671147672147673147674147675147676147677147678147679147680147681147682147683147684147685147686147687147688147689147690147691147692147693147694147695147696147697147698147699147700147701147702147703147704147705147706147707147708147709147710147711147712147713147714147715147716147717147718147719147720147721147722147723147724147725147726147727147728147729147730147731147732147733147734147735147736147737147738147739147740147741147742147743147744147745147746147747147748147749147750147751147752147753147754147755147756147757147758147759147760147761147762147763147764147765147766147767147768147769147770147771147772147773147774147775147776147777147778147779147780147781147782147783147784147785147786147787147788147789147790147791147792147793147794147795147796147797147798147799147800147801147802147803147804147805147806147807147808147809147810147811147812147813147814147815147816147817147818147819147820147821147822147823147824147825147826147827147828147829147830147831147832147833147834147835147836147837147838147839147840147841147842147843147844147845147846147847147848147849147850147851147852147853147854147855147856147857147858147859147860147861147862147863147864147865147866147867147868147869147870147871147872147873147874147875147876147877147878147879147880147881147882147883147884147885147886147887147888147889147890147891147892147893147894147895147896147897147898147899147900147901147902147903147904147905147906147907147908147909147910147911147912147913147914147915147916147917147918147919147920147921147922147923147924147925147926147927147928147929147930147931147932147933147934147935147936147937147938147939147940147941147942147943147944147945147946147947147948147949147950147951147952147953147954147955147956147957147958147959147960147961147962147963147964147965147966147967147968147969147970147971147972147973147974147975147976147977147978147979147980147981147982147983147984147985147986147987147988147989147990147991147992147993147994147995147996147997147998147999148000148001148002148003148004148005148006148007148008148009148010148011148012148013148014148015148016148017148018148019148020148021148022148023148024148025148026148027148028148029148030148031148032148033148034148035148036148037148038148039148040148041148042148043148044148045148046148047148048148049148050148051148052148053148054148055148056148057148058148059148060148061148062148063148064148065148066148067148068148069148070148071148072148073148074148075148076148077148078148079148080148081148082148083148084148085148086148087148088148089148090148091148092148093148094148095148096148097148098148099148100148101148102148103148104148105148106148107148108148109148110148111148112148113148114148115148116148117148118148119148120148121148122148123148124148125148126148127148128148129148130148131148132148133148134148135148136148137148138148139148140148141148142148143148144148145148146148147148148148149148150148151148152148153148154148155148156148157148158148159148160148161148162148163148164148165148166148167148168148169148170148171148172148173148174148175148176148177148178148179148180148181148182148183148184148185148186148187148188148189148190148191148192148193148194148195148196148197148198148199148200148201148202148203148204148205148206148207148208148209148210148211148212148213148214148215148216148217148218148219148220148221148222148223148224148225148226148227148228148229148230148231148232148233148234148235148236148237148238148239148240148241148242148243148244148245148246148247148248148249148250148251148252148253148254148255148256148257148258148259148260148261148262148263148264148265148266148267148268148269148270148271148272148273148274148275148276148277148278148279148280148281148282148283148284148285148286148287148288148289148290148291148292148293148294148295148296148297148298148299148300148301148302148303148304148305148306148307148308148309148310148311148312148313148314148315148316148317148318148319148320148321148322148323148324148325148326148327148328148329148330148331148332148333148334148335148336148337148338148339148340148341148342148343148344148345148346148347148348148349148350148351148352148353148354148355148356148357148358148359148360148361148362148363148364148365148366148367148368148369148370148371148372148373148374148375148376148377148378148379148380148381148382148383148384148385148386148387148388148389148390148391148392148393148394148395148396148397148398148399148400148401148402148403148404148405148406148407148408148409148410148411148412148413148414148415148416148417148418148419148420148421148422148423148424148425148426148427148428148429148430148431148432148433148434148435148436148437148438148439148440148441148442148443148444148445148446148447148448148449148450148451148452148453148454148455148456148457148458148459148460148461148462148463148464148465148466148467148468148469148470148471148472148473148474148475148476148477148478148479148480148481148482148483148484148485148486148487148488148489148490148491148492148493148494148495148496148497148498148499148500148501148502148503148504148505148506148507148508148509148510148511148512148513148514148515148516148517148518148519148520148521148522148523148524148525148526148527148528148529148530148531148532148533148534148535148536148537148538148539148540148541148542148543148544148545148546148547148548148549148550148551148552148553148554148555148556148557148558148559148560148561148562148563148564148565148566148567148568148569148570148571148572148573148574148575148576148577148578148579148580148581148582148583148584148585148586148587148588148589148590148591148592148593148594148595148596148597148598148599148600148601148602148603148604148605148606148607148608148609148610148611148612148613148614148615148616148617148618148619148620148621148622148623148624148625148626148627148628148629148630148631148632148633148634148635148636148637148638148639148640148641148642148643148644148645148646148647148648148649148650148651148652148653148654148655148656148657148658148659148660148661148662148663148664148665148666148667148668148669148670148671148672148673148674148675148676148677148678148679148680148681148682148683148684148685148686148687148688148689148690148691148692148693148694148695148696148697148698148699148700148701148702148703148704148705148706148707148708148709148710148711148712148713148714148715148716148717148718148719148720148721148722148723148724148725148726148727148728148729148730148731148732148733148734148735148736148737148738148739148740148741148742148743148744148745148746148747148748148749148750148751148752148753148754148755148756148757148758148759148760148761148762148763148764148765148766148767148768148769148770148771148772148773148774148775148776148777148778148779148780148781148782148783148784148785148786148787148788148789148790148791148792148793148794148795148796148797148798148799148800148801148802148803148804148805148806148807148808148809148810148811148812148813148814148815148816148817148818148819148820148821148822148823148824148825148826148827148828148829148830148831148832148833148834148835148836148837148838148839148840148841148842148843148844148845148846148847148848148849148850148851148852148853148854148855148856148857148858148859148860148861148862148863148864148865148866148867148868148869148870148871148872148873148874148875148876148877148878148879148880148881148882148883148884148885148886148887148888148889148890148891148892148893148894148895148896148897148898148899148900148901148902148903148904148905148906148907148908148909148910148911148912148913148914148915148916148917148918148919148920148921148922148923148924148925148926148927148928148929148930148931148932148933148934148935148936148937148938148939148940148941148942148943148944148945148946148947148948148949148950148951148952148953148954148955148956148957148958148959148960148961148962148963148964148965148966148967148968148969148970148971148972148973148974148975148976148977148978148979148980148981148982148983148984148985148986148987148988148989148990148991148992148993148994148995148996148997148998148999149000149001149002149003149004149005149006149007149008149009149010149011149012149013149014149015149016149017149018149019149020149021149022149023149024149025149026149027149028149029149030149031149032149033149034149035149036149037149038149039149040149041149042149043149044149045149046149047149048149049149050149051149052149053149054149055149056149057149058149059149060149061149062149063149064149065149066149067149068149069149070149071149072149073149074149075149076149077149078149079149080149081149082149083149084149085149086149087149088149089149090149091149092149093149094149095149096149097149098149099149100149101149102149103149104149105149106149107149108149109149110149111149112149113149114149115149116149117149118149119149120149121149122149123149124149125149126149127149128149129149130149131149132149133149134149135149136149137149138149139149140149141149142149143149144149145149146149147149148149149149150149151149152149153149154149155149156149157149158149159149160149161149162149163149164149165149166149167149168149169149170149171149172149173149174149175149176149177149178149179149180149181149182149183149184149185149186149187149188149189149190149191149192149193149194149195149196149197149198149199149200149201149202149203149204149205149206149207149208149209149210149211149212149213149214149215149216149217149218149219149220149221149222149223149224149225149226149227149228149229149230149231149232149233149234149235149236149237149238149239149240149241149242149243149244149245149246149247149248149249149250149251149252149253149254149255149256149257149258149259149260149261149262149263149264149265149266149267149268149269149270149271149272149273149274149275149276149277149278149279149280149281149282149283149284149285149286149287149288149289149290149291149292149293149294149295149296149297149298149299149300149301149302149303149304149305149306149307149308149309149310149311149312149313149314149315149316149317149318149319149320149321149322149323149324149325149326149327149328149329149330149331149332149333149334149335149336149337149338149339149340149341149342149343149344149345149346149347149348149349149350149351149352149353149354149355149356149357149358149359149360149361149362149363149364149365149366149367149368149369149370149371149372149373149374149375149376149377149378149379149380149381149382149383149384149385149386149387149388149389149390149391149392149393149394149395149396149397149398149399149400149401149402149403149404149405149406149407149408149409149410149411149412149413149414149415149416149417149418149419149420149421149422149423149424149425149426149427149428149429149430149431149432149433149434149435149436149437149438149439149440149441149442149443149444149445149446149447149448149449149450149451149452149453149454149455149456149457149458149459149460149461149462149463149464149465149466149467149468149469149470149471149472149473149474149475149476149477149478149479149480149481149482149483149484149485149486149487149488149489149490149491149492149493149494149495149496149497149498149499149500149501149502149503149504149505149506149507149508149509149510149511149512149513149514149515149516149517149518149519149520149521149522149523149524149525149526149527149528149529149530149531149532149533149534149535149536149537149538149539149540149541149542149543149544149545149546149547149548149549149550149551149552149553149554149555149556149557149558149559149560149561149562149563149564149565149566149567149568149569149570149571149572149573149574149575149576149577149578149579149580149581149582149583149584149585149586149587149588149589149590149591149592149593149594149595149596149597149598149599149600149601149602149603149604149605149606149607149608149609149610149611149612149613149614149615149616149617149618149619149620149621149622149623149624149625149626149627149628149629149630149631149632149633149634149635149636149637149638149639149640149641149642149643149644149645149646149647149648149649149650149651149652149653149654149655149656149657149658149659149660149661149662149663149664149665149666149667149668149669149670149671149672149673149674149675149676149677149678149679149680149681149682149683149684149685149686149687149688149689149690149691149692149693149694149695149696149697149698149699149700149701149702149703149704149705149706149707149708149709149710149711149712149713149714149715149716149717149718149719149720149721149722149723149724149725149726149727149728149729149730149731149732149733149734149735149736149737149738149739149740149741149742149743149744149745149746149747149748149749149750149751149752149753149754149755149756149757149758149759149760149761149762149763149764149765149766149767149768149769149770149771149772149773149774149775149776149777149778149779149780149781149782149783149784149785149786149787149788149789149790149791149792149793149794149795149796149797149798149799149800149801149802149803149804149805149806149807149808149809149810149811149812149813149814149815149816149817149818149819149820149821149822149823149824149825149826149827149828149829149830149831149832149833149834149835149836149837149838149839149840149841149842149843149844149845149846149847149848149849149850149851149852149853149854149855149856149857149858149859149860149861149862149863149864149865149866149867149868149869149870149871149872149873149874149875149876149877149878149879149880149881149882149883149884149885149886149887149888149889149890149891149892149893149894149895149896149897149898149899149900149901149902149903149904149905149906149907149908149909149910149911149912149913149914149915149916149917149918149919149920149921149922149923149924149925149926149927149928149929149930149931149932149933149934149935149936149937149938149939149940149941149942149943149944149945149946149947149948149949149950149951149952149953149954149955149956149957149958149959149960149961149962149963149964149965149966149967149968149969149970149971149972149973149974149975149976149977149978149979149980149981149982149983149984149985149986149987149988149989149990149991149992149993149994149995149996149997149998149999150000150001150002150003150004150005150006150007150008150009150010150011150012150013150014150015150016150017150018150019150020150021150022150023150024150025150026150027150028150029150030150031150032150033150034150035150036150037150038150039150040150041150042150043150044150045150046150047150048150049150050150051150052150053150054150055150056150057150058150059150060150061150062150063150064150065150066150067150068150069150070150071150072150073150074150075150076150077150078150079150080150081150082150083150084150085150086150087150088150089150090150091150092150093150094150095150096150097150098150099150100150101150102150103150104150105150106150107150108150109150110150111150112150113150114150115150116150117150118150119150120150121150122150123150124150125150126150127150128150129150130150131150132150133150134150135150136150137150138150139150140150141150142150143150144150145150146150147150148150149150150150151150152150153150154150155150156150157150158150159150160150161150162150163150164150165150166150167150168150169150170150171150172150173150174150175150176150177150178150179150180150181150182150183150184150185150186150187150188150189150190150191150192150193150194150195150196150197150198150199150200150201150202150203150204150205150206150207150208150209150210150211150212150213150214150215150216150217150218150219150220150221150222150223150224150225150226150227150228150229150230150231150232150233150234150235150236150237150238150239150240150241150242150243150244150245150246150247150248150249150250150251150252150253150254150255150256150257150258150259150260150261150262150263150264150265150266150267150268150269150270150271150272150273150274150275150276150277150278150279150280150281150282150283150284150285150286150287150288150289150290150291150292150293150294150295150296150297150298150299150300150301150302150303150304150305150306150307150308150309150310150311150312150313150314150315150316150317150318150319150320150321150322150323150324150325150326150327150328150329150330150331150332150333150334150335150336150337150338150339150340150341150342150343150344150345150346150347150348150349150350150351150352150353150354150355150356150357150358150359150360150361150362150363150364150365150366150367150368150369150370150371150372150373150374150375150376150377150378150379150380150381150382150383150384150385150386150387150388150389150390150391150392150393150394150395150396150397150398150399150400150401150402150403150404150405150406150407150408150409150410150411150412150413150414150415150416150417150418150419150420150421150422150423150424150425150426150427150428150429150430150431150432150433150434150435150436150437150438150439150440150441150442150443150444150445150446150447150448150449150450150451150452150453150454150455150456150457150458150459150460150461150462150463150464150465150466150467150468150469150470150471150472150473150474150475150476150477150478150479150480150481150482150483150484150485150486150487150488150489150490150491150492150493150494150495150496150497150498150499150500150501150502150503150504150505150506150507150508150509150510150511150512150513150514150515150516150517150518150519150520150521150522150523150524150525150526150527150528150529150530150531150532150533150534150535150536150537150538150539150540150541150542150543150544150545150546150547150548150549150550150551150552150553150554150555150556150557150558150559150560150561150562150563150564150565150566150567150568150569150570150571150572150573150574150575150576150577150578150579150580150581150582150583150584150585150586150587150588150589150590150591150592150593150594150595150596150597150598150599150600150601150602150603150604150605150606150607150608150609150610150611150612150613150614150615150616150617150618150619150620150621150622150623150624150625150626150627150628150629150630150631150632150633150634150635150636150637150638150639150640150641150642150643150644150645150646150647150648150649150650150651150652150653150654150655150656150657150658150659150660150661150662150663150664150665150666150667150668150669150670150671150672150673150674150675150676150677150678150679150680150681150682150683150684150685150686150687150688150689150690150691150692150693150694150695150696150697150698150699150700150701150702150703150704150705150706150707150708150709150710150711150712150713150714150715150716150717150718150719150720150721150722150723150724150725150726150727150728150729150730150731150732150733150734150735150736150737150738150739150740150741150742150743150744150745150746150747150748150749150750150751150752150753150754150755150756150757150758150759150760150761150762150763150764150765150766150767150768150769150770150771150772150773150774150775150776150777150778150779150780150781150782150783150784150785150786150787150788150789150790150791150792150793150794150795150796150797150798150799150800150801150802150803150804150805150806150807150808150809150810150811150812150813150814150815150816150817150818150819150820150821150822150823150824150825150826150827150828150829150830150831150832150833150834150835150836150837150838150839150840150841150842150843150844150845150846150847150848150849150850150851150852150853150854150855150856150857150858150859150860150861150862150863150864150865150866150867150868150869150870150871150872150873150874150875150876150877150878150879150880150881150882150883150884150885150886150887150888150889150890150891150892150893150894150895150896150897150898150899150900150901150902150903150904150905150906150907150908150909150910150911150912150913150914150915150916150917150918150919150920150921150922150923150924150925150926150927150928150929150930150931150932150933150934150935150936150937150938150939150940150941150942150943150944150945150946150947150948150949150950150951150952150953150954150955150956150957150958150959150960150961150962150963150964150965150966150967150968150969150970150971150972150973150974150975150976150977150978150979150980150981150982150983150984150985150986150987150988150989150990150991150992150993150994150995150996150997150998150999151000151001151002151003151004151005151006151007151008151009151010151011151012151013151014151015151016151017151018151019151020151021151022151023151024151025151026151027151028151029151030151031151032151033151034151035151036151037151038151039151040151041151042151043151044151045151046151047151048151049151050151051151052151053151054151055151056151057151058151059151060151061151062151063151064151065151066151067151068151069151070151071151072151073151074151075151076151077151078151079151080151081151082151083151084151085151086151087151088151089151090151091151092151093151094151095151096151097151098151099151100151101151102151103151104151105151106151107151108151109151110151111151112151113151114151115151116151117151118151119151120151121151122151123151124151125151126151127151128151129151130151131151132151133151134151135151136151137151138151139151140151141151142151143151144151145151146151147151148151149151150151151151152151153151154151155151156151157151158151159151160151161151162151163151164151165151166151167151168151169151170151171151172151173151174151175151176151177151178151179151180151181151182151183151184151185151186151187151188151189151190151191151192151193151194151195151196151197151198151199151200151201151202151203151204151205151206151207151208151209151210151211151212151213151214151215151216151217151218151219151220151221151222151223151224151225151226151227151228151229151230151231151232151233151234151235151236151237151238151239151240151241151242151243151244151245151246151247151248151249151250151251151252151253151254151255151256151257151258151259151260151261151262151263151264151265151266151267151268151269151270151271151272151273151274151275151276151277151278151279151280151281151282151283151284151285151286151287151288151289151290151291151292151293151294151295151296151297151298151299151300151301151302151303151304151305151306151307151308151309151310151311151312151313151314151315151316151317151318151319151320151321151322151323151324151325151326151327151328151329151330151331151332151333151334151335151336151337151338151339151340151341151342151343151344151345151346151347151348151349151350151351151352151353151354151355151356151357151358151359151360151361151362151363151364151365151366151367151368151369151370151371151372151373151374151375151376151377151378151379151380151381151382151383151384151385151386151387151388151389151390151391151392151393151394151395151396151397151398151399151400151401151402151403151404151405151406151407151408151409151410151411151412151413151414151415151416151417151418151419151420151421151422151423151424151425151426151427151428151429151430151431151432151433151434151435151436151437151438151439151440151441151442151443151444151445151446151447151448151449151450151451151452151453151454151455151456151457151458151459151460151461151462151463151464151465151466151467151468151469151470151471151472151473151474151475151476151477151478151479151480151481151482151483151484151485151486151487151488151489151490151491151492151493151494151495151496151497151498151499151500151501151502151503151504151505151506151507151508151509151510151511151512151513151514151515151516151517151518151519151520151521151522151523151524151525151526151527151528151529151530151531151532151533151534151535151536151537151538151539151540151541151542151543151544151545151546151547151548151549151550151551151552151553151554151555151556151557151558151559151560151561151562151563151564151565151566151567151568151569151570151571151572151573151574151575151576151577151578151579151580151581151582151583151584151585151586151587151588151589151590151591151592151593151594151595151596151597151598151599151600151601151602151603151604151605151606151607151608151609151610151611151612151613151614151615151616151617151618151619151620151621151622151623151624151625151626151627151628151629151630151631151632151633151634151635151636151637151638151639151640151641151642151643151644151645151646151647151648151649151650151651151652151653151654151655151656151657151658151659151660151661151662151663151664151665151666151667151668151669151670151671151672151673151674151675151676151677151678151679151680151681151682151683151684151685151686151687151688151689151690151691151692151693151694151695151696151697151698151699151700151701151702151703151704151705151706151707151708151709151710151711151712151713151714151715151716151717151718151719151720151721151722151723151724151725151726151727151728151729151730151731151732151733151734151735151736151737151738151739151740151741151742151743151744151745151746151747151748151749151750151751151752151753151754151755151756151757151758151759151760151761151762151763151764151765151766151767151768151769151770151771151772151773151774151775151776151777151778151779151780151781151782151783151784151785151786151787151788151789151790151791151792151793151794151795151796151797151798151799151800151801151802151803151804151805151806151807151808151809151810151811151812151813151814151815151816151817151818151819151820151821151822151823151824151825151826151827151828151829151830151831151832151833151834151835151836151837151838151839151840151841151842151843151844151845151846151847151848151849151850151851151852151853151854151855151856151857151858151859151860151861151862151863151864151865151866151867151868151869151870151871151872151873151874151875151876151877151878151879151880151881151882151883151884151885151886151887151888151889151890151891151892151893151894151895151896151897151898151899151900151901151902151903151904151905151906151907151908151909151910151911151912151913151914151915151916151917151918151919151920151921151922151923151924151925151926151927151928151929151930151931151932151933151934151935151936151937151938151939151940151941151942151943151944151945151946151947151948151949151950151951151952151953151954151955151956151957151958151959151960151961151962151963151964151965151966151967151968151969151970151971151972151973151974151975151976151977151978151979151980151981151982151983151984151985151986151987151988151989151990151991151992151993151994151995151996151997151998151999152000152001152002152003152004152005152006152007152008152009152010152011152012152013152014152015152016152017152018152019152020152021152022152023152024152025152026152027152028152029152030152031152032152033152034152035152036152037152038152039152040152041152042152043152044152045152046152047152048152049152050152051152052152053152054152055152056152057152058152059152060152061152062152063152064152065152066152067152068152069152070152071152072152073152074152075152076152077152078152079152080152081152082152083152084152085152086152087152088152089152090152091152092152093152094152095152096152097152098152099152100152101152102152103152104152105152106152107152108152109152110152111152112152113152114152115152116152117152118152119152120152121152122152123152124152125152126152127152128152129152130152131152132152133152134152135152136152137152138152139152140152141152142152143152144152145152146152147152148152149152150152151152152152153152154152155152156152157152158152159152160152161152162152163152164152165152166152167152168152169152170152171152172152173152174152175152176152177152178152179152180152181152182152183152184152185152186152187152188152189152190152191152192152193152194152195152196152197152198152199152200152201152202152203152204152205152206152207152208152209152210152211152212152213152214152215152216152217152218152219152220152221152222152223152224152225152226152227152228152229152230152231152232152233152234152235152236152237152238152239152240152241152242152243152244152245152246152247152248152249152250152251152252152253152254152255152256152257152258152259152260152261152262152263152264152265152266152267152268152269152270152271152272152273152274152275152276152277152278152279152280152281152282152283152284152285152286152287152288152289152290152291152292152293152294152295152296152297152298152299152300152301152302152303152304152305152306152307152308152309152310152311152312152313152314152315152316152317152318152319152320152321152322152323152324152325152326152327152328152329152330152331152332152333152334152335152336152337152338152339152340152341152342152343152344152345152346152347152348152349152350152351152352152353152354152355152356152357152358152359152360152361152362152363152364152365152366152367152368152369152370152371152372152373152374152375152376152377152378152379152380152381152382152383152384152385152386152387152388152389152390152391152392152393152394152395152396152397152398152399152400152401152402152403152404152405152406152407152408152409152410152411152412152413152414152415152416152417152418152419152420152421152422152423152424152425152426152427152428152429152430152431152432152433152434152435152436152437152438152439152440152441152442152443152444152445152446152447152448152449152450152451152452152453152454152455152456152457152458152459152460152461152462152463152464152465152466152467152468152469152470152471152472152473152474152475152476152477152478152479152480152481152482152483152484152485152486152487152488152489152490152491152492152493152494152495152496152497152498152499152500152501152502152503152504152505152506152507152508152509152510152511152512152513152514152515152516152517152518152519152520152521152522152523152524152525152526152527152528152529152530152531152532152533152534152535152536152537152538152539152540152541152542152543152544152545152546152547152548152549152550152551152552152553152554152555152556152557152558152559152560152561152562152563152564152565152566152567152568152569152570152571152572152573152574152575152576152577152578152579152580152581152582152583152584152585152586152587152588152589152590152591152592152593152594152595152596152597152598152599152600152601152602152603152604152605152606152607152608152609152610152611152612152613152614152615152616152617152618152619152620152621152622152623152624152625152626152627152628152629152630152631152632152633152634152635152636152637152638152639152640152641152642152643152644152645152646152647152648152649152650152651152652152653152654152655152656152657152658152659152660152661152662152663152664152665152666152667152668152669152670152671152672152673152674152675152676152677152678152679152680152681152682152683152684152685152686152687152688152689152690152691152692152693152694152695152696152697152698152699152700152701152702152703152704152705152706152707152708152709152710152711152712152713152714152715152716152717152718152719152720152721152722152723152724152725152726152727152728152729152730152731152732152733152734152735152736152737152738152739152740152741152742152743152744152745152746152747152748152749152750152751152752152753152754152755152756152757152758152759152760152761152762152763152764152765152766152767152768152769152770152771152772152773152774152775152776152777152778152779152780152781152782152783152784152785152786152787152788152789152790152791152792152793152794152795152796152797152798152799152800152801152802152803152804152805152806152807152808152809152810152811152812152813152814152815152816152817152818152819152820152821152822152823152824152825152826152827152828152829152830152831152832152833152834152835152836152837152838152839152840152841152842152843152844152845152846152847152848152849152850152851152852152853152854152855152856152857152858152859152860152861152862152863152864152865152866152867152868152869152870152871152872152873152874152875152876152877152878152879152880152881152882152883152884152885152886152887152888152889152890152891152892152893152894152895152896152897152898152899152900152901152902152903152904152905152906152907152908152909152910152911152912152913152914152915152916152917152918152919152920152921152922152923152924152925152926152927152928152929152930152931152932152933152934152935152936152937152938152939152940152941152942152943152944152945152946152947152948152949152950152951152952152953152954152955152956152957152958152959152960152961152962152963152964152965152966152967152968152969152970152971152972152973152974152975152976152977152978152979152980152981152982152983152984152985152986152987152988152989152990152991152992152993152994152995152996152997152998152999153000153001153002153003153004153005153006153007153008153009153010153011153012153013153014153015153016153017153018153019153020153021153022153023153024153025153026153027153028153029153030153031153032153033153034153035153036153037153038153039153040153041153042153043153044153045153046153047153048153049153050153051153052153053153054153055153056153057153058153059153060153061153062153063153064153065153066153067153068153069153070153071153072153073153074153075153076153077153078153079153080153081153082153083153084153085153086153087153088153089153090153091153092153093153094153095153096153097153098153099153100153101153102153103153104153105153106153107153108153109153110153111153112153113153114153115153116153117153118153119153120153121153122153123153124153125153126153127153128153129153130153131153132153133153134153135153136153137153138153139153140153141153142153143153144153145153146153147153148153149153150153151153152153153153154153155153156153157153158153159153160153161153162153163153164153165153166153167153168153169153170153171153172153173153174153175153176153177153178153179153180153181153182153183153184153185153186153187153188153189153190153191153192153193153194153195153196153197153198153199153200153201153202153203153204153205153206153207153208153209153210153211153212153213153214153215153216153217153218153219153220153221153222153223153224153225153226153227153228153229153230153231153232153233153234153235153236153237153238153239153240153241153242153243153244153245153246153247153248153249153250153251153252153253153254153255153256153257153258153259153260153261153262153263153264153265153266153267153268153269153270153271153272153273153274153275153276153277153278153279153280153281153282153283153284153285153286153287153288153289153290153291153292153293153294153295153296153297153298153299153300153301153302153303153304153305153306153307153308153309153310153311153312153313153314153315153316153317153318153319153320153321153322153323153324153325153326153327153328153329153330153331153332153333153334153335153336153337153338153339153340153341153342153343153344153345153346153347153348153349153350153351153352153353153354153355153356153357153358153359153360153361153362153363153364153365153366153367153368153369153370153371153372153373153374153375153376153377153378153379153380153381153382153383153384153385153386153387153388153389153390153391153392153393153394153395153396153397153398153399153400153401153402153403153404153405153406153407153408153409153410153411153412153413153414153415153416153417153418153419153420153421153422153423153424153425153426153427153428153429153430153431153432153433153434153435153436153437153438153439153440153441153442153443153444153445153446153447153448153449153450153451153452153453153454153455153456153457153458153459153460153461153462153463153464153465153466153467153468153469153470153471153472153473153474153475153476153477153478153479153480153481153482153483153484153485153486153487153488153489153490153491153492153493153494153495153496153497153498153499153500153501153502153503153504153505153506153507153508153509153510153511153512153513153514153515153516153517153518153519153520153521153522153523153524153525153526153527153528153529153530153531153532153533153534153535153536153537153538153539153540153541153542153543153544153545153546153547153548153549153550153551153552153553153554153555153556153557153558153559153560153561153562153563153564153565153566153567153568153569153570153571153572153573153574153575153576153577153578153579153580153581153582153583153584153585153586153587153588153589153590153591153592153593153594153595153596153597153598153599153600153601153602153603153604153605153606153607153608153609153610153611153612153613153614153615153616153617153618153619153620153621153622153623153624153625153626153627153628153629153630153631153632153633153634153635153636153637153638153639153640153641153642153643153644153645153646153647153648153649153650153651153652153653153654153655153656153657153658153659153660153661153662153663153664153665153666153667153668153669153670153671153672153673153674153675153676153677153678153679153680153681153682153683153684153685153686153687153688153689153690153691153692153693153694153695153696153697153698153699153700153701153702153703153704153705153706153707153708153709153710153711153712153713153714153715153716153717153718153719153720153721153722153723153724153725153726153727153728153729153730153731153732153733153734153735153736153737153738153739153740153741153742153743153744153745153746153747153748153749153750153751153752153753153754153755153756153757153758153759153760153761153762153763153764153765153766153767153768153769153770153771153772153773153774153775153776153777153778153779153780153781153782153783153784153785153786153787153788153789153790153791153792153793153794153795153796153797153798153799153800153801153802153803153804153805153806153807153808153809153810153811153812153813153814153815153816153817153818153819153820153821153822153823153824153825153826153827153828153829153830153831153832153833153834153835153836153837153838153839153840153841153842153843153844153845153846153847153848153849153850153851153852153853153854153855153856153857153858153859153860153861153862153863153864153865153866153867153868153869153870153871153872153873153874153875153876153877153878153879153880153881153882153883153884153885153886153887153888153889153890153891153892153893153894153895153896153897153898153899153900153901153902153903153904153905153906153907153908153909153910153911153912153913153914153915153916153917153918153919153920153921153922153923153924153925153926153927153928153929153930153931153932153933153934153935153936153937153938153939153940153941153942153943153944153945153946153947153948153949153950153951153952153953153954153955153956153957153958153959153960153961153962153963153964153965153966153967153968153969153970153971153972153973153974153975153976153977153978153979153980153981153982153983153984153985153986153987153988153989153990153991153992153993153994153995153996153997153998153999154000154001154002154003154004154005154006154007154008154009154010154011154012154013154014154015154016154017154018154019154020154021154022154023154024154025154026154027154028154029154030154031154032154033154034154035154036154037154038154039154040154041154042154043154044154045154046154047154048154049154050154051154052154053154054154055154056154057154058154059154060154061154062154063154064154065154066154067154068154069154070154071154072154073154074154075154076154077154078154079154080154081154082154083154084154085154086154087154088154089154090154091154092154093154094154095154096154097154098154099154100154101154102154103154104154105154106154107154108154109154110154111154112154113154114154115154116154117154118154119154120154121154122154123154124154125154126154127154128154129154130154131154132154133154134154135154136154137154138154139154140154141154142154143154144154145154146154147154148154149154150154151154152154153154154154155154156154157154158154159154160154161154162154163154164154165154166154167154168154169154170154171154172154173154174154175154176154177154178154179154180154181154182154183154184154185154186154187154188154189154190154191154192154193154194154195154196154197154198154199154200154201154202154203154204154205154206154207154208154209154210154211154212154213154214154215154216154217154218154219154220154221154222154223154224154225154226154227154228154229154230154231154232154233154234154235154236154237154238154239154240154241154242154243154244154245154246154247154248154249154250154251154252154253154254154255154256154257154258154259154260154261154262154263154264154265154266154267154268154269154270154271154272154273154274154275154276154277154278154279154280154281154282154283154284154285154286154287154288154289154290154291154292154293154294154295154296154297154298154299154300154301154302154303154304154305154306154307154308154309154310154311154312154313154314154315154316154317154318154319154320154321154322154323154324154325154326154327154328154329154330154331154332154333154334154335154336154337154338154339154340154341154342154343154344154345154346154347154348154349154350154351154352154353154354154355154356154357154358154359154360154361154362154363154364154365154366154367154368154369154370154371154372154373154374154375154376154377154378154379154380154381154382154383154384154385154386154387154388154389154390154391154392154393154394154395154396154397154398154399154400154401154402154403154404154405154406154407154408154409154410154411154412154413154414154415154416154417154418154419154420154421154422154423154424154425154426154427154428154429154430154431154432154433154434154435154436154437154438154439154440154441154442154443154444154445154446154447154448154449154450154451154452154453154454154455154456154457154458154459154460154461154462154463154464154465154466154467154468154469154470154471154472154473154474154475154476154477154478154479154480154481154482154483154484154485154486154487154488154489154490154491154492154493154494154495154496154497154498154499154500154501154502154503154504154505154506154507154508154509154510154511154512154513154514154515154516154517154518154519154520154521154522154523154524154525154526154527154528154529154530154531154532154533154534154535154536154537154538154539154540154541154542154543154544154545154546154547154548154549154550154551154552154553154554154555154556154557154558154559154560154561154562154563154564154565154566154567154568154569154570154571154572154573154574154575154576154577154578154579154580154581154582154583154584154585154586154587154588154589154590154591154592154593154594154595154596154597154598154599154600154601154602154603154604154605154606154607154608154609154610154611154612154613154614154615154616154617154618154619154620154621154622154623154624154625154626154627154628154629154630154631154632154633154634154635154636154637154638154639154640154641154642154643154644154645154646154647154648154649154650154651154652154653154654154655154656154657154658154659154660154661154662154663154664154665154666154667154668154669154670154671154672154673154674154675154676154677154678154679154680154681154682154683154684154685154686154687154688154689154690154691154692154693154694154695154696154697154698154699154700154701154702154703154704154705154706154707154708154709154710154711154712154713154714154715154716154717154718154719154720154721154722154723154724154725154726154727154728154729154730154731154732154733154734154735154736154737154738154739154740154741154742154743154744154745154746154747154748154749154750154751154752154753154754154755154756154757154758154759154760154761154762154763154764154765154766154767154768154769154770154771154772154773154774154775154776154777154778154779154780154781154782154783154784154785154786154787154788154789154790154791154792154793154794154795154796154797154798154799154800154801154802154803154804154805154806154807154808154809154810154811154812154813154814154815154816154817154818154819154820154821154822154823154824154825154826154827154828154829154830154831154832154833154834154835154836154837154838154839154840154841154842154843154844154845154846154847154848154849154850154851154852154853154854154855154856154857154858154859154860154861154862154863154864154865154866154867154868154869154870154871154872154873154874154875154876154877154878154879154880154881154882154883154884154885154886154887154888154889154890154891154892154893154894154895154896154897154898154899154900154901154902154903154904154905154906154907154908154909154910154911154912154913154914154915154916154917154918154919154920154921154922154923154924154925154926154927154928154929154930154931154932154933154934154935154936154937154938154939154940154941154942154943154944154945154946154947154948154949154950154951154952154953154954154955154956154957154958154959154960154961154962154963154964154965154966154967154968154969154970154971154972154973154974154975154976154977154978154979154980154981154982154983154984154985154986154987154988154989154990154991154992154993154994154995154996154997154998154999155000155001155002155003155004155005155006155007155008155009155010155011155012155013155014155015155016155017155018155019155020155021155022155023155024155025155026155027155028155029155030155031155032155033155034155035155036155037155038155039155040155041155042155043155044155045155046155047155048155049155050155051155052155053155054155055155056155057155058155059155060155061155062155063155064155065155066155067155068155069155070155071155072155073155074155075155076155077155078155079155080155081155082155083155084155085155086155087155088155089155090155091155092155093155094155095155096155097155098155099155100155101155102155103155104155105155106155107155108155109155110155111155112155113155114155115155116155117155118155119155120155121155122155123155124155125155126155127155128155129155130155131155132155133155134155135155136155137155138155139155140155141155142155143155144155145155146155147155148155149155150155151155152155153155154155155155156155157155158155159155160155161155162155163155164155165155166155167155168155169155170155171155172155173155174155175155176155177155178155179155180155181155182155183155184155185155186155187155188155189155190155191155192155193155194155195155196155197155198155199155200155201155202155203155204155205155206155207155208155209155210155211155212155213155214155215155216155217155218155219155220155221155222155223155224155225155226155227155228155229155230155231155232155233155234155235155236155237155238155239155240155241155242155243155244155245155246155247155248155249155250155251155252155253155254155255155256155257155258155259155260155261155262155263155264155265155266155267155268155269155270155271155272155273155274155275155276155277155278155279155280155281155282155283155284155285155286155287155288155289155290155291155292155293155294155295155296155297155298155299155300155301155302155303155304155305155306155307155308155309155310155311155312155313155314155315155316155317155318155319155320155321155322155323155324155325155326155327155328155329155330155331155332155333155334155335155336155337155338155339155340155341155342155343155344155345155346155347155348155349155350155351155352155353155354155355155356155357155358155359155360155361155362155363155364155365155366155367155368155369155370155371155372155373155374155375155376155377155378155379155380155381155382155383155384155385155386155387155388155389155390155391155392155393155394155395155396155397155398155399155400155401155402155403155404155405155406155407155408155409155410155411155412155413155414155415155416155417155418155419155420155421155422155423155424155425155426155427155428155429155430155431155432155433155434155435155436155437155438155439155440155441155442155443155444155445155446155447155448155449155450155451155452155453155454155455155456155457155458155459155460155461155462155463155464155465155466155467155468155469155470155471155472155473155474155475155476155477155478155479155480155481155482155483155484155485155486155487155488155489155490155491155492155493155494155495155496155497155498155499155500155501155502155503155504155505155506155507155508155509155510155511155512155513155514155515155516155517155518155519155520155521155522155523155524155525155526155527155528155529155530155531155532155533155534155535155536155537155538155539155540155541155542155543155544155545155546155547155548155549155550155551155552155553155554155555155556155557155558155559155560155561155562155563155564155565155566155567155568155569155570155571155572155573155574155575155576155577155578155579155580155581155582155583155584155585155586155587155588155589155590155591155592155593155594155595155596155597155598155599155600155601155602155603155604155605155606155607155608155609155610155611155612155613155614155615155616155617155618155619155620155621155622155623155624155625155626155627155628155629155630155631155632155633155634155635155636155637155638155639155640155641155642155643155644155645155646155647155648155649155650155651155652155653155654155655155656155657155658155659155660155661155662155663155664155665155666155667155668155669155670155671155672155673155674155675155676155677155678155679155680155681155682155683155684155685155686155687155688155689155690155691155692155693155694155695155696155697155698155699155700155701155702155703
  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. protected _postMultiplyPivotMatrix: boolean;
  15088. protected _isWorldMatrixFrozen: boolean;
  15089. /** @hidden */
  15090. _indexInSceneTransformNodesArray: number;
  15091. /**
  15092. * An event triggered after the world matrix is updated
  15093. */
  15094. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  15095. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  15096. /**
  15097. * Gets a string identifying the name of the class
  15098. * @returns "TransformNode" string
  15099. */
  15100. getClassName(): string;
  15101. /**
  15102. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  15103. */
  15104. get position(): Vector3;
  15105. set position(newPosition: Vector3);
  15106. /**
  15107. * 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)).
  15108. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  15109. */
  15110. get rotation(): Vector3;
  15111. set rotation(newRotation: Vector3);
  15112. /**
  15113. * 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)).
  15114. */
  15115. get scaling(): Vector3;
  15116. set scaling(newScaling: Vector3);
  15117. /**
  15118. * 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).
  15119. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  15120. */
  15121. get rotationQuaternion(): Nullable<Quaternion>;
  15122. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  15123. /**
  15124. * The forward direction of that transform in world space.
  15125. */
  15126. get forward(): Vector3;
  15127. /**
  15128. * The up direction of that transform in world space.
  15129. */
  15130. get up(): Vector3;
  15131. /**
  15132. * The right direction of that transform in world space.
  15133. */
  15134. get right(): Vector3;
  15135. /**
  15136. * Copies the parameter passed Matrix into the mesh Pose matrix.
  15137. * @param matrix the matrix to copy the pose from
  15138. * @returns this TransformNode.
  15139. */
  15140. updatePoseMatrix(matrix: Matrix): TransformNode;
  15141. /**
  15142. * Returns the mesh Pose matrix.
  15143. * @returns the pose matrix
  15144. */
  15145. getPoseMatrix(): Matrix;
  15146. /** @hidden */
  15147. _isSynchronized(): boolean;
  15148. /** @hidden */
  15149. _initCache(): void;
  15150. /**
  15151. * Flag the transform node as dirty (Forcing it to update everything)
  15152. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  15153. * @returns this transform node
  15154. */
  15155. markAsDirty(property: string): TransformNode;
  15156. /**
  15157. * Returns the current mesh absolute position.
  15158. * Returns a Vector3.
  15159. */
  15160. get absolutePosition(): Vector3;
  15161. /**
  15162. * Returns the current mesh absolute scaling.
  15163. * Returns a Vector3.
  15164. */
  15165. get absoluteScaling(): Vector3;
  15166. /**
  15167. * Returns the current mesh absolute rotation.
  15168. * Returns a Quaternion.
  15169. */
  15170. get absoluteRotationQuaternion(): Quaternion;
  15171. /**
  15172. * Sets a new matrix to apply before all other transformation
  15173. * @param matrix defines the transform matrix
  15174. * @returns the current TransformNode
  15175. */
  15176. setPreTransformMatrix(matrix: Matrix): TransformNode;
  15177. /**
  15178. * Sets a new pivot matrix to the current node
  15179. * @param matrix defines the new pivot matrix to use
  15180. * @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
  15181. * @returns the current TransformNode
  15182. */
  15183. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  15184. /**
  15185. * Returns the mesh pivot matrix.
  15186. * Default : Identity.
  15187. * @returns the matrix
  15188. */
  15189. getPivotMatrix(): Matrix;
  15190. /**
  15191. * Instantiate (when possible) or clone that node with its hierarchy
  15192. * @param newParent defines the new parent to use for the instance (or clone)
  15193. * @param options defines options to configure how copy is done
  15194. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  15195. * @returns an instance (or a clone) of the current node with its hiearchy
  15196. */
  15197. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  15198. doNotInstantiate: boolean;
  15199. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  15200. /**
  15201. * Prevents the World matrix to be computed any longer
  15202. * @param newWorldMatrix defines an optional matrix to use as world matrix
  15203. * @returns the TransformNode.
  15204. */
  15205. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  15206. /**
  15207. * Allows back the World matrix computation.
  15208. * @returns the TransformNode.
  15209. */
  15210. unfreezeWorldMatrix(): this;
  15211. /**
  15212. * True if the World matrix has been frozen.
  15213. */
  15214. get isWorldMatrixFrozen(): boolean;
  15215. /**
  15216. * Retuns the mesh absolute position in the World.
  15217. * @returns a Vector3.
  15218. */
  15219. getAbsolutePosition(): Vector3;
  15220. /**
  15221. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  15222. * @param absolutePosition the absolute position to set
  15223. * @returns the TransformNode.
  15224. */
  15225. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  15226. /**
  15227. * Sets the mesh position in its local space.
  15228. * @param vector3 the position to set in localspace
  15229. * @returns the TransformNode.
  15230. */
  15231. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  15232. /**
  15233. * Returns the mesh position in the local space from the current World matrix values.
  15234. * @returns a new Vector3.
  15235. */
  15236. getPositionExpressedInLocalSpace(): Vector3;
  15237. /**
  15238. * Translates the mesh along the passed Vector3 in its local space.
  15239. * @param vector3 the distance to translate in localspace
  15240. * @returns the TransformNode.
  15241. */
  15242. locallyTranslate(vector3: Vector3): TransformNode;
  15243. private static _lookAtVectorCache;
  15244. /**
  15245. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  15246. * @param targetPoint the position (must be in same space as current mesh) to look at
  15247. * @param yawCor optional yaw (y-axis) correction in radians
  15248. * @param pitchCor optional pitch (x-axis) correction in radians
  15249. * @param rollCor optional roll (z-axis) correction in radians
  15250. * @param space the choosen space of the target
  15251. * @returns the TransformNode.
  15252. */
  15253. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  15254. /**
  15255. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15256. * This Vector3 is expressed in the World space.
  15257. * @param localAxis axis to rotate
  15258. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15259. */
  15260. getDirection(localAxis: Vector3): Vector3;
  15261. /**
  15262. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  15263. * localAxis is expressed in the mesh local space.
  15264. * result is computed in the Wordl space from the mesh World matrix.
  15265. * @param localAxis axis to rotate
  15266. * @param result the resulting transformnode
  15267. * @returns this TransformNode.
  15268. */
  15269. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  15270. /**
  15271. * Sets this transform node rotation to the given local axis.
  15272. * @param localAxis the axis in local space
  15273. * @param yawCor optional yaw (y-axis) correction in radians
  15274. * @param pitchCor optional pitch (x-axis) correction in radians
  15275. * @param rollCor optional roll (z-axis) correction in radians
  15276. * @returns this TransformNode
  15277. */
  15278. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  15279. /**
  15280. * Sets a new pivot point to the current node
  15281. * @param point defines the new pivot point to use
  15282. * @param space defines if the point is in world or local space (local by default)
  15283. * @returns the current TransformNode
  15284. */
  15285. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  15286. /**
  15287. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  15288. * @returns the pivot point
  15289. */
  15290. getPivotPoint(): Vector3;
  15291. /**
  15292. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  15293. * @param result the vector3 to store the result
  15294. * @returns this TransformNode.
  15295. */
  15296. getPivotPointToRef(result: Vector3): TransformNode;
  15297. /**
  15298. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  15299. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  15300. */
  15301. getAbsolutePivotPoint(): Vector3;
  15302. /**
  15303. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  15304. * @param result vector3 to store the result
  15305. * @returns this TransformNode.
  15306. */
  15307. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  15308. /**
  15309. * Defines the passed node as the parent of the current node.
  15310. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  15311. * @see https://doc.babylonjs.com/how_to/parenting
  15312. * @param node the node ot set as the parent
  15313. * @returns this TransformNode.
  15314. */
  15315. setParent(node: Nullable<Node>): TransformNode;
  15316. private _nonUniformScaling;
  15317. /**
  15318. * True if the scaling property of this object is non uniform eg. (1,2,1)
  15319. */
  15320. get nonUniformScaling(): boolean;
  15321. /** @hidden */
  15322. _updateNonUniformScalingState(value: boolean): boolean;
  15323. /**
  15324. * Attach the current TransformNode to another TransformNode associated with a bone
  15325. * @param bone Bone affecting the TransformNode
  15326. * @param affectedTransformNode TransformNode associated with the bone
  15327. * @returns this object
  15328. */
  15329. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  15330. /**
  15331. * Detach the transform node if its associated with a bone
  15332. * @returns this object
  15333. */
  15334. detachFromBone(): TransformNode;
  15335. private static _rotationAxisCache;
  15336. /**
  15337. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  15338. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15339. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15340. * The passed axis is also normalized.
  15341. * @param axis the axis to rotate around
  15342. * @param amount the amount to rotate in radians
  15343. * @param space Space to rotate in (Default: local)
  15344. * @returns the TransformNode.
  15345. */
  15346. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  15347. /**
  15348. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  15349. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15350. * The passed axis is also normalized. .
  15351. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  15352. * @param point the point to rotate around
  15353. * @param axis the axis to rotate around
  15354. * @param amount the amount to rotate in radians
  15355. * @returns the TransformNode
  15356. */
  15357. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  15358. /**
  15359. * Translates the mesh along the axis vector for the passed distance in the given space.
  15360. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15361. * @param axis the axis to translate in
  15362. * @param distance the distance to translate
  15363. * @param space Space to rotate in (Default: local)
  15364. * @returns the TransformNode.
  15365. */
  15366. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  15367. /**
  15368. * Adds a rotation step to the mesh current rotation.
  15369. * x, y, z are Euler angles expressed in radians.
  15370. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  15371. * This means this rotation is made in the mesh local space only.
  15372. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  15373. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  15374. * ```javascript
  15375. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  15376. * ```
  15377. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  15378. * 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.
  15379. * @param x Rotation to add
  15380. * @param y Rotation to add
  15381. * @param z Rotation to add
  15382. * @returns the TransformNode.
  15383. */
  15384. addRotation(x: number, y: number, z: number): TransformNode;
  15385. /**
  15386. * @hidden
  15387. */
  15388. protected _getEffectiveParent(): Nullable<Node>;
  15389. /**
  15390. * Computes the world matrix of the node
  15391. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  15392. * @returns the world matrix
  15393. */
  15394. computeWorldMatrix(force?: boolean): Matrix;
  15395. /**
  15396. * Resets this nodeTransform's local matrix to Matrix.Identity().
  15397. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  15398. */
  15399. resetLocalMatrix(independentOfChildren?: boolean): void;
  15400. protected _afterComputeWorldMatrix(): void;
  15401. /**
  15402. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  15403. * @param func callback function to add
  15404. *
  15405. * @returns the TransformNode.
  15406. */
  15407. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15408. /**
  15409. * Removes a registered callback function.
  15410. * @param func callback function to remove
  15411. * @returns the TransformNode.
  15412. */
  15413. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15414. /**
  15415. * Gets the position of the current mesh in camera space
  15416. * @param camera defines the camera to use
  15417. * @returns a position
  15418. */
  15419. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  15420. /**
  15421. * Returns the distance from the mesh to the active camera
  15422. * @param camera defines the camera to use
  15423. * @returns the distance
  15424. */
  15425. getDistanceToCamera(camera?: Nullable<Camera>): number;
  15426. /**
  15427. * Clone the current transform node
  15428. * @param name Name of the new clone
  15429. * @param newParent New parent for the clone
  15430. * @param doNotCloneChildren Do not clone children hierarchy
  15431. * @returns the new transform node
  15432. */
  15433. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  15434. /**
  15435. * Serializes the objects information.
  15436. * @param currentSerializationObject defines the object to serialize in
  15437. * @returns the serialized object
  15438. */
  15439. serialize(currentSerializationObject?: any): any;
  15440. /**
  15441. * Returns a new TransformNode object parsed from the source provided.
  15442. * @param parsedTransformNode is the source.
  15443. * @param scene the scne the object belongs to
  15444. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  15445. * @returns a new TransformNode object parsed from the source provided.
  15446. */
  15447. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  15448. /**
  15449. * Get all child-transformNodes of this node
  15450. * @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
  15451. * @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
  15452. * @returns an array of TransformNode
  15453. */
  15454. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  15455. /**
  15456. * Releases resources associated with this transform node.
  15457. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  15458. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  15459. */
  15460. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  15461. /**
  15462. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  15463. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  15464. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  15465. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  15466. * @returns the current mesh
  15467. */
  15468. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  15469. private _syncAbsoluteScalingAndRotation;
  15470. }
  15471. }
  15472. declare module "babylonjs/Animations/animationPropertiesOverride" {
  15473. /**
  15474. * Class used to override all child animations of a given target
  15475. */
  15476. export class AnimationPropertiesOverride {
  15477. /**
  15478. * Gets or sets a value indicating if animation blending must be used
  15479. */
  15480. enableBlending: boolean;
  15481. /**
  15482. * Gets or sets the blending speed to use when enableBlending is true
  15483. */
  15484. blendingSpeed: number;
  15485. /**
  15486. * Gets or sets the default loop mode to use
  15487. */
  15488. loopMode: number;
  15489. }
  15490. }
  15491. declare module "babylonjs/Bones/bone" {
  15492. import { Skeleton } from "babylonjs/Bones/skeleton";
  15493. import { Vector3, Quaternion, Matrix } from "babylonjs/Maths/math.vector";
  15494. import { Nullable } from "babylonjs/types";
  15495. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  15496. import { TransformNode } from "babylonjs/Meshes/transformNode";
  15497. import { Node } from "babylonjs/node";
  15498. import { Space } from "babylonjs/Maths/math.axis";
  15499. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  15500. /**
  15501. * Class used to store bone information
  15502. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  15503. */
  15504. export class Bone extends Node {
  15505. /**
  15506. * defines the bone name
  15507. */
  15508. name: string;
  15509. private static _tmpVecs;
  15510. private static _tmpQuat;
  15511. private static _tmpMats;
  15512. /**
  15513. * Gets the list of child bones
  15514. */
  15515. children: Bone[];
  15516. /** Gets the animations associated with this bone */
  15517. animations: import("babylonjs/Animations/animation").Animation[];
  15518. /**
  15519. * Gets or sets bone length
  15520. */
  15521. length: number;
  15522. /**
  15523. * @hidden Internal only
  15524. * Set this value to map this bone to a different index in the transform matrices
  15525. * Set this value to -1 to exclude the bone from the transform matrices
  15526. */
  15527. _index: Nullable<number>;
  15528. private _skeleton;
  15529. private _localMatrix;
  15530. private _restPose;
  15531. private _bindPose;
  15532. private _baseMatrix;
  15533. private _absoluteTransform;
  15534. private _invertedAbsoluteTransform;
  15535. private _parent;
  15536. private _scalingDeterminant;
  15537. private _worldTransform;
  15538. private _localScaling;
  15539. private _localRotation;
  15540. private _localPosition;
  15541. private _needToDecompose;
  15542. private _needToCompose;
  15543. /** @hidden */
  15544. _linkedTransformNode: Nullable<TransformNode>;
  15545. /** @hidden */
  15546. _waitingTransformNodeId: Nullable<string>;
  15547. /** @hidden */
  15548. get _matrix(): Matrix;
  15549. /** @hidden */
  15550. set _matrix(value: Matrix);
  15551. /**
  15552. * Create a new bone
  15553. * @param name defines the bone name
  15554. * @param skeleton defines the parent skeleton
  15555. * @param parentBone defines the parent (can be null if the bone is the root)
  15556. * @param localMatrix defines the local matrix
  15557. * @param restPose defines the rest pose matrix
  15558. * @param baseMatrix defines the base matrix
  15559. * @param index defines index of the bone in the hiearchy
  15560. */
  15561. constructor(
  15562. /**
  15563. * defines the bone name
  15564. */
  15565. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  15566. /**
  15567. * Gets the current object class name.
  15568. * @return the class name
  15569. */
  15570. getClassName(): string;
  15571. /**
  15572. * Gets the parent skeleton
  15573. * @returns a skeleton
  15574. */
  15575. getSkeleton(): Skeleton;
  15576. /**
  15577. * Gets parent bone
  15578. * @returns a bone or null if the bone is the root of the bone hierarchy
  15579. */
  15580. getParent(): Nullable<Bone>;
  15581. /**
  15582. * Returns an array containing the root bones
  15583. * @returns an array containing the root bones
  15584. */
  15585. getChildren(): Array<Bone>;
  15586. /**
  15587. * Gets the node index in matrix array generated for rendering
  15588. * @returns the node index
  15589. */
  15590. getIndex(): number;
  15591. /**
  15592. * Sets the parent bone
  15593. * @param parent defines the parent (can be null if the bone is the root)
  15594. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15595. */
  15596. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  15597. /**
  15598. * Gets the local matrix
  15599. * @returns a matrix
  15600. */
  15601. getLocalMatrix(): Matrix;
  15602. /**
  15603. * Gets the base matrix (initial matrix which remains unchanged)
  15604. * @returns a matrix
  15605. */
  15606. getBaseMatrix(): Matrix;
  15607. /**
  15608. * Gets the rest pose matrix
  15609. * @returns a matrix
  15610. */
  15611. getRestPose(): Matrix;
  15612. /**
  15613. * Sets the rest pose matrix
  15614. * @param matrix the local-space rest pose to set for this bone
  15615. */
  15616. setRestPose(matrix: Matrix): void;
  15617. /**
  15618. * Gets the bind pose matrix
  15619. * @returns the bind pose matrix
  15620. */
  15621. getBindPose(): Matrix;
  15622. /**
  15623. * Sets the bind pose matrix
  15624. * @param matrix the local-space bind pose to set for this bone
  15625. */
  15626. setBindPose(matrix: Matrix): void;
  15627. /**
  15628. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  15629. */
  15630. getWorldMatrix(): Matrix;
  15631. /**
  15632. * Sets the local matrix to rest pose matrix
  15633. */
  15634. returnToRest(): void;
  15635. /**
  15636. * Gets the inverse of the absolute transform matrix.
  15637. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  15638. * @returns a matrix
  15639. */
  15640. getInvertedAbsoluteTransform(): Matrix;
  15641. /**
  15642. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  15643. * @returns a matrix
  15644. */
  15645. getAbsoluteTransform(): Matrix;
  15646. /**
  15647. * Links with the given transform node.
  15648. * The local matrix of this bone is copied from the transform node every frame.
  15649. * @param transformNode defines the transform node to link to
  15650. */
  15651. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  15652. /**
  15653. * Gets the node used to drive the bone's transformation
  15654. * @returns a transform node or null
  15655. */
  15656. getTransformNode(): Nullable<TransformNode>;
  15657. /** Gets or sets current position (in local space) */
  15658. get position(): Vector3;
  15659. set position(newPosition: Vector3);
  15660. /** Gets or sets current rotation (in local space) */
  15661. get rotation(): Vector3;
  15662. set rotation(newRotation: Vector3);
  15663. /** Gets or sets current rotation quaternion (in local space) */
  15664. get rotationQuaternion(): Quaternion;
  15665. set rotationQuaternion(newRotation: Quaternion);
  15666. /** Gets or sets current scaling (in local space) */
  15667. get scaling(): Vector3;
  15668. set scaling(newScaling: Vector3);
  15669. /**
  15670. * Gets the animation properties override
  15671. */
  15672. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  15673. private _decompose;
  15674. private _compose;
  15675. /**
  15676. * Update the base and local matrices
  15677. * @param matrix defines the new base or local matrix
  15678. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15679. * @param updateLocalMatrix defines if the local matrix should be updated
  15680. */
  15681. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  15682. /** @hidden */
  15683. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  15684. /**
  15685. * Flag the bone as dirty (Forcing it to update everything)
  15686. */
  15687. markAsDirty(): void;
  15688. /** @hidden */
  15689. _markAsDirtyAndCompose(): void;
  15690. private _markAsDirtyAndDecompose;
  15691. /**
  15692. * Translate the bone in local or world space
  15693. * @param vec The amount to translate the bone
  15694. * @param space The space that the translation is in
  15695. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15696. */
  15697. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15698. /**
  15699. * Set the postion of the bone in local or world space
  15700. * @param position The position to set the bone
  15701. * @param space The space that the position is in
  15702. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15703. */
  15704. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15705. /**
  15706. * Set the absolute position of the bone (world space)
  15707. * @param position The position to set the bone
  15708. * @param mesh The mesh that this bone is attached to
  15709. */
  15710. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  15711. /**
  15712. * Scale the bone on the x, y and z axes (in local space)
  15713. * @param x The amount to scale the bone on the x axis
  15714. * @param y The amount to scale the bone on the y axis
  15715. * @param z The amount to scale the bone on the z axis
  15716. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  15717. */
  15718. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  15719. /**
  15720. * Set the bone scaling in local space
  15721. * @param scale defines the scaling vector
  15722. */
  15723. setScale(scale: Vector3): void;
  15724. /**
  15725. * Gets the current scaling in local space
  15726. * @returns the current scaling vector
  15727. */
  15728. getScale(): Vector3;
  15729. /**
  15730. * Gets the current scaling in local space and stores it in a target vector
  15731. * @param result defines the target vector
  15732. */
  15733. getScaleToRef(result: Vector3): void;
  15734. /**
  15735. * Set the yaw, pitch, and roll of the bone in local or world space
  15736. * @param yaw The rotation of the bone on the y axis
  15737. * @param pitch The rotation of the bone on the x axis
  15738. * @param roll The rotation of the bone on the z axis
  15739. * @param space The space that the axes of rotation are in
  15740. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15741. */
  15742. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  15743. /**
  15744. * Add a rotation to the bone on an axis in local or world space
  15745. * @param axis The axis to rotate the bone on
  15746. * @param amount The amount to rotate the bone
  15747. * @param space The space that the axis is in
  15748. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15749. */
  15750. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  15751. /**
  15752. * Set the rotation of the bone to a particular axis angle in local or world space
  15753. * @param axis The axis to rotate the bone on
  15754. * @param angle The angle that the bone should be rotated to
  15755. * @param space The space that the axis is in
  15756. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15757. */
  15758. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  15759. /**
  15760. * Set the euler rotation of the bone in local of world space
  15761. * @param rotation The euler rotation that the bone should be set to
  15762. * @param space The space that the rotation is in
  15763. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15764. */
  15765. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15766. /**
  15767. * Set the quaternion rotation of the bone in local of world space
  15768. * @param quat The quaternion rotation that the bone should be set to
  15769. * @param space The space that the rotation is in
  15770. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15771. */
  15772. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  15773. /**
  15774. * Set the rotation matrix of the bone in local of world space
  15775. * @param rotMat The rotation matrix that the bone should be set to
  15776. * @param space The space that the rotation is in
  15777. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15778. */
  15779. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  15780. private _rotateWithMatrix;
  15781. private _getNegativeRotationToRef;
  15782. /**
  15783. * Get the position of the bone in local or world space
  15784. * @param space The space that the returned position is in
  15785. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15786. * @returns The position of the bone
  15787. */
  15788. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15789. /**
  15790. * Copy the position of the bone to a vector3 in local or world space
  15791. * @param space The space that the returned position is in
  15792. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15793. * @param result The vector3 to copy the position to
  15794. */
  15795. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  15796. /**
  15797. * Get the absolute position of the bone (world space)
  15798. * @param mesh The mesh that this bone is attached to
  15799. * @returns The absolute position of the bone
  15800. */
  15801. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  15802. /**
  15803. * Copy the absolute position of the bone (world space) to the result param
  15804. * @param mesh The mesh that this bone is attached to
  15805. * @param result The vector3 to copy the absolute position to
  15806. */
  15807. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  15808. /**
  15809. * Compute the absolute transforms of this bone and its children
  15810. */
  15811. computeAbsoluteTransforms(): void;
  15812. /**
  15813. * Get the world direction from an axis that is in the local space of the bone
  15814. * @param localAxis The local direction that is used to compute the world direction
  15815. * @param mesh The mesh that this bone is attached to
  15816. * @returns The world direction
  15817. */
  15818. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15819. /**
  15820. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  15821. * @param localAxis The local direction that is used to compute the world direction
  15822. * @param mesh The mesh that this bone is attached to
  15823. * @param result The vector3 that the world direction will be copied to
  15824. */
  15825. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15826. /**
  15827. * Get the euler rotation of the bone in local or world space
  15828. * @param space The space that the rotation should be in
  15829. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15830. * @returns The euler rotation
  15831. */
  15832. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15833. /**
  15834. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  15835. * @param space The space that the rotation should be in
  15836. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15837. * @param result The vector3 that the rotation should be copied to
  15838. */
  15839. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15840. /**
  15841. * Get the quaternion rotation of the bone in either local or world space
  15842. * @param space The space that the rotation should be in
  15843. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15844. * @returns The quaternion rotation
  15845. */
  15846. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  15847. /**
  15848. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  15849. * @param space The space that the rotation should be in
  15850. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15851. * @param result The quaternion that the rotation should be copied to
  15852. */
  15853. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  15854. /**
  15855. * Get the rotation matrix of the bone in local or world space
  15856. * @param space The space that the rotation should be in
  15857. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15858. * @returns The rotation matrix
  15859. */
  15860. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  15861. /**
  15862. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  15863. * @param space The space that the rotation should be in
  15864. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15865. * @param result The quaternion that the rotation should be copied to
  15866. */
  15867. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  15868. /**
  15869. * Get the world position of a point that is in the local space of the bone
  15870. * @param position The local position
  15871. * @param mesh The mesh that this bone is attached to
  15872. * @returns The world position
  15873. */
  15874. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15875. /**
  15876. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  15877. * @param position The local position
  15878. * @param mesh The mesh that this bone is attached to
  15879. * @param result The vector3 that the world position should be copied to
  15880. */
  15881. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15882. /**
  15883. * Get the local position of a point that is in world space
  15884. * @param position The world position
  15885. * @param mesh The mesh that this bone is attached to
  15886. * @returns The local position
  15887. */
  15888. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15889. /**
  15890. * Get the local position of a point that is in world space and copy it to the result param
  15891. * @param position The world position
  15892. * @param mesh The mesh that this bone is attached to
  15893. * @param result The vector3 that the local position should be copied to
  15894. */
  15895. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15896. }
  15897. }
  15898. declare module "babylonjs/Animations/runtimeAnimation" {
  15899. import { Animation, _IAnimationState } from "babylonjs/Animations/animation";
  15900. import { Animatable } from "babylonjs/Animations/animatable";
  15901. import { Scene } from "babylonjs/scene";
  15902. /**
  15903. * Defines a runtime animation
  15904. */
  15905. export class RuntimeAnimation {
  15906. private _events;
  15907. /**
  15908. * The current frame of the runtime animation
  15909. */
  15910. private _currentFrame;
  15911. /**
  15912. * The animation used by the runtime animation
  15913. */
  15914. private _animation;
  15915. /**
  15916. * The target of the runtime animation
  15917. */
  15918. private _target;
  15919. /**
  15920. * The initiating animatable
  15921. */
  15922. private _host;
  15923. /**
  15924. * The original value of the runtime animation
  15925. */
  15926. private _originalValue;
  15927. /**
  15928. * The original blend value of the runtime animation
  15929. */
  15930. private _originalBlendValue;
  15931. /**
  15932. * The offsets cache of the runtime animation
  15933. */
  15934. private _offsetsCache;
  15935. /**
  15936. * The high limits cache of the runtime animation
  15937. */
  15938. private _highLimitsCache;
  15939. /**
  15940. * Specifies if the runtime animation has been stopped
  15941. */
  15942. private _stopped;
  15943. /**
  15944. * The blending factor of the runtime animation
  15945. */
  15946. private _blendingFactor;
  15947. /**
  15948. * The BabylonJS scene
  15949. */
  15950. private _scene;
  15951. /**
  15952. * The current value of the runtime animation
  15953. */
  15954. private _currentValue;
  15955. /** @hidden */
  15956. _animationState: _IAnimationState;
  15957. /**
  15958. * The active target of the runtime animation
  15959. */
  15960. private _activeTargets;
  15961. private _currentActiveTarget;
  15962. private _directTarget;
  15963. /**
  15964. * The target path of the runtime animation
  15965. */
  15966. private _targetPath;
  15967. /**
  15968. * The weight of the runtime animation
  15969. */
  15970. private _weight;
  15971. /**
  15972. * The ratio offset of the runtime animation
  15973. */
  15974. private _ratioOffset;
  15975. /**
  15976. * The previous delay of the runtime animation
  15977. */
  15978. private _previousDelay;
  15979. /**
  15980. * The previous ratio of the runtime animation
  15981. */
  15982. private _previousRatio;
  15983. private _enableBlending;
  15984. private _keys;
  15985. private _minFrame;
  15986. private _maxFrame;
  15987. private _minValue;
  15988. private _maxValue;
  15989. private _targetIsArray;
  15990. /**
  15991. * Gets the current frame of the runtime animation
  15992. */
  15993. get currentFrame(): number;
  15994. /**
  15995. * Gets the weight of the runtime animation
  15996. */
  15997. get weight(): number;
  15998. /**
  15999. * Gets the current value of the runtime animation
  16000. */
  16001. get currentValue(): any;
  16002. /**
  16003. * Gets the target path of the runtime animation
  16004. */
  16005. get targetPath(): string;
  16006. /**
  16007. * Gets the actual target of the runtime animation
  16008. */
  16009. get target(): any;
  16010. /**
  16011. * Gets the additive state of the runtime animation
  16012. */
  16013. get isAdditive(): boolean;
  16014. /** @hidden */
  16015. _onLoop: () => void;
  16016. /**
  16017. * Create a new RuntimeAnimation object
  16018. * @param target defines the target of the animation
  16019. * @param animation defines the source animation object
  16020. * @param scene defines the hosting scene
  16021. * @param host defines the initiating Animatable
  16022. */
  16023. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  16024. private _preparePath;
  16025. /**
  16026. * Gets the animation from the runtime animation
  16027. */
  16028. get animation(): Animation;
  16029. /**
  16030. * Resets the runtime animation to the beginning
  16031. * @param restoreOriginal defines whether to restore the target property to the original value
  16032. */
  16033. reset(restoreOriginal?: boolean): void;
  16034. /**
  16035. * Specifies if the runtime animation is stopped
  16036. * @returns Boolean specifying if the runtime animation is stopped
  16037. */
  16038. isStopped(): boolean;
  16039. /**
  16040. * Disposes of the runtime animation
  16041. */
  16042. dispose(): void;
  16043. /**
  16044. * Apply the interpolated value to the target
  16045. * @param currentValue defines the value computed by the animation
  16046. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  16047. */
  16048. setValue(currentValue: any, weight: number): void;
  16049. private _getOriginalValues;
  16050. private _setValue;
  16051. /**
  16052. * Gets the loop pmode of the runtime animation
  16053. * @returns Loop Mode
  16054. */
  16055. private _getCorrectLoopMode;
  16056. /**
  16057. * Move the current animation to a given frame
  16058. * @param frame defines the frame to move to
  16059. */
  16060. goToFrame(frame: number): void;
  16061. /**
  16062. * @hidden Internal use only
  16063. */
  16064. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  16065. /**
  16066. * Execute the current animation
  16067. * @param delay defines the delay to add to the current frame
  16068. * @param from defines the lower bound of the animation range
  16069. * @param to defines the upper bound of the animation range
  16070. * @param loop defines if the current animation must loop
  16071. * @param speedRatio defines the current speed ratio
  16072. * @param weight defines the weight of the animation (default is -1 so no weight)
  16073. * @param onLoop optional callback called when animation loops
  16074. * @returns a boolean indicating if the animation is running
  16075. */
  16076. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  16077. }
  16078. }
  16079. declare module "babylonjs/Animations/animatable" {
  16080. import { Animation } from "babylonjs/Animations/animation";
  16081. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  16082. import { Nullable } from "babylonjs/types";
  16083. import { Observable } from "babylonjs/Misc/observable";
  16084. import { Scene } from "babylonjs/scene";
  16085. import { Matrix, Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  16086. import { Node } from "babylonjs/node";
  16087. /**
  16088. * Class used to store an actual running animation
  16089. */
  16090. export class Animatable {
  16091. /** defines the target object */
  16092. target: any;
  16093. /** defines the starting frame number (default is 0) */
  16094. fromFrame: number;
  16095. /** defines the ending frame number (default is 100) */
  16096. toFrame: number;
  16097. /** defines if the animation must loop (default is false) */
  16098. loopAnimation: boolean;
  16099. /** defines a callback to call when animation ends if it is not looping */
  16100. onAnimationEnd?: (() => void) | null | undefined;
  16101. /** defines a callback to call when animation loops */
  16102. onAnimationLoop?: (() => void) | null | undefined;
  16103. /** defines whether the animation should be evaluated additively */
  16104. isAdditive: boolean;
  16105. private _localDelayOffset;
  16106. private _pausedDelay;
  16107. private _runtimeAnimations;
  16108. private _paused;
  16109. private _scene;
  16110. private _speedRatio;
  16111. private _weight;
  16112. private _syncRoot;
  16113. /**
  16114. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  16115. * This will only apply for non looping animation (default is true)
  16116. */
  16117. disposeOnEnd: boolean;
  16118. /**
  16119. * Gets a boolean indicating if the animation has started
  16120. */
  16121. animationStarted: boolean;
  16122. /**
  16123. * Observer raised when the animation ends
  16124. */
  16125. onAnimationEndObservable: Observable<Animatable>;
  16126. /**
  16127. * Observer raised when the animation loops
  16128. */
  16129. onAnimationLoopObservable: Observable<Animatable>;
  16130. /**
  16131. * Gets the root Animatable used to synchronize and normalize animations
  16132. */
  16133. get syncRoot(): Nullable<Animatable>;
  16134. /**
  16135. * Gets the current frame of the first RuntimeAnimation
  16136. * Used to synchronize Animatables
  16137. */
  16138. get masterFrame(): number;
  16139. /**
  16140. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  16141. */
  16142. get weight(): number;
  16143. set weight(value: number);
  16144. /**
  16145. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  16146. */
  16147. get speedRatio(): number;
  16148. set speedRatio(value: number);
  16149. /**
  16150. * Creates a new Animatable
  16151. * @param scene defines the hosting scene
  16152. * @param target defines the target object
  16153. * @param fromFrame defines the starting frame number (default is 0)
  16154. * @param toFrame defines the ending frame number (default is 100)
  16155. * @param loopAnimation defines if the animation must loop (default is false)
  16156. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  16157. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  16158. * @param animations defines a group of animation to add to the new Animatable
  16159. * @param onAnimationLoop defines a callback to call when animation loops
  16160. * @param isAdditive defines whether the animation should be evaluated additively
  16161. */
  16162. constructor(scene: Scene,
  16163. /** defines the target object */
  16164. target: any,
  16165. /** defines the starting frame number (default is 0) */
  16166. fromFrame?: number,
  16167. /** defines the ending frame number (default is 100) */
  16168. toFrame?: number,
  16169. /** defines if the animation must loop (default is false) */
  16170. loopAnimation?: boolean, speedRatio?: number,
  16171. /** defines a callback to call when animation ends if it is not looping */
  16172. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  16173. /** defines a callback to call when animation loops */
  16174. onAnimationLoop?: (() => void) | null | undefined,
  16175. /** defines whether the animation should be evaluated additively */
  16176. isAdditive?: boolean);
  16177. /**
  16178. * Synchronize and normalize current Animatable with a source Animatable
  16179. * This is useful when using animation weights and when animations are not of the same length
  16180. * @param root defines the root Animatable to synchronize with
  16181. * @returns the current Animatable
  16182. */
  16183. syncWith(root: Animatable): Animatable;
  16184. /**
  16185. * Gets the list of runtime animations
  16186. * @returns an array of RuntimeAnimation
  16187. */
  16188. getAnimations(): RuntimeAnimation[];
  16189. /**
  16190. * Adds more animations to the current animatable
  16191. * @param target defines the target of the animations
  16192. * @param animations defines the new animations to add
  16193. */
  16194. appendAnimations(target: any, animations: Animation[]): void;
  16195. /**
  16196. * Gets the source animation for a specific property
  16197. * @param property defines the propertyu to look for
  16198. * @returns null or the source animation for the given property
  16199. */
  16200. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  16201. /**
  16202. * Gets the runtime animation for a specific property
  16203. * @param property defines the propertyu to look for
  16204. * @returns null or the runtime animation for the given property
  16205. */
  16206. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  16207. /**
  16208. * Resets the animatable to its original state
  16209. */
  16210. reset(): void;
  16211. /**
  16212. * Allows the animatable to blend with current running animations
  16213. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16214. * @param blendingSpeed defines the blending speed to use
  16215. */
  16216. enableBlending(blendingSpeed: number): void;
  16217. /**
  16218. * Disable animation blending
  16219. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16220. */
  16221. disableBlending(): void;
  16222. /**
  16223. * Jump directly to a given frame
  16224. * @param frame defines the frame to jump to
  16225. */
  16226. goToFrame(frame: number): void;
  16227. /**
  16228. * Pause the animation
  16229. */
  16230. pause(): void;
  16231. /**
  16232. * Restart the animation
  16233. */
  16234. restart(): void;
  16235. private _raiseOnAnimationEnd;
  16236. /**
  16237. * Stop and delete the current animation
  16238. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  16239. * @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)
  16240. */
  16241. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  16242. /**
  16243. * Wait asynchronously for the animation to end
  16244. * @returns a promise which will be fullfilled when the animation ends
  16245. */
  16246. waitAsync(): Promise<Animatable>;
  16247. /** @hidden */
  16248. _animate(delay: number): boolean;
  16249. }
  16250. module "babylonjs/scene" {
  16251. interface Scene {
  16252. /** @hidden */
  16253. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  16254. /** @hidden */
  16255. _processLateAnimationBindingsForMatrices(holder: {
  16256. totalWeight: number;
  16257. totalAdditiveWeight: number;
  16258. animations: RuntimeAnimation[];
  16259. additiveAnimations: RuntimeAnimation[];
  16260. originalValue: Matrix;
  16261. }): any;
  16262. /** @hidden */
  16263. _processLateAnimationBindingsForQuaternions(holder: {
  16264. totalWeight: number;
  16265. totalAdditiveWeight: number;
  16266. animations: RuntimeAnimation[];
  16267. additiveAnimations: RuntimeAnimation[];
  16268. originalValue: Quaternion;
  16269. }, refQuaternion: Quaternion): Quaternion;
  16270. /** @hidden */
  16271. _processLateAnimationBindings(): void;
  16272. /**
  16273. * Will start the animation sequence of a given target
  16274. * @param target defines the target
  16275. * @param from defines from which frame should animation start
  16276. * @param to defines until which frame should animation run.
  16277. * @param weight defines the weight to apply to the animation (1.0 by default)
  16278. * @param loop defines if the animation loops
  16279. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16280. * @param onAnimationEnd defines the function to be executed when the animation ends
  16281. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16282. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16283. * @param onAnimationLoop defines the callback to call when an animation loops
  16284. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16285. * @returns the animatable object created for this animation
  16286. */
  16287. 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;
  16288. /**
  16289. * Will start the animation sequence of a given target
  16290. * @param target defines the target
  16291. * @param from defines from which frame should animation start
  16292. * @param to defines until which frame should animation run.
  16293. * @param loop defines if the animation loops
  16294. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16295. * @param onAnimationEnd defines the function to be executed when the animation ends
  16296. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16297. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16298. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  16299. * @param onAnimationLoop defines the callback to call when an animation loops
  16300. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16301. * @returns the animatable object created for this animation
  16302. */
  16303. 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;
  16304. /**
  16305. * Will start the animation sequence of a given target and its hierarchy
  16306. * @param target defines the target
  16307. * @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.
  16308. * @param from defines from which frame should animation start
  16309. * @param to defines until which frame should animation run.
  16310. * @param loop defines if the animation loops
  16311. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16312. * @param onAnimationEnd defines the function to be executed when the animation ends
  16313. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16314. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16315. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16316. * @param onAnimationLoop defines the callback to call when an animation loops
  16317. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16318. * @returns the list of created animatables
  16319. */
  16320. 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[];
  16321. /**
  16322. * Begin a new animation on a given node
  16323. * @param target defines the target where the animation will take place
  16324. * @param animations defines the list of animations to start
  16325. * @param from defines the initial value
  16326. * @param to defines the final value
  16327. * @param loop defines if you want animation to loop (off by default)
  16328. * @param speedRatio defines the speed ratio to apply to all animations
  16329. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16330. * @param onAnimationLoop defines the callback to call when an animation loops
  16331. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16332. * @returns the list of created animatables
  16333. */
  16334. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16335. /**
  16336. * Begin a new animation on a given node and its hierarchy
  16337. * @param target defines the root node where the animation will take place
  16338. * @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.
  16339. * @param animations defines the list of animations to start
  16340. * @param from defines the initial value
  16341. * @param to defines the final value
  16342. * @param loop defines if you want animation to loop (off by default)
  16343. * @param speedRatio defines the speed ratio to apply to all animations
  16344. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16345. * @param onAnimationLoop defines the callback to call when an animation loops
  16346. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16347. * @returns the list of animatables created for all nodes
  16348. */
  16349. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  16350. /**
  16351. * Gets the animatable associated with a specific target
  16352. * @param target defines the target of the animatable
  16353. * @returns the required animatable if found
  16354. */
  16355. getAnimatableByTarget(target: any): Nullable<Animatable>;
  16356. /**
  16357. * Gets all animatables associated with a given target
  16358. * @param target defines the target to look animatables for
  16359. * @returns an array of Animatables
  16360. */
  16361. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  16362. /**
  16363. * Stops and removes all animations that have been applied to the scene
  16364. */
  16365. stopAllAnimations(): void;
  16366. /**
  16367. * Gets the current delta time used by animation engine
  16368. */
  16369. deltaTime: number;
  16370. }
  16371. }
  16372. module "babylonjs/Bones/bone" {
  16373. interface Bone {
  16374. /**
  16375. * Copy an animation range from another bone
  16376. * @param source defines the source bone
  16377. * @param rangeName defines the range name to copy
  16378. * @param frameOffset defines the frame offset
  16379. * @param rescaleAsRequired defines if rescaling must be applied if required
  16380. * @param skelDimensionsRatio defines the scaling ratio
  16381. * @returns true if operation was successful
  16382. */
  16383. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  16384. }
  16385. }
  16386. }
  16387. declare module "babylonjs/Bones/skeleton" {
  16388. import { Bone } from "babylonjs/Bones/bone";
  16389. import { Observable } from "babylonjs/Misc/observable";
  16390. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16391. import { Scene } from "babylonjs/scene";
  16392. import { Nullable } from "babylonjs/types";
  16393. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16394. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  16395. import { Animatable } from "babylonjs/Animations/animatable";
  16396. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  16397. import { Animation } from "babylonjs/Animations/animation";
  16398. import { AnimationRange } from "babylonjs/Animations/animationRange";
  16399. import { IInspectable } from "babylonjs/Misc/iInspectable";
  16400. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  16401. /**
  16402. * Class used to handle skinning animations
  16403. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  16404. */
  16405. export class Skeleton implements IAnimatable {
  16406. /** defines the skeleton name */
  16407. name: string;
  16408. /** defines the skeleton Id */
  16409. id: string;
  16410. /**
  16411. * Defines the list of child bones
  16412. */
  16413. bones: Bone[];
  16414. /**
  16415. * Defines an estimate of the dimension of the skeleton at rest
  16416. */
  16417. dimensionsAtRest: Vector3;
  16418. /**
  16419. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  16420. */
  16421. needInitialSkinMatrix: boolean;
  16422. /**
  16423. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  16424. */
  16425. overrideMesh: Nullable<AbstractMesh>;
  16426. /**
  16427. * Gets the list of animations attached to this skeleton
  16428. */
  16429. animations: Array<Animation>;
  16430. private _scene;
  16431. private _isDirty;
  16432. private _transformMatrices;
  16433. private _transformMatrixTexture;
  16434. private _meshesWithPoseMatrix;
  16435. private _animatables;
  16436. private _identity;
  16437. private _synchronizedWithMesh;
  16438. private _ranges;
  16439. private _lastAbsoluteTransformsUpdateId;
  16440. private _canUseTextureForBones;
  16441. private _uniqueId;
  16442. /** @hidden */
  16443. _numBonesWithLinkedTransformNode: number;
  16444. /** @hidden */
  16445. _hasWaitingData: Nullable<boolean>;
  16446. /**
  16447. * Specifies if the skeleton should be serialized
  16448. */
  16449. doNotSerialize: boolean;
  16450. private _useTextureToStoreBoneMatrices;
  16451. /**
  16452. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  16453. * Please note that this option is not available if the hardware does not support it
  16454. */
  16455. get useTextureToStoreBoneMatrices(): boolean;
  16456. set useTextureToStoreBoneMatrices(value: boolean);
  16457. private _animationPropertiesOverride;
  16458. /**
  16459. * Gets or sets the animation properties override
  16460. */
  16461. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  16462. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  16463. /**
  16464. * List of inspectable custom properties (used by the Inspector)
  16465. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  16466. */
  16467. inspectableCustomProperties: IInspectable[];
  16468. /**
  16469. * An observable triggered before computing the skeleton's matrices
  16470. */
  16471. onBeforeComputeObservable: Observable<Skeleton>;
  16472. /**
  16473. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  16474. */
  16475. get isUsingTextureForMatrices(): boolean;
  16476. /**
  16477. * Gets the unique ID of this skeleton
  16478. */
  16479. get uniqueId(): number;
  16480. /**
  16481. * Creates a new skeleton
  16482. * @param name defines the skeleton name
  16483. * @param id defines the skeleton Id
  16484. * @param scene defines the hosting scene
  16485. */
  16486. constructor(
  16487. /** defines the skeleton name */
  16488. name: string,
  16489. /** defines the skeleton Id */
  16490. id: string, scene: Scene);
  16491. /**
  16492. * Gets the current object class name.
  16493. * @return the class name
  16494. */
  16495. getClassName(): string;
  16496. /**
  16497. * Returns an array containing the root bones
  16498. * @returns an array containing the root bones
  16499. */
  16500. getChildren(): Array<Bone>;
  16501. /**
  16502. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  16503. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16504. * @returns a Float32Array containing matrices data
  16505. */
  16506. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  16507. /**
  16508. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  16509. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16510. * @returns a raw texture containing the data
  16511. */
  16512. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  16513. /**
  16514. * Gets the current hosting scene
  16515. * @returns a scene object
  16516. */
  16517. getScene(): Scene;
  16518. /**
  16519. * Gets a string representing the current skeleton data
  16520. * @param fullDetails defines a boolean indicating if we want a verbose version
  16521. * @returns a string representing the current skeleton data
  16522. */
  16523. toString(fullDetails?: boolean): string;
  16524. /**
  16525. * Get bone's index searching by name
  16526. * @param name defines bone's name to search for
  16527. * @return the indice of the bone. Returns -1 if not found
  16528. */
  16529. getBoneIndexByName(name: string): number;
  16530. /**
  16531. * Creater a new animation range
  16532. * @param name defines the name of the range
  16533. * @param from defines the start key
  16534. * @param to defines the end key
  16535. */
  16536. createAnimationRange(name: string, from: number, to: number): void;
  16537. /**
  16538. * Delete a specific animation range
  16539. * @param name defines the name of the range
  16540. * @param deleteFrames defines if frames must be removed as well
  16541. */
  16542. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  16543. /**
  16544. * Gets a specific animation range
  16545. * @param name defines the name of the range to look for
  16546. * @returns the requested animation range or null if not found
  16547. */
  16548. getAnimationRange(name: string): Nullable<AnimationRange>;
  16549. /**
  16550. * Gets the list of all animation ranges defined on this skeleton
  16551. * @returns an array
  16552. */
  16553. getAnimationRanges(): Nullable<AnimationRange>[];
  16554. /**
  16555. * Copy animation range from a source skeleton.
  16556. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  16557. * @param source defines the source skeleton
  16558. * @param name defines the name of the range to copy
  16559. * @param rescaleAsRequired defines if rescaling must be applied if required
  16560. * @returns true if operation was successful
  16561. */
  16562. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  16563. /**
  16564. * Forces the skeleton to go to rest pose
  16565. */
  16566. returnToRest(): void;
  16567. private _getHighestAnimationFrame;
  16568. /**
  16569. * Begin a specific animation range
  16570. * @param name defines the name of the range to start
  16571. * @param loop defines if looping must be turned on (false by default)
  16572. * @param speedRatio defines the speed ratio to apply (1 by default)
  16573. * @param onAnimationEnd defines a callback which will be called when animation will end
  16574. * @returns a new animatable
  16575. */
  16576. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  16577. /**
  16578. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  16579. * @param skeleton defines the Skeleton containing the animation range to convert
  16580. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  16581. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  16582. * @returns the original skeleton
  16583. */
  16584. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  16585. /** @hidden */
  16586. _markAsDirty(): void;
  16587. /** @hidden */
  16588. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16589. /** @hidden */
  16590. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16591. private _computeTransformMatrices;
  16592. /**
  16593. * Build all resources required to render a skeleton
  16594. */
  16595. prepare(): void;
  16596. /**
  16597. * Gets the list of animatables currently running for this skeleton
  16598. * @returns an array of animatables
  16599. */
  16600. getAnimatables(): IAnimatable[];
  16601. /**
  16602. * Clone the current skeleton
  16603. * @param name defines the name of the new skeleton
  16604. * @param id defines the id of the new skeleton
  16605. * @returns the new skeleton
  16606. */
  16607. clone(name: string, id?: string): Skeleton;
  16608. /**
  16609. * Enable animation blending for this skeleton
  16610. * @param blendingSpeed defines the blending speed to apply
  16611. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16612. */
  16613. enableBlending(blendingSpeed?: number): void;
  16614. /**
  16615. * Releases all resources associated with the current skeleton
  16616. */
  16617. dispose(): void;
  16618. /**
  16619. * Serialize the skeleton in a JSON object
  16620. * @returns a JSON object
  16621. */
  16622. serialize(): any;
  16623. /**
  16624. * Creates a new skeleton from serialized data
  16625. * @param parsedSkeleton defines the serialized data
  16626. * @param scene defines the hosting scene
  16627. * @returns a new skeleton
  16628. */
  16629. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  16630. /**
  16631. * Compute all node absolute transforms
  16632. * @param forceUpdate defines if computation must be done even if cache is up to date
  16633. */
  16634. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  16635. /**
  16636. * Gets the root pose matrix
  16637. * @returns a matrix
  16638. */
  16639. getPoseMatrix(): Nullable<Matrix>;
  16640. /**
  16641. * Sorts bones per internal index
  16642. */
  16643. sortBones(): void;
  16644. private _sortBones;
  16645. }
  16646. }
  16647. declare module "babylonjs/Meshes/instancedMesh" {
  16648. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  16649. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16650. import { Camera } from "babylonjs/Cameras/camera";
  16651. import { Node } from "babylonjs/node";
  16652. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16653. import { Mesh } from "babylonjs/Meshes/mesh";
  16654. import { Material } from "babylonjs/Materials/material";
  16655. import { Skeleton } from "babylonjs/Bones/skeleton";
  16656. import { Light } from "babylonjs/Lights/light";
  16657. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  16658. /**
  16659. * Creates an instance based on a source mesh.
  16660. */
  16661. export class InstancedMesh extends AbstractMesh {
  16662. private _sourceMesh;
  16663. private _currentLOD;
  16664. /** @hidden */
  16665. _indexInSourceMeshInstanceArray: number;
  16666. constructor(name: string, source: Mesh);
  16667. /**
  16668. * Returns the string "InstancedMesh".
  16669. */
  16670. getClassName(): string;
  16671. /** Gets the list of lights affecting that mesh */
  16672. get lightSources(): Light[];
  16673. _resyncLightSources(): void;
  16674. _resyncLightSource(light: Light): void;
  16675. _removeLightSource(light: Light, dispose: boolean): void;
  16676. /**
  16677. * If the source mesh receives shadows
  16678. */
  16679. get receiveShadows(): boolean;
  16680. /**
  16681. * The material of the source mesh
  16682. */
  16683. get material(): Nullable<Material>;
  16684. /**
  16685. * Visibility of the source mesh
  16686. */
  16687. get visibility(): number;
  16688. /**
  16689. * Skeleton of the source mesh
  16690. */
  16691. get skeleton(): Nullable<Skeleton>;
  16692. /**
  16693. * Rendering ground id of the source mesh
  16694. */
  16695. get renderingGroupId(): number;
  16696. set renderingGroupId(value: number);
  16697. /**
  16698. * Returns the total number of vertices (integer).
  16699. */
  16700. getTotalVertices(): number;
  16701. /**
  16702. * Returns a positive integer : the total number of indices in this mesh geometry.
  16703. * @returns the numner of indices or zero if the mesh has no geometry.
  16704. */
  16705. getTotalIndices(): number;
  16706. /**
  16707. * The source mesh of the instance
  16708. */
  16709. get sourceMesh(): Mesh;
  16710. /**
  16711. * Creates a new InstancedMesh object from the mesh model.
  16712. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  16713. * @param name defines the name of the new instance
  16714. * @returns a new InstancedMesh
  16715. */
  16716. createInstance(name: string): InstancedMesh;
  16717. /**
  16718. * Is this node ready to be used/rendered
  16719. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  16720. * @return {boolean} is it ready
  16721. */
  16722. isReady(completeCheck?: boolean): boolean;
  16723. /**
  16724. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  16725. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  16726. * @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.
  16727. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  16728. */
  16729. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  16730. /**
  16731. * Sets the vertex data of the mesh geometry for the requested `kind`.
  16732. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  16733. * The `data` are either a numeric array either a Float32Array.
  16734. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  16735. * 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).
  16736. * Note that a new underlying VertexBuffer object is created each call.
  16737. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  16738. *
  16739. * Possible `kind` values :
  16740. * - VertexBuffer.PositionKind
  16741. * - VertexBuffer.UVKind
  16742. * - VertexBuffer.UV2Kind
  16743. * - VertexBuffer.UV3Kind
  16744. * - VertexBuffer.UV4Kind
  16745. * - VertexBuffer.UV5Kind
  16746. * - VertexBuffer.UV6Kind
  16747. * - VertexBuffer.ColorKind
  16748. * - VertexBuffer.MatricesIndicesKind
  16749. * - VertexBuffer.MatricesIndicesExtraKind
  16750. * - VertexBuffer.MatricesWeightsKind
  16751. * - VertexBuffer.MatricesWeightsExtraKind
  16752. *
  16753. * Returns the Mesh.
  16754. */
  16755. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  16756. /**
  16757. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  16758. * If the mesh has no geometry, it is simply returned as it is.
  16759. * The `data` are either a numeric array either a Float32Array.
  16760. * No new underlying VertexBuffer object is created.
  16761. * 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.
  16762. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  16763. *
  16764. * Possible `kind` values :
  16765. * - VertexBuffer.PositionKind
  16766. * - VertexBuffer.UVKind
  16767. * - VertexBuffer.UV2Kind
  16768. * - VertexBuffer.UV3Kind
  16769. * - VertexBuffer.UV4Kind
  16770. * - VertexBuffer.UV5Kind
  16771. * - VertexBuffer.UV6Kind
  16772. * - VertexBuffer.ColorKind
  16773. * - VertexBuffer.MatricesIndicesKind
  16774. * - VertexBuffer.MatricesIndicesExtraKind
  16775. * - VertexBuffer.MatricesWeightsKind
  16776. * - VertexBuffer.MatricesWeightsExtraKind
  16777. *
  16778. * Returns the Mesh.
  16779. */
  16780. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  16781. /**
  16782. * Sets the mesh indices.
  16783. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  16784. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  16785. * This method creates a new index buffer each call.
  16786. * Returns the Mesh.
  16787. */
  16788. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  16789. /**
  16790. * Boolean : True if the mesh owns the requested kind of data.
  16791. */
  16792. isVerticesDataPresent(kind: string): boolean;
  16793. /**
  16794. * Returns an array of indices (IndicesArray).
  16795. */
  16796. getIndices(): Nullable<IndicesArray>;
  16797. get _positions(): Nullable<Vector3[]>;
  16798. /**
  16799. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  16800. * This means the mesh underlying bounding box and sphere are recomputed.
  16801. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  16802. * @returns the current mesh
  16803. */
  16804. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  16805. /** @hidden */
  16806. _preActivate(): InstancedMesh;
  16807. /** @hidden */
  16808. _activate(renderId: number, intermediateRendering: boolean): boolean;
  16809. /** @hidden */
  16810. _postActivate(): void;
  16811. getWorldMatrix(): Matrix;
  16812. get isAnInstance(): boolean;
  16813. /**
  16814. * Returns the current associated LOD AbstractMesh.
  16815. */
  16816. getLOD(camera: Camera): AbstractMesh;
  16817. /** @hidden */
  16818. _preActivateForIntermediateRendering(renderId: number): Mesh;
  16819. /** @hidden */
  16820. _syncSubMeshes(): InstancedMesh;
  16821. /** @hidden */
  16822. _generatePointsArray(): boolean;
  16823. /** @hidden */
  16824. _updateBoundingInfo(): AbstractMesh;
  16825. /**
  16826. * Creates a new InstancedMesh from the current mesh.
  16827. * - name (string) : the cloned mesh name
  16828. * - newParent (optional Node) : the optional Node to parent the clone to.
  16829. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  16830. *
  16831. * Returns the clone.
  16832. */
  16833. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  16834. /**
  16835. * Disposes the InstancedMesh.
  16836. * Returns nothing.
  16837. */
  16838. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  16839. }
  16840. module "babylonjs/Meshes/mesh" {
  16841. interface Mesh {
  16842. /**
  16843. * Register a custom buffer that will be instanced
  16844. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16845. * @param kind defines the buffer kind
  16846. * @param stride defines the stride in floats
  16847. */
  16848. registerInstancedBuffer(kind: string, stride: number): void;
  16849. /**
  16850. * true to use the edge renderer for all instances of this mesh
  16851. */
  16852. edgesShareWithInstances: boolean;
  16853. /** @hidden */
  16854. _userInstancedBuffersStorage: {
  16855. data: {
  16856. [key: string]: Float32Array;
  16857. };
  16858. sizes: {
  16859. [key: string]: number;
  16860. };
  16861. vertexBuffers: {
  16862. [key: string]: Nullable<VertexBuffer>;
  16863. };
  16864. strides: {
  16865. [key: string]: number;
  16866. };
  16867. };
  16868. }
  16869. }
  16870. module "babylonjs/Meshes/abstractMesh" {
  16871. interface AbstractMesh {
  16872. /**
  16873. * Object used to store instanced buffers defined by user
  16874. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16875. */
  16876. instancedBuffers: {
  16877. [key: string]: any;
  16878. };
  16879. }
  16880. }
  16881. }
  16882. declare module "babylonjs/Materials/shaderMaterial" {
  16883. import { Nullable } from "babylonjs/types";
  16884. import { Scene } from "babylonjs/scene";
  16885. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  16886. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16887. import { Mesh } from "babylonjs/Meshes/mesh";
  16888. import { SubMesh } from "babylonjs/Meshes/subMesh";
  16889. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  16890. import { Effect } from "babylonjs/Materials/effect";
  16891. import { Material } from "babylonjs/Materials/material";
  16892. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  16893. /**
  16894. * Defines the options associated with the creation of a shader material.
  16895. */
  16896. export interface IShaderMaterialOptions {
  16897. /**
  16898. * Does the material work in alpha blend mode
  16899. */
  16900. needAlphaBlending: boolean;
  16901. /**
  16902. * Does the material work in alpha test mode
  16903. */
  16904. needAlphaTesting: boolean;
  16905. /**
  16906. * The list of attribute names used in the shader
  16907. */
  16908. attributes: string[];
  16909. /**
  16910. * The list of unifrom names used in the shader
  16911. */
  16912. uniforms: string[];
  16913. /**
  16914. * The list of UBO names used in the shader
  16915. */
  16916. uniformBuffers: string[];
  16917. /**
  16918. * The list of sampler names used in the shader
  16919. */
  16920. samplers: string[];
  16921. /**
  16922. * The list of defines used in the shader
  16923. */
  16924. defines: string[];
  16925. }
  16926. /**
  16927. * 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.
  16928. *
  16929. * This returned material effects how the mesh will look based on the code in the shaders.
  16930. *
  16931. * @see https://doc.babylonjs.com/how_to/shader_material
  16932. */
  16933. export class ShaderMaterial extends Material {
  16934. private _shaderPath;
  16935. private _options;
  16936. private _textures;
  16937. private _textureArrays;
  16938. private _floats;
  16939. private _ints;
  16940. private _floatsArrays;
  16941. private _colors3;
  16942. private _colors3Arrays;
  16943. private _colors4;
  16944. private _colors4Arrays;
  16945. private _vectors2;
  16946. private _vectors3;
  16947. private _vectors4;
  16948. private _matrices;
  16949. private _matrixArrays;
  16950. private _matrices3x3;
  16951. private _matrices2x2;
  16952. private _vectors2Arrays;
  16953. private _vectors3Arrays;
  16954. private _vectors4Arrays;
  16955. private _cachedWorldViewMatrix;
  16956. private _cachedWorldViewProjectionMatrix;
  16957. private _renderId;
  16958. private _multiview;
  16959. private _cachedDefines;
  16960. /** Define the Url to load snippets */
  16961. static SnippetUrl: string;
  16962. /** Snippet ID if the material was created from the snippet server */
  16963. snippetId: string;
  16964. /**
  16965. * Instantiate a new shader material.
  16966. * 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.
  16967. * This returned material effects how the mesh will look based on the code in the shaders.
  16968. * @see https://doc.babylonjs.com/how_to/shader_material
  16969. * @param name Define the name of the material in the scene
  16970. * @param scene Define the scene the material belongs to
  16971. * @param shaderPath Defines the route to the shader code in one of three ways:
  16972. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  16973. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  16974. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  16975. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  16976. * @param options Define the options used to create the shader
  16977. */
  16978. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  16979. /**
  16980. * Gets the shader path used to define the shader code
  16981. * It can be modified to trigger a new compilation
  16982. */
  16983. get shaderPath(): any;
  16984. /**
  16985. * Sets the shader path used to define the shader code
  16986. * It can be modified to trigger a new compilation
  16987. */
  16988. set shaderPath(shaderPath: any);
  16989. /**
  16990. * Gets the options used to compile the shader.
  16991. * They can be modified to trigger a new compilation
  16992. */
  16993. get options(): IShaderMaterialOptions;
  16994. /**
  16995. * Gets the current class name of the material e.g. "ShaderMaterial"
  16996. * Mainly use in serialization.
  16997. * @returns the class name
  16998. */
  16999. getClassName(): string;
  17000. /**
  17001. * Specifies if the material will require alpha blending
  17002. * @returns a boolean specifying if alpha blending is needed
  17003. */
  17004. needAlphaBlending(): boolean;
  17005. /**
  17006. * Specifies if this material should be rendered in alpha test mode
  17007. * @returns a boolean specifying if an alpha test is needed.
  17008. */
  17009. needAlphaTesting(): boolean;
  17010. private _checkUniform;
  17011. /**
  17012. * Set a texture in the shader.
  17013. * @param name Define the name of the uniform samplers as defined in the shader
  17014. * @param texture Define the texture to bind to this sampler
  17015. * @return the material itself allowing "fluent" like uniform updates
  17016. */
  17017. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  17018. /**
  17019. * Set a texture array in the shader.
  17020. * @param name Define the name of the uniform sampler array as defined in the shader
  17021. * @param textures Define the list of textures to bind to this sampler
  17022. * @return the material itself allowing "fluent" like uniform updates
  17023. */
  17024. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  17025. /**
  17026. * Set a float in the shader.
  17027. * @param name Define the name of the uniform as defined in the shader
  17028. * @param value Define the value to give to the uniform
  17029. * @return the material itself allowing "fluent" like uniform updates
  17030. */
  17031. setFloat(name: string, value: number): ShaderMaterial;
  17032. /**
  17033. * Set a int in the shader.
  17034. * @param name Define the name of the uniform as defined in the shader
  17035. * @param value Define the value to give to the uniform
  17036. * @return the material itself allowing "fluent" like uniform updates
  17037. */
  17038. setInt(name: string, value: number): ShaderMaterial;
  17039. /**
  17040. * Set an array of floats in the shader.
  17041. * @param name Define the name of the uniform as defined in the shader
  17042. * @param value Define the value to give to the uniform
  17043. * @return the material itself allowing "fluent" like uniform updates
  17044. */
  17045. setFloats(name: string, value: number[]): ShaderMaterial;
  17046. /**
  17047. * Set a vec3 in the shader from a Color3.
  17048. * @param name Define the name of the uniform as defined in the shader
  17049. * @param value Define the value to give to the uniform
  17050. * @return the material itself allowing "fluent" like uniform updates
  17051. */
  17052. setColor3(name: string, value: Color3): ShaderMaterial;
  17053. /**
  17054. * Set a vec3 array in the shader from a Color3 array.
  17055. * @param name Define the name of the uniform as defined in the shader
  17056. * @param value Define the value to give to the uniform
  17057. * @return the material itself allowing "fluent" like uniform updates
  17058. */
  17059. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  17060. /**
  17061. * Set a vec4 in the shader from a Color4.
  17062. * @param name Define the name of the uniform as defined in the shader
  17063. * @param value Define the value to give to the uniform
  17064. * @return the material itself allowing "fluent" like uniform updates
  17065. */
  17066. setColor4(name: string, value: Color4): ShaderMaterial;
  17067. /**
  17068. * Set a vec4 array in the shader from a Color4 array.
  17069. * @param name Define the name of the uniform as defined in the shader
  17070. * @param value Define the value to give to the uniform
  17071. * @return the material itself allowing "fluent" like uniform updates
  17072. */
  17073. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  17074. /**
  17075. * Set a vec2 in the shader from a Vector2.
  17076. * @param name Define the name of the uniform as defined in the shader
  17077. * @param value Define the value to give to the uniform
  17078. * @return the material itself allowing "fluent" like uniform updates
  17079. */
  17080. setVector2(name: string, value: Vector2): ShaderMaterial;
  17081. /**
  17082. * Set a vec3 in the shader from a Vector3.
  17083. * @param name Define the name of the uniform as defined in the shader
  17084. * @param value Define the value to give to the uniform
  17085. * @return the material itself allowing "fluent" like uniform updates
  17086. */
  17087. setVector3(name: string, value: Vector3): ShaderMaterial;
  17088. /**
  17089. * Set a vec4 in the shader from a Vector4.
  17090. * @param name Define the name of the uniform as defined in the shader
  17091. * @param value Define the value to give to the uniform
  17092. * @return the material itself allowing "fluent" like uniform updates
  17093. */
  17094. setVector4(name: string, value: Vector4): ShaderMaterial;
  17095. /**
  17096. * Set a mat4 in the shader from a Matrix.
  17097. * @param name Define the name of the uniform as defined in the shader
  17098. * @param value Define the value to give to the uniform
  17099. * @return the material itself allowing "fluent" like uniform updates
  17100. */
  17101. setMatrix(name: string, value: Matrix): ShaderMaterial;
  17102. /**
  17103. * Set a float32Array in the shader from a matrix array.
  17104. * @param name Define the name of the uniform as defined in the shader
  17105. * @param value Define the value to give to the uniform
  17106. * @return the material itself allowing "fluent" like uniform updates
  17107. */
  17108. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  17109. /**
  17110. * Set a mat3 in the shader from a Float32Array.
  17111. * @param name Define the name of the uniform as defined in the shader
  17112. * @param value Define the value to give to the uniform
  17113. * @return the material itself allowing "fluent" like uniform updates
  17114. */
  17115. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  17116. /**
  17117. * Set a mat2 in the shader from a Float32Array.
  17118. * @param name Define the name of the uniform as defined in the shader
  17119. * @param value Define the value to give to the uniform
  17120. * @return the material itself allowing "fluent" like uniform updates
  17121. */
  17122. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  17123. /**
  17124. * Set a vec2 array in the shader from a number array.
  17125. * @param name Define the name of the uniform as defined in the shader
  17126. * @param value Define the value to give to the uniform
  17127. * @return the material itself allowing "fluent" like uniform updates
  17128. */
  17129. setArray2(name: string, value: number[]): ShaderMaterial;
  17130. /**
  17131. * Set a vec3 array in the shader from a number array.
  17132. * @param name Define the name of the uniform as defined in the shader
  17133. * @param value Define the value to give to the uniform
  17134. * @return the material itself allowing "fluent" like uniform updates
  17135. */
  17136. setArray3(name: string, value: number[]): ShaderMaterial;
  17137. /**
  17138. * Set a vec4 array in the shader from a number array.
  17139. * @param name Define the name of the uniform as defined in the shader
  17140. * @param value Define the value to give to the uniform
  17141. * @return the material itself allowing "fluent" like uniform updates
  17142. */
  17143. setArray4(name: string, value: number[]): ShaderMaterial;
  17144. private _checkCache;
  17145. /**
  17146. * Specifies that the submesh is ready to be used
  17147. * @param mesh defines the mesh to check
  17148. * @param subMesh defines which submesh to check
  17149. * @param useInstances specifies that instances should be used
  17150. * @returns a boolean indicating that the submesh is ready or not
  17151. */
  17152. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  17153. /**
  17154. * Checks if the material is ready to render the requested mesh
  17155. * @param mesh Define the mesh to render
  17156. * @param useInstances Define whether or not the material is used with instances
  17157. * @returns true if ready, otherwise false
  17158. */
  17159. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  17160. /**
  17161. * Binds the world matrix to the material
  17162. * @param world defines the world transformation matrix
  17163. * @param effectOverride - If provided, use this effect instead of internal effect
  17164. */
  17165. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  17166. /**
  17167. * Binds the submesh to this material by preparing the effect and shader to draw
  17168. * @param world defines the world transformation matrix
  17169. * @param mesh defines the mesh containing the submesh
  17170. * @param subMesh defines the submesh to bind the material to
  17171. */
  17172. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  17173. /**
  17174. * Binds the material to the mesh
  17175. * @param world defines the world transformation matrix
  17176. * @param mesh defines the mesh to bind the material to
  17177. * @param effectOverride - If provided, use this effect instead of internal effect
  17178. */
  17179. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  17180. protected _afterBind(mesh?: Mesh): void;
  17181. /**
  17182. * Gets the active textures from the material
  17183. * @returns an array of textures
  17184. */
  17185. getActiveTextures(): BaseTexture[];
  17186. /**
  17187. * Specifies if the material uses a texture
  17188. * @param texture defines the texture to check against the material
  17189. * @returns a boolean specifying if the material uses the texture
  17190. */
  17191. hasTexture(texture: BaseTexture): boolean;
  17192. /**
  17193. * Makes a duplicate of the material, and gives it a new name
  17194. * @param name defines the new name for the duplicated material
  17195. * @returns the cloned material
  17196. */
  17197. clone(name: string): ShaderMaterial;
  17198. /**
  17199. * Disposes the material
  17200. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  17201. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  17202. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  17203. */
  17204. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  17205. /**
  17206. * Serializes this material in a JSON representation
  17207. * @returns the serialized material object
  17208. */
  17209. serialize(): any;
  17210. /**
  17211. * Creates a shader material from parsed shader material data
  17212. * @param source defines the JSON represnetation of the material
  17213. * @param scene defines the hosting scene
  17214. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17215. * @returns a new material
  17216. */
  17217. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  17218. /**
  17219. * Creates a new ShaderMaterial from a snippet saved in a remote file
  17220. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  17221. * @param url defines the url to load from
  17222. * @param scene defines the hosting scene
  17223. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17224. * @returns a promise that will resolve to the new ShaderMaterial
  17225. */
  17226. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17227. /**
  17228. * Creates a ShaderMaterial from a snippet saved by the Inspector
  17229. * @param snippetId defines the snippet to load
  17230. * @param scene defines the hosting scene
  17231. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17232. * @returns a promise that will resolve to the new ShaderMaterial
  17233. */
  17234. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17235. }
  17236. }
  17237. declare module "babylonjs/Shaders/color.fragment" {
  17238. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  17239. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  17240. /** @hidden */
  17241. export var colorPixelShader: {
  17242. name: string;
  17243. shader: string;
  17244. };
  17245. }
  17246. declare module "babylonjs/Shaders/color.vertex" {
  17247. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  17248. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  17249. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17250. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17251. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  17252. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  17253. /** @hidden */
  17254. export var colorVertexShader: {
  17255. name: string;
  17256. shader: string;
  17257. };
  17258. }
  17259. declare module "babylonjs/Meshes/linesMesh" {
  17260. import { Nullable } from "babylonjs/types";
  17261. import { Scene } from "babylonjs/scene";
  17262. import { Color3 } from "babylonjs/Maths/math.color";
  17263. import { Node } from "babylonjs/node";
  17264. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17265. import { Mesh } from "babylonjs/Meshes/mesh";
  17266. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  17267. import { Effect } from "babylonjs/Materials/effect";
  17268. import { Material } from "babylonjs/Materials/material";
  17269. import "babylonjs/Shaders/color.fragment";
  17270. import "babylonjs/Shaders/color.vertex";
  17271. /**
  17272. * Line mesh
  17273. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  17274. */
  17275. export class LinesMesh extends Mesh {
  17276. /**
  17277. * If vertex color should be applied to the mesh
  17278. */
  17279. readonly useVertexColor?: boolean | undefined;
  17280. /**
  17281. * If vertex alpha should be applied to the mesh
  17282. */
  17283. readonly useVertexAlpha?: boolean | undefined;
  17284. /**
  17285. * Color of the line (Default: White)
  17286. */
  17287. color: Color3;
  17288. /**
  17289. * Alpha of the line (Default: 1)
  17290. */
  17291. alpha: number;
  17292. /**
  17293. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17294. * This margin is expressed in world space coordinates, so its value may vary.
  17295. * Default value is 0.1
  17296. */
  17297. intersectionThreshold: number;
  17298. private _colorShader;
  17299. private color4;
  17300. /**
  17301. * Creates a new LinesMesh
  17302. * @param name defines the name
  17303. * @param scene defines the hosting scene
  17304. * @param parent defines the parent mesh if any
  17305. * @param source defines the optional source LinesMesh used to clone data from
  17306. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  17307. * When false, achieved by calling a clone(), also passing False.
  17308. * This will make creation of children, recursive.
  17309. * @param useVertexColor defines if this LinesMesh supports vertex color
  17310. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  17311. */
  17312. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  17313. /**
  17314. * If vertex color should be applied to the mesh
  17315. */
  17316. useVertexColor?: boolean | undefined,
  17317. /**
  17318. * If vertex alpha should be applied to the mesh
  17319. */
  17320. useVertexAlpha?: boolean | undefined);
  17321. private _addClipPlaneDefine;
  17322. private _removeClipPlaneDefine;
  17323. isReady(): boolean;
  17324. /**
  17325. * Returns the string "LineMesh"
  17326. */
  17327. getClassName(): string;
  17328. /**
  17329. * @hidden
  17330. */
  17331. get material(): Material;
  17332. /**
  17333. * @hidden
  17334. */
  17335. set material(value: Material);
  17336. /**
  17337. * @hidden
  17338. */
  17339. get checkCollisions(): boolean;
  17340. /** @hidden */
  17341. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  17342. /** @hidden */
  17343. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  17344. /**
  17345. * Disposes of the line mesh
  17346. * @param doNotRecurse If children should be disposed
  17347. */
  17348. dispose(doNotRecurse?: boolean): void;
  17349. /**
  17350. * Returns a new LineMesh object cloned from the current one.
  17351. */
  17352. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  17353. /**
  17354. * Creates a new InstancedLinesMesh object from the mesh model.
  17355. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  17356. * @param name defines the name of the new instance
  17357. * @returns a new InstancedLinesMesh
  17358. */
  17359. createInstance(name: string): InstancedLinesMesh;
  17360. }
  17361. /**
  17362. * Creates an instance based on a source LinesMesh
  17363. */
  17364. export class InstancedLinesMesh extends InstancedMesh {
  17365. /**
  17366. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17367. * This margin is expressed in world space coordinates, so its value may vary.
  17368. * Initilized with the intersectionThreshold value of the source LinesMesh
  17369. */
  17370. intersectionThreshold: number;
  17371. constructor(name: string, source: LinesMesh);
  17372. /**
  17373. * Returns the string "InstancedLinesMesh".
  17374. */
  17375. getClassName(): string;
  17376. }
  17377. }
  17378. declare module "babylonjs/Shaders/line.fragment" {
  17379. /** @hidden */
  17380. export var linePixelShader: {
  17381. name: string;
  17382. shader: string;
  17383. };
  17384. }
  17385. declare module "babylonjs/Shaders/line.vertex" {
  17386. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17387. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17388. /** @hidden */
  17389. export var lineVertexShader: {
  17390. name: string;
  17391. shader: string;
  17392. };
  17393. }
  17394. declare module "babylonjs/Rendering/edgesRenderer" {
  17395. import { Nullable } from "babylonjs/types";
  17396. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  17397. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17398. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17399. import { IDisposable } from "babylonjs/scene";
  17400. import { ShaderMaterial } from "babylonjs/Materials/shaderMaterial";
  17401. import "babylonjs/Shaders/line.fragment";
  17402. import "babylonjs/Shaders/line.vertex";
  17403. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  17404. import { SmartArray } from "babylonjs/Misc/smartArray";
  17405. module "babylonjs/scene" {
  17406. interface Scene {
  17407. /** @hidden */
  17408. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  17409. }
  17410. }
  17411. module "babylonjs/Meshes/abstractMesh" {
  17412. interface AbstractMesh {
  17413. /**
  17414. * Gets the edgesRenderer associated with the mesh
  17415. */
  17416. edgesRenderer: Nullable<EdgesRenderer>;
  17417. }
  17418. }
  17419. module "babylonjs/Meshes/linesMesh" {
  17420. interface LinesMesh {
  17421. /**
  17422. * Enables the edge rendering mode on the mesh.
  17423. * This mode makes the mesh edges visible
  17424. * @param epsilon defines the maximal distance between two angles to detect a face
  17425. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17426. * @returns the currentAbstractMesh
  17427. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17428. */
  17429. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  17430. }
  17431. }
  17432. module "babylonjs/Meshes/linesMesh" {
  17433. interface InstancedLinesMesh {
  17434. /**
  17435. * Enables the edge rendering mode on the mesh.
  17436. * This mode makes the mesh edges visible
  17437. * @param epsilon defines the maximal distance between two angles to detect a face
  17438. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17439. * @returns the current InstancedLinesMesh
  17440. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17441. */
  17442. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  17443. }
  17444. }
  17445. /**
  17446. * Defines the minimum contract an Edges renderer should follow.
  17447. */
  17448. export interface IEdgesRenderer extends IDisposable {
  17449. /**
  17450. * Gets or sets a boolean indicating if the edgesRenderer is active
  17451. */
  17452. isEnabled: boolean;
  17453. /**
  17454. * Renders the edges of the attached mesh,
  17455. */
  17456. render(): void;
  17457. /**
  17458. * Checks wether or not the edges renderer is ready to render.
  17459. * @return true if ready, otherwise false.
  17460. */
  17461. isReady(): boolean;
  17462. /**
  17463. * List of instances to render in case the source mesh has instances
  17464. */
  17465. customInstances: SmartArray<Matrix>;
  17466. }
  17467. /**
  17468. * Defines the additional options of the edges renderer
  17469. */
  17470. export interface IEdgesRendererOptions {
  17471. /**
  17472. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  17473. * If not defined, the default value is true
  17474. */
  17475. useAlternateEdgeFinder?: boolean;
  17476. /**
  17477. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  17478. * If not defined, the default value is true.
  17479. * 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)
  17480. * This option is used only if useAlternateEdgeFinder = true
  17481. */
  17482. useFastVertexMerger?: boolean;
  17483. /**
  17484. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  17485. * The default value is 1e-6
  17486. * This option is used only if useAlternateEdgeFinder = true
  17487. */
  17488. epsilonVertexMerge?: number;
  17489. /**
  17490. * 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
  17491. * 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.
  17492. * This option is used only if useAlternateEdgeFinder = true
  17493. */
  17494. applyTessellation?: boolean;
  17495. /**
  17496. * 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
  17497. * The default value is 1e-6
  17498. * This option is used only if useAlternateEdgeFinder = true
  17499. */
  17500. epsilonVertexAligned?: number;
  17501. }
  17502. /**
  17503. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  17504. */
  17505. export class EdgesRenderer implements IEdgesRenderer {
  17506. /**
  17507. * Define the size of the edges with an orthographic camera
  17508. */
  17509. edgesWidthScalerForOrthographic: number;
  17510. /**
  17511. * Define the size of the edges with a perspective camera
  17512. */
  17513. edgesWidthScalerForPerspective: number;
  17514. protected _source: AbstractMesh;
  17515. protected _linesPositions: number[];
  17516. protected _linesNormals: number[];
  17517. protected _linesIndices: number[];
  17518. protected _epsilon: number;
  17519. protected _indicesCount: number;
  17520. protected _lineShader: ShaderMaterial;
  17521. protected _ib: DataBuffer;
  17522. protected _buffers: {
  17523. [key: string]: Nullable<VertexBuffer>;
  17524. };
  17525. protected _buffersForInstances: {
  17526. [key: string]: Nullable<VertexBuffer>;
  17527. };
  17528. protected _checkVerticesInsteadOfIndices: boolean;
  17529. protected _options: Nullable<IEdgesRendererOptions>;
  17530. private _meshRebuildObserver;
  17531. private _meshDisposeObserver;
  17532. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  17533. isEnabled: boolean;
  17534. /**
  17535. * List of instances to render in case the source mesh has instances
  17536. */
  17537. customInstances: SmartArray<Matrix>;
  17538. private static GetShader;
  17539. /**
  17540. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  17541. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  17542. * @param source Mesh used to create edges
  17543. * @param epsilon sum of angles in adjacency to check for edge
  17544. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  17545. * @param generateEdgesLines - should generate Lines or only prepare resources.
  17546. * @param options The options to apply when generating the edges
  17547. */
  17548. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  17549. protected _prepareRessources(): void;
  17550. /** @hidden */
  17551. _rebuild(): void;
  17552. /**
  17553. * Releases the required resources for the edges renderer
  17554. */
  17555. dispose(): void;
  17556. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  17557. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  17558. /**
  17559. * Checks if the pair of p0 and p1 is en edge
  17560. * @param faceIndex
  17561. * @param edge
  17562. * @param faceNormals
  17563. * @param p0
  17564. * @param p1
  17565. * @private
  17566. */
  17567. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  17568. /**
  17569. * push line into the position, normal and index buffer
  17570. * @protected
  17571. */
  17572. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  17573. /**
  17574. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  17575. */
  17576. private _tessellateTriangle;
  17577. private _generateEdgesLinesAlternate;
  17578. /**
  17579. * Generates lines edges from adjacencjes
  17580. * @private
  17581. */
  17582. _generateEdgesLines(): void;
  17583. /**
  17584. * Checks wether or not the edges renderer is ready to render.
  17585. * @return true if ready, otherwise false.
  17586. */
  17587. isReady(): boolean;
  17588. /**
  17589. * Renders the edges of the attached mesh,
  17590. */
  17591. render(): void;
  17592. }
  17593. /**
  17594. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  17595. */
  17596. export class LineEdgesRenderer extends EdgesRenderer {
  17597. /**
  17598. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  17599. * @param source LineMesh used to generate edges
  17600. * @param epsilon not important (specified angle for edge detection)
  17601. * @param checkVerticesInsteadOfIndices not important for LineMesh
  17602. */
  17603. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  17604. /**
  17605. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  17606. */
  17607. _generateEdgesLines(): void;
  17608. }
  17609. }
  17610. declare module "babylonjs/Rendering/renderingGroup" {
  17611. import { SmartArray, SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  17612. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17613. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17614. import { Nullable } from "babylonjs/types";
  17615. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17616. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  17617. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17618. import { Material } from "babylonjs/Materials/material";
  17619. import { Scene } from "babylonjs/scene";
  17620. /**
  17621. * This represents the object necessary to create a rendering group.
  17622. * This is exclusively used and created by the rendering manager.
  17623. * To modify the behavior, you use the available helpers in your scene or meshes.
  17624. * @hidden
  17625. */
  17626. export class RenderingGroup {
  17627. index: number;
  17628. private static _zeroVector;
  17629. private _scene;
  17630. private _opaqueSubMeshes;
  17631. private _transparentSubMeshes;
  17632. private _alphaTestSubMeshes;
  17633. private _depthOnlySubMeshes;
  17634. private _particleSystems;
  17635. private _spriteManagers;
  17636. private _opaqueSortCompareFn;
  17637. private _alphaTestSortCompareFn;
  17638. private _transparentSortCompareFn;
  17639. private _renderOpaque;
  17640. private _renderAlphaTest;
  17641. private _renderTransparent;
  17642. /** @hidden */
  17643. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  17644. onBeforeTransparentRendering: () => void;
  17645. /**
  17646. * Set the opaque sort comparison function.
  17647. * If null the sub meshes will be render in the order they were created
  17648. */
  17649. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17650. /**
  17651. * Set the alpha test sort comparison function.
  17652. * If null the sub meshes will be render in the order they were created
  17653. */
  17654. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17655. /**
  17656. * Set the transparent sort comparison function.
  17657. * If null the sub meshes will be render in the order they were created
  17658. */
  17659. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17660. /**
  17661. * Creates a new rendering group.
  17662. * @param index The rendering group index
  17663. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  17664. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  17665. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  17666. */
  17667. 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>);
  17668. /**
  17669. * Render all the sub meshes contained in the group.
  17670. * @param customRenderFunction Used to override the default render behaviour of the group.
  17671. * @returns true if rendered some submeshes.
  17672. */
  17673. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  17674. /**
  17675. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  17676. * @param subMeshes The submeshes to render
  17677. */
  17678. private renderOpaqueSorted;
  17679. /**
  17680. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  17681. * @param subMeshes The submeshes to render
  17682. */
  17683. private renderAlphaTestSorted;
  17684. /**
  17685. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  17686. * @param subMeshes The submeshes to render
  17687. */
  17688. private renderTransparentSorted;
  17689. /**
  17690. * Renders the submeshes in a specified order.
  17691. * @param subMeshes The submeshes to sort before render
  17692. * @param sortCompareFn The comparison function use to sort
  17693. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  17694. * @param transparent Specifies to activate blending if true
  17695. */
  17696. private static renderSorted;
  17697. /**
  17698. * Renders the submeshes in the order they were dispatched (no sort applied).
  17699. * @param subMeshes The submeshes to render
  17700. */
  17701. private static renderUnsorted;
  17702. /**
  17703. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17704. * are rendered back to front if in the same alpha index.
  17705. *
  17706. * @param a The first submesh
  17707. * @param b The second submesh
  17708. * @returns The result of the comparison
  17709. */
  17710. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  17711. /**
  17712. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17713. * are rendered back to front.
  17714. *
  17715. * @param a The first submesh
  17716. * @param b The second submesh
  17717. * @returns The result of the comparison
  17718. */
  17719. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  17720. /**
  17721. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17722. * are rendered front to back (prevent overdraw).
  17723. *
  17724. * @param a The first submesh
  17725. * @param b The second submesh
  17726. * @returns The result of the comparison
  17727. */
  17728. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  17729. /**
  17730. * Resets the different lists of submeshes to prepare a new frame.
  17731. */
  17732. prepare(): void;
  17733. dispose(): void;
  17734. /**
  17735. * Inserts the submesh in its correct queue depending on its material.
  17736. * @param subMesh The submesh to dispatch
  17737. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17738. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17739. */
  17740. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17741. dispatchSprites(spriteManager: ISpriteManager): void;
  17742. dispatchParticles(particleSystem: IParticleSystem): void;
  17743. private _renderParticles;
  17744. private _renderSprites;
  17745. }
  17746. }
  17747. declare module "babylonjs/Rendering/renderingManager" {
  17748. import { Nullable } from "babylonjs/types";
  17749. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17750. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17751. import { SmartArray } from "babylonjs/Misc/smartArray";
  17752. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17753. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17754. import { Material } from "babylonjs/Materials/material";
  17755. import { Scene } from "babylonjs/scene";
  17756. import { Camera } from "babylonjs/Cameras/camera";
  17757. /**
  17758. * Interface describing the different options available in the rendering manager
  17759. * regarding Auto Clear between groups.
  17760. */
  17761. export interface IRenderingManagerAutoClearSetup {
  17762. /**
  17763. * Defines whether or not autoclear is enable.
  17764. */
  17765. autoClear: boolean;
  17766. /**
  17767. * Defines whether or not to autoclear the depth buffer.
  17768. */
  17769. depth: boolean;
  17770. /**
  17771. * Defines whether or not to autoclear the stencil buffer.
  17772. */
  17773. stencil: boolean;
  17774. }
  17775. /**
  17776. * This class is used by the onRenderingGroupObservable
  17777. */
  17778. export class RenderingGroupInfo {
  17779. /**
  17780. * The Scene that being rendered
  17781. */
  17782. scene: Scene;
  17783. /**
  17784. * The camera currently used for the rendering pass
  17785. */
  17786. camera: Nullable<Camera>;
  17787. /**
  17788. * The ID of the renderingGroup being processed
  17789. */
  17790. renderingGroupId: number;
  17791. }
  17792. /**
  17793. * This is the manager responsible of all the rendering for meshes sprites and particles.
  17794. * It is enable to manage the different groups as well as the different necessary sort functions.
  17795. * This should not be used directly aside of the few static configurations
  17796. */
  17797. export class RenderingManager {
  17798. /**
  17799. * The max id used for rendering groups (not included)
  17800. */
  17801. static MAX_RENDERINGGROUPS: number;
  17802. /**
  17803. * The min id used for rendering groups (included)
  17804. */
  17805. static MIN_RENDERINGGROUPS: number;
  17806. /**
  17807. * Used to globally prevent autoclearing scenes.
  17808. */
  17809. static AUTOCLEAR: boolean;
  17810. /**
  17811. * @hidden
  17812. */
  17813. _useSceneAutoClearSetup: boolean;
  17814. private _scene;
  17815. private _renderingGroups;
  17816. private _depthStencilBufferAlreadyCleaned;
  17817. private _autoClearDepthStencil;
  17818. private _customOpaqueSortCompareFn;
  17819. private _customAlphaTestSortCompareFn;
  17820. private _customTransparentSortCompareFn;
  17821. private _renderingGroupInfo;
  17822. /**
  17823. * Instantiates a new rendering group for a particular scene
  17824. * @param scene Defines the scene the groups belongs to
  17825. */
  17826. constructor(scene: Scene);
  17827. private _clearDepthStencilBuffer;
  17828. /**
  17829. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  17830. * @hidden
  17831. */
  17832. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  17833. /**
  17834. * Resets the different information of the group to prepare a new frame
  17835. * @hidden
  17836. */
  17837. reset(): void;
  17838. /**
  17839. * Dispose and release the group and its associated resources.
  17840. * @hidden
  17841. */
  17842. dispose(): void;
  17843. /**
  17844. * Clear the info related to rendering groups preventing retention points during dispose.
  17845. */
  17846. freeRenderingGroups(): void;
  17847. private _prepareRenderingGroup;
  17848. /**
  17849. * Add a sprite manager to the rendering manager in order to render it this frame.
  17850. * @param spriteManager Define the sprite manager to render
  17851. */
  17852. dispatchSprites(spriteManager: ISpriteManager): void;
  17853. /**
  17854. * Add a particle system to the rendering manager in order to render it this frame.
  17855. * @param particleSystem Define the particle system to render
  17856. */
  17857. dispatchParticles(particleSystem: IParticleSystem): void;
  17858. /**
  17859. * Add a submesh to the manager in order to render it this frame
  17860. * @param subMesh The submesh to dispatch
  17861. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17862. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17863. */
  17864. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17865. /**
  17866. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  17867. * This allowed control for front to back rendering or reversly depending of the special needs.
  17868. *
  17869. * @param renderingGroupId The rendering group id corresponding to its index
  17870. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  17871. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  17872. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  17873. */
  17874. 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;
  17875. /**
  17876. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  17877. *
  17878. * @param renderingGroupId The rendering group id corresponding to its index
  17879. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  17880. * @param depth Automatically clears depth between groups if true and autoClear is true.
  17881. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  17882. */
  17883. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  17884. /**
  17885. * Gets the current auto clear configuration for one rendering group of the rendering
  17886. * manager.
  17887. * @param index the rendering group index to get the information for
  17888. * @returns The auto clear setup for the requested rendering group
  17889. */
  17890. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  17891. }
  17892. }
  17893. declare module "babylonjs/Lights/Shadows/shadowGenerator" {
  17894. import { SmartArray } from "babylonjs/Misc/smartArray";
  17895. import { Nullable } from "babylonjs/types";
  17896. import { Scene } from "babylonjs/scene";
  17897. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  17898. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17899. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17900. import { Mesh } from "babylonjs/Meshes/mesh";
  17901. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  17902. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  17903. import { Effect } from "babylonjs/Materials/effect";
  17904. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  17905. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  17906. import "babylonjs/Shaders/shadowMap.fragment";
  17907. import "babylonjs/Shaders/shadowMap.vertex";
  17908. import "babylonjs/Shaders/depthBoxBlur.fragment";
  17909. import "babylonjs/Shaders/ShadersInclude/shadowMapFragmentSoftTransparentShadow";
  17910. import { Observable } from "babylonjs/Misc/observable";
  17911. /**
  17912. * Defines the options associated with the creation of a custom shader for a shadow generator.
  17913. */
  17914. export interface ICustomShaderOptions {
  17915. /**
  17916. * Gets or sets the custom shader name to use
  17917. */
  17918. shaderName: string;
  17919. /**
  17920. * The list of attribute names used in the shader
  17921. */
  17922. attributes?: string[];
  17923. /**
  17924. * The list of unifrom names used in the shader
  17925. */
  17926. uniforms?: string[];
  17927. /**
  17928. * The list of sampler names used in the shader
  17929. */
  17930. samplers?: string[];
  17931. /**
  17932. * The list of defines used in the shader
  17933. */
  17934. defines?: string[];
  17935. }
  17936. /**
  17937. * Interface to implement to create a shadow generator compatible with BJS.
  17938. */
  17939. export interface IShadowGenerator {
  17940. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  17941. id: string;
  17942. /**
  17943. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  17944. * @returns The render target texture if present otherwise, null
  17945. */
  17946. getShadowMap(): Nullable<RenderTargetTexture>;
  17947. /**
  17948. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  17949. * @param subMesh The submesh we want to render in the shadow map
  17950. * @param useInstances Defines wether will draw in the map using instances
  17951. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  17952. * @returns true if ready otherwise, false
  17953. */
  17954. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  17955. /**
  17956. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  17957. * @param defines Defines of the material we want to update
  17958. * @param lightIndex Index of the light in the enabled light list of the material
  17959. */
  17960. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  17961. /**
  17962. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  17963. * defined in the generator but impacting the effect).
  17964. * It implies the unifroms available on the materials are the standard BJS ones.
  17965. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  17966. * @param effect The effect we are binfing the information for
  17967. */
  17968. bindShadowLight(lightIndex: string, effect: Effect): void;
  17969. /**
  17970. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  17971. * (eq to shadow prjection matrix * light transform matrix)
  17972. * @returns The transform matrix used to create the shadow map
  17973. */
  17974. getTransformMatrix(): Matrix;
  17975. /**
  17976. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  17977. * Cube and 2D textures for instance.
  17978. */
  17979. recreateShadowMap(): void;
  17980. /**
  17981. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  17982. * @param onCompiled Callback triggered at the and of the effects compilation
  17983. * @param options Sets of optional options forcing the compilation with different modes
  17984. */
  17985. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  17986. useInstances: boolean;
  17987. }>): void;
  17988. /**
  17989. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  17990. * @param options Sets of optional options forcing the compilation with different modes
  17991. * @returns A promise that resolves when the compilation completes
  17992. */
  17993. forceCompilationAsync(options?: Partial<{
  17994. useInstances: boolean;
  17995. }>): Promise<void>;
  17996. /**
  17997. * Serializes the shadow generator setup to a json object.
  17998. * @returns The serialized JSON object
  17999. */
  18000. serialize(): any;
  18001. /**
  18002. * Disposes the Shadow map and related Textures and effects.
  18003. */
  18004. dispose(): void;
  18005. }
  18006. /**
  18007. * Default implementation IShadowGenerator.
  18008. * This is the main object responsible of generating shadows in the framework.
  18009. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  18010. */
  18011. export class ShadowGenerator implements IShadowGenerator {
  18012. /**
  18013. * Name of the shadow generator class
  18014. */
  18015. static CLASSNAME: string;
  18016. /**
  18017. * Shadow generator mode None: no filtering applied.
  18018. */
  18019. static readonly FILTER_NONE: number;
  18020. /**
  18021. * Shadow generator mode ESM: Exponential Shadow Mapping.
  18022. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18023. */
  18024. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  18025. /**
  18026. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  18027. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  18028. */
  18029. static readonly FILTER_POISSONSAMPLING: number;
  18030. /**
  18031. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  18032. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18033. */
  18034. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  18035. /**
  18036. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  18037. * edge artifacts on steep falloff.
  18038. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18039. */
  18040. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  18041. /**
  18042. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  18043. * edge artifacts on steep falloff.
  18044. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18045. */
  18046. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  18047. /**
  18048. * Shadow generator mode PCF: Percentage Closer Filtering
  18049. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  18050. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  18051. */
  18052. static readonly FILTER_PCF: number;
  18053. /**
  18054. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  18055. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  18056. * Contact Hardening
  18057. */
  18058. static readonly FILTER_PCSS: number;
  18059. /**
  18060. * Reserved for PCF and PCSS
  18061. * Highest Quality.
  18062. *
  18063. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  18064. *
  18065. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  18066. */
  18067. static readonly QUALITY_HIGH: number;
  18068. /**
  18069. * Reserved for PCF and PCSS
  18070. * Good tradeoff for quality/perf cross devices
  18071. *
  18072. * Execute PCF on a 3*3 kernel.
  18073. *
  18074. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  18075. */
  18076. static readonly QUALITY_MEDIUM: number;
  18077. /**
  18078. * Reserved for PCF and PCSS
  18079. * The lowest quality but the fastest.
  18080. *
  18081. * Execute PCF on a 1*1 kernel.
  18082. *
  18083. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  18084. */
  18085. static readonly QUALITY_LOW: number;
  18086. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  18087. id: string;
  18088. /** Gets or sets the custom shader name to use */
  18089. customShaderOptions: ICustomShaderOptions;
  18090. /**
  18091. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  18092. */
  18093. onBeforeShadowMapRenderObservable: Observable<Effect>;
  18094. /**
  18095. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  18096. */
  18097. onAfterShadowMapRenderObservable: Observable<Effect>;
  18098. /**
  18099. * Observable triggered before a mesh is rendered in the shadow map.
  18100. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  18101. */
  18102. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  18103. /**
  18104. * Observable triggered after a mesh is rendered in the shadow map.
  18105. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  18106. */
  18107. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  18108. protected _bias: number;
  18109. /**
  18110. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  18111. */
  18112. get bias(): number;
  18113. /**
  18114. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  18115. */
  18116. set bias(bias: number);
  18117. protected _normalBias: number;
  18118. /**
  18119. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  18120. */
  18121. get normalBias(): number;
  18122. /**
  18123. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  18124. */
  18125. set normalBias(normalBias: number);
  18126. protected _blurBoxOffset: number;
  18127. /**
  18128. * Gets the blur box offset: offset applied during the blur pass.
  18129. * Only useful if useKernelBlur = false
  18130. */
  18131. get blurBoxOffset(): number;
  18132. /**
  18133. * Sets the blur box offset: offset applied during the blur pass.
  18134. * Only useful if useKernelBlur = false
  18135. */
  18136. set blurBoxOffset(value: number);
  18137. protected _blurScale: number;
  18138. /**
  18139. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  18140. * 2 means half of the size.
  18141. */
  18142. get blurScale(): number;
  18143. /**
  18144. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  18145. * 2 means half of the size.
  18146. */
  18147. set blurScale(value: number);
  18148. protected _blurKernel: number;
  18149. /**
  18150. * Gets the blur kernel: kernel size of the blur pass.
  18151. * Only useful if useKernelBlur = true
  18152. */
  18153. get blurKernel(): number;
  18154. /**
  18155. * Sets the blur kernel: kernel size of the blur pass.
  18156. * Only useful if useKernelBlur = true
  18157. */
  18158. set blurKernel(value: number);
  18159. protected _useKernelBlur: boolean;
  18160. /**
  18161. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  18162. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  18163. */
  18164. get useKernelBlur(): boolean;
  18165. /**
  18166. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  18167. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  18168. */
  18169. set useKernelBlur(value: boolean);
  18170. protected _depthScale: number;
  18171. /**
  18172. * Gets the depth scale used in ESM mode.
  18173. */
  18174. get depthScale(): number;
  18175. /**
  18176. * Sets the depth scale used in ESM mode.
  18177. * This can override the scale stored on the light.
  18178. */
  18179. set depthScale(value: number);
  18180. protected _validateFilter(filter: number): number;
  18181. protected _filter: number;
  18182. /**
  18183. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  18184. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  18185. */
  18186. get filter(): number;
  18187. /**
  18188. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  18189. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  18190. */
  18191. set filter(value: number);
  18192. /**
  18193. * Gets if the current filter is set to Poisson Sampling.
  18194. */
  18195. get usePoissonSampling(): boolean;
  18196. /**
  18197. * Sets the current filter to Poisson Sampling.
  18198. */
  18199. set usePoissonSampling(value: boolean);
  18200. /**
  18201. * Gets if the current filter is set to ESM.
  18202. */
  18203. get useExponentialShadowMap(): boolean;
  18204. /**
  18205. * Sets the current filter is to ESM.
  18206. */
  18207. set useExponentialShadowMap(value: boolean);
  18208. /**
  18209. * Gets if the current filter is set to filtered ESM.
  18210. */
  18211. get useBlurExponentialShadowMap(): boolean;
  18212. /**
  18213. * Gets if the current filter is set to filtered ESM.
  18214. */
  18215. set useBlurExponentialShadowMap(value: boolean);
  18216. /**
  18217. * Gets if the current filter is set to "close ESM" (using the inverse of the
  18218. * exponential to prevent steep falloff artifacts).
  18219. */
  18220. get useCloseExponentialShadowMap(): boolean;
  18221. /**
  18222. * Sets the current filter to "close ESM" (using the inverse of the
  18223. * exponential to prevent steep falloff artifacts).
  18224. */
  18225. set useCloseExponentialShadowMap(value: boolean);
  18226. /**
  18227. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  18228. * exponential to prevent steep falloff artifacts).
  18229. */
  18230. get useBlurCloseExponentialShadowMap(): boolean;
  18231. /**
  18232. * Sets the current filter to filtered "close ESM" (using the inverse of the
  18233. * exponential to prevent steep falloff artifacts).
  18234. */
  18235. set useBlurCloseExponentialShadowMap(value: boolean);
  18236. /**
  18237. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  18238. */
  18239. get usePercentageCloserFiltering(): boolean;
  18240. /**
  18241. * Sets the current filter to "PCF" (percentage closer filtering).
  18242. */
  18243. set usePercentageCloserFiltering(value: boolean);
  18244. protected _filteringQuality: number;
  18245. /**
  18246. * Gets the PCF or PCSS Quality.
  18247. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18248. */
  18249. get filteringQuality(): number;
  18250. /**
  18251. * Sets the PCF or PCSS Quality.
  18252. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18253. */
  18254. set filteringQuality(filteringQuality: number);
  18255. /**
  18256. * Gets if the current filter is set to "PCSS" (contact hardening).
  18257. */
  18258. get useContactHardeningShadow(): boolean;
  18259. /**
  18260. * Sets the current filter to "PCSS" (contact hardening).
  18261. */
  18262. set useContactHardeningShadow(value: boolean);
  18263. protected _contactHardeningLightSizeUVRatio: number;
  18264. /**
  18265. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18266. * Using a ratio helps keeping shape stability independently of the map size.
  18267. *
  18268. * It does not account for the light projection as it was having too much
  18269. * instability during the light setup or during light position changes.
  18270. *
  18271. * Only valid if useContactHardeningShadow is true.
  18272. */
  18273. get contactHardeningLightSizeUVRatio(): number;
  18274. /**
  18275. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18276. * Using a ratio helps keeping shape stability independently of the map size.
  18277. *
  18278. * It does not account for the light projection as it was having too much
  18279. * instability during the light setup or during light position changes.
  18280. *
  18281. * Only valid if useContactHardeningShadow is true.
  18282. */
  18283. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  18284. protected _darkness: number;
  18285. /** Gets or sets the actual darkness of a shadow */
  18286. get darkness(): number;
  18287. set darkness(value: number);
  18288. /**
  18289. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  18290. * 0 means strongest and 1 would means no shadow.
  18291. * @returns the darkness.
  18292. */
  18293. getDarkness(): number;
  18294. /**
  18295. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  18296. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  18297. * @returns the shadow generator allowing fluent coding.
  18298. */
  18299. setDarkness(darkness: number): ShadowGenerator;
  18300. protected _transparencyShadow: boolean;
  18301. /** Gets or sets the ability to have transparent shadow */
  18302. get transparencyShadow(): boolean;
  18303. set transparencyShadow(value: boolean);
  18304. /**
  18305. * Sets the ability to have transparent shadow (boolean).
  18306. * @param transparent True if transparent else False
  18307. * @returns the shadow generator allowing fluent coding
  18308. */
  18309. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  18310. /**
  18311. * Enables or disables shadows with varying strength based on the transparency
  18312. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  18313. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  18314. * mesh.visibility * alphaTexture.a
  18315. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  18316. */
  18317. enableSoftTransparentShadow: boolean;
  18318. protected _shadowMap: Nullable<RenderTargetTexture>;
  18319. protected _shadowMap2: Nullable<RenderTargetTexture>;
  18320. /**
  18321. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  18322. * @returns The render target texture if present otherwise, null
  18323. */
  18324. getShadowMap(): Nullable<RenderTargetTexture>;
  18325. /**
  18326. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  18327. * @returns The render target texture if the shadow map is present otherwise, null
  18328. */
  18329. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  18330. /**
  18331. * Gets the class name of that object
  18332. * @returns "ShadowGenerator"
  18333. */
  18334. getClassName(): string;
  18335. /**
  18336. * Helper function to add a mesh and its descendants to the list of shadow casters.
  18337. * @param mesh Mesh to add
  18338. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  18339. * @returns the Shadow Generator itself
  18340. */
  18341. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18342. /**
  18343. * Helper function to remove a mesh and its descendants from the list of shadow casters
  18344. * @param mesh Mesh to remove
  18345. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  18346. * @returns the Shadow Generator itself
  18347. */
  18348. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18349. /**
  18350. * Controls the extent to which the shadows fade out at the edge of the frustum
  18351. */
  18352. frustumEdgeFalloff: number;
  18353. protected _light: IShadowLight;
  18354. /**
  18355. * Returns the associated light object.
  18356. * @returns the light generating the shadow
  18357. */
  18358. getLight(): IShadowLight;
  18359. /**
  18360. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  18361. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  18362. * It might on the other hand introduce peter panning.
  18363. */
  18364. forceBackFacesOnly: boolean;
  18365. protected _scene: Scene;
  18366. protected _lightDirection: Vector3;
  18367. protected _effect: Effect;
  18368. protected _viewMatrix: Matrix;
  18369. protected _projectionMatrix: Matrix;
  18370. protected _transformMatrix: Matrix;
  18371. protected _cachedPosition: Vector3;
  18372. protected _cachedDirection: Vector3;
  18373. protected _cachedDefines: string;
  18374. protected _currentRenderID: number;
  18375. protected _boxBlurPostprocess: Nullable<PostProcess>;
  18376. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  18377. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  18378. protected _blurPostProcesses: PostProcess[];
  18379. protected _mapSize: number;
  18380. protected _currentFaceIndex: number;
  18381. protected _currentFaceIndexCache: number;
  18382. protected _textureType: number;
  18383. protected _defaultTextureMatrix: Matrix;
  18384. protected _storedUniqueId: Nullable<number>;
  18385. /** @hidden */
  18386. static _SceneComponentInitialization: (scene: Scene) => void;
  18387. /**
  18388. * Creates a ShadowGenerator object.
  18389. * A ShadowGenerator is the required tool to use the shadows.
  18390. * Each light casting shadows needs to use its own ShadowGenerator.
  18391. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  18392. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  18393. * @param light The light object generating the shadows.
  18394. * @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.
  18395. */
  18396. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  18397. protected _initializeGenerator(): void;
  18398. protected _createTargetRenderTexture(): void;
  18399. protected _initializeShadowMap(): void;
  18400. protected _initializeBlurRTTAndPostProcesses(): void;
  18401. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  18402. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  18403. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  18404. protected _applyFilterValues(): void;
  18405. /**
  18406. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18407. * @param onCompiled Callback triggered at the and of the effects compilation
  18408. * @param options Sets of optional options forcing the compilation with different modes
  18409. */
  18410. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  18411. useInstances: boolean;
  18412. }>): void;
  18413. /**
  18414. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18415. * @param options Sets of optional options forcing the compilation with different modes
  18416. * @returns A promise that resolves when the compilation completes
  18417. */
  18418. forceCompilationAsync(options?: Partial<{
  18419. useInstances: boolean;
  18420. }>): Promise<void>;
  18421. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  18422. private _prepareShadowDefines;
  18423. /**
  18424. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  18425. * @param subMesh The submesh we want to render in the shadow map
  18426. * @param useInstances Defines wether will draw in the map using instances
  18427. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  18428. * @returns true if ready otherwise, false
  18429. */
  18430. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  18431. /**
  18432. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  18433. * @param defines Defines of the material we want to update
  18434. * @param lightIndex Index of the light in the enabled light list of the material
  18435. */
  18436. prepareDefines(defines: any, lightIndex: number): void;
  18437. /**
  18438. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  18439. * defined in the generator but impacting the effect).
  18440. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  18441. * @param effect The effect we are binfing the information for
  18442. */
  18443. bindShadowLight(lightIndex: string, effect: Effect): void;
  18444. /**
  18445. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  18446. * (eq to shadow prjection matrix * light transform matrix)
  18447. * @returns The transform matrix used to create the shadow map
  18448. */
  18449. getTransformMatrix(): Matrix;
  18450. /**
  18451. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  18452. * Cube and 2D textures for instance.
  18453. */
  18454. recreateShadowMap(): void;
  18455. protected _disposeBlurPostProcesses(): void;
  18456. protected _disposeRTTandPostProcesses(): void;
  18457. /**
  18458. * Disposes the ShadowGenerator.
  18459. * Returns nothing.
  18460. */
  18461. dispose(): void;
  18462. /**
  18463. * Serializes the shadow generator setup to a json object.
  18464. * @returns The serialized JSON object
  18465. */
  18466. serialize(): any;
  18467. /**
  18468. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  18469. * @param parsedShadowGenerator The JSON object to parse
  18470. * @param scene The scene to create the shadow map for
  18471. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  18472. * @returns The parsed shadow generator
  18473. */
  18474. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  18475. }
  18476. }
  18477. declare module "babylonjs/Lights/light" {
  18478. import { Nullable } from "babylonjs/types";
  18479. import { Scene } from "babylonjs/scene";
  18480. import { Vector3 } from "babylonjs/Maths/math.vector";
  18481. import { Color3 } from "babylonjs/Maths/math.color";
  18482. import { Node } from "babylonjs/node";
  18483. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  18484. import { Effect } from "babylonjs/Materials/effect";
  18485. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  18486. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  18487. /**
  18488. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  18489. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  18490. * 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.
  18491. */
  18492. export abstract class Light extends Node {
  18493. /**
  18494. * Falloff Default: light is falling off following the material specification:
  18495. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  18496. */
  18497. static readonly FALLOFF_DEFAULT: number;
  18498. /**
  18499. * Falloff Physical: light is falling off following the inverse squared distance law.
  18500. */
  18501. static readonly FALLOFF_PHYSICAL: number;
  18502. /**
  18503. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  18504. * to enhance interoperability with other engines.
  18505. */
  18506. static readonly FALLOFF_GLTF: number;
  18507. /**
  18508. * Falloff Standard: light is falling off like in the standard material
  18509. * to enhance interoperability with other materials.
  18510. */
  18511. static readonly FALLOFF_STANDARD: number;
  18512. /**
  18513. * If every light affecting the material is in this lightmapMode,
  18514. * material.lightmapTexture adds or multiplies
  18515. * (depends on material.useLightmapAsShadowmap)
  18516. * after every other light calculations.
  18517. */
  18518. static readonly LIGHTMAP_DEFAULT: number;
  18519. /**
  18520. * material.lightmapTexture as only diffuse lighting from this light
  18521. * adds only specular lighting from this light
  18522. * adds dynamic shadows
  18523. */
  18524. static readonly LIGHTMAP_SPECULAR: number;
  18525. /**
  18526. * material.lightmapTexture as only lighting
  18527. * no light calculation from this light
  18528. * only adds dynamic shadows from this light
  18529. */
  18530. static readonly LIGHTMAP_SHADOWSONLY: number;
  18531. /**
  18532. * Each light type uses the default quantity according to its type:
  18533. * point/spot lights use luminous intensity
  18534. * directional lights use illuminance
  18535. */
  18536. static readonly INTENSITYMODE_AUTOMATIC: number;
  18537. /**
  18538. * lumen (lm)
  18539. */
  18540. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  18541. /**
  18542. * candela (lm/sr)
  18543. */
  18544. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  18545. /**
  18546. * lux (lm/m^2)
  18547. */
  18548. static readonly INTENSITYMODE_ILLUMINANCE: number;
  18549. /**
  18550. * nit (cd/m^2)
  18551. */
  18552. static readonly INTENSITYMODE_LUMINANCE: number;
  18553. /**
  18554. * Light type const id of the point light.
  18555. */
  18556. static readonly LIGHTTYPEID_POINTLIGHT: number;
  18557. /**
  18558. * Light type const id of the directional light.
  18559. */
  18560. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  18561. /**
  18562. * Light type const id of the spot light.
  18563. */
  18564. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  18565. /**
  18566. * Light type const id of the hemispheric light.
  18567. */
  18568. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  18569. /**
  18570. * Diffuse gives the basic color to an object.
  18571. */
  18572. diffuse: Color3;
  18573. /**
  18574. * Specular produces a highlight color on an object.
  18575. * Note: This is note affecting PBR materials.
  18576. */
  18577. specular: Color3;
  18578. /**
  18579. * Defines the falloff type for this light. This lets overrriding how punctual light are
  18580. * falling off base on range or angle.
  18581. * This can be set to any values in Light.FALLOFF_x.
  18582. *
  18583. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  18584. * other types of materials.
  18585. */
  18586. falloffType: number;
  18587. /**
  18588. * Strength of the light.
  18589. * Note: By default it is define in the framework own unit.
  18590. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  18591. */
  18592. intensity: number;
  18593. private _range;
  18594. protected _inverseSquaredRange: number;
  18595. /**
  18596. * Defines how far from the source the light is impacting in scene units.
  18597. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18598. */
  18599. get range(): number;
  18600. /**
  18601. * Defines how far from the source the light is impacting in scene units.
  18602. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18603. */
  18604. set range(value: number);
  18605. /**
  18606. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  18607. * of light.
  18608. */
  18609. private _photometricScale;
  18610. private _intensityMode;
  18611. /**
  18612. * Gets the photometric scale used to interpret the intensity.
  18613. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18614. */
  18615. get intensityMode(): number;
  18616. /**
  18617. * Sets the photometric scale used to interpret the intensity.
  18618. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18619. */
  18620. set intensityMode(value: number);
  18621. private _radius;
  18622. /**
  18623. * Gets the light radius used by PBR Materials to simulate soft area lights.
  18624. */
  18625. get radius(): number;
  18626. /**
  18627. * sets the light radius used by PBR Materials to simulate soft area lights.
  18628. */
  18629. set radius(value: number);
  18630. private _renderPriority;
  18631. /**
  18632. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  18633. * exceeding the number allowed of the materials.
  18634. */
  18635. renderPriority: number;
  18636. private _shadowEnabled;
  18637. /**
  18638. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18639. * the current shadow generator.
  18640. */
  18641. get shadowEnabled(): boolean;
  18642. /**
  18643. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18644. * the current shadow generator.
  18645. */
  18646. set shadowEnabled(value: boolean);
  18647. private _includedOnlyMeshes;
  18648. /**
  18649. * Gets the only meshes impacted by this light.
  18650. */
  18651. get includedOnlyMeshes(): AbstractMesh[];
  18652. /**
  18653. * Sets the only meshes impacted by this light.
  18654. */
  18655. set includedOnlyMeshes(value: AbstractMesh[]);
  18656. private _excludedMeshes;
  18657. /**
  18658. * Gets the meshes not impacted by this light.
  18659. */
  18660. get excludedMeshes(): AbstractMesh[];
  18661. /**
  18662. * Sets the meshes not impacted by this light.
  18663. */
  18664. set excludedMeshes(value: AbstractMesh[]);
  18665. private _excludeWithLayerMask;
  18666. /**
  18667. * Gets the layer id use to find what meshes are not impacted by the light.
  18668. * Inactive if 0
  18669. */
  18670. get excludeWithLayerMask(): number;
  18671. /**
  18672. * Sets the layer id use to find what meshes are not impacted by the light.
  18673. * Inactive if 0
  18674. */
  18675. set excludeWithLayerMask(value: number);
  18676. private _includeOnlyWithLayerMask;
  18677. /**
  18678. * Gets the layer id use to find what meshes are impacted by the light.
  18679. * Inactive if 0
  18680. */
  18681. get includeOnlyWithLayerMask(): number;
  18682. /**
  18683. * Sets the layer id use to find what meshes are impacted by the light.
  18684. * Inactive if 0
  18685. */
  18686. set includeOnlyWithLayerMask(value: number);
  18687. private _lightmapMode;
  18688. /**
  18689. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18690. */
  18691. get lightmapMode(): number;
  18692. /**
  18693. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18694. */
  18695. set lightmapMode(value: number);
  18696. /**
  18697. * Shadow generator associted to the light.
  18698. * @hidden Internal use only.
  18699. */
  18700. _shadowGenerator: Nullable<IShadowGenerator>;
  18701. /**
  18702. * @hidden Internal use only.
  18703. */
  18704. _excludedMeshesIds: string[];
  18705. /**
  18706. * @hidden Internal use only.
  18707. */
  18708. _includedOnlyMeshesIds: string[];
  18709. /**
  18710. * The current light unifom buffer.
  18711. * @hidden Internal use only.
  18712. */
  18713. _uniformBuffer: UniformBuffer;
  18714. /** @hidden */
  18715. _renderId: number;
  18716. /**
  18717. * Creates a Light object in the scene.
  18718. * Documentation : https://doc.babylonjs.com/babylon101/lights
  18719. * @param name The firendly name of the light
  18720. * @param scene The scene the light belongs too
  18721. */
  18722. constructor(name: string, scene: Scene);
  18723. protected abstract _buildUniformLayout(): void;
  18724. /**
  18725. * Sets the passed Effect "effect" with the Light information.
  18726. * @param effect The effect to update
  18727. * @param lightIndex The index of the light in the effect to update
  18728. * @returns The light
  18729. */
  18730. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  18731. /**
  18732. * Sets the passed Effect "effect" with the Light textures.
  18733. * @param effect The effect to update
  18734. * @param lightIndex The index of the light in the effect to update
  18735. * @returns The light
  18736. */
  18737. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  18738. /**
  18739. * Binds the lights information from the scene to the effect for the given mesh.
  18740. * @param lightIndex Light index
  18741. * @param scene The scene where the light belongs to
  18742. * @param effect The effect we are binding the data to
  18743. * @param useSpecular Defines if specular is supported
  18744. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  18745. */
  18746. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  18747. /**
  18748. * Sets the passed Effect "effect" with the Light information.
  18749. * @param effect The effect to update
  18750. * @param lightDataUniformName The uniform used to store light data (position or direction)
  18751. * @returns The light
  18752. */
  18753. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  18754. /**
  18755. * Returns the string "Light".
  18756. * @returns the class name
  18757. */
  18758. getClassName(): string;
  18759. /** @hidden */
  18760. readonly _isLight: boolean;
  18761. /**
  18762. * Converts the light information to a readable string for debug purpose.
  18763. * @param fullDetails Supports for multiple levels of logging within scene loading
  18764. * @returns the human readable light info
  18765. */
  18766. toString(fullDetails?: boolean): string;
  18767. /** @hidden */
  18768. protected _syncParentEnabledState(): void;
  18769. /**
  18770. * Set the enabled state of this node.
  18771. * @param value - the new enabled state
  18772. */
  18773. setEnabled(value: boolean): void;
  18774. /**
  18775. * Returns the Light associated shadow generator if any.
  18776. * @return the associated shadow generator.
  18777. */
  18778. getShadowGenerator(): Nullable<IShadowGenerator>;
  18779. /**
  18780. * Returns a Vector3, the absolute light position in the World.
  18781. * @returns the world space position of the light
  18782. */
  18783. getAbsolutePosition(): Vector3;
  18784. /**
  18785. * Specifies if the light will affect the passed mesh.
  18786. * @param mesh The mesh to test against the light
  18787. * @return true the mesh is affected otherwise, false.
  18788. */
  18789. canAffectMesh(mesh: AbstractMesh): boolean;
  18790. /**
  18791. * Sort function to order lights for rendering.
  18792. * @param a First Light object to compare to second.
  18793. * @param b Second Light object to compare first.
  18794. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  18795. */
  18796. static CompareLightsPriority(a: Light, b: Light): number;
  18797. /**
  18798. * Releases resources associated with this node.
  18799. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  18800. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  18801. */
  18802. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  18803. /**
  18804. * Returns the light type ID (integer).
  18805. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  18806. */
  18807. getTypeID(): number;
  18808. /**
  18809. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  18810. * @returns the scaled intensity in intensity mode unit
  18811. */
  18812. getScaledIntensity(): number;
  18813. /**
  18814. * Returns a new Light object, named "name", from the current one.
  18815. * @param name The name of the cloned light
  18816. * @param newParent The parent of this light, if it has one
  18817. * @returns the new created light
  18818. */
  18819. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  18820. /**
  18821. * Serializes the current light into a Serialization object.
  18822. * @returns the serialized object.
  18823. */
  18824. serialize(): any;
  18825. /**
  18826. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  18827. * This new light is named "name" and added to the passed scene.
  18828. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  18829. * @param name The friendly name of the light
  18830. * @param scene The scene the new light will belong to
  18831. * @returns the constructor function
  18832. */
  18833. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  18834. /**
  18835. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  18836. * @param parsedLight The JSON representation of the light
  18837. * @param scene The scene to create the parsed light in
  18838. * @returns the created light after parsing
  18839. */
  18840. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  18841. private _hookArrayForExcluded;
  18842. private _hookArrayForIncludedOnly;
  18843. private _resyncMeshes;
  18844. /**
  18845. * Forces the meshes to update their light related information in their rendering used effects
  18846. * @hidden Internal Use Only
  18847. */
  18848. _markMeshesAsLightDirty(): void;
  18849. /**
  18850. * Recomputes the cached photometric scale if needed.
  18851. */
  18852. private _computePhotometricScale;
  18853. /**
  18854. * Returns the Photometric Scale according to the light type and intensity mode.
  18855. */
  18856. private _getPhotometricScale;
  18857. /**
  18858. * Reorder the light in the scene according to their defined priority.
  18859. * @hidden Internal Use Only
  18860. */
  18861. _reorderLightsInScene(): void;
  18862. /**
  18863. * Prepares the list of defines specific to the light type.
  18864. * @param defines the list of defines
  18865. * @param lightIndex defines the index of the light for the effect
  18866. */
  18867. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  18868. }
  18869. }
  18870. declare module "babylonjs/Cameras/targetCamera" {
  18871. import { Nullable } from "babylonjs/types";
  18872. import { Camera } from "babylonjs/Cameras/camera";
  18873. import { Scene } from "babylonjs/scene";
  18874. import { Quaternion, Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  18875. /**
  18876. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  18877. * This is the base of the follow, arc rotate cameras and Free camera
  18878. * @see https://doc.babylonjs.com/features/cameras
  18879. */
  18880. export class TargetCamera extends Camera {
  18881. private static _RigCamTransformMatrix;
  18882. private static _TargetTransformMatrix;
  18883. private static _TargetFocalPoint;
  18884. private _tmpUpVector;
  18885. private _tmpTargetVector;
  18886. /**
  18887. * Define the current direction the camera is moving to
  18888. */
  18889. cameraDirection: Vector3;
  18890. /**
  18891. * Define the current rotation the camera is rotating to
  18892. */
  18893. cameraRotation: Vector2;
  18894. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  18895. ignoreParentScaling: boolean;
  18896. /**
  18897. * When set, the up vector of the camera will be updated by the rotation of the camera
  18898. */
  18899. updateUpVectorFromRotation: boolean;
  18900. private _tmpQuaternion;
  18901. /**
  18902. * Define the current rotation of the camera
  18903. */
  18904. rotation: Vector3;
  18905. /**
  18906. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  18907. */
  18908. rotationQuaternion: Quaternion;
  18909. /**
  18910. * Define the current speed of the camera
  18911. */
  18912. speed: number;
  18913. /**
  18914. * Add constraint to the camera to prevent it to move freely in all directions and
  18915. * around all axis.
  18916. */
  18917. noRotationConstraint: boolean;
  18918. /**
  18919. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  18920. * panning
  18921. */
  18922. invertRotation: boolean;
  18923. /**
  18924. * Speed multiplier for inverse camera panning
  18925. */
  18926. inverseRotationSpeed: number;
  18927. /**
  18928. * Define the current target of the camera as an object or a position.
  18929. */
  18930. lockedTarget: any;
  18931. /** @hidden */
  18932. _currentTarget: Vector3;
  18933. /** @hidden */
  18934. _initialFocalDistance: number;
  18935. /** @hidden */
  18936. _viewMatrix: Matrix;
  18937. /** @hidden */
  18938. _camMatrix: Matrix;
  18939. /** @hidden */
  18940. _cameraTransformMatrix: Matrix;
  18941. /** @hidden */
  18942. _cameraRotationMatrix: Matrix;
  18943. /** @hidden */
  18944. _referencePoint: Vector3;
  18945. /** @hidden */
  18946. _transformedReferencePoint: Vector3;
  18947. /** @hidden */
  18948. _reset: () => void;
  18949. private _defaultUp;
  18950. /**
  18951. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  18952. * This is the base of the follow, arc rotate cameras and Free camera
  18953. * @see https://doc.babylonjs.com/features/cameras
  18954. * @param name Defines the name of the camera in the scene
  18955. * @param position Defines the start position of the camera in the scene
  18956. * @param scene Defines the scene the camera belongs to
  18957. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  18958. */
  18959. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  18960. /**
  18961. * Gets the position in front of the camera at a given distance.
  18962. * @param distance The distance from the camera we want the position to be
  18963. * @returns the position
  18964. */
  18965. getFrontPosition(distance: number): Vector3;
  18966. /** @hidden */
  18967. _getLockedTargetPosition(): Nullable<Vector3>;
  18968. private _storedPosition;
  18969. private _storedRotation;
  18970. private _storedRotationQuaternion;
  18971. /**
  18972. * Store current camera state of the camera (fov, position, rotation, etc..)
  18973. * @returns the camera
  18974. */
  18975. storeState(): Camera;
  18976. /**
  18977. * Restored camera state. You must call storeState() first
  18978. * @returns whether it was successful or not
  18979. * @hidden
  18980. */
  18981. _restoreStateValues(): boolean;
  18982. /** @hidden */
  18983. _initCache(): void;
  18984. /** @hidden */
  18985. _updateCache(ignoreParentClass?: boolean): void;
  18986. /** @hidden */
  18987. _isSynchronizedViewMatrix(): boolean;
  18988. /** @hidden */
  18989. _computeLocalCameraSpeed(): number;
  18990. /**
  18991. * Defines the target the camera should look at.
  18992. * @param target Defines the new target as a Vector or a mesh
  18993. */
  18994. setTarget(target: Vector3): void;
  18995. /**
  18996. * Defines the target point of the camera.
  18997. * The camera looks towards it form the radius distance.
  18998. */
  18999. get target(): Vector3;
  19000. set target(value: Vector3);
  19001. /**
  19002. * Return the current target position of the camera. This value is expressed in local space.
  19003. * @returns the target position
  19004. */
  19005. getTarget(): Vector3;
  19006. /** @hidden */
  19007. _decideIfNeedsToMove(): boolean;
  19008. /** @hidden */
  19009. _updatePosition(): void;
  19010. /** @hidden */
  19011. _checkInputs(): void;
  19012. protected _updateCameraRotationMatrix(): void;
  19013. /**
  19014. * 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)
  19015. * @returns the current camera
  19016. */
  19017. private _rotateUpVectorWithCameraRotationMatrix;
  19018. private _cachedRotationZ;
  19019. private _cachedQuaternionRotationZ;
  19020. /** @hidden */
  19021. _getViewMatrix(): Matrix;
  19022. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  19023. /**
  19024. * @hidden
  19025. */
  19026. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  19027. /**
  19028. * @hidden
  19029. */
  19030. _updateRigCameras(): void;
  19031. private _getRigCamPositionAndTarget;
  19032. /**
  19033. * Gets the current object class name.
  19034. * @return the class name
  19035. */
  19036. getClassName(): string;
  19037. }
  19038. }
  19039. declare module "babylonjs/Events/keyboardEvents" {
  19040. /**
  19041. * Gather the list of keyboard event types as constants.
  19042. */
  19043. export class KeyboardEventTypes {
  19044. /**
  19045. * The keydown event is fired when a key becomes active (pressed).
  19046. */
  19047. static readonly KEYDOWN: number;
  19048. /**
  19049. * The keyup event is fired when a key has been released.
  19050. */
  19051. static readonly KEYUP: number;
  19052. }
  19053. /**
  19054. * This class is used to store keyboard related info for the onKeyboardObservable event.
  19055. */
  19056. export class KeyboardInfo {
  19057. /**
  19058. * Defines the type of event (KeyboardEventTypes)
  19059. */
  19060. type: number;
  19061. /**
  19062. * Defines the related dom event
  19063. */
  19064. event: KeyboardEvent;
  19065. /**
  19066. * Instantiates a new keyboard info.
  19067. * This class is used to store keyboard related info for the onKeyboardObservable event.
  19068. * @param type Defines the type of event (KeyboardEventTypes)
  19069. * @param event Defines the related dom event
  19070. */
  19071. constructor(
  19072. /**
  19073. * Defines the type of event (KeyboardEventTypes)
  19074. */
  19075. type: number,
  19076. /**
  19077. * Defines the related dom event
  19078. */
  19079. event: KeyboardEvent);
  19080. }
  19081. /**
  19082. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  19083. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  19084. */
  19085. export class KeyboardInfoPre extends KeyboardInfo {
  19086. /**
  19087. * Defines the type of event (KeyboardEventTypes)
  19088. */
  19089. type: number;
  19090. /**
  19091. * Defines the related dom event
  19092. */
  19093. event: KeyboardEvent;
  19094. /**
  19095. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  19096. */
  19097. skipOnPointerObservable: boolean;
  19098. /**
  19099. * Instantiates a new keyboard pre info.
  19100. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  19101. * @param type Defines the type of event (KeyboardEventTypes)
  19102. * @param event Defines the related dom event
  19103. */
  19104. constructor(
  19105. /**
  19106. * Defines the type of event (KeyboardEventTypes)
  19107. */
  19108. type: number,
  19109. /**
  19110. * Defines the related dom event
  19111. */
  19112. event: KeyboardEvent);
  19113. }
  19114. }
  19115. declare module "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput" {
  19116. import { Nullable } from "babylonjs/types";
  19117. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19118. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19119. /**
  19120. * Manage the keyboard inputs to control the movement of a free camera.
  19121. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19122. */
  19123. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  19124. /**
  19125. * Defines the camera the input is attached to.
  19126. */
  19127. camera: FreeCamera;
  19128. /**
  19129. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  19130. */
  19131. keysUp: number[];
  19132. /**
  19133. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  19134. */
  19135. keysUpward: number[];
  19136. /**
  19137. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  19138. */
  19139. keysDown: number[];
  19140. /**
  19141. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  19142. */
  19143. keysDownward: number[];
  19144. /**
  19145. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  19146. */
  19147. keysLeft: number[];
  19148. /**
  19149. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  19150. */
  19151. keysRight: number[];
  19152. private _keys;
  19153. private _onCanvasBlurObserver;
  19154. private _onKeyboardObserver;
  19155. private _engine;
  19156. private _scene;
  19157. /**
  19158. * Attach the input controls to a specific dom element to get the input from.
  19159. * @param element Defines the element the controls should be listened from
  19160. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19161. */
  19162. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19163. /**
  19164. * Detach the current controls from the specified dom element.
  19165. * @param element Defines the element to stop listening the inputs from
  19166. */
  19167. detachControl(element: Nullable<HTMLElement>): void;
  19168. /**
  19169. * Update the current camera state depending on the inputs that have been used this frame.
  19170. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19171. */
  19172. checkInputs(): void;
  19173. /**
  19174. * Gets the class name of the current intput.
  19175. * @returns the class name
  19176. */
  19177. getClassName(): string;
  19178. /** @hidden */
  19179. _onLostFocus(): void;
  19180. /**
  19181. * Get the friendly name associated with the input class.
  19182. * @returns the input friendly name
  19183. */
  19184. getSimpleName(): string;
  19185. }
  19186. }
  19187. declare module "babylonjs/Events/pointerEvents" {
  19188. import { Nullable } from "babylonjs/types";
  19189. import { Vector2 } from "babylonjs/Maths/math.vector";
  19190. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  19191. import { Ray } from "babylonjs/Culling/ray";
  19192. /**
  19193. * Gather the list of pointer event types as constants.
  19194. */
  19195. export class PointerEventTypes {
  19196. /**
  19197. * 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.
  19198. */
  19199. static readonly POINTERDOWN: number;
  19200. /**
  19201. * The pointerup event is fired when a pointer is no longer active.
  19202. */
  19203. static readonly POINTERUP: number;
  19204. /**
  19205. * The pointermove event is fired when a pointer changes coordinates.
  19206. */
  19207. static readonly POINTERMOVE: number;
  19208. /**
  19209. * The pointerwheel event is fired when a mouse wheel has been rotated.
  19210. */
  19211. static readonly POINTERWHEEL: number;
  19212. /**
  19213. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  19214. */
  19215. static readonly POINTERPICK: number;
  19216. /**
  19217. * The pointertap event is fired when a the object has been touched and released without drag.
  19218. */
  19219. static readonly POINTERTAP: number;
  19220. /**
  19221. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  19222. */
  19223. static readonly POINTERDOUBLETAP: number;
  19224. }
  19225. /**
  19226. * Base class of pointer info types.
  19227. */
  19228. export class PointerInfoBase {
  19229. /**
  19230. * Defines the type of event (PointerEventTypes)
  19231. */
  19232. type: number;
  19233. /**
  19234. * Defines the related dom event
  19235. */
  19236. event: PointerEvent | MouseWheelEvent;
  19237. /**
  19238. * Instantiates the base class of pointers info.
  19239. * @param type Defines the type of event (PointerEventTypes)
  19240. * @param event Defines the related dom event
  19241. */
  19242. constructor(
  19243. /**
  19244. * Defines the type of event (PointerEventTypes)
  19245. */
  19246. type: number,
  19247. /**
  19248. * Defines the related dom event
  19249. */
  19250. event: PointerEvent | MouseWheelEvent);
  19251. }
  19252. /**
  19253. * This class is used to store pointer related info for the onPrePointerObservable event.
  19254. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  19255. */
  19256. export class PointerInfoPre extends PointerInfoBase {
  19257. /**
  19258. * Ray from a pointer if availible (eg. 6dof controller)
  19259. */
  19260. ray: Nullable<Ray>;
  19261. /**
  19262. * Defines the local position of the pointer on the canvas.
  19263. */
  19264. localPosition: Vector2;
  19265. /**
  19266. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  19267. */
  19268. skipOnPointerObservable: boolean;
  19269. /**
  19270. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  19271. * @param type Defines the type of event (PointerEventTypes)
  19272. * @param event Defines the related dom event
  19273. * @param localX Defines the local x coordinates of the pointer when the event occured
  19274. * @param localY Defines the local y coordinates of the pointer when the event occured
  19275. */
  19276. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  19277. }
  19278. /**
  19279. * This type contains all the data related to a pointer event in Babylon.js.
  19280. * 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.
  19281. */
  19282. export class PointerInfo extends PointerInfoBase {
  19283. /**
  19284. * Defines the picking info associated to the info (if any)\
  19285. */
  19286. pickInfo: Nullable<PickingInfo>;
  19287. /**
  19288. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  19289. * @param type Defines the type of event (PointerEventTypes)
  19290. * @param event Defines the related dom event
  19291. * @param pickInfo Defines the picking info associated to the info (if any)\
  19292. */
  19293. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  19294. /**
  19295. * Defines the picking info associated to the info (if any)\
  19296. */
  19297. pickInfo: Nullable<PickingInfo>);
  19298. }
  19299. /**
  19300. * Data relating to a touch event on the screen.
  19301. */
  19302. export interface PointerTouch {
  19303. /**
  19304. * X coordinate of touch.
  19305. */
  19306. x: number;
  19307. /**
  19308. * Y coordinate of touch.
  19309. */
  19310. y: number;
  19311. /**
  19312. * Id of touch. Unique for each finger.
  19313. */
  19314. pointerId: number;
  19315. /**
  19316. * Event type passed from DOM.
  19317. */
  19318. type: any;
  19319. }
  19320. }
  19321. declare module "babylonjs/Cameras/Inputs/freeCameraMouseInput" {
  19322. import { Observable } from "babylonjs/Misc/observable";
  19323. import { Nullable } from "babylonjs/types";
  19324. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19325. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19326. /**
  19327. * Manage the mouse inputs to control the movement of a free camera.
  19328. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19329. */
  19330. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  19331. /**
  19332. * Define if touch is enabled in the mouse input
  19333. */
  19334. touchEnabled: boolean;
  19335. /**
  19336. * Defines the camera the input is attached to.
  19337. */
  19338. camera: FreeCamera;
  19339. /**
  19340. * Defines the buttons associated with the input to handle camera move.
  19341. */
  19342. buttons: number[];
  19343. /**
  19344. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  19345. */
  19346. angularSensibility: number;
  19347. private _pointerInput;
  19348. private _onMouseMove;
  19349. private _observer;
  19350. private previousPosition;
  19351. /**
  19352. * Observable for when a pointer move event occurs containing the move offset
  19353. */
  19354. onPointerMovedObservable: Observable<{
  19355. offsetX: number;
  19356. offsetY: number;
  19357. }>;
  19358. /**
  19359. * @hidden
  19360. * If the camera should be rotated automatically based on pointer movement
  19361. */
  19362. _allowCameraRotation: boolean;
  19363. /**
  19364. * Manage the mouse inputs to control the movement of a free camera.
  19365. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19366. * @param touchEnabled Defines if touch is enabled or not
  19367. */
  19368. constructor(
  19369. /**
  19370. * Define if touch is enabled in the mouse input
  19371. */
  19372. touchEnabled?: boolean);
  19373. /**
  19374. * Attach the input controls to a specific dom element to get the input from.
  19375. * @param element Defines the element the controls should be listened from
  19376. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19377. */
  19378. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19379. /**
  19380. * Called on JS contextmenu event.
  19381. * Override this method to provide functionality.
  19382. */
  19383. protected onContextMenu(evt: PointerEvent): void;
  19384. /**
  19385. * Detach the current controls from the specified dom element.
  19386. * @param element Defines the element to stop listening the inputs from
  19387. */
  19388. detachControl(element: Nullable<HTMLElement>): void;
  19389. /**
  19390. * Gets the class name of the current intput.
  19391. * @returns the class name
  19392. */
  19393. getClassName(): string;
  19394. /**
  19395. * Get the friendly name associated with the input class.
  19396. * @returns the input friendly name
  19397. */
  19398. getSimpleName(): string;
  19399. }
  19400. }
  19401. declare module "babylonjs/Cameras/Inputs/freeCameraTouchInput" {
  19402. import { Nullable } from "babylonjs/types";
  19403. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19404. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19405. /**
  19406. * Manage the touch inputs to control the movement of a free camera.
  19407. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19408. */
  19409. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  19410. /**
  19411. * Define if mouse events can be treated as touch events
  19412. */
  19413. allowMouse: boolean;
  19414. /**
  19415. * Defines the camera the input is attached to.
  19416. */
  19417. camera: FreeCamera;
  19418. /**
  19419. * Defines the touch sensibility for rotation.
  19420. * The higher the faster.
  19421. */
  19422. touchAngularSensibility: number;
  19423. /**
  19424. * Defines the touch sensibility for move.
  19425. * The higher the faster.
  19426. */
  19427. touchMoveSensibility: number;
  19428. private _offsetX;
  19429. private _offsetY;
  19430. private _pointerPressed;
  19431. private _pointerInput;
  19432. private _observer;
  19433. private _onLostFocus;
  19434. /**
  19435. * Manage the touch inputs to control the movement of a free camera.
  19436. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19437. * @param allowMouse Defines if mouse events can be treated as touch events
  19438. */
  19439. constructor(
  19440. /**
  19441. * Define if mouse events can be treated as touch events
  19442. */
  19443. allowMouse?: boolean);
  19444. /**
  19445. * Attach the input controls to a specific dom element to get the input from.
  19446. * @param element Defines the element the controls should be listened from
  19447. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19448. */
  19449. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19450. /**
  19451. * Detach the current controls from the specified dom element.
  19452. * @param element Defines the element to stop listening the inputs from
  19453. */
  19454. detachControl(element: Nullable<HTMLElement>): void;
  19455. /**
  19456. * Update the current camera state depending on the inputs that have been used this frame.
  19457. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19458. */
  19459. checkInputs(): void;
  19460. /**
  19461. * Gets the class name of the current intput.
  19462. * @returns the class name
  19463. */
  19464. getClassName(): string;
  19465. /**
  19466. * Get the friendly name associated with the input class.
  19467. * @returns the input friendly name
  19468. */
  19469. getSimpleName(): string;
  19470. }
  19471. }
  19472. declare module "babylonjs/Cameras/freeCameraInputsManager" {
  19473. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19474. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  19475. import { FreeCameraMouseInput } from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  19476. import { Nullable } from "babylonjs/types";
  19477. /**
  19478. * Default Inputs manager for the FreeCamera.
  19479. * It groups all the default supported inputs for ease of use.
  19480. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19481. */
  19482. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  19483. /**
  19484. * @hidden
  19485. */
  19486. _mouseInput: Nullable<FreeCameraMouseInput>;
  19487. /**
  19488. * Instantiates a new FreeCameraInputsManager.
  19489. * @param camera Defines the camera the inputs belong to
  19490. */
  19491. constructor(camera: FreeCamera);
  19492. /**
  19493. * Add keyboard input support to the input manager.
  19494. * @returns the current input manager
  19495. */
  19496. addKeyboard(): FreeCameraInputsManager;
  19497. /**
  19498. * Add mouse input support to the input manager.
  19499. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  19500. * @returns the current input manager
  19501. */
  19502. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  19503. /**
  19504. * Removes the mouse input support from the manager
  19505. * @returns the current input manager
  19506. */
  19507. removeMouse(): FreeCameraInputsManager;
  19508. /**
  19509. * Add touch input support to the input manager.
  19510. * @returns the current input manager
  19511. */
  19512. addTouch(): FreeCameraInputsManager;
  19513. /**
  19514. * Remove all attached input methods from a camera
  19515. */
  19516. clear(): void;
  19517. }
  19518. }
  19519. declare module "babylonjs/Cameras/freeCamera" {
  19520. import { Vector3 } from "babylonjs/Maths/math.vector";
  19521. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19522. import { Scene } from "babylonjs/scene";
  19523. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19524. import { FreeCameraInputsManager } from "babylonjs/Cameras/freeCameraInputsManager";
  19525. /**
  19526. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19527. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  19528. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19529. */
  19530. export class FreeCamera extends TargetCamera {
  19531. /**
  19532. * Define the collision ellipsoid of the camera.
  19533. * This is helpful to simulate a camera body like the player body around the camera
  19534. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  19535. */
  19536. ellipsoid: Vector3;
  19537. /**
  19538. * Define an offset for the position of the ellipsoid around the camera.
  19539. * This can be helpful to determine the center of the body near the gravity center of the body
  19540. * instead of its head.
  19541. */
  19542. ellipsoidOffset: Vector3;
  19543. /**
  19544. * Enable or disable collisions of the camera with the rest of the scene objects.
  19545. */
  19546. checkCollisions: boolean;
  19547. /**
  19548. * Enable or disable gravity on the camera.
  19549. */
  19550. applyGravity: boolean;
  19551. /**
  19552. * Define the input manager associated to the camera.
  19553. */
  19554. inputs: FreeCameraInputsManager;
  19555. /**
  19556. * Gets the input sensibility for a mouse input. (default is 2000.0)
  19557. * Higher values reduce sensitivity.
  19558. */
  19559. get angularSensibility(): number;
  19560. /**
  19561. * Sets the input sensibility for a mouse input. (default is 2000.0)
  19562. * Higher values reduce sensitivity.
  19563. */
  19564. set angularSensibility(value: number);
  19565. /**
  19566. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  19567. */
  19568. get keysUp(): number[];
  19569. set keysUp(value: number[]);
  19570. /**
  19571. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  19572. */
  19573. get keysUpward(): number[];
  19574. set keysUpward(value: number[]);
  19575. /**
  19576. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  19577. */
  19578. get keysDown(): number[];
  19579. set keysDown(value: number[]);
  19580. /**
  19581. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  19582. */
  19583. get keysDownward(): number[];
  19584. set keysDownward(value: number[]);
  19585. /**
  19586. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  19587. */
  19588. get keysLeft(): number[];
  19589. set keysLeft(value: number[]);
  19590. /**
  19591. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  19592. */
  19593. get keysRight(): number[];
  19594. set keysRight(value: number[]);
  19595. /**
  19596. * Event raised when the camera collide with a mesh in the scene.
  19597. */
  19598. onCollide: (collidedMesh: AbstractMesh) => void;
  19599. private _collider;
  19600. private _needMoveForGravity;
  19601. private _oldPosition;
  19602. private _diffPosition;
  19603. private _newPosition;
  19604. /** @hidden */
  19605. _localDirection: Vector3;
  19606. /** @hidden */
  19607. _transformedDirection: Vector3;
  19608. /**
  19609. * Instantiates a Free Camera.
  19610. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19611. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  19612. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19613. * @param name Define the name of the camera in the scene
  19614. * @param position Define the start position of the camera in the scene
  19615. * @param scene Define the scene the camera belongs to
  19616. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  19617. */
  19618. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  19619. /**
  19620. * Attached controls to the current camera.
  19621. * @param element Defines the element the controls should be listened from
  19622. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19623. */
  19624. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19625. /**
  19626. * Detach the current controls from the camera.
  19627. * The camera will stop reacting to inputs.
  19628. * @param element Defines the element to stop listening the inputs from
  19629. */
  19630. detachControl(element: HTMLElement): void;
  19631. private _collisionMask;
  19632. /**
  19633. * Define a collision mask to limit the list of object the camera can collide with
  19634. */
  19635. get collisionMask(): number;
  19636. set collisionMask(mask: number);
  19637. /** @hidden */
  19638. _collideWithWorld(displacement: Vector3): void;
  19639. private _onCollisionPositionChange;
  19640. /** @hidden */
  19641. _checkInputs(): void;
  19642. /** @hidden */
  19643. _decideIfNeedsToMove(): boolean;
  19644. /** @hidden */
  19645. _updatePosition(): void;
  19646. /**
  19647. * Destroy the camera and release the current resources hold by it.
  19648. */
  19649. dispose(): void;
  19650. /**
  19651. * Gets the current object class name.
  19652. * @return the class name
  19653. */
  19654. getClassName(): string;
  19655. }
  19656. }
  19657. declare module "babylonjs/Gamepads/gamepad" {
  19658. import { Observable } from "babylonjs/Misc/observable";
  19659. /**
  19660. * Represents a gamepad control stick position
  19661. */
  19662. export class StickValues {
  19663. /**
  19664. * The x component of the control stick
  19665. */
  19666. x: number;
  19667. /**
  19668. * The y component of the control stick
  19669. */
  19670. y: number;
  19671. /**
  19672. * Initializes the gamepad x and y control stick values
  19673. * @param x The x component of the gamepad control stick value
  19674. * @param y The y component of the gamepad control stick value
  19675. */
  19676. constructor(
  19677. /**
  19678. * The x component of the control stick
  19679. */
  19680. x: number,
  19681. /**
  19682. * The y component of the control stick
  19683. */
  19684. y: number);
  19685. }
  19686. /**
  19687. * An interface which manages callbacks for gamepad button changes
  19688. */
  19689. export interface GamepadButtonChanges {
  19690. /**
  19691. * Called when a gamepad has been changed
  19692. */
  19693. changed: boolean;
  19694. /**
  19695. * Called when a gamepad press event has been triggered
  19696. */
  19697. pressChanged: boolean;
  19698. /**
  19699. * Called when a touch event has been triggered
  19700. */
  19701. touchChanged: boolean;
  19702. /**
  19703. * Called when a value has changed
  19704. */
  19705. valueChanged: boolean;
  19706. }
  19707. /**
  19708. * Represents a gamepad
  19709. */
  19710. export class Gamepad {
  19711. /**
  19712. * The id of the gamepad
  19713. */
  19714. id: string;
  19715. /**
  19716. * The index of the gamepad
  19717. */
  19718. index: number;
  19719. /**
  19720. * The browser gamepad
  19721. */
  19722. browserGamepad: any;
  19723. /**
  19724. * Specifies what type of gamepad this represents
  19725. */
  19726. type: number;
  19727. private _leftStick;
  19728. private _rightStick;
  19729. /** @hidden */
  19730. _isConnected: boolean;
  19731. private _leftStickAxisX;
  19732. private _leftStickAxisY;
  19733. private _rightStickAxisX;
  19734. private _rightStickAxisY;
  19735. /**
  19736. * Triggered when the left control stick has been changed
  19737. */
  19738. private _onleftstickchanged;
  19739. /**
  19740. * Triggered when the right control stick has been changed
  19741. */
  19742. private _onrightstickchanged;
  19743. /**
  19744. * Represents a gamepad controller
  19745. */
  19746. static GAMEPAD: number;
  19747. /**
  19748. * Represents a generic controller
  19749. */
  19750. static GENERIC: number;
  19751. /**
  19752. * Represents an XBox controller
  19753. */
  19754. static XBOX: number;
  19755. /**
  19756. * Represents a pose-enabled controller
  19757. */
  19758. static POSE_ENABLED: number;
  19759. /**
  19760. * Represents an Dual Shock controller
  19761. */
  19762. static DUALSHOCK: number;
  19763. /**
  19764. * Specifies whether the left control stick should be Y-inverted
  19765. */
  19766. protected _invertLeftStickY: boolean;
  19767. /**
  19768. * Specifies if the gamepad has been connected
  19769. */
  19770. get isConnected(): boolean;
  19771. /**
  19772. * Initializes the gamepad
  19773. * @param id The id of the gamepad
  19774. * @param index The index of the gamepad
  19775. * @param browserGamepad The browser gamepad
  19776. * @param leftStickX The x component of the left joystick
  19777. * @param leftStickY The y component of the left joystick
  19778. * @param rightStickX The x component of the right joystick
  19779. * @param rightStickY The y component of the right joystick
  19780. */
  19781. constructor(
  19782. /**
  19783. * The id of the gamepad
  19784. */
  19785. id: string,
  19786. /**
  19787. * The index of the gamepad
  19788. */
  19789. index: number,
  19790. /**
  19791. * The browser gamepad
  19792. */
  19793. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  19794. /**
  19795. * Callback triggered when the left joystick has changed
  19796. * @param callback
  19797. */
  19798. onleftstickchanged(callback: (values: StickValues) => void): void;
  19799. /**
  19800. * Callback triggered when the right joystick has changed
  19801. * @param callback
  19802. */
  19803. onrightstickchanged(callback: (values: StickValues) => void): void;
  19804. /**
  19805. * Gets the left joystick
  19806. */
  19807. get leftStick(): StickValues;
  19808. /**
  19809. * Sets the left joystick values
  19810. */
  19811. set leftStick(newValues: StickValues);
  19812. /**
  19813. * Gets the right joystick
  19814. */
  19815. get rightStick(): StickValues;
  19816. /**
  19817. * Sets the right joystick value
  19818. */
  19819. set rightStick(newValues: StickValues);
  19820. /**
  19821. * Updates the gamepad joystick positions
  19822. */
  19823. update(): void;
  19824. /**
  19825. * Disposes the gamepad
  19826. */
  19827. dispose(): void;
  19828. }
  19829. /**
  19830. * Represents a generic gamepad
  19831. */
  19832. export class GenericPad extends Gamepad {
  19833. private _buttons;
  19834. private _onbuttondown;
  19835. private _onbuttonup;
  19836. /**
  19837. * Observable triggered when a button has been pressed
  19838. */
  19839. onButtonDownObservable: Observable<number>;
  19840. /**
  19841. * Observable triggered when a button has been released
  19842. */
  19843. onButtonUpObservable: Observable<number>;
  19844. /**
  19845. * Callback triggered when a button has been pressed
  19846. * @param callback Called when a button has been pressed
  19847. */
  19848. onbuttondown(callback: (buttonPressed: number) => void): void;
  19849. /**
  19850. * Callback triggered when a button has been released
  19851. * @param callback Called when a button has been released
  19852. */
  19853. onbuttonup(callback: (buttonReleased: number) => void): void;
  19854. /**
  19855. * Initializes the generic gamepad
  19856. * @param id The id of the generic gamepad
  19857. * @param index The index of the generic gamepad
  19858. * @param browserGamepad The browser gamepad
  19859. */
  19860. constructor(id: string, index: number, browserGamepad: any);
  19861. private _setButtonValue;
  19862. /**
  19863. * Updates the generic gamepad
  19864. */
  19865. update(): void;
  19866. /**
  19867. * Disposes the generic gamepad
  19868. */
  19869. dispose(): void;
  19870. }
  19871. }
  19872. declare module "babylonjs/Gamepads/Controllers/poseEnabledController" {
  19873. import { Observable } from "babylonjs/Misc/observable";
  19874. import { Nullable } from "babylonjs/types";
  19875. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  19876. import { TransformNode } from "babylonjs/Meshes/transformNode";
  19877. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19878. import { Ray } from "babylonjs/Culling/ray";
  19879. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  19880. import { PoseControlled, DevicePose } from "babylonjs/Cameras/VR/webVRCamera";
  19881. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19882. /**
  19883. * Defines the types of pose enabled controllers that are supported
  19884. */
  19885. export enum PoseEnabledControllerType {
  19886. /**
  19887. * HTC Vive
  19888. */
  19889. VIVE = 0,
  19890. /**
  19891. * Oculus Rift
  19892. */
  19893. OCULUS = 1,
  19894. /**
  19895. * Windows mixed reality
  19896. */
  19897. WINDOWS = 2,
  19898. /**
  19899. * Samsung gear VR
  19900. */
  19901. GEAR_VR = 3,
  19902. /**
  19903. * Google Daydream
  19904. */
  19905. DAYDREAM = 4,
  19906. /**
  19907. * Generic
  19908. */
  19909. GENERIC = 5
  19910. }
  19911. /**
  19912. * Defines the MutableGamepadButton interface for the state of a gamepad button
  19913. */
  19914. export interface MutableGamepadButton {
  19915. /**
  19916. * Value of the button/trigger
  19917. */
  19918. value: number;
  19919. /**
  19920. * If the button/trigger is currently touched
  19921. */
  19922. touched: boolean;
  19923. /**
  19924. * If the button/trigger is currently pressed
  19925. */
  19926. pressed: boolean;
  19927. }
  19928. /**
  19929. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  19930. * @hidden
  19931. */
  19932. export interface ExtendedGamepadButton extends GamepadButton {
  19933. /**
  19934. * If the button/trigger is currently pressed
  19935. */
  19936. readonly pressed: boolean;
  19937. /**
  19938. * If the button/trigger is currently touched
  19939. */
  19940. readonly touched: boolean;
  19941. /**
  19942. * Value of the button/trigger
  19943. */
  19944. readonly value: number;
  19945. }
  19946. /** @hidden */
  19947. export interface _GamePadFactory {
  19948. /**
  19949. * Returns whether or not the current gamepad can be created for this type of controller.
  19950. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  19951. * @returns true if it can be created, otherwise false
  19952. */
  19953. canCreate(gamepadInfo: any): boolean;
  19954. /**
  19955. * Creates a new instance of the Gamepad.
  19956. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  19957. * @returns the new gamepad instance
  19958. */
  19959. create(gamepadInfo: any): Gamepad;
  19960. }
  19961. /**
  19962. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  19963. */
  19964. export class PoseEnabledControllerHelper {
  19965. /** @hidden */
  19966. static _ControllerFactories: _GamePadFactory[];
  19967. /** @hidden */
  19968. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  19969. /**
  19970. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  19971. * @param vrGamepad the gamepad to initialized
  19972. * @returns a vr controller of the type the gamepad identified as
  19973. */
  19974. static InitiateController(vrGamepad: any): Gamepad;
  19975. }
  19976. /**
  19977. * Defines the PoseEnabledController object that contains state of a vr capable controller
  19978. */
  19979. export class PoseEnabledController extends Gamepad implements PoseControlled {
  19980. /**
  19981. * If the controller is used in a webXR session
  19982. */
  19983. isXR: boolean;
  19984. private _deviceRoomPosition;
  19985. private _deviceRoomRotationQuaternion;
  19986. /**
  19987. * The device position in babylon space
  19988. */
  19989. devicePosition: Vector3;
  19990. /**
  19991. * The device rotation in babylon space
  19992. */
  19993. deviceRotationQuaternion: Quaternion;
  19994. /**
  19995. * The scale factor of the device in babylon space
  19996. */
  19997. deviceScaleFactor: number;
  19998. /**
  19999. * (Likely devicePosition should be used instead) The device position in its room space
  20000. */
  20001. position: Vector3;
  20002. /**
  20003. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  20004. */
  20005. rotationQuaternion: Quaternion;
  20006. /**
  20007. * The type of controller (Eg. Windows mixed reality)
  20008. */
  20009. controllerType: PoseEnabledControllerType;
  20010. protected _calculatedPosition: Vector3;
  20011. private _calculatedRotation;
  20012. /**
  20013. * The raw pose from the device
  20014. */
  20015. rawPose: DevicePose;
  20016. private _trackPosition;
  20017. private _maxRotationDistFromHeadset;
  20018. private _draggedRoomRotation;
  20019. /**
  20020. * @hidden
  20021. */
  20022. _disableTrackPosition(fixedPosition: Vector3): void;
  20023. /**
  20024. * Internal, the mesh attached to the controller
  20025. * @hidden
  20026. */
  20027. _mesh: Nullable<AbstractMesh>;
  20028. private _poseControlledCamera;
  20029. private _leftHandSystemQuaternion;
  20030. /**
  20031. * Internal, matrix used to convert room space to babylon space
  20032. * @hidden
  20033. */
  20034. _deviceToWorld: Matrix;
  20035. /**
  20036. * Node to be used when casting a ray from the controller
  20037. * @hidden
  20038. */
  20039. _pointingPoseNode: Nullable<TransformNode>;
  20040. /**
  20041. * Name of the child mesh that can be used to cast a ray from the controller
  20042. */
  20043. static readonly POINTING_POSE: string;
  20044. /**
  20045. * Creates a new PoseEnabledController from a gamepad
  20046. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  20047. */
  20048. constructor(browserGamepad: any);
  20049. private _workingMatrix;
  20050. /**
  20051. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  20052. */
  20053. update(): void;
  20054. /**
  20055. * Updates only the pose device and mesh without doing any button event checking
  20056. */
  20057. protected _updatePoseAndMesh(): void;
  20058. /**
  20059. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  20060. * @param poseData raw pose fromthe device
  20061. */
  20062. updateFromDevice(poseData: DevicePose): void;
  20063. /**
  20064. * @hidden
  20065. */
  20066. _meshAttachedObservable: Observable<AbstractMesh>;
  20067. /**
  20068. * Attaches a mesh to the controller
  20069. * @param mesh the mesh to be attached
  20070. */
  20071. attachToMesh(mesh: AbstractMesh): void;
  20072. /**
  20073. * Attaches the controllers mesh to a camera
  20074. * @param camera the camera the mesh should be attached to
  20075. */
  20076. attachToPoseControlledCamera(camera: TargetCamera): void;
  20077. /**
  20078. * Disposes of the controller
  20079. */
  20080. dispose(): void;
  20081. /**
  20082. * The mesh that is attached to the controller
  20083. */
  20084. get mesh(): Nullable<AbstractMesh>;
  20085. /**
  20086. * Gets the ray of the controller in the direction the controller is pointing
  20087. * @param length the length the resulting ray should be
  20088. * @returns a ray in the direction the controller is pointing
  20089. */
  20090. getForwardRay(length?: number): Ray;
  20091. }
  20092. }
  20093. declare module "babylonjs/Gamepads/Controllers/webVRController" {
  20094. import { Observable } from "babylonjs/Misc/observable";
  20095. import { Scene } from "babylonjs/scene";
  20096. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20097. import { PoseEnabledController, ExtendedGamepadButton, MutableGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  20098. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  20099. import { Nullable } from "babylonjs/types";
  20100. /**
  20101. * Defines the WebVRController object that represents controllers tracked in 3D space
  20102. */
  20103. export abstract class WebVRController extends PoseEnabledController {
  20104. /**
  20105. * Internal, the default controller model for the controller
  20106. */
  20107. protected _defaultModel: Nullable<AbstractMesh>;
  20108. /**
  20109. * Fired when the trigger state has changed
  20110. */
  20111. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  20112. /**
  20113. * Fired when the main button state has changed
  20114. */
  20115. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  20116. /**
  20117. * Fired when the secondary button state has changed
  20118. */
  20119. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  20120. /**
  20121. * Fired when the pad state has changed
  20122. */
  20123. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  20124. /**
  20125. * Fired when controllers stick values have changed
  20126. */
  20127. onPadValuesChangedObservable: Observable<StickValues>;
  20128. /**
  20129. * Array of button availible on the controller
  20130. */
  20131. protected _buttons: Array<MutableGamepadButton>;
  20132. private _onButtonStateChange;
  20133. /**
  20134. * Fired when a controller button's state has changed
  20135. * @param callback the callback containing the button that was modified
  20136. */
  20137. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  20138. /**
  20139. * X and Y axis corresponding to the controllers joystick
  20140. */
  20141. pad: StickValues;
  20142. /**
  20143. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  20144. */
  20145. hand: string;
  20146. /**
  20147. * The default controller model for the controller
  20148. */
  20149. get defaultModel(): Nullable<AbstractMesh>;
  20150. /**
  20151. * Creates a new WebVRController from a gamepad
  20152. * @param vrGamepad the gamepad that the WebVRController should be created from
  20153. */
  20154. constructor(vrGamepad: any);
  20155. /**
  20156. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  20157. */
  20158. update(): void;
  20159. /**
  20160. * Function to be called when a button is modified
  20161. */
  20162. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  20163. /**
  20164. * Loads a mesh and attaches it to the controller
  20165. * @param scene the scene the mesh should be added to
  20166. * @param meshLoaded callback for when the mesh has been loaded
  20167. */
  20168. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  20169. private _setButtonValue;
  20170. private _changes;
  20171. private _checkChanges;
  20172. /**
  20173. * Disposes of th webVRCOntroller
  20174. */
  20175. dispose(): void;
  20176. }
  20177. }
  20178. declare module "babylonjs/Lights/hemisphericLight" {
  20179. import { Nullable } from "babylonjs/types";
  20180. import { Scene } from "babylonjs/scene";
  20181. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20182. import { Color3 } from "babylonjs/Maths/math.color";
  20183. import { Effect } from "babylonjs/Materials/effect";
  20184. import { Light } from "babylonjs/Lights/light";
  20185. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  20186. /**
  20187. * The HemisphericLight simulates the ambient environment light,
  20188. * so the passed direction is the light reflection direction, not the incoming direction.
  20189. */
  20190. export class HemisphericLight extends Light {
  20191. /**
  20192. * The groundColor is the light in the opposite direction to the one specified during creation.
  20193. * 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.
  20194. */
  20195. groundColor: Color3;
  20196. /**
  20197. * The light reflection direction, not the incoming direction.
  20198. */
  20199. direction: Vector3;
  20200. /**
  20201. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  20202. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  20203. * The HemisphericLight can't cast shadows.
  20204. * Documentation : https://doc.babylonjs.com/babylon101/lights
  20205. * @param name The friendly name of the light
  20206. * @param direction The direction of the light reflection
  20207. * @param scene The scene the light belongs to
  20208. */
  20209. constructor(name: string, direction: Vector3, scene: Scene);
  20210. protected _buildUniformLayout(): void;
  20211. /**
  20212. * Returns the string "HemisphericLight".
  20213. * @return The class name
  20214. */
  20215. getClassName(): string;
  20216. /**
  20217. * Sets the HemisphericLight direction towards the passed target (Vector3).
  20218. * Returns the updated direction.
  20219. * @param target The target the direction should point to
  20220. * @return The computed direction
  20221. */
  20222. setDirectionToTarget(target: Vector3): Vector3;
  20223. /**
  20224. * Returns the shadow generator associated to the light.
  20225. * @returns Always null for hemispheric lights because it does not support shadows.
  20226. */
  20227. getShadowGenerator(): Nullable<IShadowGenerator>;
  20228. /**
  20229. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  20230. * @param effect The effect to update
  20231. * @param lightIndex The index of the light in the effect to update
  20232. * @returns The hemispheric light
  20233. */
  20234. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  20235. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  20236. /**
  20237. * Computes the world matrix of the node
  20238. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  20239. * @param useWasUpdatedFlag defines a reserved property
  20240. * @returns the world matrix
  20241. */
  20242. computeWorldMatrix(): Matrix;
  20243. /**
  20244. * Returns the integer 3.
  20245. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  20246. */
  20247. getTypeID(): number;
  20248. /**
  20249. * Prepares the list of defines specific to the light type.
  20250. * @param defines the list of defines
  20251. * @param lightIndex defines the index of the light for the effect
  20252. */
  20253. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  20254. }
  20255. }
  20256. declare module "babylonjs/Shaders/vrMultiviewToSingleview.fragment" {
  20257. /** @hidden */
  20258. export var vrMultiviewToSingleviewPixelShader: {
  20259. name: string;
  20260. shader: string;
  20261. };
  20262. }
  20263. declare module "babylonjs/Materials/Textures/MultiviewRenderTarget" {
  20264. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20265. import { Scene } from "babylonjs/scene";
  20266. /**
  20267. * Renders to multiple views with a single draw call
  20268. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  20269. */
  20270. export class MultiviewRenderTarget extends RenderTargetTexture {
  20271. /**
  20272. * Creates a multiview render target
  20273. * @param scene scene used with the render target
  20274. * @param size the size of the render target (used for each view)
  20275. */
  20276. constructor(scene: Scene, size?: number | {
  20277. width: number;
  20278. height: number;
  20279. } | {
  20280. ratio: number;
  20281. });
  20282. /**
  20283. * @hidden
  20284. * @param faceIndex the face index, if its a cube texture
  20285. */
  20286. _bindFrameBuffer(faceIndex?: number): void;
  20287. /**
  20288. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  20289. * @returns the view count
  20290. */
  20291. getViewCount(): number;
  20292. }
  20293. }
  20294. declare module "babylonjs/Engines/Extensions/engine.multiview" {
  20295. import { Camera } from "babylonjs/Cameras/camera";
  20296. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  20297. import { Nullable } from "babylonjs/types";
  20298. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20299. import { Matrix } from "babylonjs/Maths/math.vector";
  20300. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20301. module "babylonjs/Engines/engine" {
  20302. interface Engine {
  20303. /**
  20304. * Creates a new multiview render target
  20305. * @param width defines the width of the texture
  20306. * @param height defines the height of the texture
  20307. * @returns the created multiview texture
  20308. */
  20309. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  20310. /**
  20311. * Binds a multiview framebuffer to be drawn to
  20312. * @param multiviewTexture texture to bind
  20313. */
  20314. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  20315. }
  20316. }
  20317. module "babylonjs/Cameras/camera" {
  20318. interface Camera {
  20319. /**
  20320. * @hidden
  20321. * 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)
  20322. */
  20323. _useMultiviewToSingleView: boolean;
  20324. /**
  20325. * @hidden
  20326. * 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)
  20327. */
  20328. _multiviewTexture: Nullable<RenderTargetTexture>;
  20329. /**
  20330. * @hidden
  20331. * ensures the multiview texture of the camera exists and has the specified width/height
  20332. * @param width height to set on the multiview texture
  20333. * @param height width to set on the multiview texture
  20334. */
  20335. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  20336. }
  20337. }
  20338. module "babylonjs/scene" {
  20339. interface Scene {
  20340. /** @hidden */
  20341. _transformMatrixR: Matrix;
  20342. /** @hidden */
  20343. _multiviewSceneUbo: Nullable<UniformBuffer>;
  20344. /** @hidden */
  20345. _createMultiviewUbo(): void;
  20346. /** @hidden */
  20347. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  20348. /** @hidden */
  20349. _renderMultiviewToSingleView(camera: Camera): void;
  20350. }
  20351. }
  20352. }
  20353. declare module "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess" {
  20354. import { Camera } from "babylonjs/Cameras/camera";
  20355. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  20356. import "babylonjs/Shaders/vrMultiviewToSingleview.fragment";
  20357. import "babylonjs/Engines/Extensions/engine.multiview";
  20358. /**
  20359. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  20360. * This will not be used for webXR as it supports displaying texture arrays directly
  20361. */
  20362. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  20363. /**
  20364. * Gets a string identifying the name of the class
  20365. * @returns "VRMultiviewToSingleviewPostProcess" string
  20366. */
  20367. getClassName(): string;
  20368. /**
  20369. * Initializes a VRMultiviewToSingleview
  20370. * @param name name of the post process
  20371. * @param camera camera to be applied to
  20372. * @param scaleFactor scaling factor to the size of the output texture
  20373. */
  20374. constructor(name: string, camera: Camera, scaleFactor: number);
  20375. }
  20376. }
  20377. declare module "babylonjs/Cameras/RigModes/webVRRigMode" { }
  20378. declare module "babylonjs/Engines/Extensions/engine.webVR" {
  20379. import { Nullable } from "babylonjs/types";
  20380. import { Size } from "babylonjs/Maths/math.size";
  20381. import { Observable } from "babylonjs/Misc/observable";
  20382. import { WebVROptions } from "babylonjs/Cameras/VR/webVRCamera";
  20383. /**
  20384. * Interface used to define additional presentation attributes
  20385. */
  20386. export interface IVRPresentationAttributes {
  20387. /**
  20388. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  20389. */
  20390. highRefreshRate: boolean;
  20391. /**
  20392. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  20393. */
  20394. foveationLevel: number;
  20395. }
  20396. module "babylonjs/Engines/engine" {
  20397. interface Engine {
  20398. /** @hidden */
  20399. _vrDisplay: any;
  20400. /** @hidden */
  20401. _vrSupported: boolean;
  20402. /** @hidden */
  20403. _oldSize: Size;
  20404. /** @hidden */
  20405. _oldHardwareScaleFactor: number;
  20406. /** @hidden */
  20407. _vrExclusivePointerMode: boolean;
  20408. /** @hidden */
  20409. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  20410. /** @hidden */
  20411. _onVRDisplayPointerRestricted: () => void;
  20412. /** @hidden */
  20413. _onVRDisplayPointerUnrestricted: () => void;
  20414. /** @hidden */
  20415. _onVrDisplayConnect: Nullable<(display: any) => void>;
  20416. /** @hidden */
  20417. _onVrDisplayDisconnect: Nullable<() => void>;
  20418. /** @hidden */
  20419. _onVrDisplayPresentChange: Nullable<() => void>;
  20420. /**
  20421. * Observable signaled when VR display mode changes
  20422. */
  20423. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  20424. /**
  20425. * Observable signaled when VR request present is complete
  20426. */
  20427. onVRRequestPresentComplete: Observable<boolean>;
  20428. /**
  20429. * Observable signaled when VR request present starts
  20430. */
  20431. onVRRequestPresentStart: Observable<Engine>;
  20432. /**
  20433. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  20434. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  20435. */
  20436. isInVRExclusivePointerMode: boolean;
  20437. /**
  20438. * Gets a boolean indicating if a webVR device was detected
  20439. * @returns true if a webVR device was detected
  20440. */
  20441. isVRDevicePresent(): boolean;
  20442. /**
  20443. * Gets the current webVR device
  20444. * @returns the current webVR device (or null)
  20445. */
  20446. getVRDevice(): any;
  20447. /**
  20448. * Initializes a webVR display and starts listening to display change events
  20449. * The onVRDisplayChangedObservable will be notified upon these changes
  20450. * @returns A promise containing a VRDisplay and if vr is supported
  20451. */
  20452. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  20453. /** @hidden */
  20454. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  20455. /**
  20456. * Gets or sets the presentation attributes used to configure VR rendering
  20457. */
  20458. vrPresentationAttributes?: IVRPresentationAttributes;
  20459. /**
  20460. * Call this function to switch to webVR mode
  20461. * Will do nothing if webVR is not supported or if there is no webVR device
  20462. * @param options the webvr options provided to the camera. mainly used for multiview
  20463. * @see https://doc.babylonjs.com/how_to/webvr_camera
  20464. */
  20465. enableVR(options: WebVROptions): void;
  20466. /** @hidden */
  20467. _onVRFullScreenTriggered(): void;
  20468. }
  20469. }
  20470. }
  20471. declare module "babylonjs/Cameras/VR/webVRCamera" {
  20472. import { Nullable } from "babylonjs/types";
  20473. import { Observable } from "babylonjs/Misc/observable";
  20474. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  20475. import { Scene } from "babylonjs/scene";
  20476. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20477. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  20478. import { Node } from "babylonjs/node";
  20479. import { Ray } from "babylonjs/Culling/ray";
  20480. import "babylonjs/Cameras/RigModes/webVRRigMode";
  20481. import "babylonjs/Engines/Extensions/engine.webVR";
  20482. /**
  20483. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  20484. * IMPORTANT!! The data is right-hand data.
  20485. * @export
  20486. * @interface DevicePose
  20487. */
  20488. export interface DevicePose {
  20489. /**
  20490. * The position of the device, values in array are [x,y,z].
  20491. */
  20492. readonly position: Nullable<Float32Array>;
  20493. /**
  20494. * The linearVelocity of the device, values in array are [x,y,z].
  20495. */
  20496. readonly linearVelocity: Nullable<Float32Array>;
  20497. /**
  20498. * The linearAcceleration of the device, values in array are [x,y,z].
  20499. */
  20500. readonly linearAcceleration: Nullable<Float32Array>;
  20501. /**
  20502. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  20503. */
  20504. readonly orientation: Nullable<Float32Array>;
  20505. /**
  20506. * The angularVelocity of the device, values in array are [x,y,z].
  20507. */
  20508. readonly angularVelocity: Nullable<Float32Array>;
  20509. /**
  20510. * The angularAcceleration of the device, values in array are [x,y,z].
  20511. */
  20512. readonly angularAcceleration: Nullable<Float32Array>;
  20513. }
  20514. /**
  20515. * Interface representing a pose controlled object in Babylon.
  20516. * A pose controlled object has both regular pose values as well as pose values
  20517. * from an external device such as a VR head mounted display
  20518. */
  20519. export interface PoseControlled {
  20520. /**
  20521. * The position of the object in babylon space.
  20522. */
  20523. position: Vector3;
  20524. /**
  20525. * The rotation quaternion of the object in babylon space.
  20526. */
  20527. rotationQuaternion: Quaternion;
  20528. /**
  20529. * The position of the device in babylon space.
  20530. */
  20531. devicePosition?: Vector3;
  20532. /**
  20533. * The rotation quaternion of the device in babylon space.
  20534. */
  20535. deviceRotationQuaternion: Quaternion;
  20536. /**
  20537. * The raw pose coming from the device.
  20538. */
  20539. rawPose: Nullable<DevicePose>;
  20540. /**
  20541. * The scale of the device to be used when translating from device space to babylon space.
  20542. */
  20543. deviceScaleFactor: number;
  20544. /**
  20545. * Updates the poseControlled values based on the input device pose.
  20546. * @param poseData the pose data to update the object with
  20547. */
  20548. updateFromDevice(poseData: DevicePose): void;
  20549. }
  20550. /**
  20551. * Set of options to customize the webVRCamera
  20552. */
  20553. export interface WebVROptions {
  20554. /**
  20555. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  20556. */
  20557. trackPosition?: boolean;
  20558. /**
  20559. * Sets the scale of the vrDevice in babylon space. (default: 1)
  20560. */
  20561. positionScale?: number;
  20562. /**
  20563. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  20564. */
  20565. displayName?: string;
  20566. /**
  20567. * Should the native controller meshes be initialized. (default: true)
  20568. */
  20569. controllerMeshes?: boolean;
  20570. /**
  20571. * Creating a default HemiLight only on controllers. (default: true)
  20572. */
  20573. defaultLightingOnControllers?: boolean;
  20574. /**
  20575. * If you don't want to use the default VR button of the helper. (default: false)
  20576. */
  20577. useCustomVRButton?: boolean;
  20578. /**
  20579. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  20580. */
  20581. customVRButton?: HTMLButtonElement;
  20582. /**
  20583. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  20584. */
  20585. rayLength?: number;
  20586. /**
  20587. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  20588. */
  20589. defaultHeight?: number;
  20590. /**
  20591. * If multiview should be used if availible (default: false)
  20592. */
  20593. useMultiview?: boolean;
  20594. }
  20595. /**
  20596. * This represents a WebVR camera.
  20597. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  20598. * @example https://doc.babylonjs.com/how_to/webvr_camera
  20599. */
  20600. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  20601. private webVROptions;
  20602. /**
  20603. * @hidden
  20604. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  20605. */
  20606. _vrDevice: any;
  20607. /**
  20608. * The rawPose of the vrDevice.
  20609. */
  20610. rawPose: Nullable<DevicePose>;
  20611. private _onVREnabled;
  20612. private _specsVersion;
  20613. private _attached;
  20614. private _frameData;
  20615. protected _descendants: Array<Node>;
  20616. private _deviceRoomPosition;
  20617. /** @hidden */
  20618. _deviceRoomRotationQuaternion: Quaternion;
  20619. private _standingMatrix;
  20620. /**
  20621. * Represents device position in babylon space.
  20622. */
  20623. devicePosition: Vector3;
  20624. /**
  20625. * Represents device rotation in babylon space.
  20626. */
  20627. deviceRotationQuaternion: Quaternion;
  20628. /**
  20629. * The scale of the device to be used when translating from device space to babylon space.
  20630. */
  20631. deviceScaleFactor: number;
  20632. private _deviceToWorld;
  20633. private _worldToDevice;
  20634. /**
  20635. * References to the webVR controllers for the vrDevice.
  20636. */
  20637. controllers: Array<WebVRController>;
  20638. /**
  20639. * Emits an event when a controller is attached.
  20640. */
  20641. onControllersAttachedObservable: Observable<WebVRController[]>;
  20642. /**
  20643. * Emits an event when a controller's mesh has been loaded;
  20644. */
  20645. onControllerMeshLoadedObservable: Observable<WebVRController>;
  20646. /**
  20647. * Emits an event when the HMD's pose has been updated.
  20648. */
  20649. onPoseUpdatedFromDeviceObservable: Observable<any>;
  20650. private _poseSet;
  20651. /**
  20652. * If the rig cameras be used as parent instead of this camera.
  20653. */
  20654. rigParenting: boolean;
  20655. private _lightOnControllers;
  20656. private _defaultHeight?;
  20657. /**
  20658. * Instantiates a WebVRFreeCamera.
  20659. * @param name The name of the WebVRFreeCamera
  20660. * @param position The starting anchor position for the camera
  20661. * @param scene The scene the camera belongs to
  20662. * @param webVROptions a set of customizable options for the webVRCamera
  20663. */
  20664. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  20665. /**
  20666. * Gets the device distance from the ground in meters.
  20667. * @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.
  20668. */
  20669. deviceDistanceToRoomGround(): number;
  20670. /**
  20671. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20672. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  20673. */
  20674. useStandingMatrix(callback?: (bool: boolean) => void): void;
  20675. /**
  20676. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20677. * @returns A promise with a boolean set to if the standing matrix is supported.
  20678. */
  20679. useStandingMatrixAsync(): Promise<boolean>;
  20680. /**
  20681. * Disposes the camera
  20682. */
  20683. dispose(): void;
  20684. /**
  20685. * Gets a vrController by name.
  20686. * @param name The name of the controller to retreive
  20687. * @returns the controller matching the name specified or null if not found
  20688. */
  20689. getControllerByName(name: string): Nullable<WebVRController>;
  20690. private _leftController;
  20691. /**
  20692. * The controller corresponding to the users left hand.
  20693. */
  20694. get leftController(): Nullable<WebVRController>;
  20695. private _rightController;
  20696. /**
  20697. * The controller corresponding to the users right hand.
  20698. */
  20699. get rightController(): Nullable<WebVRController>;
  20700. /**
  20701. * Casts a ray forward from the vrCamera's gaze.
  20702. * @param length Length of the ray (default: 100)
  20703. * @returns the ray corresponding to the gaze
  20704. */
  20705. getForwardRay(length?: number): Ray;
  20706. /**
  20707. * @hidden
  20708. * Updates the camera based on device's frame data
  20709. */
  20710. _checkInputs(): void;
  20711. /**
  20712. * Updates the poseControlled values based on the input device pose.
  20713. * @param poseData Pose coming from the device
  20714. */
  20715. updateFromDevice(poseData: DevicePose): void;
  20716. private _htmlElementAttached;
  20717. private _detachIfAttached;
  20718. /**
  20719. * WebVR's attach control will start broadcasting frames to the device.
  20720. * Note that in certain browsers (chrome for example) this function must be called
  20721. * within a user-interaction callback. Example:
  20722. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  20723. *
  20724. * @param element html element to attach the vrDevice to
  20725. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  20726. */
  20727. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  20728. /**
  20729. * Detaches the camera from the html element and disables VR
  20730. *
  20731. * @param element html element to detach from
  20732. */
  20733. detachControl(element: HTMLElement): void;
  20734. /**
  20735. * @returns the name of this class
  20736. */
  20737. getClassName(): string;
  20738. /**
  20739. * Calls resetPose on the vrDisplay
  20740. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  20741. */
  20742. resetToCurrentRotation(): void;
  20743. /**
  20744. * @hidden
  20745. * Updates the rig cameras (left and right eye)
  20746. */
  20747. _updateRigCameras(): void;
  20748. private _workingVector;
  20749. private _oneVector;
  20750. private _workingMatrix;
  20751. private updateCacheCalled;
  20752. private _correctPositionIfNotTrackPosition;
  20753. /**
  20754. * @hidden
  20755. * Updates the cached values of the camera
  20756. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  20757. */
  20758. _updateCache(ignoreParentClass?: boolean): void;
  20759. /**
  20760. * @hidden
  20761. * Get current device position in babylon world
  20762. */
  20763. _computeDevicePosition(): void;
  20764. /**
  20765. * Updates the current device position and rotation in the babylon world
  20766. */
  20767. update(): void;
  20768. /**
  20769. * @hidden
  20770. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  20771. * @returns an identity matrix
  20772. */
  20773. _getViewMatrix(): Matrix;
  20774. private _tmpMatrix;
  20775. /**
  20776. * This function is called by the two RIG cameras.
  20777. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  20778. * @hidden
  20779. */
  20780. _getWebVRViewMatrix(): Matrix;
  20781. /** @hidden */
  20782. _getWebVRProjectionMatrix(): Matrix;
  20783. private _onGamepadConnectedObserver;
  20784. private _onGamepadDisconnectedObserver;
  20785. private _updateCacheWhenTrackingDisabledObserver;
  20786. /**
  20787. * Initializes the controllers and their meshes
  20788. */
  20789. initControllers(): void;
  20790. }
  20791. }
  20792. declare module "babylonjs/Materials/materialHelper" {
  20793. import { Nullable } from "babylonjs/types";
  20794. import { Scene } from "babylonjs/scene";
  20795. import { Engine } from "babylonjs/Engines/engine";
  20796. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20797. import { Light } from "babylonjs/Lights/light";
  20798. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20799. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  20800. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  20801. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  20802. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  20803. /**
  20804. * "Static Class" containing the most commonly used helper while dealing with material for rendering purpose.
  20805. *
  20806. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  20807. *
  20808. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  20809. */
  20810. export class MaterialHelper {
  20811. /**
  20812. * Bind the current view position to an effect.
  20813. * @param effect The effect to be bound
  20814. * @param scene The scene the eyes position is used from
  20815. * @param variableName name of the shader variable that will hold the eye position
  20816. */
  20817. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  20818. /**
  20819. * Helps preparing the defines values about the UVs in used in the effect.
  20820. * UVs are shared as much as we can accross channels in the shaders.
  20821. * @param texture The texture we are preparing the UVs for
  20822. * @param defines The defines to update
  20823. * @param key The channel key "diffuse", "specular"... used in the shader
  20824. */
  20825. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  20826. /**
  20827. * Binds a texture matrix value to its corrsponding uniform
  20828. * @param texture The texture to bind the matrix for
  20829. * @param uniformBuffer The uniform buffer receivin the data
  20830. * @param key The channel key "diffuse", "specular"... used in the shader
  20831. */
  20832. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  20833. /**
  20834. * Gets the current status of the fog (should it be enabled?)
  20835. * @param mesh defines the mesh to evaluate for fog support
  20836. * @param scene defines the hosting scene
  20837. * @returns true if fog must be enabled
  20838. */
  20839. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  20840. /**
  20841. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  20842. * @param mesh defines the current mesh
  20843. * @param scene defines the current scene
  20844. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  20845. * @param pointsCloud defines if point cloud rendering has to be turned on
  20846. * @param fogEnabled defines if fog has to be turned on
  20847. * @param alphaTest defines if alpha testing has to be turned on
  20848. * @param defines defines the current list of defines
  20849. */
  20850. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  20851. /**
  20852. * Helper used to prepare the list of defines associated with frame values for shader compilation
  20853. * @param scene defines the current scene
  20854. * @param engine defines the current engine
  20855. * @param defines specifies the list of active defines
  20856. * @param useInstances defines if instances have to be turned on
  20857. * @param useClipPlane defines if clip plane have to be turned on
  20858. * @param useInstances defines if instances have to be turned on
  20859. * @param useThinInstances defines if thin instances have to be turned on
  20860. */
  20861. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  20862. /**
  20863. * Prepares the defines for bones
  20864. * @param mesh The mesh containing the geometry data we will draw
  20865. * @param defines The defines to update
  20866. */
  20867. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  20868. /**
  20869. * Prepares the defines for morph targets
  20870. * @param mesh The mesh containing the geometry data we will draw
  20871. * @param defines The defines to update
  20872. */
  20873. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  20874. /**
  20875. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  20876. * @param mesh The mesh containing the geometry data we will draw
  20877. * @param defines The defines to update
  20878. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  20879. * @param useBones Precise whether bones should be used or not (override mesh info)
  20880. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  20881. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  20882. * @returns false if defines are considered not dirty and have not been checked
  20883. */
  20884. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  20885. /**
  20886. * Prepares the defines related to multiview
  20887. * @param scene The scene we are intending to draw
  20888. * @param defines The defines to update
  20889. */
  20890. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  20891. /**
  20892. * Prepares the defines related to the prepass
  20893. * @param scene The scene we are intending to draw
  20894. * @param defines The defines to update
  20895. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  20896. */
  20897. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  20898. /**
  20899. * Prepares the defines related to the light information passed in parameter
  20900. * @param scene The scene we are intending to draw
  20901. * @param mesh The mesh the effect is compiling for
  20902. * @param light The light the effect is compiling for
  20903. * @param lightIndex The index of the light
  20904. * @param defines The defines to update
  20905. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20906. * @param state Defines the current state regarding what is needed (normals, etc...)
  20907. */
  20908. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  20909. needNormals: boolean;
  20910. needRebuild: boolean;
  20911. shadowEnabled: boolean;
  20912. specularEnabled: boolean;
  20913. lightmapMode: boolean;
  20914. }): void;
  20915. /**
  20916. * Prepares the defines related to the light information passed in parameter
  20917. * @param scene The scene we are intending to draw
  20918. * @param mesh The mesh the effect is compiling for
  20919. * @param defines The defines to update
  20920. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20921. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  20922. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  20923. * @returns true if normals will be required for the rest of the effect
  20924. */
  20925. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  20926. /**
  20927. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  20928. * @param lightIndex defines the light index
  20929. * @param uniformsList The uniform list
  20930. * @param samplersList The sampler list
  20931. * @param projectedLightTexture defines if projected texture must be used
  20932. * @param uniformBuffersList defines an optional list of uniform buffers
  20933. */
  20934. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  20935. /**
  20936. * Prepares the uniforms and samplers list to be used in the effect
  20937. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  20938. * @param samplersList The sampler list
  20939. * @param defines The defines helping in the list generation
  20940. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  20941. */
  20942. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  20943. /**
  20944. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  20945. * @param defines The defines to update while falling back
  20946. * @param fallbacks The authorized effect fallbacks
  20947. * @param maxSimultaneousLights The maximum number of lights allowed
  20948. * @param rank the current rank of the Effect
  20949. * @returns The newly affected rank
  20950. */
  20951. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  20952. private static _TmpMorphInfluencers;
  20953. /**
  20954. * Prepares the list of attributes required for morph targets according to the effect defines.
  20955. * @param attribs The current list of supported attribs
  20956. * @param mesh The mesh to prepare the morph targets attributes for
  20957. * @param influencers The number of influencers
  20958. */
  20959. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  20960. /**
  20961. * Prepares the list of attributes required for morph targets according to the effect defines.
  20962. * @param attribs The current list of supported attribs
  20963. * @param mesh The mesh to prepare the morph targets attributes for
  20964. * @param defines The current Defines of the effect
  20965. */
  20966. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  20967. /**
  20968. * Prepares the list of attributes required for bones according to the effect defines.
  20969. * @param attribs The current list of supported attribs
  20970. * @param mesh The mesh to prepare the bones attributes for
  20971. * @param defines The current Defines of the effect
  20972. * @param fallbacks The current efffect fallback strategy
  20973. */
  20974. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  20975. /**
  20976. * Check and prepare the list of attributes required for instances according to the effect defines.
  20977. * @param attribs The current list of supported attribs
  20978. * @param defines The current MaterialDefines of the effect
  20979. */
  20980. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  20981. /**
  20982. * Add the list of attributes required for instances to the attribs array.
  20983. * @param attribs The current list of supported attribs
  20984. */
  20985. static PushAttributesForInstances(attribs: string[]): void;
  20986. /**
  20987. * Binds the light information to the effect.
  20988. * @param light The light containing the generator
  20989. * @param effect The effect we are binding the data to
  20990. * @param lightIndex The light index in the effect used to render
  20991. */
  20992. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  20993. /**
  20994. * Binds the lights information from the scene to the effect for the given mesh.
  20995. * @param light Light to bind
  20996. * @param lightIndex Light index
  20997. * @param scene The scene where the light belongs to
  20998. * @param effect The effect we are binding the data to
  20999. * @param useSpecular Defines if specular is supported
  21000. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  21001. */
  21002. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  21003. /**
  21004. * Binds the lights information from the scene to the effect for the given mesh.
  21005. * @param scene The scene the lights belongs to
  21006. * @param mesh The mesh we are binding the information to render
  21007. * @param effect The effect we are binding the data to
  21008. * @param defines The generated defines for the effect
  21009. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  21010. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  21011. */
  21012. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  21013. private static _tempFogColor;
  21014. /**
  21015. * Binds the fog information from the scene to the effect for the given mesh.
  21016. * @param scene The scene the lights belongs to
  21017. * @param mesh The mesh we are binding the information to render
  21018. * @param effect The effect we are binding the data to
  21019. * @param linearSpace Defines if the fog effect is applied in linear space
  21020. */
  21021. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  21022. /**
  21023. * Binds the bones information from the mesh to the effect.
  21024. * @param mesh The mesh we are binding the information to render
  21025. * @param effect The effect we are binding the data to
  21026. */
  21027. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  21028. /**
  21029. * Binds the morph targets information from the mesh to the effect.
  21030. * @param abstractMesh The mesh we are binding the information to render
  21031. * @param effect The effect we are binding the data to
  21032. */
  21033. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  21034. /**
  21035. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  21036. * @param defines The generated defines used in the effect
  21037. * @param effect The effect we are binding the data to
  21038. * @param scene The scene we are willing to render with logarithmic scale for
  21039. */
  21040. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  21041. /**
  21042. * Binds the clip plane information from the scene to the effect.
  21043. * @param scene The scene the clip plane information are extracted from
  21044. * @param effect The effect we are binding the data to
  21045. */
  21046. static BindClipPlane(effect: Effect, scene: Scene): void;
  21047. }
  21048. }
  21049. declare module "babylonjs/Materials/Node/Blocks/Input/inputBlock" {
  21050. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21051. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21052. import { NodeMaterialSystemValues } from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  21053. import { Nullable } from "babylonjs/types";
  21054. import { Effect } from "babylonjs/Materials/effect";
  21055. import { Matrix } from "babylonjs/Maths/math.vector";
  21056. import { Scene } from "babylonjs/scene";
  21057. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21058. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21059. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21060. import { AnimatedInputBlockTypes } from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  21061. import { Observable } from "babylonjs/Misc/observable";
  21062. /**
  21063. * Block used to expose an input value
  21064. */
  21065. export class InputBlock extends NodeMaterialBlock {
  21066. private _mode;
  21067. private _associatedVariableName;
  21068. private _storedValue;
  21069. private _valueCallback;
  21070. private _type;
  21071. private _animationType;
  21072. /** Gets or set a value used to limit the range of float values */
  21073. min: number;
  21074. /** Gets or set a value used to limit the range of float values */
  21075. max: number;
  21076. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  21077. isBoolean: boolean;
  21078. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  21079. matrixMode: number;
  21080. /** @hidden */
  21081. _systemValue: Nullable<NodeMaterialSystemValues>;
  21082. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  21083. visibleInInspector: boolean;
  21084. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  21085. isConstant: boolean;
  21086. /** Gets or sets the group to use to display this block in the Inspector */
  21087. groupInInspector: string;
  21088. /** Gets an observable raised when the value is changed */
  21089. onValueChangedObservable: Observable<InputBlock>;
  21090. /**
  21091. * Gets or sets the connection point type (default is float)
  21092. */
  21093. get type(): NodeMaterialBlockConnectionPointTypes;
  21094. /**
  21095. * Creates a new InputBlock
  21096. * @param name defines the block name
  21097. * @param target defines the target of that block (Vertex by default)
  21098. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  21099. */
  21100. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  21101. /**
  21102. * Validates if a name is a reserve word.
  21103. * @param newName the new name to be given to the node.
  21104. * @returns false if the name is a reserve word, else true.
  21105. */
  21106. validateBlockName(newName: string): boolean;
  21107. /**
  21108. * Gets the output component
  21109. */
  21110. get output(): NodeMaterialConnectionPoint;
  21111. /**
  21112. * Set the source of this connection point to a vertex attribute
  21113. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  21114. * @returns the current connection point
  21115. */
  21116. setAsAttribute(attributeName?: string): InputBlock;
  21117. /**
  21118. * Set the source of this connection point to a system value
  21119. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  21120. * @returns the current connection point
  21121. */
  21122. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  21123. /**
  21124. * Gets or sets the value of that point.
  21125. * Please note that this value will be ignored if valueCallback is defined
  21126. */
  21127. get value(): any;
  21128. set value(value: any);
  21129. /**
  21130. * Gets or sets a callback used to get the value of that point.
  21131. * Please note that setting this value will force the connection point to ignore the value property
  21132. */
  21133. get valueCallback(): () => any;
  21134. set valueCallback(value: () => any);
  21135. /**
  21136. * Gets or sets the associated variable name in the shader
  21137. */
  21138. get associatedVariableName(): string;
  21139. set associatedVariableName(value: string);
  21140. /** Gets or sets the type of animation applied to the input */
  21141. get animationType(): AnimatedInputBlockTypes;
  21142. set animationType(value: AnimatedInputBlockTypes);
  21143. /**
  21144. * Gets a boolean indicating that this connection point not defined yet
  21145. */
  21146. get isUndefined(): boolean;
  21147. /**
  21148. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  21149. * In this case the connection point name must be the name of the uniform to use.
  21150. * Can only be set on inputs
  21151. */
  21152. get isUniform(): boolean;
  21153. set isUniform(value: boolean);
  21154. /**
  21155. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  21156. * In this case the connection point name must be the name of the attribute to use
  21157. * Can only be set on inputs
  21158. */
  21159. get isAttribute(): boolean;
  21160. set isAttribute(value: boolean);
  21161. /**
  21162. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  21163. * Can only be set on exit points
  21164. */
  21165. get isVarying(): boolean;
  21166. set isVarying(value: boolean);
  21167. /**
  21168. * Gets a boolean indicating that the current connection point is a system value
  21169. */
  21170. get isSystemValue(): boolean;
  21171. /**
  21172. * Gets or sets the current well known value or null if not defined as a system value
  21173. */
  21174. get systemValue(): Nullable<NodeMaterialSystemValues>;
  21175. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  21176. /**
  21177. * Gets the current class name
  21178. * @returns the class name
  21179. */
  21180. getClassName(): string;
  21181. /**
  21182. * Animate the input if animationType !== None
  21183. * @param scene defines the rendering scene
  21184. */
  21185. animate(scene: Scene): void;
  21186. private _emitDefine;
  21187. initialize(state: NodeMaterialBuildState): void;
  21188. /**
  21189. * Set the input block to its default value (based on its type)
  21190. */
  21191. setDefaultValue(): void;
  21192. private _emitConstant;
  21193. /** @hidden */
  21194. get _noContextSwitch(): boolean;
  21195. private _emit;
  21196. /** @hidden */
  21197. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  21198. /** @hidden */
  21199. _transmit(effect: Effect, scene: Scene): void;
  21200. protected _buildBlock(state: NodeMaterialBuildState): void;
  21201. protected _dumpPropertiesCode(): string;
  21202. dispose(): void;
  21203. serialize(): any;
  21204. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21205. }
  21206. }
  21207. declare module "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint" {
  21208. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21209. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21210. import { Nullable } from "babylonjs/types";
  21211. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  21212. import { Observable } from "babylonjs/Misc/observable";
  21213. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21214. /**
  21215. * Enum used to define the compatibility state between two connection points
  21216. */
  21217. export enum NodeMaterialConnectionPointCompatibilityStates {
  21218. /** Points are compatibles */
  21219. Compatible = 0,
  21220. /** Points are incompatible because of their types */
  21221. TypeIncompatible = 1,
  21222. /** Points are incompatible because of their targets (vertex vs fragment) */
  21223. TargetIncompatible = 2
  21224. }
  21225. /**
  21226. * Defines the direction of a connection point
  21227. */
  21228. export enum NodeMaterialConnectionPointDirection {
  21229. /** Input */
  21230. Input = 0,
  21231. /** Output */
  21232. Output = 1
  21233. }
  21234. /**
  21235. * Defines a connection point for a block
  21236. */
  21237. export class NodeMaterialConnectionPoint {
  21238. /** @hidden */
  21239. _ownerBlock: NodeMaterialBlock;
  21240. /** @hidden */
  21241. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  21242. private _endpoints;
  21243. private _associatedVariableName;
  21244. private _direction;
  21245. /** @hidden */
  21246. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21247. /** @hidden */
  21248. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21249. private _type;
  21250. /** @hidden */
  21251. _enforceAssociatedVariableName: boolean;
  21252. /** Gets the direction of the point */
  21253. get direction(): NodeMaterialConnectionPointDirection;
  21254. /** Indicates that this connection point needs dual validation before being connected to another point */
  21255. needDualDirectionValidation: boolean;
  21256. /**
  21257. * Gets or sets the additional types supported by this connection point
  21258. */
  21259. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21260. /**
  21261. * Gets or sets the additional types excluded by this connection point
  21262. */
  21263. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21264. /**
  21265. * Observable triggered when this point is connected
  21266. */
  21267. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  21268. /**
  21269. * Gets or sets the associated variable name in the shader
  21270. */
  21271. get associatedVariableName(): string;
  21272. set associatedVariableName(value: string);
  21273. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  21274. get innerType(): NodeMaterialBlockConnectionPointTypes;
  21275. /**
  21276. * Gets or sets the connection point type (default is float)
  21277. */
  21278. get type(): NodeMaterialBlockConnectionPointTypes;
  21279. set type(value: NodeMaterialBlockConnectionPointTypes);
  21280. /**
  21281. * Gets or sets the connection point name
  21282. */
  21283. name: string;
  21284. /**
  21285. * Gets or sets the connection point name
  21286. */
  21287. displayName: string;
  21288. /**
  21289. * Gets or sets a boolean indicating that this connection point can be omitted
  21290. */
  21291. isOptional: boolean;
  21292. /**
  21293. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  21294. */
  21295. isExposedOnFrame: boolean;
  21296. /**
  21297. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  21298. */
  21299. define: string;
  21300. /** @hidden */
  21301. _prioritizeVertex: boolean;
  21302. private _target;
  21303. /** Gets or sets the target of that connection point */
  21304. get target(): NodeMaterialBlockTargets;
  21305. set target(value: NodeMaterialBlockTargets);
  21306. /**
  21307. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  21308. */
  21309. get isConnected(): boolean;
  21310. /**
  21311. * Gets a boolean indicating that the current point is connected to an input block
  21312. */
  21313. get isConnectedToInputBlock(): boolean;
  21314. /**
  21315. * Gets a the connected input block (if any)
  21316. */
  21317. get connectInputBlock(): Nullable<InputBlock>;
  21318. /** Get the other side of the connection (if any) */
  21319. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  21320. /** Get the block that owns this connection point */
  21321. get ownerBlock(): NodeMaterialBlock;
  21322. /** Get the block connected on the other side of this connection (if any) */
  21323. get sourceBlock(): Nullable<NodeMaterialBlock>;
  21324. /** Get the block connected on the endpoints of this connection (if any) */
  21325. get connectedBlocks(): Array<NodeMaterialBlock>;
  21326. /** Gets the list of connected endpoints */
  21327. get endpoints(): NodeMaterialConnectionPoint[];
  21328. /** Gets a boolean indicating if that output point is connected to at least one input */
  21329. get hasEndpoints(): boolean;
  21330. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  21331. get isConnectedInVertexShader(): boolean;
  21332. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  21333. get isConnectedInFragmentShader(): boolean;
  21334. /**
  21335. * Creates a block suitable to be used as an input for this input point.
  21336. * If null is returned, a block based on the point type will be created.
  21337. * @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
  21338. */
  21339. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21340. /**
  21341. * Creates a new connection point
  21342. * @param name defines the connection point name
  21343. * @param ownerBlock defines the block hosting this connection point
  21344. * @param direction defines the direction of the connection point
  21345. */
  21346. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  21347. /**
  21348. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  21349. * @returns the class name
  21350. */
  21351. getClassName(): string;
  21352. /**
  21353. * Gets a boolean indicating if the current point can be connected to another point
  21354. * @param connectionPoint defines the other connection point
  21355. * @returns a boolean
  21356. */
  21357. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  21358. /**
  21359. * Gets a number indicating if the current point can be connected to another point
  21360. * @param connectionPoint defines the other connection point
  21361. * @returns a number defining the compatibility state
  21362. */
  21363. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21364. /**
  21365. * Connect this point to another connection point
  21366. * @param connectionPoint defines the other connection point
  21367. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  21368. * @returns the current connection point
  21369. */
  21370. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  21371. /**
  21372. * Disconnect this point from one of his endpoint
  21373. * @param endpoint defines the other connection point
  21374. * @returns the current connection point
  21375. */
  21376. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  21377. /**
  21378. * Serializes this point in a JSON representation
  21379. * @param isInput defines if the connection point is an input (default is true)
  21380. * @returns the serialized point object
  21381. */
  21382. serialize(isInput?: boolean): any;
  21383. /**
  21384. * Release resources
  21385. */
  21386. dispose(): void;
  21387. }
  21388. }
  21389. declare module "babylonjs/Materials/Node/Enums/nodeMaterialModes" {
  21390. /**
  21391. * Enum used to define the material modes
  21392. */
  21393. export enum NodeMaterialModes {
  21394. /** Regular material */
  21395. Material = 0,
  21396. /** For post process */
  21397. PostProcess = 1,
  21398. /** For particle system */
  21399. Particle = 2
  21400. }
  21401. }
  21402. declare module "babylonjs/Materials/Node/Blocks/Dual/textureBlock" {
  21403. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21404. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21405. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21406. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21407. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21408. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21409. import { Effect } from "babylonjs/Materials/effect";
  21410. import { Mesh } from "babylonjs/Meshes/mesh";
  21411. import { Nullable } from "babylonjs/types";
  21412. import { Texture } from "babylonjs/Materials/Textures/texture";
  21413. import { Scene } from "babylonjs/scene";
  21414. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  21415. /**
  21416. * Block used to read a texture from a sampler
  21417. */
  21418. export class TextureBlock extends NodeMaterialBlock {
  21419. private _defineName;
  21420. private _linearDefineName;
  21421. private _gammaDefineName;
  21422. private _tempTextureRead;
  21423. private _samplerName;
  21424. private _transformedUVName;
  21425. private _textureTransformName;
  21426. private _textureInfoName;
  21427. private _mainUVName;
  21428. private _mainUVDefineName;
  21429. private _fragmentOnly;
  21430. /**
  21431. * Gets or sets the texture associated with the node
  21432. */
  21433. texture: Nullable<Texture>;
  21434. /**
  21435. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21436. */
  21437. convertToGammaSpace: boolean;
  21438. /**
  21439. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21440. */
  21441. convertToLinearSpace: boolean;
  21442. /**
  21443. * Create a new TextureBlock
  21444. * @param name defines the block name
  21445. */
  21446. constructor(name: string, fragmentOnly?: boolean);
  21447. /**
  21448. * Gets the current class name
  21449. * @returns the class name
  21450. */
  21451. getClassName(): string;
  21452. /**
  21453. * Gets the uv input component
  21454. */
  21455. get uv(): NodeMaterialConnectionPoint;
  21456. /**
  21457. * Gets the rgba output component
  21458. */
  21459. get rgba(): NodeMaterialConnectionPoint;
  21460. /**
  21461. * Gets the rgb output component
  21462. */
  21463. get rgb(): NodeMaterialConnectionPoint;
  21464. /**
  21465. * Gets the r output component
  21466. */
  21467. get r(): NodeMaterialConnectionPoint;
  21468. /**
  21469. * Gets the g output component
  21470. */
  21471. get g(): NodeMaterialConnectionPoint;
  21472. /**
  21473. * Gets the b output component
  21474. */
  21475. get b(): NodeMaterialConnectionPoint;
  21476. /**
  21477. * Gets the a output component
  21478. */
  21479. get a(): NodeMaterialConnectionPoint;
  21480. get target(): NodeMaterialBlockTargets;
  21481. autoConfigure(material: NodeMaterial): void;
  21482. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  21483. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21484. isReady(): boolean;
  21485. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21486. private get _isMixed();
  21487. private _injectVertexCode;
  21488. private _writeTextureRead;
  21489. private _writeOutput;
  21490. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21491. protected _dumpPropertiesCode(): string;
  21492. serialize(): any;
  21493. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21494. }
  21495. }
  21496. declare module "babylonjs/Shaders/ShadersInclude/reflectionFunction" {
  21497. /** @hidden */
  21498. export var reflectionFunction: {
  21499. name: string;
  21500. shader: string;
  21501. };
  21502. }
  21503. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock" {
  21504. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21505. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21506. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21507. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21508. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21509. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21510. import { Effect } from "babylonjs/Materials/effect";
  21511. import { Mesh } from "babylonjs/Meshes/mesh";
  21512. import { Nullable } from "babylonjs/types";
  21513. import { Scene } from "babylonjs/scene";
  21514. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  21515. /**
  21516. * Base block used to read a reflection texture from a sampler
  21517. */
  21518. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  21519. /** @hidden */
  21520. _define3DName: string;
  21521. /** @hidden */
  21522. _defineCubicName: string;
  21523. /** @hidden */
  21524. _defineExplicitName: string;
  21525. /** @hidden */
  21526. _defineProjectionName: string;
  21527. /** @hidden */
  21528. _defineLocalCubicName: string;
  21529. /** @hidden */
  21530. _defineSphericalName: string;
  21531. /** @hidden */
  21532. _definePlanarName: string;
  21533. /** @hidden */
  21534. _defineEquirectangularName: string;
  21535. /** @hidden */
  21536. _defineMirroredEquirectangularFixedName: string;
  21537. /** @hidden */
  21538. _defineEquirectangularFixedName: string;
  21539. /** @hidden */
  21540. _defineSkyboxName: string;
  21541. /** @hidden */
  21542. _defineOppositeZ: string;
  21543. /** @hidden */
  21544. _cubeSamplerName: string;
  21545. /** @hidden */
  21546. _2DSamplerName: string;
  21547. protected _positionUVWName: string;
  21548. protected _directionWName: string;
  21549. protected _reflectionVectorName: string;
  21550. /** @hidden */
  21551. _reflectionCoordsName: string;
  21552. /** @hidden */
  21553. _reflectionMatrixName: string;
  21554. protected _reflectionColorName: string;
  21555. /**
  21556. * Gets or sets the texture associated with the node
  21557. */
  21558. texture: Nullable<BaseTexture>;
  21559. /**
  21560. * Create a new ReflectionTextureBaseBlock
  21561. * @param name defines the block name
  21562. */
  21563. constructor(name: string);
  21564. /**
  21565. * Gets the current class name
  21566. * @returns the class name
  21567. */
  21568. getClassName(): string;
  21569. /**
  21570. * Gets the world position input component
  21571. */
  21572. abstract get position(): NodeMaterialConnectionPoint;
  21573. /**
  21574. * Gets the world position input component
  21575. */
  21576. abstract get worldPosition(): NodeMaterialConnectionPoint;
  21577. /**
  21578. * Gets the world normal input component
  21579. */
  21580. abstract get worldNormal(): NodeMaterialConnectionPoint;
  21581. /**
  21582. * Gets the world input component
  21583. */
  21584. abstract get world(): NodeMaterialConnectionPoint;
  21585. /**
  21586. * Gets the camera (or eye) position component
  21587. */
  21588. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  21589. /**
  21590. * Gets the view input component
  21591. */
  21592. abstract get view(): NodeMaterialConnectionPoint;
  21593. protected _getTexture(): Nullable<BaseTexture>;
  21594. autoConfigure(material: NodeMaterial): void;
  21595. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21596. isReady(): boolean;
  21597. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21598. /**
  21599. * Gets the code to inject in the vertex shader
  21600. * @param state current state of the node material building
  21601. * @returns the shader code
  21602. */
  21603. handleVertexSide(state: NodeMaterialBuildState): string;
  21604. /**
  21605. * Handles the inits for the fragment code path
  21606. * @param state node material build state
  21607. */
  21608. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  21609. /**
  21610. * Generates the reflection coords code for the fragment code path
  21611. * @param worldNormalVarName name of the world normal variable
  21612. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  21613. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  21614. * @returns the shader code
  21615. */
  21616. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  21617. /**
  21618. * Generates the reflection color code for the fragment code path
  21619. * @param lodVarName name of the lod variable
  21620. * @param swizzleLookupTexture swizzle to use for the final color variable
  21621. * @returns the shader code
  21622. */
  21623. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  21624. /**
  21625. * Generates the code corresponding to the connected output points
  21626. * @param state node material build state
  21627. * @param varName name of the variable to output
  21628. * @returns the shader code
  21629. */
  21630. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  21631. protected _buildBlock(state: NodeMaterialBuildState): this;
  21632. protected _dumpPropertiesCode(): string;
  21633. serialize(): any;
  21634. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21635. }
  21636. }
  21637. declare module "babylonjs/Materials/Node/nodeMaterialConnectionPointCustomObject" {
  21638. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21639. import { NodeMaterialConnectionPoint, NodeMaterialConnectionPointDirection, NodeMaterialConnectionPointCompatibilityStates } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21640. import { Nullable } from "babylonjs/types";
  21641. /**
  21642. * Defines a connection point to be used for points with a custom object type
  21643. */
  21644. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  21645. private _blockType;
  21646. private _blockName;
  21647. private _nameForCheking?;
  21648. /**
  21649. * Creates a new connection point
  21650. * @param name defines the connection point name
  21651. * @param ownerBlock defines the block hosting this connection point
  21652. * @param direction defines the direction of the connection point
  21653. */
  21654. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  21655. /**
  21656. * Gets a number indicating if the current point can be connected to another point
  21657. * @param connectionPoint defines the other connection point
  21658. * @returns a number defining the compatibility state
  21659. */
  21660. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21661. /**
  21662. * Creates a block suitable to be used as an input for this input point.
  21663. * If null is returned, a block based on the point type will be created.
  21664. * @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
  21665. */
  21666. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21667. }
  21668. }
  21669. declare module "babylonjs/Materials/Node/nodeMaterialDecorator" {
  21670. /**
  21671. * Enum defining the type of properties that can be edited in the property pages in the NME
  21672. */
  21673. export enum PropertyTypeForEdition {
  21674. /** property is a boolean */
  21675. Boolean = 0,
  21676. /** property is a float */
  21677. Float = 1,
  21678. /** property is a Vector2 */
  21679. Vector2 = 2,
  21680. /** property is a list of values */
  21681. List = 3
  21682. }
  21683. /**
  21684. * Interface that defines an option in a variable of type list
  21685. */
  21686. export interface IEditablePropertyListOption {
  21687. /** label of the option */
  21688. "label": string;
  21689. /** value of the option */
  21690. "value": number;
  21691. }
  21692. /**
  21693. * Interface that defines the options available for an editable property
  21694. */
  21695. export interface IEditablePropertyOption {
  21696. /** min value */
  21697. "min"?: number;
  21698. /** max value */
  21699. "max"?: number;
  21700. /** notifiers: indicates which actions to take when the property is changed */
  21701. "notifiers"?: {
  21702. /** the material should be rebuilt */
  21703. "rebuild"?: boolean;
  21704. /** the preview should be updated */
  21705. "update"?: boolean;
  21706. };
  21707. /** list of the options for a variable of type list */
  21708. "options"?: IEditablePropertyListOption[];
  21709. }
  21710. /**
  21711. * Interface that describes an editable property
  21712. */
  21713. export interface IPropertyDescriptionForEdition {
  21714. /** name of the property */
  21715. "propertyName": string;
  21716. /** display name of the property */
  21717. "displayName": string;
  21718. /** type of the property */
  21719. "type": PropertyTypeForEdition;
  21720. /** group of the property - all properties with the same group value will be displayed in a specific section */
  21721. "groupName": string;
  21722. /** options for the property */
  21723. "options": IEditablePropertyOption;
  21724. }
  21725. /**
  21726. * Decorator that flags a property in a node material block as being editable
  21727. */
  21728. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  21729. }
  21730. declare module "babylonjs/Materials/Node/Blocks/PBR/refractionBlock" {
  21731. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21732. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21733. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21734. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21735. import { Nullable } from "babylonjs/types";
  21736. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21737. import { Mesh } from "babylonjs/Meshes/mesh";
  21738. import { SubMesh } from "babylonjs/Meshes/subMesh";
  21739. import { Effect } from "babylonjs/Materials/effect";
  21740. import { Scene } from "babylonjs/scene";
  21741. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21742. /**
  21743. * Block used to implement the refraction part of the sub surface module of the PBR material
  21744. */
  21745. export class RefractionBlock extends NodeMaterialBlock {
  21746. /** @hidden */
  21747. _define3DName: string;
  21748. /** @hidden */
  21749. _refractionMatrixName: string;
  21750. /** @hidden */
  21751. _defineLODRefractionAlpha: string;
  21752. /** @hidden */
  21753. _defineLinearSpecularRefraction: string;
  21754. /** @hidden */
  21755. _defineOppositeZ: string;
  21756. /** @hidden */
  21757. _cubeSamplerName: string;
  21758. /** @hidden */
  21759. _2DSamplerName: string;
  21760. /** @hidden */
  21761. _vRefractionMicrosurfaceInfosName: string;
  21762. /** @hidden */
  21763. _vRefractionInfosName: string;
  21764. private _scene;
  21765. /**
  21766. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  21767. * Materials half opaque for instance using refraction could benefit from this control.
  21768. */
  21769. linkRefractionWithTransparency: boolean;
  21770. /**
  21771. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  21772. */
  21773. invertRefractionY: boolean;
  21774. /**
  21775. * Gets or sets the texture associated with the node
  21776. */
  21777. texture: Nullable<BaseTexture>;
  21778. /**
  21779. * Create a new RefractionBlock
  21780. * @param name defines the block name
  21781. */
  21782. constructor(name: string);
  21783. /**
  21784. * Gets the current class name
  21785. * @returns the class name
  21786. */
  21787. getClassName(): string;
  21788. /**
  21789. * Gets the intensity input component
  21790. */
  21791. get intensity(): NodeMaterialConnectionPoint;
  21792. /**
  21793. * Gets the index of refraction input component
  21794. */
  21795. get indexOfRefraction(): NodeMaterialConnectionPoint;
  21796. /**
  21797. * Gets the tint at distance input component
  21798. */
  21799. get tintAtDistance(): NodeMaterialConnectionPoint;
  21800. /**
  21801. * Gets the view input component
  21802. */
  21803. get view(): NodeMaterialConnectionPoint;
  21804. /**
  21805. * Gets the refraction object output component
  21806. */
  21807. get refraction(): NodeMaterialConnectionPoint;
  21808. /**
  21809. * Returns true if the block has a texture
  21810. */
  21811. get hasTexture(): boolean;
  21812. protected _getTexture(): Nullable<BaseTexture>;
  21813. autoConfigure(material: NodeMaterial): void;
  21814. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21815. isReady(): boolean;
  21816. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  21817. /**
  21818. * Gets the main code of the block (fragment side)
  21819. * @param state current state of the node material building
  21820. * @returns the shader code
  21821. */
  21822. getCode(state: NodeMaterialBuildState): string;
  21823. protected _buildBlock(state: NodeMaterialBuildState): this;
  21824. protected _dumpPropertiesCode(): string;
  21825. serialize(): any;
  21826. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21827. }
  21828. }
  21829. declare module "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock" {
  21830. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21831. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21832. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21833. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21834. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21835. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21836. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21837. import { Nullable } from "babylonjs/types";
  21838. import { Scene } from "babylonjs/scene";
  21839. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  21840. /**
  21841. * Base block used as input for post process
  21842. */
  21843. export class CurrentScreenBlock extends NodeMaterialBlock {
  21844. private _samplerName;
  21845. private _linearDefineName;
  21846. private _gammaDefineName;
  21847. private _mainUVName;
  21848. private _tempTextureRead;
  21849. /**
  21850. * Gets or sets the texture associated with the node
  21851. */
  21852. texture: Nullable<BaseTexture>;
  21853. /**
  21854. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21855. */
  21856. convertToGammaSpace: boolean;
  21857. /**
  21858. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21859. */
  21860. convertToLinearSpace: boolean;
  21861. /**
  21862. * Create a new CurrentScreenBlock
  21863. * @param name defines the block name
  21864. */
  21865. constructor(name: string);
  21866. /**
  21867. * Gets the current class name
  21868. * @returns the class name
  21869. */
  21870. getClassName(): string;
  21871. /**
  21872. * Gets the uv input component
  21873. */
  21874. get uv(): NodeMaterialConnectionPoint;
  21875. /**
  21876. * Gets the rgba output component
  21877. */
  21878. get rgba(): NodeMaterialConnectionPoint;
  21879. /**
  21880. * Gets the rgb output component
  21881. */
  21882. get rgb(): NodeMaterialConnectionPoint;
  21883. /**
  21884. * Gets the r output component
  21885. */
  21886. get r(): NodeMaterialConnectionPoint;
  21887. /**
  21888. * Gets the g output component
  21889. */
  21890. get g(): NodeMaterialConnectionPoint;
  21891. /**
  21892. * Gets the b output component
  21893. */
  21894. get b(): NodeMaterialConnectionPoint;
  21895. /**
  21896. * Gets the a output component
  21897. */
  21898. get a(): NodeMaterialConnectionPoint;
  21899. /**
  21900. * Initialize the block and prepare the context for build
  21901. * @param state defines the state that will be used for the build
  21902. */
  21903. initialize(state: NodeMaterialBuildState): void;
  21904. get target(): NodeMaterialBlockTargets;
  21905. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21906. isReady(): boolean;
  21907. private _injectVertexCode;
  21908. private _writeTextureRead;
  21909. private _writeOutput;
  21910. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21911. serialize(): any;
  21912. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21913. }
  21914. }
  21915. declare module "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock" {
  21916. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21917. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21918. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21919. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21920. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21921. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21922. import { Nullable } from "babylonjs/types";
  21923. import { Scene } from "babylonjs/scene";
  21924. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  21925. /**
  21926. * Base block used for the particle texture
  21927. */
  21928. export class ParticleTextureBlock extends NodeMaterialBlock {
  21929. private _samplerName;
  21930. private _linearDefineName;
  21931. private _gammaDefineName;
  21932. private _tempTextureRead;
  21933. /**
  21934. * Gets or sets the texture associated with the node
  21935. */
  21936. texture: Nullable<BaseTexture>;
  21937. /**
  21938. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21939. */
  21940. convertToGammaSpace: boolean;
  21941. /**
  21942. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21943. */
  21944. convertToLinearSpace: boolean;
  21945. /**
  21946. * Create a new ParticleTextureBlock
  21947. * @param name defines the block name
  21948. */
  21949. constructor(name: string);
  21950. /**
  21951. * Gets the current class name
  21952. * @returns the class name
  21953. */
  21954. getClassName(): string;
  21955. /**
  21956. * Gets the uv input component
  21957. */
  21958. get uv(): NodeMaterialConnectionPoint;
  21959. /**
  21960. * Gets the rgba output component
  21961. */
  21962. get rgba(): NodeMaterialConnectionPoint;
  21963. /**
  21964. * Gets the rgb output component
  21965. */
  21966. get rgb(): NodeMaterialConnectionPoint;
  21967. /**
  21968. * Gets the r output component
  21969. */
  21970. get r(): NodeMaterialConnectionPoint;
  21971. /**
  21972. * Gets the g output component
  21973. */
  21974. get g(): NodeMaterialConnectionPoint;
  21975. /**
  21976. * Gets the b output component
  21977. */
  21978. get b(): NodeMaterialConnectionPoint;
  21979. /**
  21980. * Gets the a output component
  21981. */
  21982. get a(): NodeMaterialConnectionPoint;
  21983. /**
  21984. * Initialize the block and prepare the context for build
  21985. * @param state defines the state that will be used for the build
  21986. */
  21987. initialize(state: NodeMaterialBuildState): void;
  21988. autoConfigure(material: NodeMaterial): void;
  21989. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21990. isReady(): boolean;
  21991. private _writeOutput;
  21992. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21993. serialize(): any;
  21994. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21995. }
  21996. }
  21997. declare module "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData" {
  21998. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21999. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22000. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  22001. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  22002. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  22003. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  22004. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  22005. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  22006. import { Scene } from "babylonjs/scene";
  22007. /**
  22008. * Class used to store shared data between 2 NodeMaterialBuildState
  22009. */
  22010. export class NodeMaterialBuildStateSharedData {
  22011. /**
  22012. * Gets the list of emitted varyings
  22013. */
  22014. temps: string[];
  22015. /**
  22016. * Gets the list of emitted varyings
  22017. */
  22018. varyings: string[];
  22019. /**
  22020. * Gets the varying declaration string
  22021. */
  22022. varyingDeclaration: string;
  22023. /**
  22024. * Input blocks
  22025. */
  22026. inputBlocks: InputBlock[];
  22027. /**
  22028. * Input blocks
  22029. */
  22030. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  22031. /**
  22032. * Bindable blocks (Blocks that need to set data to the effect)
  22033. */
  22034. bindableBlocks: NodeMaterialBlock[];
  22035. /**
  22036. * List of blocks that can provide a compilation fallback
  22037. */
  22038. blocksWithFallbacks: NodeMaterialBlock[];
  22039. /**
  22040. * List of blocks that can provide a define update
  22041. */
  22042. blocksWithDefines: NodeMaterialBlock[];
  22043. /**
  22044. * List of blocks that can provide a repeatable content
  22045. */
  22046. repeatableContentBlocks: NodeMaterialBlock[];
  22047. /**
  22048. * List of blocks that can provide a dynamic list of uniforms
  22049. */
  22050. dynamicUniformBlocks: NodeMaterialBlock[];
  22051. /**
  22052. * List of blocks that can block the isReady function for the material
  22053. */
  22054. blockingBlocks: NodeMaterialBlock[];
  22055. /**
  22056. * Gets the list of animated inputs
  22057. */
  22058. animatedInputs: InputBlock[];
  22059. /**
  22060. * Build Id used to avoid multiple recompilations
  22061. */
  22062. buildId: number;
  22063. /** List of emitted variables */
  22064. variableNames: {
  22065. [key: string]: number;
  22066. };
  22067. /** List of emitted defines */
  22068. defineNames: {
  22069. [key: string]: number;
  22070. };
  22071. /** Should emit comments? */
  22072. emitComments: boolean;
  22073. /** Emit build activity */
  22074. verbose: boolean;
  22075. /** Gets or sets the hosting scene */
  22076. scene: Scene;
  22077. /**
  22078. * Gets the compilation hints emitted at compilation time
  22079. */
  22080. hints: {
  22081. needWorldViewMatrix: boolean;
  22082. needWorldViewProjectionMatrix: boolean;
  22083. needAlphaBlending: boolean;
  22084. needAlphaTesting: boolean;
  22085. };
  22086. /**
  22087. * List of compilation checks
  22088. */
  22089. checks: {
  22090. emitVertex: boolean;
  22091. emitFragment: boolean;
  22092. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  22093. };
  22094. /**
  22095. * Is vertex program allowed to be empty?
  22096. */
  22097. allowEmptyVertexProgram: boolean;
  22098. /** Creates a new shared data */
  22099. constructor();
  22100. /**
  22101. * Emits console errors and exceptions if there is a failing check
  22102. */
  22103. emitErrors(): void;
  22104. }
  22105. }
  22106. declare module "babylonjs/Materials/Node/nodeMaterialBuildState" {
  22107. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  22108. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  22109. import { NodeMaterialBuildStateSharedData } from "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData";
  22110. /**
  22111. * Class used to store node based material build state
  22112. */
  22113. export class NodeMaterialBuildState {
  22114. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  22115. supportUniformBuffers: boolean;
  22116. /**
  22117. * Gets the list of emitted attributes
  22118. */
  22119. attributes: string[];
  22120. /**
  22121. * Gets the list of emitted uniforms
  22122. */
  22123. uniforms: string[];
  22124. /**
  22125. * Gets the list of emitted constants
  22126. */
  22127. constants: string[];
  22128. /**
  22129. * Gets the list of emitted samplers
  22130. */
  22131. samplers: string[];
  22132. /**
  22133. * Gets the list of emitted functions
  22134. */
  22135. functions: {
  22136. [key: string]: string;
  22137. };
  22138. /**
  22139. * Gets the list of emitted extensions
  22140. */
  22141. extensions: {
  22142. [key: string]: string;
  22143. };
  22144. /**
  22145. * Gets the target of the compilation state
  22146. */
  22147. target: NodeMaterialBlockTargets;
  22148. /**
  22149. * Gets the list of emitted counters
  22150. */
  22151. counters: {
  22152. [key: string]: number;
  22153. };
  22154. /**
  22155. * Shared data between multiple NodeMaterialBuildState instances
  22156. */
  22157. sharedData: NodeMaterialBuildStateSharedData;
  22158. /** @hidden */
  22159. _vertexState: NodeMaterialBuildState;
  22160. /** @hidden */
  22161. _attributeDeclaration: string;
  22162. /** @hidden */
  22163. _uniformDeclaration: string;
  22164. /** @hidden */
  22165. _constantDeclaration: string;
  22166. /** @hidden */
  22167. _samplerDeclaration: string;
  22168. /** @hidden */
  22169. _varyingTransfer: string;
  22170. /** @hidden */
  22171. _injectAtEnd: string;
  22172. private _repeatableContentAnchorIndex;
  22173. /** @hidden */
  22174. _builtCompilationString: string;
  22175. /**
  22176. * Gets the emitted compilation strings
  22177. */
  22178. compilationString: string;
  22179. /**
  22180. * Finalize the compilation strings
  22181. * @param state defines the current compilation state
  22182. */
  22183. finalize(state: NodeMaterialBuildState): void;
  22184. /** @hidden */
  22185. get _repeatableContentAnchor(): string;
  22186. /** @hidden */
  22187. _getFreeVariableName(prefix: string): string;
  22188. /** @hidden */
  22189. _getFreeDefineName(prefix: string): string;
  22190. /** @hidden */
  22191. _excludeVariableName(name: string): void;
  22192. /** @hidden */
  22193. _emit2DSampler(name: string): void;
  22194. /** @hidden */
  22195. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  22196. /** @hidden */
  22197. _emitExtension(name: string, extension: string, define?: string): void;
  22198. /** @hidden */
  22199. _emitFunction(name: string, code: string, comments: string): void;
  22200. /** @hidden */
  22201. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  22202. replaceStrings?: {
  22203. search: RegExp;
  22204. replace: string;
  22205. }[];
  22206. repeatKey?: string;
  22207. }): string;
  22208. /** @hidden */
  22209. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  22210. repeatKey?: string;
  22211. removeAttributes?: boolean;
  22212. removeUniforms?: boolean;
  22213. removeVaryings?: boolean;
  22214. removeIfDef?: boolean;
  22215. replaceStrings?: {
  22216. search: RegExp;
  22217. replace: string;
  22218. }[];
  22219. }, storeKey?: string): void;
  22220. /** @hidden */
  22221. _registerTempVariable(name: string): boolean;
  22222. /** @hidden */
  22223. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  22224. /** @hidden */
  22225. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  22226. /** @hidden */
  22227. _emitFloat(value: number): string;
  22228. }
  22229. }
  22230. declare module "babylonjs/Misc/uniqueIdGenerator" {
  22231. /**
  22232. * Helper class used to generate session unique ID
  22233. */
  22234. export class UniqueIdGenerator {
  22235. private static _UniqueIdCounter;
  22236. /**
  22237. * Gets an unique (relatively to the current scene) Id
  22238. */
  22239. static get UniqueId(): number;
  22240. }
  22241. }
  22242. declare module "babylonjs/Materials/Node/nodeMaterialBlock" {
  22243. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  22244. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22245. import { Nullable } from "babylonjs/types";
  22246. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22247. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  22248. import { Effect } from "babylonjs/Materials/effect";
  22249. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22250. import { Mesh } from "babylonjs/Meshes/mesh";
  22251. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22252. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22253. import { Scene } from "babylonjs/scene";
  22254. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  22255. /**
  22256. * Defines a block that can be used inside a node based material
  22257. */
  22258. export class NodeMaterialBlock {
  22259. private _buildId;
  22260. private _buildTarget;
  22261. private _target;
  22262. private _isFinalMerger;
  22263. private _isInput;
  22264. private _name;
  22265. protected _isUnique: boolean;
  22266. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  22267. inputsAreExclusive: boolean;
  22268. /** @hidden */
  22269. _codeVariableName: string;
  22270. /** @hidden */
  22271. _inputs: NodeMaterialConnectionPoint[];
  22272. /** @hidden */
  22273. _outputs: NodeMaterialConnectionPoint[];
  22274. /** @hidden */
  22275. _preparationId: number;
  22276. /**
  22277. * Gets the name of the block
  22278. */
  22279. get name(): string;
  22280. /**
  22281. * Sets the name of the block. Will check if the name is valid.
  22282. */
  22283. set name(newName: string);
  22284. /**
  22285. * Gets or sets the unique id of the node
  22286. */
  22287. uniqueId: number;
  22288. /**
  22289. * Gets or sets the comments associated with this block
  22290. */
  22291. comments: string;
  22292. /**
  22293. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  22294. */
  22295. get isUnique(): boolean;
  22296. /**
  22297. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  22298. */
  22299. get isFinalMerger(): boolean;
  22300. /**
  22301. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  22302. */
  22303. get isInput(): boolean;
  22304. /**
  22305. * Gets or sets the build Id
  22306. */
  22307. get buildId(): number;
  22308. set buildId(value: number);
  22309. /**
  22310. * Gets or sets the target of the block
  22311. */
  22312. get target(): NodeMaterialBlockTargets;
  22313. set target(value: NodeMaterialBlockTargets);
  22314. /**
  22315. * Gets the list of input points
  22316. */
  22317. get inputs(): NodeMaterialConnectionPoint[];
  22318. /** Gets the list of output points */
  22319. get outputs(): NodeMaterialConnectionPoint[];
  22320. /**
  22321. * Find an input by its name
  22322. * @param name defines the name of the input to look for
  22323. * @returns the input or null if not found
  22324. */
  22325. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22326. /**
  22327. * Find an output by its name
  22328. * @param name defines the name of the outputto look for
  22329. * @returns the output or null if not found
  22330. */
  22331. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22332. /**
  22333. * Creates a new NodeMaterialBlock
  22334. * @param name defines the block name
  22335. * @param target defines the target of that block (Vertex by default)
  22336. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  22337. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  22338. */
  22339. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  22340. /**
  22341. * Initialize the block and prepare the context for build
  22342. * @param state defines the state that will be used for the build
  22343. */
  22344. initialize(state: NodeMaterialBuildState): void;
  22345. /**
  22346. * Bind data to effect. Will only be called for blocks with isBindable === true
  22347. * @param effect defines the effect to bind data to
  22348. * @param nodeMaterial defines the hosting NodeMaterial
  22349. * @param mesh defines the mesh that will be rendered
  22350. * @param subMesh defines the submesh that will be rendered
  22351. */
  22352. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  22353. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  22354. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  22355. protected _writeFloat(value: number): string;
  22356. /**
  22357. * Gets the current class name e.g. "NodeMaterialBlock"
  22358. * @returns the class name
  22359. */
  22360. getClassName(): string;
  22361. /**
  22362. * Register a new input. Must be called inside a block constructor
  22363. * @param name defines the connection point name
  22364. * @param type defines the connection point type
  22365. * @param isOptional defines a boolean indicating that this input can be omitted
  22366. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22367. * @param point an already created connection point. If not provided, create a new one
  22368. * @returns the current block
  22369. */
  22370. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22371. /**
  22372. * Register a new output. Must be called inside a block constructor
  22373. * @param name defines the connection point name
  22374. * @param type defines the connection point type
  22375. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22376. * @param point an already created connection point. If not provided, create a new one
  22377. * @returns the current block
  22378. */
  22379. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22380. /**
  22381. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  22382. * @param forOutput defines an optional connection point to check compatibility with
  22383. * @returns the first available input or null
  22384. */
  22385. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  22386. /**
  22387. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  22388. * @param forBlock defines an optional block to check compatibility with
  22389. * @returns the first available input or null
  22390. */
  22391. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  22392. /**
  22393. * Gets the sibling of the given output
  22394. * @param current defines the current output
  22395. * @returns the next output in the list or null
  22396. */
  22397. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  22398. /**
  22399. * Connect current block with another block
  22400. * @param other defines the block to connect with
  22401. * @param options define the various options to help pick the right connections
  22402. * @returns the current block
  22403. */
  22404. connectTo(other: NodeMaterialBlock, options?: {
  22405. input?: string;
  22406. output?: string;
  22407. outputSwizzle?: string;
  22408. }): this | undefined;
  22409. protected _buildBlock(state: NodeMaterialBuildState): void;
  22410. /**
  22411. * Add uniforms, samplers and uniform buffers at compilation time
  22412. * @param state defines the state to update
  22413. * @param nodeMaterial defines the node material requesting the update
  22414. * @param defines defines the material defines to update
  22415. * @param uniformBuffers defines the list of uniform buffer names
  22416. */
  22417. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  22418. /**
  22419. * Add potential fallbacks if shader compilation fails
  22420. * @param mesh defines the mesh to be rendered
  22421. * @param fallbacks defines the current prioritized list of fallbacks
  22422. */
  22423. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  22424. /**
  22425. * Initialize defines for shader compilation
  22426. * @param mesh defines the mesh to be rendered
  22427. * @param nodeMaterial defines the node material requesting the update
  22428. * @param defines defines the material defines to update
  22429. * @param useInstances specifies that instances should be used
  22430. */
  22431. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  22432. /**
  22433. * Update defines for shader compilation
  22434. * @param mesh defines the mesh to be rendered
  22435. * @param nodeMaterial defines the node material requesting the update
  22436. * @param defines defines the material defines to update
  22437. * @param useInstances specifies that instances should be used
  22438. * @param subMesh defines which submesh to render
  22439. */
  22440. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22441. /**
  22442. * Lets the block try to connect some inputs automatically
  22443. * @param material defines the hosting NodeMaterial
  22444. */
  22445. autoConfigure(material: NodeMaterial): void;
  22446. /**
  22447. * Function called when a block is declared as repeatable content generator
  22448. * @param vertexShaderState defines the current compilation state for the vertex shader
  22449. * @param fragmentShaderState defines the current compilation state for the fragment shader
  22450. * @param mesh defines the mesh to be rendered
  22451. * @param defines defines the material defines to update
  22452. */
  22453. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  22454. /**
  22455. * Checks if the block is ready
  22456. * @param mesh defines the mesh to be rendered
  22457. * @param nodeMaterial defines the node material requesting the update
  22458. * @param defines defines the material defines to update
  22459. * @param useInstances specifies that instances should be used
  22460. * @returns true if the block is ready
  22461. */
  22462. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  22463. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  22464. private _processBuild;
  22465. /**
  22466. * Validates the new name for the block node.
  22467. * @param newName the new name to be given to the node.
  22468. * @returns false if the name is a reserve word, else true.
  22469. */
  22470. validateBlockName(newName: string): boolean;
  22471. /**
  22472. * Compile the current node and generate the shader code
  22473. * @param state defines the current compilation state (uniforms, samplers, current string)
  22474. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  22475. * @returns true if already built
  22476. */
  22477. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  22478. protected _inputRename(name: string): string;
  22479. protected _outputRename(name: string): string;
  22480. protected _dumpPropertiesCode(): string;
  22481. /** @hidden */
  22482. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  22483. /** @hidden */
  22484. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  22485. /**
  22486. * Clone the current block to a new identical block
  22487. * @param scene defines the hosting scene
  22488. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  22489. * @returns a copy of the current block
  22490. */
  22491. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  22492. /**
  22493. * Serializes this block in a JSON representation
  22494. * @returns the serialized block object
  22495. */
  22496. serialize(): any;
  22497. /** @hidden */
  22498. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22499. private _deserializePortDisplayNamesAndExposedOnFrame;
  22500. /**
  22501. * Release resources
  22502. */
  22503. dispose(): void;
  22504. }
  22505. }
  22506. declare module "babylonjs/Materials/pushMaterial" {
  22507. import { Nullable } from "babylonjs/types";
  22508. import { Scene } from "babylonjs/scene";
  22509. import { Matrix } from "babylonjs/Maths/math.vector";
  22510. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22511. import { Mesh } from "babylonjs/Meshes/mesh";
  22512. import { Material } from "babylonjs/Materials/material";
  22513. import { Effect } from "babylonjs/Materials/effect";
  22514. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22515. /**
  22516. * Base class of materials working in push mode in babylon JS
  22517. * @hidden
  22518. */
  22519. export class PushMaterial extends Material {
  22520. protected _activeEffect: Effect;
  22521. protected _normalMatrix: Matrix;
  22522. constructor(name: string, scene: Scene);
  22523. getEffect(): Effect;
  22524. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  22525. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  22526. /**
  22527. * Binds the given world matrix to the active effect
  22528. *
  22529. * @param world the matrix to bind
  22530. */
  22531. bindOnlyWorldMatrix(world: Matrix): void;
  22532. /**
  22533. * Binds the given normal matrix to the active effect
  22534. *
  22535. * @param normalMatrix the matrix to bind
  22536. */
  22537. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  22538. bind(world: Matrix, mesh?: Mesh): void;
  22539. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  22540. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  22541. }
  22542. }
  22543. declare module "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer" {
  22544. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22545. /**
  22546. * Root class for all node material optimizers
  22547. */
  22548. export class NodeMaterialOptimizer {
  22549. /**
  22550. * Function used to optimize a NodeMaterial graph
  22551. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  22552. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  22553. */
  22554. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  22555. }
  22556. }
  22557. declare module "babylonjs/Materials/Node/Blocks/transformBlock" {
  22558. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22559. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22560. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22561. import { Scene } from "babylonjs/scene";
  22562. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22563. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22564. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22565. /**
  22566. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  22567. */
  22568. export class TransformBlock extends NodeMaterialBlock {
  22569. /**
  22570. * Defines the value to use to complement W value to transform it to a Vector4
  22571. */
  22572. complementW: number;
  22573. /**
  22574. * Defines the value to use to complement z value to transform it to a Vector4
  22575. */
  22576. complementZ: number;
  22577. /**
  22578. * Creates a new TransformBlock
  22579. * @param name defines the block name
  22580. */
  22581. constructor(name: string);
  22582. /**
  22583. * Gets the current class name
  22584. * @returns the class name
  22585. */
  22586. getClassName(): string;
  22587. /**
  22588. * Gets the vector input
  22589. */
  22590. get vector(): NodeMaterialConnectionPoint;
  22591. /**
  22592. * Gets the output component
  22593. */
  22594. get output(): NodeMaterialConnectionPoint;
  22595. /**
  22596. * Gets the xyz output component
  22597. */
  22598. get xyz(): NodeMaterialConnectionPoint;
  22599. /**
  22600. * Gets the matrix transform input
  22601. */
  22602. get transform(): NodeMaterialConnectionPoint;
  22603. protected _buildBlock(state: NodeMaterialBuildState): this;
  22604. /**
  22605. * Update defines for shader compilation
  22606. * @param mesh defines the mesh to be rendered
  22607. * @param nodeMaterial defines the node material requesting the update
  22608. * @param defines defines the material defines to update
  22609. * @param useInstances specifies that instances should be used
  22610. * @param subMesh defines which submesh to render
  22611. */
  22612. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22613. serialize(): any;
  22614. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22615. protected _dumpPropertiesCode(): string;
  22616. }
  22617. }
  22618. declare module "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock" {
  22619. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22620. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22621. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22622. /**
  22623. * Block used to output the vertex position
  22624. */
  22625. export class VertexOutputBlock extends NodeMaterialBlock {
  22626. /**
  22627. * Creates a new VertexOutputBlock
  22628. * @param name defines the block name
  22629. */
  22630. constructor(name: string);
  22631. /**
  22632. * Gets the current class name
  22633. * @returns the class name
  22634. */
  22635. getClassName(): string;
  22636. /**
  22637. * Gets the vector input component
  22638. */
  22639. get vector(): NodeMaterialConnectionPoint;
  22640. protected _buildBlock(state: NodeMaterialBuildState): this;
  22641. }
  22642. }
  22643. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock" {
  22644. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22645. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22646. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22647. /**
  22648. * Block used to output the final color
  22649. */
  22650. export class FragmentOutputBlock extends NodeMaterialBlock {
  22651. /**
  22652. * Create a new FragmentOutputBlock
  22653. * @param name defines the block name
  22654. */
  22655. constructor(name: string);
  22656. /**
  22657. * Gets the current class name
  22658. * @returns the class name
  22659. */
  22660. getClassName(): string;
  22661. /**
  22662. * Gets the rgba input component
  22663. */
  22664. get rgba(): NodeMaterialConnectionPoint;
  22665. /**
  22666. * Gets the rgb input component
  22667. */
  22668. get rgb(): NodeMaterialConnectionPoint;
  22669. /**
  22670. * Gets the a input component
  22671. */
  22672. get a(): NodeMaterialConnectionPoint;
  22673. protected _buildBlock(state: NodeMaterialBuildState): this;
  22674. }
  22675. }
  22676. declare module "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock" {
  22677. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22678. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22679. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22680. /**
  22681. * Block used for the particle ramp gradient section
  22682. */
  22683. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  22684. /**
  22685. * Create a new ParticleRampGradientBlock
  22686. * @param name defines the block name
  22687. */
  22688. constructor(name: string);
  22689. /**
  22690. * Gets the current class name
  22691. * @returns the class name
  22692. */
  22693. getClassName(): string;
  22694. /**
  22695. * Gets the color input component
  22696. */
  22697. get color(): NodeMaterialConnectionPoint;
  22698. /**
  22699. * Gets the rampColor output component
  22700. */
  22701. get rampColor(): NodeMaterialConnectionPoint;
  22702. /**
  22703. * Initialize the block and prepare the context for build
  22704. * @param state defines the state that will be used for the build
  22705. */
  22706. initialize(state: NodeMaterialBuildState): void;
  22707. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22708. }
  22709. }
  22710. declare module "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock" {
  22711. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22712. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22713. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22714. /**
  22715. * Block used for the particle blend multiply section
  22716. */
  22717. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  22718. /**
  22719. * Create a new ParticleBlendMultiplyBlock
  22720. * @param name defines the block name
  22721. */
  22722. constructor(name: string);
  22723. /**
  22724. * Gets the current class name
  22725. * @returns the class name
  22726. */
  22727. getClassName(): string;
  22728. /**
  22729. * Gets the color input component
  22730. */
  22731. get color(): NodeMaterialConnectionPoint;
  22732. /**
  22733. * Gets the alphaTexture input component
  22734. */
  22735. get alphaTexture(): NodeMaterialConnectionPoint;
  22736. /**
  22737. * Gets the alphaColor input component
  22738. */
  22739. get alphaColor(): NodeMaterialConnectionPoint;
  22740. /**
  22741. * Gets the blendColor output component
  22742. */
  22743. get blendColor(): NodeMaterialConnectionPoint;
  22744. /**
  22745. * Initialize the block and prepare the context for build
  22746. * @param state defines the state that will be used for the build
  22747. */
  22748. initialize(state: NodeMaterialBuildState): void;
  22749. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22750. }
  22751. }
  22752. declare module "babylonjs/Materials/Node/Blocks/vectorMergerBlock" {
  22753. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22754. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22755. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22756. /**
  22757. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  22758. */
  22759. export class VectorMergerBlock extends NodeMaterialBlock {
  22760. /**
  22761. * Create a new VectorMergerBlock
  22762. * @param name defines the block name
  22763. */
  22764. constructor(name: string);
  22765. /**
  22766. * Gets the current class name
  22767. * @returns the class name
  22768. */
  22769. getClassName(): string;
  22770. /**
  22771. * Gets the xyz component (input)
  22772. */
  22773. get xyzIn(): NodeMaterialConnectionPoint;
  22774. /**
  22775. * Gets the xy component (input)
  22776. */
  22777. get xyIn(): NodeMaterialConnectionPoint;
  22778. /**
  22779. * Gets the x component (input)
  22780. */
  22781. get x(): NodeMaterialConnectionPoint;
  22782. /**
  22783. * Gets the y component (input)
  22784. */
  22785. get y(): NodeMaterialConnectionPoint;
  22786. /**
  22787. * Gets the z component (input)
  22788. */
  22789. get z(): NodeMaterialConnectionPoint;
  22790. /**
  22791. * Gets the w component (input)
  22792. */
  22793. get w(): NodeMaterialConnectionPoint;
  22794. /**
  22795. * Gets the xyzw component (output)
  22796. */
  22797. get xyzw(): NodeMaterialConnectionPoint;
  22798. /**
  22799. * Gets the xyz component (output)
  22800. */
  22801. get xyzOut(): NodeMaterialConnectionPoint;
  22802. /**
  22803. * Gets the xy component (output)
  22804. */
  22805. get xyOut(): NodeMaterialConnectionPoint;
  22806. /**
  22807. * Gets the xy component (output)
  22808. * @deprecated Please use xyOut instead.
  22809. */
  22810. get xy(): NodeMaterialConnectionPoint;
  22811. /**
  22812. * Gets the xyz component (output)
  22813. * @deprecated Please use xyzOut instead.
  22814. */
  22815. get xyz(): NodeMaterialConnectionPoint;
  22816. protected _buildBlock(state: NodeMaterialBuildState): this;
  22817. }
  22818. }
  22819. declare module "babylonjs/Materials/Node/Blocks/remapBlock" {
  22820. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22821. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22822. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22823. import { Vector2 } from "babylonjs/Maths/math.vector";
  22824. import { Scene } from "babylonjs/scene";
  22825. /**
  22826. * Block used to remap a float from a range to a new one
  22827. */
  22828. export class RemapBlock extends NodeMaterialBlock {
  22829. /**
  22830. * Gets or sets the source range
  22831. */
  22832. sourceRange: Vector2;
  22833. /**
  22834. * Gets or sets the target range
  22835. */
  22836. targetRange: Vector2;
  22837. /**
  22838. * Creates a new RemapBlock
  22839. * @param name defines the block name
  22840. */
  22841. constructor(name: string);
  22842. /**
  22843. * Gets the current class name
  22844. * @returns the class name
  22845. */
  22846. getClassName(): string;
  22847. /**
  22848. * Gets the input component
  22849. */
  22850. get input(): NodeMaterialConnectionPoint;
  22851. /**
  22852. * Gets the source min input component
  22853. */
  22854. get sourceMin(): NodeMaterialConnectionPoint;
  22855. /**
  22856. * Gets the source max input component
  22857. */
  22858. get sourceMax(): NodeMaterialConnectionPoint;
  22859. /**
  22860. * Gets the target min input component
  22861. */
  22862. get targetMin(): NodeMaterialConnectionPoint;
  22863. /**
  22864. * Gets the target max input component
  22865. */
  22866. get targetMax(): NodeMaterialConnectionPoint;
  22867. /**
  22868. * Gets the output component
  22869. */
  22870. get output(): NodeMaterialConnectionPoint;
  22871. protected _buildBlock(state: NodeMaterialBuildState): this;
  22872. protected _dumpPropertiesCode(): string;
  22873. serialize(): any;
  22874. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22875. }
  22876. }
  22877. declare module "babylonjs/Materials/Node/Blocks/multiplyBlock" {
  22878. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22879. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22880. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22881. /**
  22882. * Block used to multiply 2 values
  22883. */
  22884. export class MultiplyBlock extends NodeMaterialBlock {
  22885. /**
  22886. * Creates a new MultiplyBlock
  22887. * @param name defines the block name
  22888. */
  22889. constructor(name: string);
  22890. /**
  22891. * Gets the current class name
  22892. * @returns the class name
  22893. */
  22894. getClassName(): string;
  22895. /**
  22896. * Gets the left operand input component
  22897. */
  22898. get left(): NodeMaterialConnectionPoint;
  22899. /**
  22900. * Gets the right operand input component
  22901. */
  22902. get right(): NodeMaterialConnectionPoint;
  22903. /**
  22904. * Gets the output component
  22905. */
  22906. get output(): NodeMaterialConnectionPoint;
  22907. protected _buildBlock(state: NodeMaterialBuildState): this;
  22908. }
  22909. }
  22910. declare module "babylonjs/Materials/Node/Blocks/colorSplitterBlock" {
  22911. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22912. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22913. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22914. /**
  22915. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  22916. */
  22917. export class ColorSplitterBlock extends NodeMaterialBlock {
  22918. /**
  22919. * Create a new ColorSplitterBlock
  22920. * @param name defines the block name
  22921. */
  22922. constructor(name: string);
  22923. /**
  22924. * Gets the current class name
  22925. * @returns the class name
  22926. */
  22927. getClassName(): string;
  22928. /**
  22929. * Gets the rgba component (input)
  22930. */
  22931. get rgba(): NodeMaterialConnectionPoint;
  22932. /**
  22933. * Gets the rgb component (input)
  22934. */
  22935. get rgbIn(): NodeMaterialConnectionPoint;
  22936. /**
  22937. * Gets the rgb component (output)
  22938. */
  22939. get rgbOut(): NodeMaterialConnectionPoint;
  22940. /**
  22941. * Gets the r component (output)
  22942. */
  22943. get r(): NodeMaterialConnectionPoint;
  22944. /**
  22945. * Gets the g component (output)
  22946. */
  22947. get g(): NodeMaterialConnectionPoint;
  22948. /**
  22949. * Gets the b component (output)
  22950. */
  22951. get b(): NodeMaterialConnectionPoint;
  22952. /**
  22953. * Gets the a component (output)
  22954. */
  22955. get a(): NodeMaterialConnectionPoint;
  22956. protected _inputRename(name: string): string;
  22957. protected _outputRename(name: string): string;
  22958. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22959. }
  22960. }
  22961. declare module "babylonjs/Materials/Node/nodeMaterial" {
  22962. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22963. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  22964. import { Scene } from "babylonjs/scene";
  22965. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22966. import { Matrix } from "babylonjs/Maths/math.vector";
  22967. import { Mesh } from "babylonjs/Meshes/mesh";
  22968. import { Engine } from "babylonjs/Engines/engine";
  22969. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  22970. import { Observable } from "babylonjs/Misc/observable";
  22971. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22972. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  22973. import { NodeMaterialOptimizer } from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  22974. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  22975. import { Nullable } from "babylonjs/types";
  22976. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  22977. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  22978. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  22979. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  22980. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  22981. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  22982. import { Effect } from "babylonjs/Materials/effect";
  22983. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  22984. import { Camera } from "babylonjs/Cameras/camera";
  22985. import { NodeMaterialModes } from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  22986. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  22987. /**
  22988. * Interface used to configure the node material editor
  22989. */
  22990. export interface INodeMaterialEditorOptions {
  22991. /** Define the URl to load node editor script */
  22992. editorURL?: string;
  22993. }
  22994. /** @hidden */
  22995. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  22996. NORMAL: boolean;
  22997. TANGENT: boolean;
  22998. UV1: boolean;
  22999. /** BONES */
  23000. NUM_BONE_INFLUENCERS: number;
  23001. BonesPerMesh: number;
  23002. BONETEXTURE: boolean;
  23003. /** MORPH TARGETS */
  23004. MORPHTARGETS: boolean;
  23005. MORPHTARGETS_NORMAL: boolean;
  23006. MORPHTARGETS_TANGENT: boolean;
  23007. MORPHTARGETS_UV: boolean;
  23008. NUM_MORPH_INFLUENCERS: number;
  23009. /** IMAGE PROCESSING */
  23010. IMAGEPROCESSING: boolean;
  23011. VIGNETTE: boolean;
  23012. VIGNETTEBLENDMODEMULTIPLY: boolean;
  23013. VIGNETTEBLENDMODEOPAQUE: boolean;
  23014. TONEMAPPING: boolean;
  23015. TONEMAPPING_ACES: boolean;
  23016. CONTRAST: boolean;
  23017. EXPOSURE: boolean;
  23018. COLORCURVES: boolean;
  23019. COLORGRADING: boolean;
  23020. COLORGRADING3D: boolean;
  23021. SAMPLER3DGREENDEPTH: boolean;
  23022. SAMPLER3DBGRMAP: boolean;
  23023. IMAGEPROCESSINGPOSTPROCESS: boolean;
  23024. /** MISC. */
  23025. BUMPDIRECTUV: number;
  23026. constructor();
  23027. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  23028. }
  23029. /**
  23030. * Class used to configure NodeMaterial
  23031. */
  23032. export interface INodeMaterialOptions {
  23033. /**
  23034. * Defines if blocks should emit comments
  23035. */
  23036. emitComments: boolean;
  23037. }
  23038. /**
  23039. * Class used to create a node based material built by assembling shader blocks
  23040. */
  23041. export class NodeMaterial extends PushMaterial {
  23042. private static _BuildIdGenerator;
  23043. private _options;
  23044. private _vertexCompilationState;
  23045. private _fragmentCompilationState;
  23046. private _sharedData;
  23047. private _buildId;
  23048. private _buildWasSuccessful;
  23049. private _cachedWorldViewMatrix;
  23050. private _cachedWorldViewProjectionMatrix;
  23051. private _optimizers;
  23052. private _animationFrame;
  23053. /** Define the Url to load node editor script */
  23054. static EditorURL: string;
  23055. /** Define the Url to load snippets */
  23056. static SnippetUrl: string;
  23057. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  23058. static IgnoreTexturesAtLoadTime: boolean;
  23059. private BJSNODEMATERIALEDITOR;
  23060. /** Get the inspector from bundle or global */
  23061. private _getGlobalNodeMaterialEditor;
  23062. /**
  23063. * Snippet ID if the material was created from the snippet server
  23064. */
  23065. snippetId: string;
  23066. /**
  23067. * Gets or sets data used by visual editor
  23068. * @see https://nme.babylonjs.com
  23069. */
  23070. editorData: any;
  23071. /**
  23072. * 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)
  23073. */
  23074. ignoreAlpha: boolean;
  23075. /**
  23076. * Defines the maximum number of lights that can be used in the material
  23077. */
  23078. maxSimultaneousLights: number;
  23079. /**
  23080. * Observable raised when the material is built
  23081. */
  23082. onBuildObservable: Observable<NodeMaterial>;
  23083. /**
  23084. * Gets or sets the root nodes of the material vertex shader
  23085. */
  23086. _vertexOutputNodes: NodeMaterialBlock[];
  23087. /**
  23088. * Gets or sets the root nodes of the material fragment (pixel) shader
  23089. */
  23090. _fragmentOutputNodes: NodeMaterialBlock[];
  23091. /** Gets or sets options to control the node material overall behavior */
  23092. get options(): INodeMaterialOptions;
  23093. set options(options: INodeMaterialOptions);
  23094. /**
  23095. * Default configuration related to image processing available in the standard Material.
  23096. */
  23097. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  23098. /**
  23099. * Gets the image processing configuration used either in this material.
  23100. */
  23101. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  23102. /**
  23103. * Sets the Default image processing configuration used either in the this material.
  23104. *
  23105. * If sets to null, the scene one is in use.
  23106. */
  23107. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  23108. /**
  23109. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  23110. */
  23111. attachedBlocks: NodeMaterialBlock[];
  23112. /**
  23113. * Specifies the mode of the node material
  23114. * @hidden
  23115. */
  23116. _mode: NodeMaterialModes;
  23117. /**
  23118. * Gets the mode property
  23119. */
  23120. get mode(): NodeMaterialModes;
  23121. /**
  23122. * Create a new node based material
  23123. * @param name defines the material name
  23124. * @param scene defines the hosting scene
  23125. * @param options defines creation option
  23126. */
  23127. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  23128. /**
  23129. * Gets the current class name of the material e.g. "NodeMaterial"
  23130. * @returns the class name
  23131. */
  23132. getClassName(): string;
  23133. /**
  23134. * Keep track of the image processing observer to allow dispose and replace.
  23135. */
  23136. private _imageProcessingObserver;
  23137. /**
  23138. * Attaches a new image processing configuration to the Standard Material.
  23139. * @param configuration
  23140. */
  23141. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  23142. /**
  23143. * Get a block by its name
  23144. * @param name defines the name of the block to retrieve
  23145. * @returns the required block or null if not found
  23146. */
  23147. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  23148. /**
  23149. * Get a block by its name
  23150. * @param predicate defines the predicate used to find the good candidate
  23151. * @returns the required block or null if not found
  23152. */
  23153. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  23154. /**
  23155. * Get an input block by its name
  23156. * @param predicate defines the predicate used to find the good candidate
  23157. * @returns the required input block or null if not found
  23158. */
  23159. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  23160. /**
  23161. * Gets the list of input blocks attached to this material
  23162. * @returns an array of InputBlocks
  23163. */
  23164. getInputBlocks(): InputBlock[];
  23165. /**
  23166. * Adds a new optimizer to the list of optimizers
  23167. * @param optimizer defines the optimizers to add
  23168. * @returns the current material
  23169. */
  23170. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  23171. /**
  23172. * Remove an optimizer from the list of optimizers
  23173. * @param optimizer defines the optimizers to remove
  23174. * @returns the current material
  23175. */
  23176. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  23177. /**
  23178. * Add a new block to the list of output nodes
  23179. * @param node defines the node to add
  23180. * @returns the current material
  23181. */
  23182. addOutputNode(node: NodeMaterialBlock): this;
  23183. /**
  23184. * Remove a block from the list of root nodes
  23185. * @param node defines the node to remove
  23186. * @returns the current material
  23187. */
  23188. removeOutputNode(node: NodeMaterialBlock): this;
  23189. private _addVertexOutputNode;
  23190. private _removeVertexOutputNode;
  23191. private _addFragmentOutputNode;
  23192. private _removeFragmentOutputNode;
  23193. /**
  23194. * Specifies if the material will require alpha blending
  23195. * @returns a boolean specifying if alpha blending is needed
  23196. */
  23197. needAlphaBlending(): boolean;
  23198. /**
  23199. * Specifies if this material should be rendered in alpha test mode
  23200. * @returns a boolean specifying if an alpha test is needed.
  23201. */
  23202. needAlphaTesting(): boolean;
  23203. private _initializeBlock;
  23204. private _resetDualBlocks;
  23205. /**
  23206. * Remove a block from the current node material
  23207. * @param block defines the block to remove
  23208. */
  23209. removeBlock(block: NodeMaterialBlock): void;
  23210. /**
  23211. * Build the material and generates the inner effect
  23212. * @param verbose defines if the build should log activity
  23213. */
  23214. build(verbose?: boolean): void;
  23215. /**
  23216. * Runs an otpimization phase to try to improve the shader code
  23217. */
  23218. optimize(): void;
  23219. private _prepareDefinesForAttributes;
  23220. /**
  23221. * Create a post process from the material
  23222. * @param camera The camera to apply the render pass to.
  23223. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23224. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23225. * @param engine The engine which the post process will be applied. (default: current engine)
  23226. * @param reusable If the post process can be reused on the same frame. (default: false)
  23227. * @param textureType Type of textures used when performing the post process. (default: 0)
  23228. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  23229. * @returns the post process created
  23230. */
  23231. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): PostProcess;
  23232. /**
  23233. * Create the post process effect from the material
  23234. * @param postProcess The post process to create the effect for
  23235. */
  23236. createEffectForPostProcess(postProcess: PostProcess): void;
  23237. private _createEffectOrPostProcess;
  23238. private _createEffectForParticles;
  23239. /**
  23240. * Create the effect to be used as the custom effect for a particle system
  23241. * @param particleSystem Particle system to create the effect for
  23242. * @param onCompiled defines a function to call when the effect creation is successful
  23243. * @param onError defines a function to call when the effect creation has failed
  23244. */
  23245. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23246. private _processDefines;
  23247. /**
  23248. * Get if the submesh is ready to be used and all its information available.
  23249. * Child classes can use it to update shaders
  23250. * @param mesh defines the mesh to check
  23251. * @param subMesh defines which submesh to check
  23252. * @param useInstances specifies that instances should be used
  23253. * @returns a boolean indicating that the submesh is ready or not
  23254. */
  23255. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  23256. /**
  23257. * Get a string representing the shaders built by the current node graph
  23258. */
  23259. get compiledShaders(): string;
  23260. /**
  23261. * Binds the world matrix to the material
  23262. * @param world defines the world transformation matrix
  23263. */
  23264. bindOnlyWorldMatrix(world: Matrix): void;
  23265. /**
  23266. * Binds the submesh to this material by preparing the effect and shader to draw
  23267. * @param world defines the world transformation matrix
  23268. * @param mesh defines the mesh containing the submesh
  23269. * @param subMesh defines the submesh to bind the material to
  23270. */
  23271. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  23272. /**
  23273. * Gets the active textures from the material
  23274. * @returns an array of textures
  23275. */
  23276. getActiveTextures(): BaseTexture[];
  23277. /**
  23278. * Gets the list of texture blocks
  23279. * @returns an array of texture blocks
  23280. */
  23281. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  23282. /**
  23283. * Specifies if the material uses a texture
  23284. * @param texture defines the texture to check against the material
  23285. * @returns a boolean specifying if the material uses the texture
  23286. */
  23287. hasTexture(texture: BaseTexture): boolean;
  23288. /**
  23289. * Disposes the material
  23290. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  23291. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  23292. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  23293. */
  23294. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  23295. /** Creates the node editor window. */
  23296. private _createNodeEditor;
  23297. /**
  23298. * Launch the node material editor
  23299. * @param config Define the configuration of the editor
  23300. * @return a promise fulfilled when the node editor is visible
  23301. */
  23302. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  23303. /**
  23304. * Clear the current material
  23305. */
  23306. clear(): void;
  23307. /**
  23308. * Clear the current material and set it to a default state
  23309. */
  23310. setToDefault(): void;
  23311. /**
  23312. * Clear the current material and set it to a default state for post process
  23313. */
  23314. setToDefaultPostProcess(): void;
  23315. /**
  23316. * Clear the current material and set it to a default state for particle
  23317. */
  23318. setToDefaultParticle(): void;
  23319. /**
  23320. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  23321. * @param url defines the url to load from
  23322. * @returns a promise that will fullfil when the material is fully loaded
  23323. */
  23324. loadAsync(url: string): Promise<void>;
  23325. private _gatherBlocks;
  23326. /**
  23327. * Generate a string containing the code declaration required to create an equivalent of this material
  23328. * @returns a string
  23329. */
  23330. generateCode(): string;
  23331. /**
  23332. * Serializes this material in a JSON representation
  23333. * @returns the serialized material object
  23334. */
  23335. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  23336. private _restoreConnections;
  23337. /**
  23338. * Clear the current graph and load a new one from a serialization object
  23339. * @param source defines the JSON representation of the material
  23340. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23341. * @param merge defines whether or not the source must be merged or replace the current content
  23342. */
  23343. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  23344. /**
  23345. * Makes a duplicate of the current material.
  23346. * @param name - name to use for the new material.
  23347. */
  23348. clone(name: string): NodeMaterial;
  23349. /**
  23350. * Creates a node material from parsed material data
  23351. * @param source defines the JSON representation of the material
  23352. * @param scene defines the hosting scene
  23353. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23354. * @returns a new node material
  23355. */
  23356. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  23357. /**
  23358. * Creates a node material from a snippet saved in a remote file
  23359. * @param name defines the name of the material to create
  23360. * @param url defines the url to load from
  23361. * @param scene defines the hosting scene
  23362. * @returns a promise that will resolve to the new node material
  23363. */
  23364. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  23365. /**
  23366. * Creates a node material from a snippet saved by the node material editor
  23367. * @param snippetId defines the snippet to load
  23368. * @param scene defines the hosting scene
  23369. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23370. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  23371. * @returns a promise that will resolve to the new node material
  23372. */
  23373. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  23374. /**
  23375. * Creates a new node material set to default basic configuration
  23376. * @param name defines the name of the material
  23377. * @param scene defines the hosting scene
  23378. * @returns a new NodeMaterial
  23379. */
  23380. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  23381. }
  23382. }
  23383. declare module "babylonjs/PostProcesses/postProcess" {
  23384. import { Nullable } from "babylonjs/types";
  23385. import { SmartArray } from "babylonjs/Misc/smartArray";
  23386. import { Observable } from "babylonjs/Misc/observable";
  23387. import { Vector2 } from "babylonjs/Maths/math.vector";
  23388. import { Camera } from "babylonjs/Cameras/camera";
  23389. import { Effect } from "babylonjs/Materials/effect";
  23390. import "babylonjs/Shaders/postprocess.vertex";
  23391. import { IInspectable } from "babylonjs/Misc/iInspectable";
  23392. import { Engine } from "babylonjs/Engines/engine";
  23393. import { Color4 } from "babylonjs/Maths/math.color";
  23394. import "babylonjs/Engines/Extensions/engine.renderTarget";
  23395. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  23396. import { Scene } from "babylonjs/scene";
  23397. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  23398. /**
  23399. * Size options for a post process
  23400. */
  23401. export type PostProcessOptions = {
  23402. width: number;
  23403. height: number;
  23404. };
  23405. /**
  23406. * PostProcess can be used to apply a shader to a texture after it has been rendered
  23407. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  23408. */
  23409. export class PostProcess {
  23410. /**
  23411. * Gets or sets the unique id of the post process
  23412. */
  23413. uniqueId: number;
  23414. /** Name of the PostProcess. */
  23415. name: string;
  23416. /**
  23417. * Width of the texture to apply the post process on
  23418. */
  23419. width: number;
  23420. /**
  23421. * Height of the texture to apply the post process on
  23422. */
  23423. height: number;
  23424. /**
  23425. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  23426. */
  23427. nodeMaterialSource: Nullable<NodeMaterial>;
  23428. /**
  23429. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  23430. * @hidden
  23431. */
  23432. _outputTexture: Nullable<InternalTexture>;
  23433. /**
  23434. * Sampling mode used by the shader
  23435. * See https://doc.babylonjs.com/classes/3.1/texture
  23436. */
  23437. renderTargetSamplingMode: number;
  23438. /**
  23439. * Clear color to use when screen clearing
  23440. */
  23441. clearColor: Color4;
  23442. /**
  23443. * If the buffer needs to be cleared before applying the post process. (default: true)
  23444. * Should be set to false if shader will overwrite all previous pixels.
  23445. */
  23446. autoClear: boolean;
  23447. /**
  23448. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  23449. */
  23450. alphaMode: number;
  23451. /**
  23452. * Sets the setAlphaBlendConstants of the babylon engine
  23453. */
  23454. alphaConstants: Color4;
  23455. /**
  23456. * Animations to be used for the post processing
  23457. */
  23458. animations: import("babylonjs/Animations/animation").Animation[];
  23459. /**
  23460. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  23461. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  23462. */
  23463. enablePixelPerfectMode: boolean;
  23464. /**
  23465. * Force the postprocess to be applied without taking in account viewport
  23466. */
  23467. forceFullscreenViewport: boolean;
  23468. /**
  23469. * List of inspectable custom properties (used by the Inspector)
  23470. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  23471. */
  23472. inspectableCustomProperties: IInspectable[];
  23473. /**
  23474. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  23475. *
  23476. * | Value | Type | Description |
  23477. * | ----- | ----------------------------------- | ----------- |
  23478. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  23479. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  23480. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  23481. *
  23482. */
  23483. scaleMode: number;
  23484. /**
  23485. * Force textures to be a power of two (default: false)
  23486. */
  23487. alwaysForcePOT: boolean;
  23488. private _samples;
  23489. /**
  23490. * Number of sample textures (default: 1)
  23491. */
  23492. get samples(): number;
  23493. set samples(n: number);
  23494. /**
  23495. * Modify the scale of the post process to be the same as the viewport (default: false)
  23496. */
  23497. adaptScaleToCurrentViewport: boolean;
  23498. private _camera;
  23499. protected _scene: Scene;
  23500. private _engine;
  23501. private _options;
  23502. private _reusable;
  23503. private _textureType;
  23504. private _textureFormat;
  23505. /**
  23506. * Smart array of input and output textures for the post process.
  23507. * @hidden
  23508. */
  23509. _textures: SmartArray<import("babylonjs/Materials/Textures/internalTexture").InternalTexture>;
  23510. /**
  23511. * The index in _textures that corresponds to the output texture.
  23512. * @hidden
  23513. */
  23514. _currentRenderTextureInd: number;
  23515. private _effect;
  23516. private _samplers;
  23517. private _fragmentUrl;
  23518. private _vertexUrl;
  23519. private _parameters;
  23520. private _scaleRatio;
  23521. protected _indexParameters: any;
  23522. private _shareOutputWithPostProcess;
  23523. private _texelSize;
  23524. private _forcedOutputTexture;
  23525. /**
  23526. * Returns the fragment url or shader name used in the post process.
  23527. * @returns the fragment url or name in the shader store.
  23528. */
  23529. getEffectName(): string;
  23530. /**
  23531. * An event triggered when the postprocess is activated.
  23532. */
  23533. onActivateObservable: Observable<Camera>;
  23534. private _onActivateObserver;
  23535. /**
  23536. * A function that is added to the onActivateObservable
  23537. */
  23538. set onActivate(callback: Nullable<(camera: Camera) => void>);
  23539. /**
  23540. * An event triggered when the postprocess changes its size.
  23541. */
  23542. onSizeChangedObservable: Observable<PostProcess>;
  23543. private _onSizeChangedObserver;
  23544. /**
  23545. * A function that is added to the onSizeChangedObservable
  23546. */
  23547. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  23548. /**
  23549. * An event triggered when the postprocess applies its effect.
  23550. */
  23551. onApplyObservable: Observable<Effect>;
  23552. private _onApplyObserver;
  23553. /**
  23554. * A function that is added to the onApplyObservable
  23555. */
  23556. set onApply(callback: (effect: Effect) => void);
  23557. /**
  23558. * An event triggered before rendering the postprocess
  23559. */
  23560. onBeforeRenderObservable: Observable<Effect>;
  23561. private _onBeforeRenderObserver;
  23562. /**
  23563. * A function that is added to the onBeforeRenderObservable
  23564. */
  23565. set onBeforeRender(callback: (effect: Effect) => void);
  23566. /**
  23567. * An event triggered after rendering the postprocess
  23568. */
  23569. onAfterRenderObservable: Observable<Effect>;
  23570. private _onAfterRenderObserver;
  23571. /**
  23572. * A function that is added to the onAfterRenderObservable
  23573. */
  23574. set onAfterRender(callback: (efect: Effect) => void);
  23575. /**
  23576. * 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
  23577. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  23578. */
  23579. get inputTexture(): InternalTexture;
  23580. set inputTexture(value: InternalTexture);
  23581. /**
  23582. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  23583. * the only way to unset it is to use this function to restore its internal state
  23584. */
  23585. restoreDefaultInputTexture(): void;
  23586. /**
  23587. * Gets the camera which post process is applied to.
  23588. * @returns The camera the post process is applied to.
  23589. */
  23590. getCamera(): Camera;
  23591. /**
  23592. * Gets the texel size of the postprocess.
  23593. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  23594. */
  23595. get texelSize(): Vector2;
  23596. /**
  23597. * Creates a new instance PostProcess
  23598. * @param name The name of the PostProcess.
  23599. * @param fragmentUrl The url of the fragment shader to be used.
  23600. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  23601. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  23602. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23603. * @param camera The camera to apply the render pass to.
  23604. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23605. * @param engine The engine which the post process will be applied. (default: current engine)
  23606. * @param reusable If the post process can be reused on the same frame. (default: false)
  23607. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  23608. * @param textureType Type of textures used when performing the post process. (default: 0)
  23609. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  23610. * @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
  23611. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  23612. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  23613. */
  23614. 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);
  23615. /**
  23616. * Gets a string identifying the name of the class
  23617. * @returns "PostProcess" string
  23618. */
  23619. getClassName(): string;
  23620. /**
  23621. * Gets the engine which this post process belongs to.
  23622. * @returns The engine the post process was enabled with.
  23623. */
  23624. getEngine(): Engine;
  23625. /**
  23626. * The effect that is created when initializing the post process.
  23627. * @returns The created effect corresponding the the postprocess.
  23628. */
  23629. getEffect(): Effect;
  23630. /**
  23631. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  23632. * @param postProcess The post process to share the output with.
  23633. * @returns This post process.
  23634. */
  23635. shareOutputWith(postProcess: PostProcess): PostProcess;
  23636. /**
  23637. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  23638. * This should be called if the post process that shares output with this post process is disabled/disposed.
  23639. */
  23640. useOwnOutput(): void;
  23641. /**
  23642. * Updates the effect with the current post process compile time values and recompiles the shader.
  23643. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23644. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23645. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23646. * @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
  23647. * @param onCompiled Called when the shader has been compiled.
  23648. * @param onError Called if there is an error when compiling a shader.
  23649. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  23650. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  23651. */
  23652. 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;
  23653. /**
  23654. * The post process is reusable if it can be used multiple times within one frame.
  23655. * @returns If the post process is reusable
  23656. */
  23657. isReusable(): boolean;
  23658. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  23659. markTextureDirty(): void;
  23660. /**
  23661. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  23662. * 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.
  23663. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  23664. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  23665. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  23666. * @returns The target texture that was bound to be written to.
  23667. */
  23668. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  23669. /**
  23670. * If the post process is supported.
  23671. */
  23672. get isSupported(): boolean;
  23673. /**
  23674. * The aspect ratio of the output texture.
  23675. */
  23676. get aspectRatio(): number;
  23677. /**
  23678. * Get a value indicating if the post-process is ready to be used
  23679. * @returns true if the post-process is ready (shader is compiled)
  23680. */
  23681. isReady(): boolean;
  23682. /**
  23683. * Binds all textures and uniforms to the shader, this will be run on every pass.
  23684. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  23685. */
  23686. apply(): Nullable<Effect>;
  23687. private _disposeTextures;
  23688. /**
  23689. * Disposes the post process.
  23690. * @param camera The camera to dispose the post process on.
  23691. */
  23692. dispose(camera?: Camera): void;
  23693. /**
  23694. * Serializes the particle system to a JSON object
  23695. * @returns the JSON object
  23696. */
  23697. serialize(): any;
  23698. /**
  23699. * Creates a material from parsed material data
  23700. * @param parsedPostProcess defines parsed post process data
  23701. * @param scene defines the hosting scene
  23702. * @param rootUrl defines the root URL to use to load textures
  23703. * @returns a new post process
  23704. */
  23705. static Parse(parsedPostProcess: any, scene: Scene, rootUrl: string): Nullable<PostProcess>;
  23706. }
  23707. }
  23708. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration" {
  23709. /** @hidden */
  23710. export var kernelBlurVaryingDeclaration: {
  23711. name: string;
  23712. shader: string;
  23713. };
  23714. }
  23715. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment" {
  23716. /** @hidden */
  23717. export var kernelBlurFragment: {
  23718. name: string;
  23719. shader: string;
  23720. };
  23721. }
  23722. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2" {
  23723. /** @hidden */
  23724. export var kernelBlurFragment2: {
  23725. name: string;
  23726. shader: string;
  23727. };
  23728. }
  23729. declare module "babylonjs/Shaders/kernelBlur.fragment" {
  23730. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23731. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  23732. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment";
  23733. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2";
  23734. /** @hidden */
  23735. export var kernelBlurPixelShader: {
  23736. name: string;
  23737. shader: string;
  23738. };
  23739. }
  23740. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVertex" {
  23741. /** @hidden */
  23742. export var kernelBlurVertex: {
  23743. name: string;
  23744. shader: string;
  23745. };
  23746. }
  23747. declare module "babylonjs/Shaders/kernelBlur.vertex" {
  23748. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23749. import "babylonjs/Shaders/ShadersInclude/kernelBlurVertex";
  23750. /** @hidden */
  23751. export var kernelBlurVertexShader: {
  23752. name: string;
  23753. shader: string;
  23754. };
  23755. }
  23756. declare module "babylonjs/PostProcesses/blurPostProcess" {
  23757. import { Vector2 } from "babylonjs/Maths/math.vector";
  23758. import { Nullable } from "babylonjs/types";
  23759. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  23760. import { Camera } from "babylonjs/Cameras/camera";
  23761. import { Effect } from "babylonjs/Materials/effect";
  23762. import { Engine } from "babylonjs/Engines/engine";
  23763. import "babylonjs/Shaders/kernelBlur.fragment";
  23764. import "babylonjs/Shaders/kernelBlur.vertex";
  23765. import { Scene } from "babylonjs/scene";
  23766. /**
  23767. * The Blur Post Process which blurs an image based on a kernel and direction.
  23768. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  23769. */
  23770. export class BlurPostProcess extends PostProcess {
  23771. private blockCompilation;
  23772. protected _kernel: number;
  23773. protected _idealKernel: number;
  23774. protected _packedFloat: boolean;
  23775. private _staticDefines;
  23776. /** The direction in which to blur the image. */
  23777. direction: Vector2;
  23778. /**
  23779. * Sets the length in pixels of the blur sample region
  23780. */
  23781. set kernel(v: number);
  23782. /**
  23783. * Gets the length in pixels of the blur sample region
  23784. */
  23785. get kernel(): number;
  23786. /**
  23787. * Sets wether or not the blur needs to unpack/repack floats
  23788. */
  23789. set packedFloat(v: boolean);
  23790. /**
  23791. * Gets wether or not the blur is unpacking/repacking floats
  23792. */
  23793. get packedFloat(): boolean;
  23794. /**
  23795. * Gets a string identifying the name of the class
  23796. * @returns "BlurPostProcess" string
  23797. */
  23798. getClassName(): string;
  23799. /**
  23800. * Creates a new instance BlurPostProcess
  23801. * @param name The name of the effect.
  23802. * @param direction The direction in which to blur the image.
  23803. * @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.
  23804. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23805. * @param camera The camera to apply the render pass to.
  23806. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23807. * @param engine The engine which the post process will be applied. (default: current engine)
  23808. * @param reusable If the post process can be reused on the same frame. (default: false)
  23809. * @param textureType Type of textures used when performing the post process. (default: 0)
  23810. * @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)
  23811. */
  23812. 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);
  23813. /**
  23814. * Updates the effect with the current post process compile time values and recompiles the shader.
  23815. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23816. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23817. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23818. * @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
  23819. * @param onCompiled Called when the shader has been compiled.
  23820. * @param onError Called if there is an error when compiling a shader.
  23821. */
  23822. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23823. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23824. /**
  23825. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  23826. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  23827. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  23828. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  23829. * The gaps between physical kernels are compensated for in the weighting of the samples
  23830. * @param idealKernel Ideal blur kernel.
  23831. * @return Nearest best kernel.
  23832. */
  23833. protected _nearestBestKernel(idealKernel: number): number;
  23834. /**
  23835. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  23836. * @param x The point on the Gaussian distribution to sample.
  23837. * @return the value of the Gaussian function at x.
  23838. */
  23839. protected _gaussianWeight(x: number): number;
  23840. /**
  23841. * Generates a string that can be used as a floating point number in GLSL.
  23842. * @param x Value to print.
  23843. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  23844. * @return GLSL float string.
  23845. */
  23846. protected _glslFloat(x: number, decimalFigures?: number): string;
  23847. /** @hidden */
  23848. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlurPostProcess>;
  23849. }
  23850. }
  23851. declare module "babylonjs/Materials/Textures/mirrorTexture" {
  23852. import { Scene } from "babylonjs/scene";
  23853. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  23854. import { Plane } from "babylonjs/Maths/math.plane";
  23855. /**
  23856. * Mirror texture can be used to simulate the view from a mirror in a scene.
  23857. * It will dynamically be rendered every frame to adapt to the camera point of view.
  23858. * You can then easily use it as a reflectionTexture on a flat surface.
  23859. * In case the surface is not a plane, please consider relying on reflection probes.
  23860. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23861. */
  23862. export class MirrorTexture extends RenderTargetTexture {
  23863. private scene;
  23864. /**
  23865. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  23866. * 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.
  23867. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23868. */
  23869. mirrorPlane: Plane;
  23870. /**
  23871. * Define the blur ratio used to blur the reflection if needed.
  23872. */
  23873. set blurRatio(value: number);
  23874. get blurRatio(): number;
  23875. /**
  23876. * Define the adaptive blur kernel used to blur the reflection if needed.
  23877. * This will autocompute the closest best match for the `blurKernel`
  23878. */
  23879. set adaptiveBlurKernel(value: number);
  23880. /**
  23881. * Define the blur kernel used to blur the reflection if needed.
  23882. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23883. */
  23884. set blurKernel(value: number);
  23885. /**
  23886. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  23887. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23888. */
  23889. set blurKernelX(value: number);
  23890. get blurKernelX(): number;
  23891. /**
  23892. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  23893. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23894. */
  23895. set blurKernelY(value: number);
  23896. get blurKernelY(): number;
  23897. private _autoComputeBlurKernel;
  23898. protected _onRatioRescale(): void;
  23899. private _updateGammaSpace;
  23900. private _imageProcessingConfigChangeObserver;
  23901. private _transformMatrix;
  23902. private _mirrorMatrix;
  23903. private _savedViewMatrix;
  23904. private _blurX;
  23905. private _blurY;
  23906. private _adaptiveBlurKernel;
  23907. private _blurKernelX;
  23908. private _blurKernelY;
  23909. private _blurRatio;
  23910. /**
  23911. * Instantiates a Mirror Texture.
  23912. * Mirror texture can be used to simulate the view from a mirror in a scene.
  23913. * It will dynamically be rendered every frame to adapt to the camera point of view.
  23914. * You can then easily use it as a reflectionTexture on a flat surface.
  23915. * In case the surface is not a plane, please consider relying on reflection probes.
  23916. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23917. * @param name
  23918. * @param size
  23919. * @param scene
  23920. * @param generateMipMaps
  23921. * @param type
  23922. * @param samplingMode
  23923. * @param generateDepthBuffer
  23924. */
  23925. constructor(name: string, size: number | {
  23926. width: number;
  23927. height: number;
  23928. } | {
  23929. ratio: number;
  23930. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  23931. private _preparePostProcesses;
  23932. /**
  23933. * Clone the mirror texture.
  23934. * @returns the cloned texture
  23935. */
  23936. clone(): MirrorTexture;
  23937. /**
  23938. * Serialize the texture to a JSON representation you could use in Parse later on
  23939. * @returns the serialized JSON representation
  23940. */
  23941. serialize(): any;
  23942. /**
  23943. * Dispose the texture and release its associated resources.
  23944. */
  23945. dispose(): void;
  23946. }
  23947. }
  23948. declare module "babylonjs/Materials/Textures/texture" {
  23949. import { Observable } from "babylonjs/Misc/observable";
  23950. import { Nullable } from "babylonjs/types";
  23951. import { Matrix } from "babylonjs/Maths/math.vector";
  23952. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  23953. import { IInspectable } from "babylonjs/Misc/iInspectable";
  23954. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  23955. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  23956. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  23957. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  23958. import { Scene } from "babylonjs/scene";
  23959. /**
  23960. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  23961. * @see https://doc.babylonjs.com/babylon101/materials#texture
  23962. */
  23963. export class Texture extends BaseTexture {
  23964. /**
  23965. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  23966. */
  23967. static SerializeBuffers: boolean;
  23968. /** @hidden */
  23969. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  23970. /** @hidden */
  23971. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  23972. /** @hidden */
  23973. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  23974. /** nearest is mag = nearest and min = nearest and mip = linear */
  23975. static readonly NEAREST_SAMPLINGMODE: number;
  23976. /** nearest is mag = nearest and min = nearest and mip = linear */
  23977. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  23978. /** Bilinear is mag = linear and min = linear and mip = nearest */
  23979. static readonly BILINEAR_SAMPLINGMODE: number;
  23980. /** Bilinear is mag = linear and min = linear and mip = nearest */
  23981. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  23982. /** Trilinear is mag = linear and min = linear and mip = linear */
  23983. static readonly TRILINEAR_SAMPLINGMODE: number;
  23984. /** Trilinear is mag = linear and min = linear and mip = linear */
  23985. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  23986. /** mag = nearest and min = nearest and mip = nearest */
  23987. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  23988. /** mag = nearest and min = linear and mip = nearest */
  23989. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  23990. /** mag = nearest and min = linear and mip = linear */
  23991. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  23992. /** mag = nearest and min = linear and mip = none */
  23993. static readonly NEAREST_LINEAR: number;
  23994. /** mag = nearest and min = nearest and mip = none */
  23995. static readonly NEAREST_NEAREST: number;
  23996. /** mag = linear and min = nearest and mip = nearest */
  23997. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  23998. /** mag = linear and min = nearest and mip = linear */
  23999. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  24000. /** mag = linear and min = linear and mip = none */
  24001. static readonly LINEAR_LINEAR: number;
  24002. /** mag = linear and min = nearest and mip = none */
  24003. static readonly LINEAR_NEAREST: number;
  24004. /** Explicit coordinates mode */
  24005. static readonly EXPLICIT_MODE: number;
  24006. /** Spherical coordinates mode */
  24007. static readonly SPHERICAL_MODE: number;
  24008. /** Planar coordinates mode */
  24009. static readonly PLANAR_MODE: number;
  24010. /** Cubic coordinates mode */
  24011. static readonly CUBIC_MODE: number;
  24012. /** Projection coordinates mode */
  24013. static readonly PROJECTION_MODE: number;
  24014. /** Inverse Cubic coordinates mode */
  24015. static readonly SKYBOX_MODE: number;
  24016. /** Inverse Cubic coordinates mode */
  24017. static readonly INVCUBIC_MODE: number;
  24018. /** Equirectangular coordinates mode */
  24019. static readonly EQUIRECTANGULAR_MODE: number;
  24020. /** Equirectangular Fixed coordinates mode */
  24021. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  24022. /** Equirectangular Fixed Mirrored coordinates mode */
  24023. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  24024. /** Texture is not repeating outside of 0..1 UVs */
  24025. static readonly CLAMP_ADDRESSMODE: number;
  24026. /** Texture is repeating outside of 0..1 UVs */
  24027. static readonly WRAP_ADDRESSMODE: number;
  24028. /** Texture is repeating and mirrored */
  24029. static readonly MIRROR_ADDRESSMODE: number;
  24030. /**
  24031. * 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
  24032. */
  24033. static UseSerializedUrlIfAny: boolean;
  24034. /**
  24035. * Define the url of the texture.
  24036. */
  24037. url: Nullable<string>;
  24038. /**
  24039. * Define an offset on the texture to offset the u coordinates of the UVs
  24040. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  24041. */
  24042. uOffset: number;
  24043. /**
  24044. * Define an offset on the texture to offset the v coordinates of the UVs
  24045. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  24046. */
  24047. vOffset: number;
  24048. /**
  24049. * Define an offset on the texture to scale the u coordinates of the UVs
  24050. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  24051. */
  24052. uScale: number;
  24053. /**
  24054. * Define an offset on the texture to scale the v coordinates of the UVs
  24055. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  24056. */
  24057. vScale: number;
  24058. /**
  24059. * Define an offset on the texture to rotate around the u coordinates of the UVs
  24060. * @see https://doc.babylonjs.com/how_to/more_materials
  24061. */
  24062. uAng: number;
  24063. /**
  24064. * Define an offset on the texture to rotate around the v coordinates of the UVs
  24065. * @see https://doc.babylonjs.com/how_to/more_materials
  24066. */
  24067. vAng: number;
  24068. /**
  24069. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  24070. * @see https://doc.babylonjs.com/how_to/more_materials
  24071. */
  24072. wAng: number;
  24073. /**
  24074. * Defines the center of rotation (U)
  24075. */
  24076. uRotationCenter: number;
  24077. /**
  24078. * Defines the center of rotation (V)
  24079. */
  24080. vRotationCenter: number;
  24081. /**
  24082. * Defines the center of rotation (W)
  24083. */
  24084. wRotationCenter: number;
  24085. /**
  24086. * Are mip maps generated for this texture or not.
  24087. */
  24088. get noMipmap(): boolean;
  24089. /**
  24090. * List of inspectable custom properties (used by the Inspector)
  24091. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  24092. */
  24093. inspectableCustomProperties: Nullable<IInspectable[]>;
  24094. private _noMipmap;
  24095. /** @hidden */
  24096. _invertY: boolean;
  24097. private _rowGenerationMatrix;
  24098. private _cachedTextureMatrix;
  24099. private _projectionModeMatrix;
  24100. private _t0;
  24101. private _t1;
  24102. private _t2;
  24103. private _cachedUOffset;
  24104. private _cachedVOffset;
  24105. private _cachedUScale;
  24106. private _cachedVScale;
  24107. private _cachedUAng;
  24108. private _cachedVAng;
  24109. private _cachedWAng;
  24110. private _cachedProjectionMatrixId;
  24111. private _cachedCoordinatesMode;
  24112. /** @hidden */
  24113. protected _initialSamplingMode: number;
  24114. /** @hidden */
  24115. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  24116. private _deleteBuffer;
  24117. protected _format: Nullable<number>;
  24118. private _delayedOnLoad;
  24119. private _delayedOnError;
  24120. private _mimeType?;
  24121. /** Returns the texture mime type if it was defined by a loader (undefined else) */
  24122. get mimeType(): string | undefined;
  24123. /**
  24124. * Observable triggered once the texture has been loaded.
  24125. */
  24126. onLoadObservable: Observable<Texture>;
  24127. protected _isBlocking: boolean;
  24128. /**
  24129. * Is the texture preventing material to render while loading.
  24130. * If false, a default texture will be used instead of the loading one during the preparation step.
  24131. */
  24132. set isBlocking(value: boolean);
  24133. get isBlocking(): boolean;
  24134. /**
  24135. * Get the current sampling mode associated with the texture.
  24136. */
  24137. get samplingMode(): number;
  24138. /**
  24139. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  24140. */
  24141. get invertY(): boolean;
  24142. /**
  24143. * Instantiates a new texture.
  24144. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  24145. * @see https://doc.babylonjs.com/babylon101/materials#texture
  24146. * @param url defines the url of the picture to load as a texture
  24147. * @param sceneOrEngine defines the scene or engine the texture will belong to
  24148. * @param noMipmap defines if the texture will require mip maps or not
  24149. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  24150. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24151. * @param onLoad defines a callback triggered when the texture has been loaded
  24152. * @param onError defines a callback triggered when an error occurred during the loading session
  24153. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  24154. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  24155. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24156. * @param mimeType defines an optional mime type information
  24157. */
  24158. 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);
  24159. /**
  24160. * Update the url (and optional buffer) of this texture if url was null during construction.
  24161. * @param url the url of the texture
  24162. * @param buffer the buffer of the texture (defaults to null)
  24163. * @param onLoad callback called when the texture is loaded (defaults to null)
  24164. */
  24165. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  24166. /**
  24167. * Finish the loading sequence of a texture flagged as delayed load.
  24168. * @hidden
  24169. */
  24170. delayLoad(): void;
  24171. private _prepareRowForTextureGeneration;
  24172. /**
  24173. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  24174. * @returns the transform matrix of the texture.
  24175. */
  24176. getTextureMatrix(uBase?: number): Matrix;
  24177. /**
  24178. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  24179. * @returns The reflection texture transform
  24180. */
  24181. getReflectionTextureMatrix(): Matrix;
  24182. /**
  24183. * Clones the texture.
  24184. * @returns the cloned texture
  24185. */
  24186. clone(): Texture;
  24187. /**
  24188. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  24189. * @returns The JSON representation of the texture
  24190. */
  24191. serialize(): any;
  24192. /**
  24193. * Get the current class name of the texture useful for serialization or dynamic coding.
  24194. * @returns "Texture"
  24195. */
  24196. getClassName(): string;
  24197. /**
  24198. * Dispose the texture and release its associated resources.
  24199. */
  24200. dispose(): void;
  24201. /**
  24202. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  24203. * @param parsedTexture Define the JSON representation of the texture
  24204. * @param scene Define the scene the parsed texture should be instantiated in
  24205. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  24206. * @returns The parsed texture if successful
  24207. */
  24208. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  24209. /**
  24210. * Creates a texture from its base 64 representation.
  24211. * @param data Define the base64 payload without the data: prefix
  24212. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  24213. * @param scene Define the scene the texture should belong to
  24214. * @param noMipmap Forces the texture to not create mip map information if true
  24215. * @param invertY define if the texture needs to be inverted on the y axis during loading
  24216. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24217. * @param onLoad define a callback triggered when the texture has been loaded
  24218. * @param onError define a callback triggered when an error occurred during the loading session
  24219. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24220. * @returns the created texture
  24221. */
  24222. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  24223. /**
  24224. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  24225. * @param data Define the base64 payload without the data: prefix
  24226. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  24227. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  24228. * @param scene Define the scene the texture should belong to
  24229. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  24230. * @param noMipmap Forces the texture to not create mip map information if true
  24231. * @param invertY define if the texture needs to be inverted on the y axis during loading
  24232. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24233. * @param onLoad define a callback triggered when the texture has been loaded
  24234. * @param onError define a callback triggered when an error occurred during the loading session
  24235. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24236. * @returns the created texture
  24237. */
  24238. 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;
  24239. }
  24240. }
  24241. declare module "babylonjs/PostProcesses/postProcessManager" {
  24242. import { Nullable } from "babylonjs/types";
  24243. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24244. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24245. import { Scene } from "babylonjs/scene";
  24246. /**
  24247. * PostProcessManager is used to manage one or more post processes or post process pipelines
  24248. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  24249. */
  24250. export class PostProcessManager {
  24251. private _scene;
  24252. private _indexBuffer;
  24253. private _vertexBuffers;
  24254. /**
  24255. * Creates a new instance PostProcess
  24256. * @param scene The scene that the post process is associated with.
  24257. */
  24258. constructor(scene: Scene);
  24259. private _prepareBuffers;
  24260. private _buildIndexBuffer;
  24261. /**
  24262. * Rebuilds the vertex buffers of the manager.
  24263. * @hidden
  24264. */
  24265. _rebuild(): void;
  24266. /**
  24267. * Prepares a frame to be run through a post process.
  24268. * @param sourceTexture The input texture to the post procesess. (default: null)
  24269. * @param postProcesses An array of post processes to be run. (default: null)
  24270. * @returns True if the post processes were able to be run.
  24271. * @hidden
  24272. */
  24273. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  24274. /**
  24275. * Manually render a set of post processes to a texture.
  24276. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  24277. * @param postProcesses An array of post processes to be run.
  24278. * @param targetTexture The target texture to render to.
  24279. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  24280. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  24281. * @param lodLevel defines which lod of the texture to render to
  24282. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  24283. */
  24284. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  24285. /**
  24286. * Finalize the result of the output of the postprocesses.
  24287. * @param doNotPresent If true the result will not be displayed to the screen.
  24288. * @param targetTexture The target texture to render to.
  24289. * @param faceIndex The index of the face to bind the target texture to.
  24290. * @param postProcesses The array of post processes to render.
  24291. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  24292. * @hidden
  24293. */
  24294. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  24295. /**
  24296. * Disposes of the post process manager.
  24297. */
  24298. dispose(): void;
  24299. }
  24300. }
  24301. declare module "babylonjs/Materials/Textures/renderTargetTexture" {
  24302. import { Observable } from "babylonjs/Misc/observable";
  24303. import { SmartArray } from "babylonjs/Misc/smartArray";
  24304. import { Nullable, Immutable } from "babylonjs/types";
  24305. import { Camera } from "babylonjs/Cameras/camera";
  24306. import { Scene } from "babylonjs/scene";
  24307. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  24308. import { Color4 } from "babylonjs/Maths/math.color";
  24309. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  24310. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  24311. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24312. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24313. import { Texture } from "babylonjs/Materials/Textures/texture";
  24314. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24315. import { RenderingManager } from "babylonjs/Rendering/renderingManager";
  24316. import "babylonjs/Engines/Extensions/engine.renderTarget";
  24317. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  24318. import { Engine } from "babylonjs/Engines/engine";
  24319. /**
  24320. * This Helps creating a texture that will be created from a camera in your scene.
  24321. * It is basically a dynamic texture that could be used to create special effects for instance.
  24322. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  24323. */
  24324. export class RenderTargetTexture extends Texture {
  24325. /**
  24326. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  24327. */
  24328. static readonly REFRESHRATE_RENDER_ONCE: number;
  24329. /**
  24330. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  24331. */
  24332. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  24333. /**
  24334. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  24335. * the central point of your effect and can save a lot of performances.
  24336. */
  24337. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  24338. /**
  24339. * Use this predicate to dynamically define the list of mesh you want to render.
  24340. * If set, the renderList property will be overwritten.
  24341. */
  24342. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  24343. private _renderList;
  24344. /**
  24345. * Use this list to define the list of mesh you want to render.
  24346. */
  24347. get renderList(): Nullable<Array<AbstractMesh>>;
  24348. set renderList(value: Nullable<Array<AbstractMesh>>);
  24349. /**
  24350. * Use this function to overload the renderList array at rendering time.
  24351. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  24352. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  24353. * the cube (if the RTT is a cube, else layerOrFace=0).
  24354. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  24355. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  24356. * hold dummy elements!
  24357. */
  24358. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  24359. private _hookArray;
  24360. /**
  24361. * Define if particles should be rendered in your texture.
  24362. */
  24363. renderParticles: boolean;
  24364. /**
  24365. * Define if sprites should be rendered in your texture.
  24366. */
  24367. renderSprites: boolean;
  24368. /**
  24369. * Define the camera used to render the texture.
  24370. */
  24371. activeCamera: Nullable<Camera>;
  24372. /**
  24373. * Override the mesh isReady function with your own one.
  24374. */
  24375. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  24376. /**
  24377. * Override the render function of the texture with your own one.
  24378. */
  24379. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  24380. /**
  24381. * Define if camera post processes should be use while rendering the texture.
  24382. */
  24383. useCameraPostProcesses: boolean;
  24384. /**
  24385. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  24386. */
  24387. ignoreCameraViewport: boolean;
  24388. private _postProcessManager;
  24389. private _postProcesses;
  24390. private _resizeObserver;
  24391. /**
  24392. * An event triggered when the texture is unbind.
  24393. */
  24394. onBeforeBindObservable: Observable<RenderTargetTexture>;
  24395. /**
  24396. * An event triggered when the texture is unbind.
  24397. */
  24398. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  24399. private _onAfterUnbindObserver;
  24400. /**
  24401. * Set a after unbind callback in the texture.
  24402. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  24403. */
  24404. set onAfterUnbind(callback: () => void);
  24405. /**
  24406. * An event triggered before rendering the texture
  24407. */
  24408. onBeforeRenderObservable: Observable<number>;
  24409. private _onBeforeRenderObserver;
  24410. /**
  24411. * Set a before render callback in the texture.
  24412. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  24413. */
  24414. set onBeforeRender(callback: (faceIndex: number) => void);
  24415. /**
  24416. * An event triggered after rendering the texture
  24417. */
  24418. onAfterRenderObservable: Observable<number>;
  24419. private _onAfterRenderObserver;
  24420. /**
  24421. * Set a after render callback in the texture.
  24422. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  24423. */
  24424. set onAfterRender(callback: (faceIndex: number) => void);
  24425. /**
  24426. * An event triggered after the texture clear
  24427. */
  24428. onClearObservable: Observable<Engine>;
  24429. private _onClearObserver;
  24430. /**
  24431. * Set a clear callback in the texture.
  24432. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  24433. */
  24434. set onClear(callback: (Engine: Engine) => void);
  24435. /**
  24436. * An event triggered when the texture is resized.
  24437. */
  24438. onResizeObservable: Observable<RenderTargetTexture>;
  24439. /**
  24440. * Define the clear color of the Render Target if it should be different from the scene.
  24441. */
  24442. clearColor: Color4;
  24443. protected _size: number | {
  24444. width: number;
  24445. height: number;
  24446. layers?: number;
  24447. };
  24448. protected _initialSizeParameter: number | {
  24449. width: number;
  24450. height: number;
  24451. } | {
  24452. ratio: number;
  24453. };
  24454. protected _sizeRatio: Nullable<number>;
  24455. /** @hidden */
  24456. _generateMipMaps: boolean;
  24457. protected _renderingManager: RenderingManager;
  24458. /** @hidden */
  24459. _waitingRenderList?: string[];
  24460. protected _doNotChangeAspectRatio: boolean;
  24461. protected _currentRefreshId: number;
  24462. protected _refreshRate: number;
  24463. protected _textureMatrix: Matrix;
  24464. protected _samples: number;
  24465. protected _renderTargetOptions: RenderTargetCreationOptions;
  24466. /**
  24467. * Gets render target creation options that were used.
  24468. */
  24469. get renderTargetOptions(): RenderTargetCreationOptions;
  24470. protected _onRatioRescale(): void;
  24471. /**
  24472. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  24473. * It must define where the camera used to render the texture is set
  24474. */
  24475. boundingBoxPosition: Vector3;
  24476. private _boundingBoxSize;
  24477. /**
  24478. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  24479. * When defined, the cubemap will switch to local mode
  24480. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  24481. * @example https://www.babylonjs-playground.com/#RNASML
  24482. */
  24483. set boundingBoxSize(value: Vector3);
  24484. get boundingBoxSize(): Vector3;
  24485. /**
  24486. * In case the RTT has been created with a depth texture, get the associated
  24487. * depth texture.
  24488. * Otherwise, return null.
  24489. */
  24490. get depthStencilTexture(): Nullable<InternalTexture>;
  24491. /**
  24492. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  24493. * or used a shadow, depth texture...
  24494. * @param name The friendly name of the texture
  24495. * @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)
  24496. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  24497. * @param generateMipMaps True if mip maps need to be generated after render.
  24498. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  24499. * @param type The type of the buffer in the RTT (int, half float, float...)
  24500. * @param isCube True if a cube texture needs to be created
  24501. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  24502. * @param generateDepthBuffer True to generate a depth buffer
  24503. * @param generateStencilBuffer True to generate a stencil buffer
  24504. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  24505. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  24506. * @param delayAllocation if the texture allocation should be delayed (default: false)
  24507. */
  24508. constructor(name: string, size: number | {
  24509. width: number;
  24510. height: number;
  24511. layers?: number;
  24512. } | {
  24513. ratio: number;
  24514. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  24515. /**
  24516. * Creates a depth stencil texture.
  24517. * This is only available in WebGL 2 or with the depth texture extension available.
  24518. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  24519. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  24520. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  24521. */
  24522. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  24523. private _processSizeParameter;
  24524. /**
  24525. * Define the number of samples to use in case of MSAA.
  24526. * It defaults to one meaning no MSAA has been enabled.
  24527. */
  24528. get samples(): number;
  24529. set samples(value: number);
  24530. /**
  24531. * Resets the refresh counter of the texture and start bak from scratch.
  24532. * Could be useful to regenerate the texture if it is setup to render only once.
  24533. */
  24534. resetRefreshCounter(): void;
  24535. /**
  24536. * Define the refresh rate of the texture or the rendering frequency.
  24537. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  24538. */
  24539. get refreshRate(): number;
  24540. set refreshRate(value: number);
  24541. /**
  24542. * Adds a post process to the render target rendering passes.
  24543. * @param postProcess define the post process to add
  24544. */
  24545. addPostProcess(postProcess: PostProcess): void;
  24546. /**
  24547. * Clear all the post processes attached to the render target
  24548. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  24549. */
  24550. clearPostProcesses(dispose?: boolean): void;
  24551. /**
  24552. * Remove one of the post process from the list of attached post processes to the texture
  24553. * @param postProcess define the post process to remove from the list
  24554. */
  24555. removePostProcess(postProcess: PostProcess): void;
  24556. /** @hidden */
  24557. _shouldRender(): boolean;
  24558. /**
  24559. * Gets the actual render size of the texture.
  24560. * @returns the width of the render size
  24561. */
  24562. getRenderSize(): number;
  24563. /**
  24564. * Gets the actual render width of the texture.
  24565. * @returns the width of the render size
  24566. */
  24567. getRenderWidth(): number;
  24568. /**
  24569. * Gets the actual render height of the texture.
  24570. * @returns the height of the render size
  24571. */
  24572. getRenderHeight(): number;
  24573. /**
  24574. * Gets the actual number of layers of the texture.
  24575. * @returns the number of layers
  24576. */
  24577. getRenderLayers(): number;
  24578. /**
  24579. * Get if the texture can be rescaled or not.
  24580. */
  24581. get canRescale(): boolean;
  24582. /**
  24583. * Resize the texture using a ratio.
  24584. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  24585. */
  24586. scale(ratio: number): void;
  24587. /**
  24588. * Get the texture reflection matrix used to rotate/transform the reflection.
  24589. * @returns the reflection matrix
  24590. */
  24591. getReflectionTextureMatrix(): Matrix;
  24592. /**
  24593. * Resize the texture to a new desired size.
  24594. * Be carrefull as it will recreate all the data in the new texture.
  24595. * @param size Define the new size. It can be:
  24596. * - a number for squared texture,
  24597. * - an object containing { width: number, height: number }
  24598. * - or an object containing a ratio { ratio: number }
  24599. */
  24600. resize(size: number | {
  24601. width: number;
  24602. height: number;
  24603. } | {
  24604. ratio: number;
  24605. }): void;
  24606. private _defaultRenderListPrepared;
  24607. /**
  24608. * Renders all the objects from the render list into the texture.
  24609. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  24610. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  24611. */
  24612. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  24613. private _bestReflectionRenderTargetDimension;
  24614. private _prepareRenderingManager;
  24615. /**
  24616. * @hidden
  24617. * @param faceIndex face index to bind to if this is a cubetexture
  24618. * @param layer defines the index of the texture to bind in the array
  24619. */
  24620. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  24621. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  24622. private renderToTarget;
  24623. /**
  24624. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  24625. * This allowed control for front to back rendering or reversly depending of the special needs.
  24626. *
  24627. * @param renderingGroupId The rendering group id corresponding to its index
  24628. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  24629. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  24630. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  24631. */
  24632. 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;
  24633. /**
  24634. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  24635. *
  24636. * @param renderingGroupId The rendering group id corresponding to its index
  24637. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  24638. */
  24639. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  24640. /**
  24641. * Clones the texture.
  24642. * @returns the cloned texture
  24643. */
  24644. clone(): RenderTargetTexture;
  24645. /**
  24646. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  24647. * @returns The JSON representation of the texture
  24648. */
  24649. serialize(): any;
  24650. /**
  24651. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  24652. */
  24653. disposeFramebufferObjects(): void;
  24654. /**
  24655. * Dispose the texture and release its associated resources.
  24656. */
  24657. dispose(): void;
  24658. /** @hidden */
  24659. _rebuild(): void;
  24660. /**
  24661. * Clear the info related to rendering groups preventing retention point in material dispose.
  24662. */
  24663. freeRenderingGroups(): void;
  24664. /**
  24665. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  24666. * @returns the view count
  24667. */
  24668. getViewCount(): number;
  24669. }
  24670. }
  24671. declare module "babylonjs/Misc/guid" {
  24672. /**
  24673. * Class used to manipulate GUIDs
  24674. */
  24675. export class GUID {
  24676. /**
  24677. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  24678. * Be aware Math.random() could cause collisions, but:
  24679. * "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"
  24680. * @returns a pseudo random id
  24681. */
  24682. static RandomId(): string;
  24683. }
  24684. }
  24685. declare module "babylonjs/Materials/shadowDepthWrapper" {
  24686. import { Nullable } from "babylonjs/types";
  24687. import { Scene } from "babylonjs/scene";
  24688. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24689. import { Material } from "babylonjs/Materials/material";
  24690. import { Effect } from "babylonjs/Materials/effect";
  24691. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  24692. /**
  24693. * Options to be used when creating a shadow depth material
  24694. */
  24695. export interface IIOptionShadowDepthMaterial {
  24696. /** Variables in the vertex shader code that need to have their names remapped.
  24697. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  24698. * "var_name" should be either: worldPos or vNormalW
  24699. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  24700. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  24701. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  24702. */
  24703. remappedVariables?: string[];
  24704. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  24705. standalone?: boolean;
  24706. }
  24707. /**
  24708. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  24709. */
  24710. export class ShadowDepthWrapper {
  24711. private _scene;
  24712. private _options?;
  24713. private _baseMaterial;
  24714. private _onEffectCreatedObserver;
  24715. private _subMeshToEffect;
  24716. private _subMeshToDepthEffect;
  24717. private _meshes;
  24718. /** @hidden */
  24719. _matriceNames: any;
  24720. /** Gets the standalone status of the wrapper */
  24721. get standalone(): boolean;
  24722. /** Gets the base material the wrapper is built upon */
  24723. get baseMaterial(): Material;
  24724. /**
  24725. * Instantiate a new shadow depth wrapper.
  24726. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  24727. * generate the shadow depth map. For more information, please refer to the documentation:
  24728. * https://doc.babylonjs.com/babylon101/shadows
  24729. * @param baseMaterial Material to wrap
  24730. * @param scene Define the scene the material belongs to
  24731. * @param options Options used to create the wrapper
  24732. */
  24733. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  24734. /**
  24735. * Gets the effect to use to generate the depth map
  24736. * @param subMesh subMesh to get the effect for
  24737. * @param shadowGenerator shadow generator to get the effect for
  24738. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  24739. */
  24740. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  24741. /**
  24742. * Specifies that the submesh is ready to be used for depth rendering
  24743. * @param subMesh submesh to check
  24744. * @param defines the list of defines to take into account when checking the effect
  24745. * @param shadowGenerator combined with subMesh, it defines the effect to check
  24746. * @param useInstances specifies that instances should be used
  24747. * @returns a boolean indicating that the submesh is ready or not
  24748. */
  24749. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  24750. /**
  24751. * Disposes the resources
  24752. */
  24753. dispose(): void;
  24754. private _makeEffect;
  24755. }
  24756. }
  24757. declare module "babylonjs/Engines/Extensions/engine.multiRender" {
  24758. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24759. import { IMultiRenderTargetOptions } from "babylonjs/Materials/Textures/multiRenderTarget";
  24760. import { Nullable } from "babylonjs/types";
  24761. module "babylonjs/Engines/thinEngine" {
  24762. interface ThinEngine {
  24763. /**
  24764. * Unbind a list of render target textures from the webGL context
  24765. * This is used only when drawBuffer extension or webGL2 are active
  24766. * @param textures defines the render target textures to unbind
  24767. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  24768. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  24769. */
  24770. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  24771. /**
  24772. * Create a multi render target texture
  24773. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  24774. * @param size defines the size of the texture
  24775. * @param options defines the creation options
  24776. * @returns the cube texture as an InternalTexture
  24777. */
  24778. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  24779. /**
  24780. * Update the sample count for a given multiple render target texture
  24781. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  24782. * @param textures defines the textures to update
  24783. * @param samples defines the sample count to set
  24784. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  24785. */
  24786. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  24787. /**
  24788. * Select a subsets of attachments to draw to.
  24789. * @param attachments gl attachments
  24790. */
  24791. bindAttachments(attachments: number[]): void;
  24792. }
  24793. }
  24794. }
  24795. declare module "babylonjs/Materials/Textures/multiRenderTarget" {
  24796. import { Scene } from "babylonjs/scene";
  24797. import { Engine } from "babylonjs/Engines/engine";
  24798. import { Texture } from "babylonjs/Materials/Textures/texture";
  24799. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  24800. import "babylonjs/Engines/Extensions/engine.multiRender";
  24801. /**
  24802. * Creation options of the multi render target texture.
  24803. */
  24804. export interface IMultiRenderTargetOptions {
  24805. /**
  24806. * Define if the texture needs to create mip maps after render.
  24807. */
  24808. generateMipMaps?: boolean;
  24809. /**
  24810. * Define the types of all the draw buffers we want to create
  24811. */
  24812. types?: number[];
  24813. /**
  24814. * Define the sampling modes of all the draw buffers we want to create
  24815. */
  24816. samplingModes?: number[];
  24817. /**
  24818. * Define if a depth buffer is required
  24819. */
  24820. generateDepthBuffer?: boolean;
  24821. /**
  24822. * Define if a stencil buffer is required
  24823. */
  24824. generateStencilBuffer?: boolean;
  24825. /**
  24826. * Define if a depth texture is required instead of a depth buffer
  24827. */
  24828. generateDepthTexture?: boolean;
  24829. /**
  24830. * Define the number of desired draw buffers
  24831. */
  24832. textureCount?: number;
  24833. /**
  24834. * Define if aspect ratio should be adapted to the texture or stay the scene one
  24835. */
  24836. doNotChangeAspectRatio?: boolean;
  24837. /**
  24838. * Define the default type of the buffers we are creating
  24839. */
  24840. defaultType?: number;
  24841. }
  24842. /**
  24843. * A multi render target, like a render target provides the ability to render to a texture.
  24844. * Unlike the render target, it can render to several draw buffers in one draw.
  24845. * This is specially interesting in deferred rendering or for any effects requiring more than
  24846. * just one color from a single pass.
  24847. */
  24848. export class MultiRenderTarget extends RenderTargetTexture {
  24849. private _internalTextures;
  24850. private _textures;
  24851. private _multiRenderTargetOptions;
  24852. private _count;
  24853. /**
  24854. * Get if draw buffers are currently supported by the used hardware and browser.
  24855. */
  24856. get isSupported(): boolean;
  24857. /**
  24858. * Get the list of textures generated by the multi render target.
  24859. */
  24860. get textures(): Texture[];
  24861. /**
  24862. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  24863. */
  24864. get count(): number;
  24865. /**
  24866. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  24867. */
  24868. get depthTexture(): Texture;
  24869. /**
  24870. * Set the wrapping mode on U of all the textures we are rendering to.
  24871. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  24872. */
  24873. set wrapU(wrap: number);
  24874. /**
  24875. * Set the wrapping mode on V of all the textures we are rendering to.
  24876. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  24877. */
  24878. set wrapV(wrap: number);
  24879. /**
  24880. * Instantiate a new multi render target texture.
  24881. * A multi render target, like a render target provides the ability to render to a texture.
  24882. * Unlike the render target, it can render to several draw buffers in one draw.
  24883. * This is specially interesting in deferred rendering or for any effects requiring more than
  24884. * just one color from a single pass.
  24885. * @param name Define the name of the texture
  24886. * @param size Define the size of the buffers to render to
  24887. * @param count Define the number of target we are rendering into
  24888. * @param scene Define the scene the texture belongs to
  24889. * @param options Define the options used to create the multi render target
  24890. */
  24891. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  24892. /** @hidden */
  24893. _rebuild(): void;
  24894. private _createInternalTextures;
  24895. private _createTextures;
  24896. /**
  24897. * Define the number of samples used if MSAA is enabled.
  24898. */
  24899. get samples(): number;
  24900. set samples(value: number);
  24901. /**
  24902. * Resize all the textures in the multi render target.
  24903. * Be carrefull as it will recreate all the data in the new texture.
  24904. * @param size Define the new size
  24905. */
  24906. resize(size: any): void;
  24907. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  24908. /**
  24909. * Dispose the render targets and their associated resources
  24910. */
  24911. dispose(): void;
  24912. /**
  24913. * Release all the underlying texture used as draw buffers.
  24914. */
  24915. releaseInternalTextures(): void;
  24916. }
  24917. }
  24918. declare module "babylonjs/Shaders/imageProcessing.fragment" {
  24919. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  24920. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  24921. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  24922. /** @hidden */
  24923. export var imageProcessingPixelShader: {
  24924. name: string;
  24925. shader: string;
  24926. };
  24927. }
  24928. declare module "babylonjs/PostProcesses/imageProcessingPostProcess" {
  24929. import { Nullable } from "babylonjs/types";
  24930. import { Color4 } from "babylonjs/Maths/math.color";
  24931. import { Camera } from "babylonjs/Cameras/camera";
  24932. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  24933. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  24934. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  24935. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  24936. import { Engine } from "babylonjs/Engines/engine";
  24937. import "babylonjs/Shaders/imageProcessing.fragment";
  24938. import "babylonjs/Shaders/postprocess.vertex";
  24939. /**
  24940. * ImageProcessingPostProcess
  24941. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  24942. */
  24943. export class ImageProcessingPostProcess extends PostProcess {
  24944. /**
  24945. * Default configuration related to image processing available in the PBR Material.
  24946. */
  24947. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  24948. /**
  24949. * Gets the image processing configuration used either in this material.
  24950. */
  24951. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  24952. /**
  24953. * Sets the Default image processing configuration used either in the this material.
  24954. *
  24955. * If sets to null, the scene one is in use.
  24956. */
  24957. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  24958. /**
  24959. * Keep track of the image processing observer to allow dispose and replace.
  24960. */
  24961. private _imageProcessingObserver;
  24962. /**
  24963. * Attaches a new image processing configuration to the PBR Material.
  24964. * @param configuration
  24965. */
  24966. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  24967. /**
  24968. * If the post process is supported.
  24969. */
  24970. get isSupported(): boolean;
  24971. /**
  24972. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  24973. */
  24974. get colorCurves(): Nullable<ColorCurves>;
  24975. /**
  24976. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  24977. */
  24978. set colorCurves(value: Nullable<ColorCurves>);
  24979. /**
  24980. * Gets wether the color curves effect is enabled.
  24981. */
  24982. get colorCurvesEnabled(): boolean;
  24983. /**
  24984. * Sets wether the color curves effect is enabled.
  24985. */
  24986. set colorCurvesEnabled(value: boolean);
  24987. /**
  24988. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  24989. */
  24990. get colorGradingTexture(): Nullable<BaseTexture>;
  24991. /**
  24992. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  24993. */
  24994. set colorGradingTexture(value: Nullable<BaseTexture>);
  24995. /**
  24996. * Gets wether the color grading effect is enabled.
  24997. */
  24998. get colorGradingEnabled(): boolean;
  24999. /**
  25000. * Gets wether the color grading effect is enabled.
  25001. */
  25002. set colorGradingEnabled(value: boolean);
  25003. /**
  25004. * Gets exposure used in the effect.
  25005. */
  25006. get exposure(): number;
  25007. /**
  25008. * Sets exposure used in the effect.
  25009. */
  25010. set exposure(value: number);
  25011. /**
  25012. * Gets wether tonemapping is enabled or not.
  25013. */
  25014. get toneMappingEnabled(): boolean;
  25015. /**
  25016. * Sets wether tonemapping is enabled or not
  25017. */
  25018. set toneMappingEnabled(value: boolean);
  25019. /**
  25020. * Gets the type of tone mapping effect.
  25021. */
  25022. get toneMappingType(): number;
  25023. /**
  25024. * Sets the type of tone mapping effect.
  25025. */
  25026. set toneMappingType(value: number);
  25027. /**
  25028. * Gets contrast used in the effect.
  25029. */
  25030. get contrast(): number;
  25031. /**
  25032. * Sets contrast used in the effect.
  25033. */
  25034. set contrast(value: number);
  25035. /**
  25036. * Gets Vignette stretch size.
  25037. */
  25038. get vignetteStretch(): number;
  25039. /**
  25040. * Sets Vignette stretch size.
  25041. */
  25042. set vignetteStretch(value: number);
  25043. /**
  25044. * Gets Vignette centre X Offset.
  25045. */
  25046. get vignetteCentreX(): number;
  25047. /**
  25048. * Sets Vignette centre X Offset.
  25049. */
  25050. set vignetteCentreX(value: number);
  25051. /**
  25052. * Gets Vignette centre Y Offset.
  25053. */
  25054. get vignetteCentreY(): number;
  25055. /**
  25056. * Sets Vignette centre Y Offset.
  25057. */
  25058. set vignetteCentreY(value: number);
  25059. /**
  25060. * Gets Vignette weight or intensity of the vignette effect.
  25061. */
  25062. get vignetteWeight(): number;
  25063. /**
  25064. * Sets Vignette weight or intensity of the vignette effect.
  25065. */
  25066. set vignetteWeight(value: number);
  25067. /**
  25068. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  25069. * if vignetteEnabled is set to true.
  25070. */
  25071. get vignetteColor(): Color4;
  25072. /**
  25073. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  25074. * if vignetteEnabled is set to true.
  25075. */
  25076. set vignetteColor(value: Color4);
  25077. /**
  25078. * Gets Camera field of view used by the Vignette effect.
  25079. */
  25080. get vignetteCameraFov(): number;
  25081. /**
  25082. * Sets Camera field of view used by the Vignette effect.
  25083. */
  25084. set vignetteCameraFov(value: number);
  25085. /**
  25086. * Gets the vignette blend mode allowing different kind of effect.
  25087. */
  25088. get vignetteBlendMode(): number;
  25089. /**
  25090. * Sets the vignette blend mode allowing different kind of effect.
  25091. */
  25092. set vignetteBlendMode(value: number);
  25093. /**
  25094. * Gets wether the vignette effect is enabled.
  25095. */
  25096. get vignetteEnabled(): boolean;
  25097. /**
  25098. * Sets wether the vignette effect is enabled.
  25099. */
  25100. set vignetteEnabled(value: boolean);
  25101. private _fromLinearSpace;
  25102. /**
  25103. * Gets wether the input of the processing is in Gamma or Linear Space.
  25104. */
  25105. get fromLinearSpace(): boolean;
  25106. /**
  25107. * Sets wether the input of the processing is in Gamma or Linear Space.
  25108. */
  25109. set fromLinearSpace(value: boolean);
  25110. /**
  25111. * Defines cache preventing GC.
  25112. */
  25113. private _defines;
  25114. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  25115. /**
  25116. * "ImageProcessingPostProcess"
  25117. * @returns "ImageProcessingPostProcess"
  25118. */
  25119. getClassName(): string;
  25120. /**
  25121. * @hidden
  25122. */
  25123. _updateParameters(): void;
  25124. dispose(camera?: Camera): void;
  25125. }
  25126. }
  25127. declare module "babylonjs/Shaders/ShadersInclude/fibonacci" {
  25128. /** @hidden */
  25129. export var fibonacci: {
  25130. name: string;
  25131. shader: string;
  25132. };
  25133. }
  25134. declare module "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions" {
  25135. /** @hidden */
  25136. export var subSurfaceScatteringFunctions: {
  25137. name: string;
  25138. shader: string;
  25139. };
  25140. }
  25141. declare module "babylonjs/Shaders/ShadersInclude/diffusionProfile" {
  25142. /** @hidden */
  25143. export var diffusionProfile: {
  25144. name: string;
  25145. shader: string;
  25146. };
  25147. }
  25148. declare module "babylonjs/Shaders/subSurfaceScattering.fragment" {
  25149. import "babylonjs/Shaders/ShadersInclude/fibonacci";
  25150. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  25151. import "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions";
  25152. import "babylonjs/Shaders/ShadersInclude/diffusionProfile";
  25153. /** @hidden */
  25154. export var subSurfaceScatteringPixelShader: {
  25155. name: string;
  25156. shader: string;
  25157. };
  25158. }
  25159. declare module "babylonjs/PostProcesses/subSurfaceScatteringPostProcess" {
  25160. import { Nullable } from "babylonjs/types";
  25161. import { Camera } from "babylonjs/Cameras/camera";
  25162. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  25163. import { Engine } from "babylonjs/Engines/engine";
  25164. import { Scene } from "babylonjs/scene";
  25165. import "babylonjs/Shaders/imageProcessing.fragment";
  25166. import "babylonjs/Shaders/subSurfaceScattering.fragment";
  25167. import "babylonjs/Shaders/postprocess.vertex";
  25168. /**
  25169. * Sub surface scattering post process
  25170. */
  25171. export class SubSurfaceScatteringPostProcess extends PostProcess {
  25172. /**
  25173. * Gets a string identifying the name of the class
  25174. * @returns "SubSurfaceScatteringPostProcess" string
  25175. */
  25176. getClassName(): string;
  25177. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  25178. }
  25179. }
  25180. declare module "babylonjs/Rendering/prePassEffectConfiguration" {
  25181. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  25182. /**
  25183. * Interface for defining prepass effects in the prepass post-process pipeline
  25184. */
  25185. export interface PrePassEffectConfiguration {
  25186. /**
  25187. * Post process to attach for this effect
  25188. */
  25189. postProcess: PostProcess;
  25190. /**
  25191. * Is the effect enabled
  25192. */
  25193. enabled: boolean;
  25194. /**
  25195. * Disposes the effect configuration
  25196. */
  25197. dispose(): void;
  25198. /**
  25199. * Disposes the effect configuration
  25200. */
  25201. createPostProcess: () => PostProcess;
  25202. }
  25203. }
  25204. declare module "babylonjs/Rendering/subSurfaceConfiguration" {
  25205. import { Scene } from "babylonjs/scene";
  25206. import { Color3 } from "babylonjs/Maths/math.color";
  25207. import { SubSurfaceScatteringPostProcess } from "babylonjs/PostProcesses/subSurfaceScatteringPostProcess";
  25208. import { PrePassEffectConfiguration } from "babylonjs/Rendering/prePassEffectConfiguration";
  25209. /**
  25210. * Contains all parameters needed for the prepass to perform
  25211. * screen space subsurface scattering
  25212. */
  25213. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  25214. private _ssDiffusionS;
  25215. private _ssFilterRadii;
  25216. private _ssDiffusionD;
  25217. /**
  25218. * Post process to attach for screen space subsurface scattering
  25219. */
  25220. postProcess: SubSurfaceScatteringPostProcess;
  25221. /**
  25222. * Diffusion profile color for subsurface scattering
  25223. */
  25224. get ssDiffusionS(): number[];
  25225. /**
  25226. * Diffusion profile max color channel value for subsurface scattering
  25227. */
  25228. get ssDiffusionD(): number[];
  25229. /**
  25230. * Diffusion profile filter radius for subsurface scattering
  25231. */
  25232. get ssFilterRadii(): number[];
  25233. /**
  25234. * Is subsurface enabled
  25235. */
  25236. enabled: boolean;
  25237. /**
  25238. * Diffusion profile colors for subsurface scattering
  25239. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  25240. * See ...
  25241. * Note that you can only store up to 5 of them
  25242. */
  25243. ssDiffusionProfileColors: Color3[];
  25244. /**
  25245. * Defines the ratio real world => scene units.
  25246. * Used for subsurface scattering
  25247. */
  25248. metersPerUnit: number;
  25249. private _scene;
  25250. /**
  25251. * Builds a subsurface configuration object
  25252. * @param scene The scene
  25253. */
  25254. constructor(scene: Scene);
  25255. /**
  25256. * Adds a new diffusion profile.
  25257. * Useful for more realistic subsurface scattering on diverse materials.
  25258. * @param color The color of the diffusion profile. Should be the average color of the material.
  25259. * @return The index of the diffusion profile for the material subsurface configuration
  25260. */
  25261. addDiffusionProfile(color: Color3): number;
  25262. /**
  25263. * Creates the sss post process
  25264. * @return The created post process
  25265. */
  25266. createPostProcess(): SubSurfaceScatteringPostProcess;
  25267. /**
  25268. * Deletes all diffusion profiles.
  25269. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  25270. */
  25271. clearAllDiffusionProfiles(): void;
  25272. /**
  25273. * Disposes this object
  25274. */
  25275. dispose(): void;
  25276. /**
  25277. * @hidden
  25278. * https://zero-radiance.github.io/post/sampling-diffusion/
  25279. *
  25280. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  25281. * ------------------------------------------------------------------------------------
  25282. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  25283. * PDF[r, phi, s] = r * R[r, phi, s]
  25284. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  25285. * ------------------------------------------------------------------------------------
  25286. * We importance sample the color channel with the widest scattering distance.
  25287. */
  25288. getDiffusionProfileParameters(color: Color3): number;
  25289. /**
  25290. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  25291. * 'u' is the random number (the value of the CDF): [0, 1).
  25292. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  25293. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  25294. */
  25295. private _sampleBurleyDiffusionProfile;
  25296. }
  25297. }
  25298. declare module "babylonjs/Rendering/prePassRenderer" {
  25299. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  25300. import { Scene } from "babylonjs/scene";
  25301. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  25302. import { Effect } from "babylonjs/Materials/effect";
  25303. import { SubSurfaceConfiguration } from "babylonjs/Rendering/subSurfaceConfiguration";
  25304. /**
  25305. * Renders a pre pass of the scene
  25306. * This means every mesh in the scene will be rendered to a render target texture
  25307. * And then this texture will be composited to the rendering canvas with post processes
  25308. * It is necessary for effects like subsurface scattering or deferred shading
  25309. */
  25310. export class PrePassRenderer {
  25311. /** @hidden */
  25312. static _SceneComponentInitialization: (scene: Scene) => void;
  25313. private _scene;
  25314. private _engine;
  25315. private _isDirty;
  25316. /**
  25317. * Number of textures in the multi render target texture where the scene is directly rendered
  25318. */
  25319. readonly mrtCount: number;
  25320. /**
  25321. * The render target where the scene is directly rendered
  25322. */
  25323. prePassRT: MultiRenderTarget;
  25324. private _mrtTypes;
  25325. private _multiRenderAttachments;
  25326. private _defaultAttachments;
  25327. private _clearAttachments;
  25328. private _postProcesses;
  25329. private readonly _clearColor;
  25330. /**
  25331. * Image processing post process for composition
  25332. */
  25333. imageProcessingPostProcess: ImageProcessingPostProcess;
  25334. /**
  25335. * Configuration for sub surface scattering post process
  25336. */
  25337. subSurfaceConfiguration: SubSurfaceConfiguration;
  25338. /**
  25339. * Should materials render their geometry on the MRT
  25340. */
  25341. materialsShouldRenderGeometry: boolean;
  25342. /**
  25343. * Should materials render the irradiance information on the MRT
  25344. */
  25345. materialsShouldRenderIrradiance: boolean;
  25346. private _enabled;
  25347. /**
  25348. * Indicates if the prepass is enabled
  25349. */
  25350. get enabled(): boolean;
  25351. /**
  25352. * How many samples are used for MSAA of the scene render target
  25353. */
  25354. get samples(): number;
  25355. set samples(n: number);
  25356. /**
  25357. * Instanciates a prepass renderer
  25358. * @param scene The scene
  25359. */
  25360. constructor(scene: Scene);
  25361. private _initializeAttachments;
  25362. private _createCompositionEffect;
  25363. /**
  25364. * Indicates if rendering a prepass is supported
  25365. */
  25366. get isSupported(): boolean;
  25367. /**
  25368. * Sets the proper output textures to draw in the engine.
  25369. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  25370. */
  25371. bindAttachmentsForEffect(effect: Effect): void;
  25372. /**
  25373. * @hidden
  25374. */
  25375. _beforeCameraDraw(): void;
  25376. /**
  25377. * @hidden
  25378. */
  25379. _afterCameraDraw(): void;
  25380. private _checkRTSize;
  25381. private _bindFrameBuffer;
  25382. /**
  25383. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  25384. */
  25385. clear(): void;
  25386. private _setState;
  25387. private _enable;
  25388. private _disable;
  25389. private _resetPostProcessChain;
  25390. private _bindPostProcessChain;
  25391. /**
  25392. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  25393. */
  25394. markAsDirty(): void;
  25395. private _update;
  25396. /**
  25397. * Disposes the prepass renderer.
  25398. */
  25399. dispose(): void;
  25400. }
  25401. }
  25402. declare module "babylonjs/Materials/material" {
  25403. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  25404. import { SmartArray } from "babylonjs/Misc/smartArray";
  25405. import { Observable } from "babylonjs/Misc/observable";
  25406. import { Nullable } from "babylonjs/types";
  25407. import { Scene } from "babylonjs/scene";
  25408. import { Matrix } from "babylonjs/Maths/math.vector";
  25409. import { SubMesh } from "babylonjs/Meshes/subMesh";
  25410. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  25411. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  25412. import { Effect } from "babylonjs/Materials/effect";
  25413. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  25414. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  25415. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  25416. import { IInspectable } from "babylonjs/Misc/iInspectable";
  25417. import { ShadowDepthWrapper } from "babylonjs/Materials/shadowDepthWrapper";
  25418. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  25419. import { Mesh } from "babylonjs/Meshes/mesh";
  25420. import { Animation } from "babylonjs/Animations/animation";
  25421. /**
  25422. * Options for compiling materials.
  25423. */
  25424. export interface IMaterialCompilationOptions {
  25425. /**
  25426. * Defines whether clip planes are enabled.
  25427. */
  25428. clipPlane: boolean;
  25429. /**
  25430. * Defines whether instances are enabled.
  25431. */
  25432. useInstances: boolean;
  25433. }
  25434. /**
  25435. * Options passed when calling customShaderNameResolve
  25436. */
  25437. export interface ICustomShaderNameResolveOptions {
  25438. /**
  25439. * 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
  25440. */
  25441. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  25442. }
  25443. /**
  25444. * Base class for the main features of a material in Babylon.js
  25445. */
  25446. export class Material implements IAnimatable {
  25447. /**
  25448. * Returns the triangle fill mode
  25449. */
  25450. static readonly TriangleFillMode: number;
  25451. /**
  25452. * Returns the wireframe mode
  25453. */
  25454. static readonly WireFrameFillMode: number;
  25455. /**
  25456. * Returns the point fill mode
  25457. */
  25458. static readonly PointFillMode: number;
  25459. /**
  25460. * Returns the point list draw mode
  25461. */
  25462. static readonly PointListDrawMode: number;
  25463. /**
  25464. * Returns the line list draw mode
  25465. */
  25466. static readonly LineListDrawMode: number;
  25467. /**
  25468. * Returns the line loop draw mode
  25469. */
  25470. static readonly LineLoopDrawMode: number;
  25471. /**
  25472. * Returns the line strip draw mode
  25473. */
  25474. static readonly LineStripDrawMode: number;
  25475. /**
  25476. * Returns the triangle strip draw mode
  25477. */
  25478. static readonly TriangleStripDrawMode: number;
  25479. /**
  25480. * Returns the triangle fan draw mode
  25481. */
  25482. static readonly TriangleFanDrawMode: number;
  25483. /**
  25484. * Stores the clock-wise side orientation
  25485. */
  25486. static readonly ClockWiseSideOrientation: number;
  25487. /**
  25488. * Stores the counter clock-wise side orientation
  25489. */
  25490. static readonly CounterClockWiseSideOrientation: number;
  25491. /**
  25492. * The dirty texture flag value
  25493. */
  25494. static readonly TextureDirtyFlag: number;
  25495. /**
  25496. * The dirty light flag value
  25497. */
  25498. static readonly LightDirtyFlag: number;
  25499. /**
  25500. * The dirty fresnel flag value
  25501. */
  25502. static readonly FresnelDirtyFlag: number;
  25503. /**
  25504. * The dirty attribute flag value
  25505. */
  25506. static readonly AttributesDirtyFlag: number;
  25507. /**
  25508. * The dirty misc flag value
  25509. */
  25510. static readonly MiscDirtyFlag: number;
  25511. /**
  25512. * The all dirty flag value
  25513. */
  25514. static readonly AllDirtyFlag: number;
  25515. /**
  25516. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  25517. */
  25518. static readonly MATERIAL_OPAQUE: number;
  25519. /**
  25520. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  25521. */
  25522. static readonly MATERIAL_ALPHATEST: number;
  25523. /**
  25524. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  25525. */
  25526. static readonly MATERIAL_ALPHABLEND: number;
  25527. /**
  25528. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  25529. * They are also discarded below the alpha cutoff threshold to improve performances.
  25530. */
  25531. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  25532. /**
  25533. * The Whiteout method is used to blend normals.
  25534. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  25535. */
  25536. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  25537. /**
  25538. * The Reoriented Normal Mapping method is used to blend normals.
  25539. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  25540. */
  25541. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  25542. /**
  25543. * Custom callback helping to override the default shader used in the material.
  25544. */
  25545. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  25546. /**
  25547. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  25548. */
  25549. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  25550. /**
  25551. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  25552. * This means that the material can keep using a previous shader while a new one is being compiled.
  25553. * This is mostly used when shader parallel compilation is supported (true by default)
  25554. */
  25555. allowShaderHotSwapping: boolean;
  25556. /**
  25557. * The ID of the material
  25558. */
  25559. id: string;
  25560. /**
  25561. * Gets or sets the unique id of the material
  25562. */
  25563. uniqueId: number;
  25564. /**
  25565. * The name of the material
  25566. */
  25567. name: string;
  25568. /**
  25569. * Gets or sets user defined metadata
  25570. */
  25571. metadata: any;
  25572. /**
  25573. * For internal use only. Please do not use.
  25574. */
  25575. reservedDataStore: any;
  25576. /**
  25577. * Specifies if the ready state should be checked on each call
  25578. */
  25579. checkReadyOnEveryCall: boolean;
  25580. /**
  25581. * Specifies if the ready state should be checked once
  25582. */
  25583. checkReadyOnlyOnce: boolean;
  25584. /**
  25585. * The state of the material
  25586. */
  25587. state: string;
  25588. /**
  25589. * If the material can be rendered to several textures with MRT extension
  25590. */
  25591. get canRenderToMRT(): boolean;
  25592. /**
  25593. * The alpha value of the material
  25594. */
  25595. protected _alpha: number;
  25596. /**
  25597. * List of inspectable custom properties (used by the Inspector)
  25598. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  25599. */
  25600. inspectableCustomProperties: IInspectable[];
  25601. /**
  25602. * Sets the alpha value of the material
  25603. */
  25604. set alpha(value: number);
  25605. /**
  25606. * Gets the alpha value of the material
  25607. */
  25608. get alpha(): number;
  25609. /**
  25610. * Specifies if back face culling is enabled
  25611. */
  25612. protected _backFaceCulling: boolean;
  25613. /**
  25614. * Sets the back-face culling state
  25615. */
  25616. set backFaceCulling(value: boolean);
  25617. /**
  25618. * Gets the back-face culling state
  25619. */
  25620. get backFaceCulling(): boolean;
  25621. /**
  25622. * Stores the value for side orientation
  25623. */
  25624. sideOrientation: number;
  25625. /**
  25626. * Callback triggered when the material is compiled
  25627. */
  25628. onCompiled: Nullable<(effect: Effect) => void>;
  25629. /**
  25630. * Callback triggered when an error occurs
  25631. */
  25632. onError: Nullable<(effect: Effect, errors: string) => void>;
  25633. /**
  25634. * Callback triggered to get the render target textures
  25635. */
  25636. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  25637. /**
  25638. * Gets a boolean indicating that current material needs to register RTT
  25639. */
  25640. get hasRenderTargetTextures(): boolean;
  25641. /**
  25642. * Specifies if the material should be serialized
  25643. */
  25644. doNotSerialize: boolean;
  25645. /**
  25646. * @hidden
  25647. */
  25648. _storeEffectOnSubMeshes: boolean;
  25649. /**
  25650. * Stores the animations for the material
  25651. */
  25652. animations: Nullable<Array<Animation>>;
  25653. /**
  25654. * An event triggered when the material is disposed
  25655. */
  25656. onDisposeObservable: Observable<Material>;
  25657. /**
  25658. * An observer which watches for dispose events
  25659. */
  25660. private _onDisposeObserver;
  25661. private _onUnBindObservable;
  25662. /**
  25663. * Called during a dispose event
  25664. */
  25665. set onDispose(callback: () => void);
  25666. private _onBindObservable;
  25667. /**
  25668. * An event triggered when the material is bound
  25669. */
  25670. get onBindObservable(): Observable<AbstractMesh>;
  25671. /**
  25672. * An observer which watches for bind events
  25673. */
  25674. private _onBindObserver;
  25675. /**
  25676. * Called during a bind event
  25677. */
  25678. set onBind(callback: (Mesh: AbstractMesh) => void);
  25679. /**
  25680. * An event triggered when the material is unbound
  25681. */
  25682. get onUnBindObservable(): Observable<Material>;
  25683. protected _onEffectCreatedObservable: Nullable<Observable<{
  25684. effect: Effect;
  25685. subMesh: Nullable<SubMesh>;
  25686. }>>;
  25687. /**
  25688. * An event triggered when the effect is (re)created
  25689. */
  25690. get onEffectCreatedObservable(): Observable<{
  25691. effect: Effect;
  25692. subMesh: Nullable<SubMesh>;
  25693. }>;
  25694. /**
  25695. * Stores the value of the alpha mode
  25696. */
  25697. private _alphaMode;
  25698. /**
  25699. * Sets the value of the alpha mode.
  25700. *
  25701. * | Value | Type | Description |
  25702. * | --- | --- | --- |
  25703. * | 0 | ALPHA_DISABLE | |
  25704. * | 1 | ALPHA_ADD | |
  25705. * | 2 | ALPHA_COMBINE | |
  25706. * | 3 | ALPHA_SUBTRACT | |
  25707. * | 4 | ALPHA_MULTIPLY | |
  25708. * | 5 | ALPHA_MAXIMIZED | |
  25709. * | 6 | ALPHA_ONEONE | |
  25710. * | 7 | ALPHA_PREMULTIPLIED | |
  25711. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  25712. * | 9 | ALPHA_INTERPOLATE | |
  25713. * | 10 | ALPHA_SCREENMODE | |
  25714. *
  25715. */
  25716. set alphaMode(value: number);
  25717. /**
  25718. * Gets the value of the alpha mode
  25719. */
  25720. get alphaMode(): number;
  25721. /**
  25722. * Stores the state of the need depth pre-pass value
  25723. */
  25724. private _needDepthPrePass;
  25725. /**
  25726. * Sets the need depth pre-pass value
  25727. */
  25728. set needDepthPrePass(value: boolean);
  25729. /**
  25730. * Gets the depth pre-pass value
  25731. */
  25732. get needDepthPrePass(): boolean;
  25733. /**
  25734. * Specifies if depth writing should be disabled
  25735. */
  25736. disableDepthWrite: boolean;
  25737. /**
  25738. * Specifies if color writing should be disabled
  25739. */
  25740. disableColorWrite: boolean;
  25741. /**
  25742. * Specifies if depth writing should be forced
  25743. */
  25744. forceDepthWrite: boolean;
  25745. /**
  25746. * Specifies the depth function that should be used. 0 means the default engine function
  25747. */
  25748. depthFunction: number;
  25749. /**
  25750. * Specifies if there should be a separate pass for culling
  25751. */
  25752. separateCullingPass: boolean;
  25753. /**
  25754. * Stores the state specifing if fog should be enabled
  25755. */
  25756. private _fogEnabled;
  25757. /**
  25758. * Sets the state for enabling fog
  25759. */
  25760. set fogEnabled(value: boolean);
  25761. /**
  25762. * Gets the value of the fog enabled state
  25763. */
  25764. get fogEnabled(): boolean;
  25765. /**
  25766. * Stores the size of points
  25767. */
  25768. pointSize: number;
  25769. /**
  25770. * Stores the z offset value
  25771. */
  25772. zOffset: number;
  25773. get wireframe(): boolean;
  25774. /**
  25775. * Sets the state of wireframe mode
  25776. */
  25777. set wireframe(value: boolean);
  25778. /**
  25779. * Gets the value specifying if point clouds are enabled
  25780. */
  25781. get pointsCloud(): boolean;
  25782. /**
  25783. * Sets the state of point cloud mode
  25784. */
  25785. set pointsCloud(value: boolean);
  25786. /**
  25787. * Gets the material fill mode
  25788. */
  25789. get fillMode(): number;
  25790. /**
  25791. * Sets the material fill mode
  25792. */
  25793. set fillMode(value: number);
  25794. /**
  25795. * @hidden
  25796. * Stores the effects for the material
  25797. */
  25798. _effect: Nullable<Effect>;
  25799. /**
  25800. * Specifies if uniform buffers should be used
  25801. */
  25802. private _useUBO;
  25803. /**
  25804. * Stores a reference to the scene
  25805. */
  25806. private _scene;
  25807. /**
  25808. * Stores the fill mode state
  25809. */
  25810. private _fillMode;
  25811. /**
  25812. * Specifies if the depth write state should be cached
  25813. */
  25814. private _cachedDepthWriteState;
  25815. /**
  25816. * Specifies if the color write state should be cached
  25817. */
  25818. private _cachedColorWriteState;
  25819. /**
  25820. * Specifies if the depth function state should be cached
  25821. */
  25822. private _cachedDepthFunctionState;
  25823. /**
  25824. * Stores the uniform buffer
  25825. */
  25826. protected _uniformBuffer: UniformBuffer;
  25827. /** @hidden */
  25828. _indexInSceneMaterialArray: number;
  25829. /** @hidden */
  25830. meshMap: Nullable<{
  25831. [id: string]: AbstractMesh | undefined;
  25832. }>;
  25833. /**
  25834. * Creates a material instance
  25835. * @param name defines the name of the material
  25836. * @param scene defines the scene to reference
  25837. * @param doNotAdd specifies if the material should be added to the scene
  25838. */
  25839. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  25840. /**
  25841. * Returns a string representation of the current material
  25842. * @param fullDetails defines a boolean indicating which levels of logging is desired
  25843. * @returns a string with material information
  25844. */
  25845. toString(fullDetails?: boolean): string;
  25846. /**
  25847. * Gets the class name of the material
  25848. * @returns a string with the class name of the material
  25849. */
  25850. getClassName(): string;
  25851. /**
  25852. * Specifies if updates for the material been locked
  25853. */
  25854. get isFrozen(): boolean;
  25855. /**
  25856. * Locks updates for the material
  25857. */
  25858. freeze(): void;
  25859. /**
  25860. * Unlocks updates for the material
  25861. */
  25862. unfreeze(): void;
  25863. /**
  25864. * Specifies if the material is ready to be used
  25865. * @param mesh defines the mesh to check
  25866. * @param useInstances specifies if instances should be used
  25867. * @returns a boolean indicating if the material is ready to be used
  25868. */
  25869. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  25870. /**
  25871. * Specifies that the submesh is ready to be used
  25872. * @param mesh defines the mesh to check
  25873. * @param subMesh defines which submesh to check
  25874. * @param useInstances specifies that instances should be used
  25875. * @returns a boolean indicating that the submesh is ready or not
  25876. */
  25877. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  25878. /**
  25879. * Returns the material effect
  25880. * @returns the effect associated with the material
  25881. */
  25882. getEffect(): Nullable<Effect>;
  25883. /**
  25884. * Returns the current scene
  25885. * @returns a Scene
  25886. */
  25887. getScene(): Scene;
  25888. /**
  25889. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  25890. */
  25891. protected _forceAlphaTest: boolean;
  25892. /**
  25893. * The transparency mode of the material.
  25894. */
  25895. protected _transparencyMode: Nullable<number>;
  25896. /**
  25897. * Gets the current transparency mode.
  25898. */
  25899. get transparencyMode(): Nullable<number>;
  25900. /**
  25901. * Sets the transparency mode of the material.
  25902. *
  25903. * | Value | Type | Description |
  25904. * | ----- | ----------------------------------- | ----------- |
  25905. * | 0 | OPAQUE | |
  25906. * | 1 | ALPHATEST | |
  25907. * | 2 | ALPHABLEND | |
  25908. * | 3 | ALPHATESTANDBLEND | |
  25909. *
  25910. */
  25911. set transparencyMode(value: Nullable<number>);
  25912. /**
  25913. * Returns true if alpha blending should be disabled.
  25914. */
  25915. protected get _disableAlphaBlending(): boolean;
  25916. /**
  25917. * Specifies whether or not this material should be rendered in alpha blend mode.
  25918. * @returns a boolean specifying if alpha blending is needed
  25919. */
  25920. needAlphaBlending(): boolean;
  25921. /**
  25922. * Specifies if the mesh will require alpha blending
  25923. * @param mesh defines the mesh to check
  25924. * @returns a boolean specifying if alpha blending is needed for the mesh
  25925. */
  25926. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  25927. /**
  25928. * Specifies whether or not this material should be rendered in alpha test mode.
  25929. * @returns a boolean specifying if an alpha test is needed.
  25930. */
  25931. needAlphaTesting(): boolean;
  25932. /**
  25933. * Specifies if material alpha testing should be turned on for the mesh
  25934. * @param mesh defines the mesh to check
  25935. */
  25936. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  25937. /**
  25938. * Gets the texture used for the alpha test
  25939. * @returns the texture to use for alpha testing
  25940. */
  25941. getAlphaTestTexture(): Nullable<BaseTexture>;
  25942. /**
  25943. * Marks the material to indicate that it needs to be re-calculated
  25944. */
  25945. markDirty(): void;
  25946. /** @hidden */
  25947. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  25948. /**
  25949. * Binds the material to the mesh
  25950. * @param world defines the world transformation matrix
  25951. * @param mesh defines the mesh to bind the material to
  25952. */
  25953. bind(world: Matrix, mesh?: Mesh): void;
  25954. /**
  25955. * Binds the submesh to the material
  25956. * @param world defines the world transformation matrix
  25957. * @param mesh defines the mesh containing the submesh
  25958. * @param subMesh defines the submesh to bind the material to
  25959. */
  25960. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  25961. /**
  25962. * Binds the world matrix to the material
  25963. * @param world defines the world transformation matrix
  25964. */
  25965. bindOnlyWorldMatrix(world: Matrix): void;
  25966. /**
  25967. * Binds the scene's uniform buffer to the effect.
  25968. * @param effect defines the effect to bind to the scene uniform buffer
  25969. * @param sceneUbo defines the uniform buffer storing scene data
  25970. */
  25971. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  25972. /**
  25973. * Binds the view matrix to the effect
  25974. * @param effect defines the effect to bind the view matrix to
  25975. */
  25976. bindView(effect: Effect): void;
  25977. /**
  25978. * Binds the view projection matrix to the effect
  25979. * @param effect defines the effect to bind the view projection matrix to
  25980. */
  25981. bindViewProjection(effect: Effect): void;
  25982. /**
  25983. * Processes to execute after binding the material to a mesh
  25984. * @param mesh defines the rendered mesh
  25985. */
  25986. protected _afterBind(mesh?: Mesh): void;
  25987. /**
  25988. * Unbinds the material from the mesh
  25989. */
  25990. unbind(): void;
  25991. /**
  25992. * Gets the active textures from the material
  25993. * @returns an array of textures
  25994. */
  25995. getActiveTextures(): BaseTexture[];
  25996. /**
  25997. * Specifies if the material uses a texture
  25998. * @param texture defines the texture to check against the material
  25999. * @returns a boolean specifying if the material uses the texture
  26000. */
  26001. hasTexture(texture: BaseTexture): boolean;
  26002. /**
  26003. * Makes a duplicate of the material, and gives it a new name
  26004. * @param name defines the new name for the duplicated material
  26005. * @returns the cloned material
  26006. */
  26007. clone(name: string): Nullable<Material>;
  26008. /**
  26009. * Gets the meshes bound to the material
  26010. * @returns an array of meshes bound to the material
  26011. */
  26012. getBindedMeshes(): AbstractMesh[];
  26013. /**
  26014. * Force shader compilation
  26015. * @param mesh defines the mesh associated with this material
  26016. * @param onCompiled defines a function to execute once the material is compiled
  26017. * @param options defines the options to configure the compilation
  26018. * @param onError defines a function to execute if the material fails compiling
  26019. */
  26020. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  26021. /**
  26022. * Force shader compilation
  26023. * @param mesh defines the mesh that will use this material
  26024. * @param options defines additional options for compiling the shaders
  26025. * @returns a promise that resolves when the compilation completes
  26026. */
  26027. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  26028. private static readonly _AllDirtyCallBack;
  26029. private static readonly _ImageProcessingDirtyCallBack;
  26030. private static readonly _TextureDirtyCallBack;
  26031. private static readonly _FresnelDirtyCallBack;
  26032. private static readonly _MiscDirtyCallBack;
  26033. private static readonly _LightsDirtyCallBack;
  26034. private static readonly _AttributeDirtyCallBack;
  26035. private static _FresnelAndMiscDirtyCallBack;
  26036. private static _TextureAndMiscDirtyCallBack;
  26037. private static readonly _DirtyCallbackArray;
  26038. private static readonly _RunDirtyCallBacks;
  26039. /**
  26040. * Marks a define in the material to indicate that it needs to be re-computed
  26041. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  26042. */
  26043. markAsDirty(flag: number): void;
  26044. /**
  26045. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  26046. * @param func defines a function which checks material defines against the submeshes
  26047. */
  26048. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  26049. /**
  26050. * Indicates that the scene should check if the rendering now needs a prepass
  26051. */
  26052. protected _markScenePrePassDirty(): void;
  26053. /**
  26054. * Indicates that we need to re-calculated for all submeshes
  26055. */
  26056. protected _markAllSubMeshesAsAllDirty(): void;
  26057. /**
  26058. * Indicates that image processing needs to be re-calculated for all submeshes
  26059. */
  26060. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  26061. /**
  26062. * Indicates that textures need to be re-calculated for all submeshes
  26063. */
  26064. protected _markAllSubMeshesAsTexturesDirty(): void;
  26065. /**
  26066. * Indicates that fresnel needs to be re-calculated for all submeshes
  26067. */
  26068. protected _markAllSubMeshesAsFresnelDirty(): void;
  26069. /**
  26070. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  26071. */
  26072. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  26073. /**
  26074. * Indicates that lights need to be re-calculated for all submeshes
  26075. */
  26076. protected _markAllSubMeshesAsLightsDirty(): void;
  26077. /**
  26078. * Indicates that attributes need to be re-calculated for all submeshes
  26079. */
  26080. protected _markAllSubMeshesAsAttributesDirty(): void;
  26081. /**
  26082. * Indicates that misc needs to be re-calculated for all submeshes
  26083. */
  26084. protected _markAllSubMeshesAsMiscDirty(): void;
  26085. /**
  26086. * Indicates that textures and misc need to be re-calculated for all submeshes
  26087. */
  26088. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  26089. /**
  26090. * Sets the required values to the prepass renderer.
  26091. * @param prePassRenderer defines the prepass renderer to setup.
  26092. * @returns true if the pre pass is needed.
  26093. */
  26094. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  26095. /**
  26096. * Disposes the material
  26097. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  26098. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  26099. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  26100. */
  26101. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  26102. /** @hidden */
  26103. private releaseVertexArrayObject;
  26104. /**
  26105. * Serializes this material
  26106. * @returns the serialized material object
  26107. */
  26108. serialize(): any;
  26109. /**
  26110. * Creates a material from parsed material data
  26111. * @param parsedMaterial defines parsed material data
  26112. * @param scene defines the hosting scene
  26113. * @param rootUrl defines the root URL to use to load textures
  26114. * @returns a new material
  26115. */
  26116. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  26117. }
  26118. }
  26119. declare module "babylonjs/Materials/multiMaterial" {
  26120. import { Nullable } from "babylonjs/types";
  26121. import { Scene } from "babylonjs/scene";
  26122. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26123. import { SubMesh } from "babylonjs/Meshes/subMesh";
  26124. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  26125. import { Material } from "babylonjs/Materials/material";
  26126. /**
  26127. * A multi-material is used to apply different materials to different parts of the same object without the need of
  26128. * separate meshes. This can be use to improve performances.
  26129. * @see https://doc.babylonjs.com/how_to/multi_materials
  26130. */
  26131. export class MultiMaterial extends Material {
  26132. private _subMaterials;
  26133. /**
  26134. * Gets or Sets the list of Materials used within the multi material.
  26135. * They need to be ordered according to the submeshes order in the associated mesh
  26136. */
  26137. get subMaterials(): Nullable<Material>[];
  26138. set subMaterials(value: Nullable<Material>[]);
  26139. /**
  26140. * Function used to align with Node.getChildren()
  26141. * @returns the list of Materials used within the multi material
  26142. */
  26143. getChildren(): Nullable<Material>[];
  26144. /**
  26145. * Instantiates a new Multi Material
  26146. * A multi-material is used to apply different materials to different parts of the same object without the need of
  26147. * separate meshes. This can be use to improve performances.
  26148. * @see https://doc.babylonjs.com/how_to/multi_materials
  26149. * @param name Define the name in the scene
  26150. * @param scene Define the scene the material belongs to
  26151. */
  26152. constructor(name: string, scene: Scene);
  26153. private _hookArray;
  26154. /**
  26155. * Get one of the submaterial by its index in the submaterials array
  26156. * @param index The index to look the sub material at
  26157. * @returns The Material if the index has been defined
  26158. */
  26159. getSubMaterial(index: number): Nullable<Material>;
  26160. /**
  26161. * Get the list of active textures for the whole sub materials list.
  26162. * @returns All the textures that will be used during the rendering
  26163. */
  26164. getActiveTextures(): BaseTexture[];
  26165. /**
  26166. * Gets the current class name of the material e.g. "MultiMaterial"
  26167. * Mainly use in serialization.
  26168. * @returns the class name
  26169. */
  26170. getClassName(): string;
  26171. /**
  26172. * Checks if the material is ready to render the requested sub mesh
  26173. * @param mesh Define the mesh the submesh belongs to
  26174. * @param subMesh Define the sub mesh to look readyness for
  26175. * @param useInstances Define whether or not the material is used with instances
  26176. * @returns true if ready, otherwise false
  26177. */
  26178. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  26179. /**
  26180. * Clones the current material and its related sub materials
  26181. * @param name Define the name of the newly cloned material
  26182. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  26183. * @returns the cloned material
  26184. */
  26185. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  26186. /**
  26187. * Serializes the materials into a JSON representation.
  26188. * @returns the JSON representation
  26189. */
  26190. serialize(): any;
  26191. /**
  26192. * Dispose the material and release its associated resources
  26193. * @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)
  26194. * @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)
  26195. * @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)
  26196. */
  26197. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  26198. /**
  26199. * Creates a MultiMaterial from parsed MultiMaterial data.
  26200. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  26201. * @param scene defines the hosting scene
  26202. * @returns a new MultiMaterial
  26203. */
  26204. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  26205. }
  26206. }
  26207. declare module "babylonjs/Meshes/subMesh" {
  26208. import { Nullable, IndicesArray, DeepImmutable, FloatArray } from "babylonjs/types";
  26209. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  26210. import { Engine } from "babylonjs/Engines/engine";
  26211. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  26212. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26213. import { Effect } from "babylonjs/Materials/effect";
  26214. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  26215. import { Plane } from "babylonjs/Maths/math.plane";
  26216. import { Collider } from "babylonjs/Collisions/collider";
  26217. import { Material } from "babylonjs/Materials/material";
  26218. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  26219. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26220. import { Mesh } from "babylonjs/Meshes/mesh";
  26221. import { Ray } from "babylonjs/Culling/ray";
  26222. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  26223. /**
  26224. * Defines a subdivision inside a mesh
  26225. */
  26226. export class SubMesh implements ICullable {
  26227. /** the material index to use */
  26228. materialIndex: number;
  26229. /** vertex index start */
  26230. verticesStart: number;
  26231. /** vertices count */
  26232. verticesCount: number;
  26233. /** index start */
  26234. indexStart: number;
  26235. /** indices count */
  26236. indexCount: number;
  26237. /** @hidden */
  26238. _materialDefines: Nullable<MaterialDefines>;
  26239. /** @hidden */
  26240. _materialEffect: Nullable<Effect>;
  26241. /** @hidden */
  26242. _effectOverride: Nullable<Effect>;
  26243. /**
  26244. * Gets material defines used by the effect associated to the sub mesh
  26245. */
  26246. get materialDefines(): Nullable<MaterialDefines>;
  26247. /**
  26248. * Sets material defines used by the effect associated to the sub mesh
  26249. */
  26250. set materialDefines(defines: Nullable<MaterialDefines>);
  26251. /**
  26252. * Gets associated effect
  26253. */
  26254. get effect(): Nullable<Effect>;
  26255. /**
  26256. * Sets associated effect (effect used to render this submesh)
  26257. * @param effect defines the effect to associate with
  26258. * @param defines defines the set of defines used to compile this effect
  26259. */
  26260. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  26261. /** @hidden */
  26262. _linesIndexCount: number;
  26263. private _mesh;
  26264. private _renderingMesh;
  26265. private _boundingInfo;
  26266. private _linesIndexBuffer;
  26267. /** @hidden */
  26268. _lastColliderWorldVertices: Nullable<Vector3[]>;
  26269. /** @hidden */
  26270. _trianglePlanes: Plane[];
  26271. /** @hidden */
  26272. _lastColliderTransformMatrix: Nullable<Matrix>;
  26273. /** @hidden */
  26274. _renderId: number;
  26275. /** @hidden */
  26276. _alphaIndex: number;
  26277. /** @hidden */
  26278. _distanceToCamera: number;
  26279. /** @hidden */
  26280. _id: number;
  26281. private _currentMaterial;
  26282. /**
  26283. * Add a new submesh to a mesh
  26284. * @param materialIndex defines the material index to use
  26285. * @param verticesStart defines vertex index start
  26286. * @param verticesCount defines vertices count
  26287. * @param indexStart defines index start
  26288. * @param indexCount defines indices count
  26289. * @param mesh defines the parent mesh
  26290. * @param renderingMesh defines an optional rendering mesh
  26291. * @param createBoundingBox defines if bounding box should be created for this submesh
  26292. * @returns the new submesh
  26293. */
  26294. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  26295. /**
  26296. * Creates a new submesh
  26297. * @param materialIndex defines the material index to use
  26298. * @param verticesStart defines vertex index start
  26299. * @param verticesCount defines vertices count
  26300. * @param indexStart defines index start
  26301. * @param indexCount defines indices count
  26302. * @param mesh defines the parent mesh
  26303. * @param renderingMesh defines an optional rendering mesh
  26304. * @param createBoundingBox defines if bounding box should be created for this submesh
  26305. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  26306. */
  26307. constructor(
  26308. /** the material index to use */
  26309. materialIndex: number,
  26310. /** vertex index start */
  26311. verticesStart: number,
  26312. /** vertices count */
  26313. verticesCount: number,
  26314. /** index start */
  26315. indexStart: number,
  26316. /** indices count */
  26317. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  26318. /**
  26319. * Returns true if this submesh covers the entire parent mesh
  26320. * @ignorenaming
  26321. */
  26322. get IsGlobal(): boolean;
  26323. /**
  26324. * Returns the submesh BoudingInfo object
  26325. * @returns current bounding info (or mesh's one if the submesh is global)
  26326. */
  26327. getBoundingInfo(): BoundingInfo;
  26328. /**
  26329. * Sets the submesh BoundingInfo
  26330. * @param boundingInfo defines the new bounding info to use
  26331. * @returns the SubMesh
  26332. */
  26333. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  26334. /**
  26335. * Returns the mesh of the current submesh
  26336. * @return the parent mesh
  26337. */
  26338. getMesh(): AbstractMesh;
  26339. /**
  26340. * Returns the rendering mesh of the submesh
  26341. * @returns the rendering mesh (could be different from parent mesh)
  26342. */
  26343. getRenderingMesh(): Mesh;
  26344. /**
  26345. * Returns the replacement mesh of the submesh
  26346. * @returns the replacement mesh (could be different from parent mesh)
  26347. */
  26348. getReplacementMesh(): Nullable<AbstractMesh>;
  26349. /**
  26350. * Returns the effective mesh of the submesh
  26351. * @returns the effective mesh (could be different from parent mesh)
  26352. */
  26353. getEffectiveMesh(): AbstractMesh;
  26354. /**
  26355. * Returns the submesh material
  26356. * @returns null or the current material
  26357. */
  26358. getMaterial(): Nullable<Material>;
  26359. private _IsMultiMaterial;
  26360. /**
  26361. * Sets a new updated BoundingInfo object to the submesh
  26362. * @param data defines an optional position array to use to determine the bounding info
  26363. * @returns the SubMesh
  26364. */
  26365. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  26366. /** @hidden */
  26367. _checkCollision(collider: Collider): boolean;
  26368. /**
  26369. * Updates the submesh BoundingInfo
  26370. * @param world defines the world matrix to use to update the bounding info
  26371. * @returns the submesh
  26372. */
  26373. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  26374. /**
  26375. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  26376. * @param frustumPlanes defines the frustum planes
  26377. * @returns true if the submesh is intersecting with the frustum
  26378. */
  26379. isInFrustum(frustumPlanes: Plane[]): boolean;
  26380. /**
  26381. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  26382. * @param frustumPlanes defines the frustum planes
  26383. * @returns true if the submesh is inside the frustum
  26384. */
  26385. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  26386. /**
  26387. * Renders the submesh
  26388. * @param enableAlphaMode defines if alpha needs to be used
  26389. * @returns the submesh
  26390. */
  26391. render(enableAlphaMode: boolean): SubMesh;
  26392. /**
  26393. * @hidden
  26394. */
  26395. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  26396. /**
  26397. * Checks if the submesh intersects with a ray
  26398. * @param ray defines the ray to test
  26399. * @returns true is the passed ray intersects the submesh bounding box
  26400. */
  26401. canIntersects(ray: Ray): boolean;
  26402. /**
  26403. * Intersects current submesh with a ray
  26404. * @param ray defines the ray to test
  26405. * @param positions defines mesh's positions array
  26406. * @param indices defines mesh's indices array
  26407. * @param fastCheck defines if the first intersection will be used (and not the closest)
  26408. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  26409. * @returns intersection info or null if no intersection
  26410. */
  26411. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  26412. /** @hidden */
  26413. private _intersectLines;
  26414. /** @hidden */
  26415. private _intersectUnIndexedLines;
  26416. /** @hidden */
  26417. private _intersectTriangles;
  26418. /** @hidden */
  26419. private _intersectUnIndexedTriangles;
  26420. /** @hidden */
  26421. _rebuild(): void;
  26422. /**
  26423. * Creates a new submesh from the passed mesh
  26424. * @param newMesh defines the new hosting mesh
  26425. * @param newRenderingMesh defines an optional rendering mesh
  26426. * @returns the new submesh
  26427. */
  26428. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  26429. /**
  26430. * Release associated resources
  26431. */
  26432. dispose(): void;
  26433. /**
  26434. * Gets the class name
  26435. * @returns the string "SubMesh".
  26436. */
  26437. getClassName(): string;
  26438. /**
  26439. * Creates a new submesh from indices data
  26440. * @param materialIndex the index of the main mesh material
  26441. * @param startIndex the index where to start the copy in the mesh indices array
  26442. * @param indexCount the number of indices to copy then from the startIndex
  26443. * @param mesh the main mesh to create the submesh from
  26444. * @param renderingMesh the optional rendering mesh
  26445. * @returns a new submesh
  26446. */
  26447. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  26448. }
  26449. }
  26450. declare module "babylonjs/Loading/sceneLoaderFlags" {
  26451. /**
  26452. * Class used to represent data loading progression
  26453. */
  26454. export class SceneLoaderFlags {
  26455. private static _ForceFullSceneLoadingForIncremental;
  26456. private static _ShowLoadingScreen;
  26457. private static _CleanBoneMatrixWeights;
  26458. private static _loggingLevel;
  26459. /**
  26460. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  26461. */
  26462. static get ForceFullSceneLoadingForIncremental(): boolean;
  26463. static set ForceFullSceneLoadingForIncremental(value: boolean);
  26464. /**
  26465. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  26466. */
  26467. static get ShowLoadingScreen(): boolean;
  26468. static set ShowLoadingScreen(value: boolean);
  26469. /**
  26470. * Defines the current logging level (while loading the scene)
  26471. * @ignorenaming
  26472. */
  26473. static get loggingLevel(): number;
  26474. static set loggingLevel(value: number);
  26475. /**
  26476. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  26477. */
  26478. static get CleanBoneMatrixWeights(): boolean;
  26479. static set CleanBoneMatrixWeights(value: boolean);
  26480. }
  26481. }
  26482. declare module "babylonjs/Meshes/geometry" {
  26483. import { Nullable, FloatArray, DataArray, IndicesArray } from "babylonjs/types";
  26484. import { Scene } from "babylonjs/scene";
  26485. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  26486. import { Engine } from "babylonjs/Engines/engine";
  26487. import { IGetSetVerticesData, VertexData } from "babylonjs/Meshes/mesh.vertexData";
  26488. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  26489. import { Effect } from "babylonjs/Materials/effect";
  26490. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26491. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  26492. import { Mesh } from "babylonjs/Meshes/mesh";
  26493. /**
  26494. * Class used to store geometry data (vertex buffers + index buffer)
  26495. */
  26496. export class Geometry implements IGetSetVerticesData {
  26497. /**
  26498. * Gets or sets the ID of the geometry
  26499. */
  26500. id: string;
  26501. /**
  26502. * Gets or sets the unique ID of the geometry
  26503. */
  26504. uniqueId: number;
  26505. /**
  26506. * Gets the delay loading state of the geometry (none by default which means not delayed)
  26507. */
  26508. delayLoadState: number;
  26509. /**
  26510. * Gets the file containing the data to load when running in delay load state
  26511. */
  26512. delayLoadingFile: Nullable<string>;
  26513. /**
  26514. * Callback called when the geometry is updated
  26515. */
  26516. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  26517. private _scene;
  26518. private _engine;
  26519. private _meshes;
  26520. private _totalVertices;
  26521. /** @hidden */
  26522. _indices: IndicesArray;
  26523. /** @hidden */
  26524. _vertexBuffers: {
  26525. [key: string]: VertexBuffer;
  26526. };
  26527. private _isDisposed;
  26528. private _extend;
  26529. private _boundingBias;
  26530. /** @hidden */
  26531. _delayInfo: Array<string>;
  26532. private _indexBuffer;
  26533. private _indexBufferIsUpdatable;
  26534. /** @hidden */
  26535. _boundingInfo: Nullable<BoundingInfo>;
  26536. /** @hidden */
  26537. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  26538. /** @hidden */
  26539. _softwareSkinningFrameId: number;
  26540. private _vertexArrayObjects;
  26541. private _updatable;
  26542. /** @hidden */
  26543. _positions: Nullable<Vector3[]>;
  26544. /**
  26545. * 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
  26546. */
  26547. get boundingBias(): Vector2;
  26548. /**
  26549. * 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
  26550. */
  26551. set boundingBias(value: Vector2);
  26552. /**
  26553. * Static function used to attach a new empty geometry to a mesh
  26554. * @param mesh defines the mesh to attach the geometry to
  26555. * @returns the new Geometry
  26556. */
  26557. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  26558. /** Get the list of meshes using this geometry */
  26559. get meshes(): Mesh[];
  26560. /**
  26561. * 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
  26562. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  26563. */
  26564. useBoundingInfoFromGeometry: boolean;
  26565. /**
  26566. * Creates a new geometry
  26567. * @param id defines the unique ID
  26568. * @param scene defines the hosting scene
  26569. * @param vertexData defines the VertexData used to get geometry data
  26570. * @param updatable defines if geometry must be updatable (false by default)
  26571. * @param mesh defines the mesh that will be associated with the geometry
  26572. */
  26573. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  26574. /**
  26575. * Gets the current extend of the geometry
  26576. */
  26577. get extend(): {
  26578. minimum: Vector3;
  26579. maximum: Vector3;
  26580. };
  26581. /**
  26582. * Gets the hosting scene
  26583. * @returns the hosting Scene
  26584. */
  26585. getScene(): Scene;
  26586. /**
  26587. * Gets the hosting engine
  26588. * @returns the hosting Engine
  26589. */
  26590. getEngine(): Engine;
  26591. /**
  26592. * Defines if the geometry is ready to use
  26593. * @returns true if the geometry is ready to be used
  26594. */
  26595. isReady(): boolean;
  26596. /**
  26597. * Gets a value indicating that the geometry should not be serialized
  26598. */
  26599. get doNotSerialize(): boolean;
  26600. /** @hidden */
  26601. _rebuild(): void;
  26602. /**
  26603. * Affects all geometry data in one call
  26604. * @param vertexData defines the geometry data
  26605. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  26606. */
  26607. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  26608. /**
  26609. * Set specific vertex data
  26610. * @param kind defines the data kind (Position, normal, etc...)
  26611. * @param data defines the vertex data to use
  26612. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  26613. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  26614. */
  26615. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  26616. /**
  26617. * Removes a specific vertex data
  26618. * @param kind defines the data kind (Position, normal, etc...)
  26619. */
  26620. removeVerticesData(kind: string): void;
  26621. /**
  26622. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  26623. * @param buffer defines the vertex buffer to use
  26624. * @param totalVertices defines the total number of vertices for position kind (could be null)
  26625. */
  26626. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  26627. /**
  26628. * Update a specific vertex buffer
  26629. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  26630. * It will do nothing if the buffer is not updatable
  26631. * @param kind defines the data kind (Position, normal, etc...)
  26632. * @param data defines the data to use
  26633. * @param offset defines the offset in the target buffer where to store the data
  26634. * @param useBytes set to true if the offset is in bytes
  26635. */
  26636. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  26637. /**
  26638. * Update a specific vertex buffer
  26639. * This function will create a new buffer if the current one is not updatable
  26640. * @param kind defines the data kind (Position, normal, etc...)
  26641. * @param data defines the data to use
  26642. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  26643. */
  26644. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  26645. private _updateBoundingInfo;
  26646. /** @hidden */
  26647. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  26648. /**
  26649. * Gets total number of vertices
  26650. * @returns the total number of vertices
  26651. */
  26652. getTotalVertices(): number;
  26653. /**
  26654. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  26655. * @param kind defines the data kind (Position, normal, etc...)
  26656. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26657. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26658. * @returns a float array containing vertex data
  26659. */
  26660. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  26661. /**
  26662. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  26663. * @param kind defines the data kind (Position, normal, etc...)
  26664. * @returns true if the vertex buffer with the specified kind is updatable
  26665. */
  26666. isVertexBufferUpdatable(kind: string): boolean;
  26667. /**
  26668. * Gets a specific vertex buffer
  26669. * @param kind defines the data kind (Position, normal, etc...)
  26670. * @returns a VertexBuffer
  26671. */
  26672. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  26673. /**
  26674. * Returns all vertex buffers
  26675. * @return an object holding all vertex buffers indexed by kind
  26676. */
  26677. getVertexBuffers(): Nullable<{
  26678. [key: string]: VertexBuffer;
  26679. }>;
  26680. /**
  26681. * Gets a boolean indicating if specific vertex buffer is present
  26682. * @param kind defines the data kind (Position, normal, etc...)
  26683. * @returns true if data is present
  26684. */
  26685. isVerticesDataPresent(kind: string): boolean;
  26686. /**
  26687. * Gets a list of all attached data kinds (Position, normal, etc...)
  26688. * @returns a list of string containing all kinds
  26689. */
  26690. getVerticesDataKinds(): string[];
  26691. /**
  26692. * Update index buffer
  26693. * @param indices defines the indices to store in the index buffer
  26694. * @param offset defines the offset in the target buffer where to store the data
  26695. * @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)
  26696. */
  26697. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  26698. /**
  26699. * Creates a new index buffer
  26700. * @param indices defines the indices to store in the index buffer
  26701. * @param totalVertices defines the total number of vertices (could be null)
  26702. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  26703. */
  26704. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  26705. /**
  26706. * Return the total number of indices
  26707. * @returns the total number of indices
  26708. */
  26709. getTotalIndices(): number;
  26710. /**
  26711. * Gets the index buffer array
  26712. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26713. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26714. * @returns the index buffer array
  26715. */
  26716. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  26717. /**
  26718. * Gets the index buffer
  26719. * @return the index buffer
  26720. */
  26721. getIndexBuffer(): Nullable<DataBuffer>;
  26722. /** @hidden */
  26723. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  26724. /**
  26725. * Release the associated resources for a specific mesh
  26726. * @param mesh defines the source mesh
  26727. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  26728. */
  26729. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  26730. /**
  26731. * Apply current geometry to a given mesh
  26732. * @param mesh defines the mesh to apply geometry to
  26733. */
  26734. applyToMesh(mesh: Mesh): void;
  26735. private _updateExtend;
  26736. private _applyToMesh;
  26737. private notifyUpdate;
  26738. /**
  26739. * Load the geometry if it was flagged as delay loaded
  26740. * @param scene defines the hosting scene
  26741. * @param onLoaded defines a callback called when the geometry is loaded
  26742. */
  26743. load(scene: Scene, onLoaded?: () => void): void;
  26744. private _queueLoad;
  26745. /**
  26746. * Invert the geometry to move from a right handed system to a left handed one.
  26747. */
  26748. toLeftHanded(): void;
  26749. /** @hidden */
  26750. _resetPointsArrayCache(): void;
  26751. /** @hidden */
  26752. _generatePointsArray(): boolean;
  26753. /**
  26754. * Gets a value indicating if the geometry is disposed
  26755. * @returns true if the geometry was disposed
  26756. */
  26757. isDisposed(): boolean;
  26758. private _disposeVertexArrayObjects;
  26759. /**
  26760. * Free all associated resources
  26761. */
  26762. dispose(): void;
  26763. /**
  26764. * Clone the current geometry into a new geometry
  26765. * @param id defines the unique ID of the new geometry
  26766. * @returns a new geometry object
  26767. */
  26768. copy(id: string): Geometry;
  26769. /**
  26770. * Serialize the current geometry info (and not the vertices data) into a JSON object
  26771. * @return a JSON representation of the current geometry data (without the vertices data)
  26772. */
  26773. serialize(): any;
  26774. private toNumberArray;
  26775. /**
  26776. * Serialize all vertices data into a JSON oject
  26777. * @returns a JSON representation of the current geometry data
  26778. */
  26779. serializeVerticeData(): any;
  26780. /**
  26781. * Extracts a clone of a mesh geometry
  26782. * @param mesh defines the source mesh
  26783. * @param id defines the unique ID of the new geometry object
  26784. * @returns the new geometry object
  26785. */
  26786. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  26787. /**
  26788. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  26789. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  26790. * Be aware Math.random() could cause collisions, but:
  26791. * "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"
  26792. * @returns a string containing a new GUID
  26793. */
  26794. static RandomId(): string;
  26795. /** @hidden */
  26796. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  26797. private static _CleanMatricesWeights;
  26798. /**
  26799. * Create a new geometry from persisted data (Using .babylon file format)
  26800. * @param parsedVertexData defines the persisted data
  26801. * @param scene defines the hosting scene
  26802. * @param rootUrl defines the root url to use to load assets (like delayed data)
  26803. * @returns the new geometry object
  26804. */
  26805. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  26806. }
  26807. }
  26808. declare module "babylonjs/Meshes/mesh.vertexData" {
  26809. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  26810. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  26811. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  26812. import { Geometry } from "babylonjs/Meshes/geometry";
  26813. import { Mesh } from "babylonjs/Meshes/mesh";
  26814. /**
  26815. * Define an interface for all classes that will get and set the data on vertices
  26816. */
  26817. export interface IGetSetVerticesData {
  26818. /**
  26819. * Gets a boolean indicating if specific vertex data is present
  26820. * @param kind defines the vertex data kind to use
  26821. * @returns true is data kind is present
  26822. */
  26823. isVerticesDataPresent(kind: string): boolean;
  26824. /**
  26825. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  26826. * @param kind defines the data kind (Position, normal, etc...)
  26827. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26828. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26829. * @returns a float array containing vertex data
  26830. */
  26831. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  26832. /**
  26833. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  26834. * @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.
  26835. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26836. * @returns the indices array or an empty array if the mesh has no geometry
  26837. */
  26838. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  26839. /**
  26840. * Set specific vertex data
  26841. * @param kind defines the data kind (Position, normal, etc...)
  26842. * @param data defines the vertex data to use
  26843. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  26844. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  26845. */
  26846. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  26847. /**
  26848. * Update a specific associated vertex buffer
  26849. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  26850. * - VertexBuffer.PositionKind
  26851. * - VertexBuffer.UVKind
  26852. * - VertexBuffer.UV2Kind
  26853. * - VertexBuffer.UV3Kind
  26854. * - VertexBuffer.UV4Kind
  26855. * - VertexBuffer.UV5Kind
  26856. * - VertexBuffer.UV6Kind
  26857. * - VertexBuffer.ColorKind
  26858. * - VertexBuffer.MatricesIndicesKind
  26859. * - VertexBuffer.MatricesIndicesExtraKind
  26860. * - VertexBuffer.MatricesWeightsKind
  26861. * - VertexBuffer.MatricesWeightsExtraKind
  26862. * @param data defines the data source
  26863. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  26864. * @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)
  26865. */
  26866. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  26867. /**
  26868. * Creates a new index buffer
  26869. * @param indices defines the indices to store in the index buffer
  26870. * @param totalVertices defines the total number of vertices (could be null)
  26871. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  26872. */
  26873. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  26874. }
  26875. /**
  26876. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  26877. */
  26878. export class VertexData {
  26879. /**
  26880. * Mesh side orientation : usually the external or front surface
  26881. */
  26882. static readonly FRONTSIDE: number;
  26883. /**
  26884. * Mesh side orientation : usually the internal or back surface
  26885. */
  26886. static readonly BACKSIDE: number;
  26887. /**
  26888. * Mesh side orientation : both internal and external or front and back surfaces
  26889. */
  26890. static readonly DOUBLESIDE: number;
  26891. /**
  26892. * Mesh side orientation : by default, `FRONTSIDE`
  26893. */
  26894. static readonly DEFAULTSIDE: number;
  26895. /**
  26896. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  26897. */
  26898. positions: Nullable<FloatArray>;
  26899. /**
  26900. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  26901. */
  26902. normals: Nullable<FloatArray>;
  26903. /**
  26904. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  26905. */
  26906. tangents: Nullable<FloatArray>;
  26907. /**
  26908. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26909. */
  26910. uvs: Nullable<FloatArray>;
  26911. /**
  26912. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26913. */
  26914. uvs2: Nullable<FloatArray>;
  26915. /**
  26916. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26917. */
  26918. uvs3: Nullable<FloatArray>;
  26919. /**
  26920. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26921. */
  26922. uvs4: Nullable<FloatArray>;
  26923. /**
  26924. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26925. */
  26926. uvs5: Nullable<FloatArray>;
  26927. /**
  26928. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26929. */
  26930. uvs6: Nullable<FloatArray>;
  26931. /**
  26932. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  26933. */
  26934. colors: Nullable<FloatArray>;
  26935. /**
  26936. * 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).
  26937. */
  26938. matricesIndices: Nullable<FloatArray>;
  26939. /**
  26940. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  26941. */
  26942. matricesWeights: Nullable<FloatArray>;
  26943. /**
  26944. * An array extending the number of possible indices
  26945. */
  26946. matricesIndicesExtra: Nullable<FloatArray>;
  26947. /**
  26948. * An array extending the number of possible weights when the number of indices is extended
  26949. */
  26950. matricesWeightsExtra: Nullable<FloatArray>;
  26951. /**
  26952. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  26953. */
  26954. indices: Nullable<IndicesArray>;
  26955. /**
  26956. * Uses the passed data array to set the set the values for the specified kind of data
  26957. * @param data a linear array of floating numbers
  26958. * @param kind the type of data that is being set, eg positions, colors etc
  26959. */
  26960. set(data: FloatArray, kind: string): void;
  26961. /**
  26962. * Associates the vertexData to the passed Mesh.
  26963. * Sets it as updatable or not (default `false`)
  26964. * @param mesh the mesh the vertexData is applied to
  26965. * @param updatable when used and having the value true allows new data to update the vertexData
  26966. * @returns the VertexData
  26967. */
  26968. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  26969. /**
  26970. * Associates the vertexData to the passed Geometry.
  26971. * Sets it as updatable or not (default `false`)
  26972. * @param geometry the geometry the vertexData is applied to
  26973. * @param updatable when used and having the value true allows new data to update the vertexData
  26974. * @returns VertexData
  26975. */
  26976. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  26977. /**
  26978. * Updates the associated mesh
  26979. * @param mesh the mesh to be updated
  26980. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  26981. * @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
  26982. * @returns VertexData
  26983. */
  26984. updateMesh(mesh: Mesh): VertexData;
  26985. /**
  26986. * Updates the associated geometry
  26987. * @param geometry the geometry to be updated
  26988. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  26989. * @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
  26990. * @returns VertexData.
  26991. */
  26992. updateGeometry(geometry: Geometry): VertexData;
  26993. private _applyTo;
  26994. private _update;
  26995. /**
  26996. * Transforms each position and each normal of the vertexData according to the passed Matrix
  26997. * @param matrix the transforming matrix
  26998. * @returns the VertexData
  26999. */
  27000. transform(matrix: Matrix): VertexData;
  27001. /**
  27002. * Merges the passed VertexData into the current one
  27003. * @param other the VertexData to be merged into the current one
  27004. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  27005. * @returns the modified VertexData
  27006. */
  27007. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  27008. private _mergeElement;
  27009. private _validate;
  27010. /**
  27011. * Serializes the VertexData
  27012. * @returns a serialized object
  27013. */
  27014. serialize(): any;
  27015. /**
  27016. * Extracts the vertexData from a mesh
  27017. * @param mesh the mesh from which to extract the VertexData
  27018. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  27019. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  27020. * @returns the object VertexData associated to the passed mesh
  27021. */
  27022. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  27023. /**
  27024. * Extracts the vertexData from the geometry
  27025. * @param geometry the geometry from which to extract the VertexData
  27026. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  27027. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  27028. * @returns the object VertexData associated to the passed mesh
  27029. */
  27030. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  27031. private static _ExtractFrom;
  27032. /**
  27033. * Creates the VertexData for a Ribbon
  27034. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  27035. * * pathArray array of paths, each of which an array of successive Vector3
  27036. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  27037. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  27038. * * 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
  27039. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27040. * * 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)
  27041. * * 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)
  27042. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  27043. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  27044. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  27045. * @returns the VertexData of the ribbon
  27046. */
  27047. static CreateRibbon(options: {
  27048. pathArray: Vector3[][];
  27049. closeArray?: boolean;
  27050. closePath?: boolean;
  27051. offset?: number;
  27052. sideOrientation?: number;
  27053. frontUVs?: Vector4;
  27054. backUVs?: Vector4;
  27055. invertUV?: boolean;
  27056. uvs?: Vector2[];
  27057. colors?: Color4[];
  27058. }): VertexData;
  27059. /**
  27060. * Creates the VertexData for a box
  27061. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27062. * * size sets the width, height and depth of the box to the value of size, optional default 1
  27063. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  27064. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  27065. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  27066. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  27067. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  27068. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27069. * * 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)
  27070. * * 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)
  27071. * @returns the VertexData of the box
  27072. */
  27073. static CreateBox(options: {
  27074. size?: number;
  27075. width?: number;
  27076. height?: number;
  27077. depth?: number;
  27078. faceUV?: Vector4[];
  27079. faceColors?: Color4[];
  27080. sideOrientation?: number;
  27081. frontUVs?: Vector4;
  27082. backUVs?: Vector4;
  27083. }): VertexData;
  27084. /**
  27085. * Creates the VertexData for a tiled box
  27086. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27087. * * faceTiles sets the pattern, tile size and number of tiles for a face
  27088. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  27089. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  27090. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27091. * @returns the VertexData of the box
  27092. */
  27093. static CreateTiledBox(options: {
  27094. pattern?: number;
  27095. width?: number;
  27096. height?: number;
  27097. depth?: number;
  27098. tileSize?: number;
  27099. tileWidth?: number;
  27100. tileHeight?: number;
  27101. alignHorizontal?: number;
  27102. alignVertical?: number;
  27103. faceUV?: Vector4[];
  27104. faceColors?: Color4[];
  27105. sideOrientation?: number;
  27106. }): VertexData;
  27107. /**
  27108. * Creates the VertexData for a tiled plane
  27109. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27110. * * pattern a limited pattern arrangement depending on the number
  27111. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  27112. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  27113. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  27114. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27115. * * 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)
  27116. * * 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)
  27117. * @returns the VertexData of the tiled plane
  27118. */
  27119. static CreateTiledPlane(options: {
  27120. pattern?: number;
  27121. tileSize?: number;
  27122. tileWidth?: number;
  27123. tileHeight?: number;
  27124. size?: number;
  27125. width?: number;
  27126. height?: number;
  27127. alignHorizontal?: number;
  27128. alignVertical?: number;
  27129. sideOrientation?: number;
  27130. frontUVs?: Vector4;
  27131. backUVs?: Vector4;
  27132. }): VertexData;
  27133. /**
  27134. * Creates the VertexData for an ellipsoid, defaults to a sphere
  27135. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27136. * * segments sets the number of horizontal strips optional, default 32
  27137. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  27138. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  27139. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  27140. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  27141. * * 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
  27142. * * 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
  27143. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27144. * * 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)
  27145. * * 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)
  27146. * @returns the VertexData of the ellipsoid
  27147. */
  27148. static CreateSphere(options: {
  27149. segments?: number;
  27150. diameter?: number;
  27151. diameterX?: number;
  27152. diameterY?: number;
  27153. diameterZ?: number;
  27154. arc?: number;
  27155. slice?: number;
  27156. sideOrientation?: number;
  27157. frontUVs?: Vector4;
  27158. backUVs?: Vector4;
  27159. }): VertexData;
  27160. /**
  27161. * Creates the VertexData for a cylinder, cone or prism
  27162. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27163. * * height sets the height (y direction) of the cylinder, optional, default 2
  27164. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  27165. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  27166. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  27167. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  27168. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  27169. * * 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
  27170. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27171. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27172. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  27173. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  27174. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27175. * * 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)
  27176. * * 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)
  27177. * @returns the VertexData of the cylinder, cone or prism
  27178. */
  27179. static CreateCylinder(options: {
  27180. height?: number;
  27181. diameterTop?: number;
  27182. diameterBottom?: number;
  27183. diameter?: number;
  27184. tessellation?: number;
  27185. subdivisions?: number;
  27186. arc?: number;
  27187. faceColors?: Color4[];
  27188. faceUV?: Vector4[];
  27189. hasRings?: boolean;
  27190. enclose?: boolean;
  27191. sideOrientation?: number;
  27192. frontUVs?: Vector4;
  27193. backUVs?: Vector4;
  27194. }): VertexData;
  27195. /**
  27196. * Creates the VertexData for a torus
  27197. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27198. * * diameter the diameter of the torus, optional default 1
  27199. * * thickness the diameter of the tube forming the torus, optional default 0.5
  27200. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  27201. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27202. * * 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)
  27203. * * 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)
  27204. * @returns the VertexData of the torus
  27205. */
  27206. static CreateTorus(options: {
  27207. diameter?: number;
  27208. thickness?: number;
  27209. tessellation?: number;
  27210. sideOrientation?: number;
  27211. frontUVs?: Vector4;
  27212. backUVs?: Vector4;
  27213. }): VertexData;
  27214. /**
  27215. * Creates the VertexData of the LineSystem
  27216. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  27217. * - lines an array of lines, each line being an array of successive Vector3
  27218. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  27219. * @returns the VertexData of the LineSystem
  27220. */
  27221. static CreateLineSystem(options: {
  27222. lines: Vector3[][];
  27223. colors?: Nullable<Color4[][]>;
  27224. }): VertexData;
  27225. /**
  27226. * Create the VertexData for a DashedLines
  27227. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  27228. * - points an array successive Vector3
  27229. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  27230. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  27231. * - dashNb the intended total number of dashes, optional, default 200
  27232. * @returns the VertexData for the DashedLines
  27233. */
  27234. static CreateDashedLines(options: {
  27235. points: Vector3[];
  27236. dashSize?: number;
  27237. gapSize?: number;
  27238. dashNb?: number;
  27239. }): VertexData;
  27240. /**
  27241. * Creates the VertexData for a Ground
  27242. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  27243. * - width the width (x direction) of the ground, optional, default 1
  27244. * - height the height (z direction) of the ground, optional, default 1
  27245. * - subdivisions the number of subdivisions per side, optional, default 1
  27246. * @returns the VertexData of the Ground
  27247. */
  27248. static CreateGround(options: {
  27249. width?: number;
  27250. height?: number;
  27251. subdivisions?: number;
  27252. subdivisionsX?: number;
  27253. subdivisionsY?: number;
  27254. }): VertexData;
  27255. /**
  27256. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  27257. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  27258. * * xmin the ground minimum X coordinate, optional, default -1
  27259. * * zmin the ground minimum Z coordinate, optional, default -1
  27260. * * xmax the ground maximum X coordinate, optional, default 1
  27261. * * zmax the ground maximum Z coordinate, optional, default 1
  27262. * * 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}
  27263. * * 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}
  27264. * @returns the VertexData of the TiledGround
  27265. */
  27266. static CreateTiledGround(options: {
  27267. xmin: number;
  27268. zmin: number;
  27269. xmax: number;
  27270. zmax: number;
  27271. subdivisions?: {
  27272. w: number;
  27273. h: number;
  27274. };
  27275. precision?: {
  27276. w: number;
  27277. h: number;
  27278. };
  27279. }): VertexData;
  27280. /**
  27281. * Creates the VertexData of the Ground designed from a heightmap
  27282. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  27283. * * width the width (x direction) of the ground
  27284. * * height the height (z direction) of the ground
  27285. * * subdivisions the number of subdivisions per side
  27286. * * minHeight the minimum altitude on the ground, optional, default 0
  27287. * * maxHeight the maximum altitude on the ground, optional default 1
  27288. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  27289. * * buffer the array holding the image color data
  27290. * * bufferWidth the width of image
  27291. * * bufferHeight the height of image
  27292. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  27293. * @returns the VertexData of the Ground designed from a heightmap
  27294. */
  27295. static CreateGroundFromHeightMap(options: {
  27296. width: number;
  27297. height: number;
  27298. subdivisions: number;
  27299. minHeight: number;
  27300. maxHeight: number;
  27301. colorFilter: Color3;
  27302. buffer: Uint8Array;
  27303. bufferWidth: number;
  27304. bufferHeight: number;
  27305. alphaFilter: number;
  27306. }): VertexData;
  27307. /**
  27308. * Creates the VertexData for a Plane
  27309. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  27310. * * size sets the width and height of the plane to the value of size, optional default 1
  27311. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  27312. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  27313. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27314. * * 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)
  27315. * * 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)
  27316. * @returns the VertexData of the box
  27317. */
  27318. static CreatePlane(options: {
  27319. size?: number;
  27320. width?: number;
  27321. height?: number;
  27322. sideOrientation?: number;
  27323. frontUVs?: Vector4;
  27324. backUVs?: Vector4;
  27325. }): VertexData;
  27326. /**
  27327. * Creates the VertexData of the Disc or regular Polygon
  27328. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  27329. * * radius the radius of the disc, optional default 0.5
  27330. * * tessellation the number of polygon sides, optional, default 64
  27331. * * 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
  27332. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27333. * * 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)
  27334. * * 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)
  27335. * @returns the VertexData of the box
  27336. */
  27337. static CreateDisc(options: {
  27338. radius?: number;
  27339. tessellation?: number;
  27340. arc?: number;
  27341. sideOrientation?: number;
  27342. frontUVs?: Vector4;
  27343. backUVs?: Vector4;
  27344. }): VertexData;
  27345. /**
  27346. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  27347. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  27348. * @param polygon a mesh built from polygonTriangulation.build()
  27349. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27350. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27351. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27352. * @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)
  27353. * @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)
  27354. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  27355. * @returns the VertexData of the Polygon
  27356. */
  27357. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  27358. /**
  27359. * Creates the VertexData of the IcoSphere
  27360. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  27361. * * radius the radius of the IcoSphere, optional default 1
  27362. * * radiusX allows stretching in the x direction, optional, default radius
  27363. * * radiusY allows stretching in the y direction, optional, default radius
  27364. * * radiusZ allows stretching in the z direction, optional, default radius
  27365. * * flat when true creates a flat shaded mesh, optional, default true
  27366. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  27367. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27368. * * 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)
  27369. * * 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)
  27370. * @returns the VertexData of the IcoSphere
  27371. */
  27372. static CreateIcoSphere(options: {
  27373. radius?: number;
  27374. radiusX?: number;
  27375. radiusY?: number;
  27376. radiusZ?: number;
  27377. flat?: boolean;
  27378. subdivisions?: number;
  27379. sideOrientation?: number;
  27380. frontUVs?: Vector4;
  27381. backUVs?: Vector4;
  27382. }): VertexData;
  27383. /**
  27384. * Creates the VertexData for a Polyhedron
  27385. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  27386. * * type provided types are:
  27387. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  27388. * * 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)
  27389. * * size the size of the IcoSphere, optional default 1
  27390. * * sizeX allows stretching in the x direction, optional, default size
  27391. * * sizeY allows stretching in the y direction, optional, default size
  27392. * * sizeZ allows stretching in the z direction, optional, default size
  27393. * * 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
  27394. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27395. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27396. * * flat when true creates a flat shaded mesh, optional, default true
  27397. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  27398. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27399. * * 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)
  27400. * * 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)
  27401. * @returns the VertexData of the Polyhedron
  27402. */
  27403. static CreatePolyhedron(options: {
  27404. type?: number;
  27405. size?: number;
  27406. sizeX?: number;
  27407. sizeY?: number;
  27408. sizeZ?: number;
  27409. custom?: any;
  27410. faceUV?: Vector4[];
  27411. faceColors?: Color4[];
  27412. flat?: boolean;
  27413. sideOrientation?: number;
  27414. frontUVs?: Vector4;
  27415. backUVs?: Vector4;
  27416. }): VertexData;
  27417. /**
  27418. * Creates the VertexData for a TorusKnot
  27419. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  27420. * * radius the radius of the torus knot, optional, default 2
  27421. * * tube the thickness of the tube, optional, default 0.5
  27422. * * radialSegments the number of sides on each tube segments, optional, default 32
  27423. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  27424. * * p the number of windings around the z axis, optional, default 2
  27425. * * q the number of windings around the x axis, optional, default 3
  27426. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27427. * * 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)
  27428. * * 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)
  27429. * @returns the VertexData of the Torus Knot
  27430. */
  27431. static CreateTorusKnot(options: {
  27432. radius?: number;
  27433. tube?: number;
  27434. radialSegments?: number;
  27435. tubularSegments?: number;
  27436. p?: number;
  27437. q?: number;
  27438. sideOrientation?: number;
  27439. frontUVs?: Vector4;
  27440. backUVs?: Vector4;
  27441. }): VertexData;
  27442. /**
  27443. * Compute normals for given positions and indices
  27444. * @param positions an array of vertex positions, [...., x, y, z, ......]
  27445. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  27446. * @param normals an array of vertex normals, [...., x, y, z, ......]
  27447. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  27448. * * facetNormals : optional array of facet normals (vector3)
  27449. * * facetPositions : optional array of facet positions (vector3)
  27450. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  27451. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  27452. * * bInfo : optional bounding info, required for facetPartitioning computation
  27453. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  27454. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  27455. * * useRightHandedSystem: optional boolean to for right handed system computation
  27456. * * depthSort : optional boolean to enable the facet depth sort computation
  27457. * * distanceTo : optional Vector3 to compute the facet depth from this location
  27458. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  27459. */
  27460. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  27461. facetNormals?: any;
  27462. facetPositions?: any;
  27463. facetPartitioning?: any;
  27464. ratio?: number;
  27465. bInfo?: any;
  27466. bbSize?: Vector3;
  27467. subDiv?: any;
  27468. useRightHandedSystem?: boolean;
  27469. depthSort?: boolean;
  27470. distanceTo?: Vector3;
  27471. depthSortedFacets?: any;
  27472. }): void;
  27473. /** @hidden */
  27474. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  27475. /**
  27476. * Applies VertexData created from the imported parameters to the geometry
  27477. * @param parsedVertexData the parsed data from an imported file
  27478. * @param geometry the geometry to apply the VertexData to
  27479. */
  27480. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  27481. }
  27482. }
  27483. declare module "babylonjs/Morph/morphTarget" {
  27484. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  27485. import { Observable } from "babylonjs/Misc/observable";
  27486. import { Nullable, FloatArray } from "babylonjs/types";
  27487. import { Scene } from "babylonjs/scene";
  27488. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  27489. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  27490. /**
  27491. * Defines a target to use with MorphTargetManager
  27492. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  27493. */
  27494. export class MorphTarget implements IAnimatable {
  27495. /** defines the name of the target */
  27496. name: string;
  27497. /**
  27498. * Gets or sets the list of animations
  27499. */
  27500. animations: import("babylonjs/Animations/animation").Animation[];
  27501. private _scene;
  27502. private _positions;
  27503. private _normals;
  27504. private _tangents;
  27505. private _uvs;
  27506. private _influence;
  27507. private _uniqueId;
  27508. /**
  27509. * Observable raised when the influence changes
  27510. */
  27511. onInfluenceChanged: Observable<boolean>;
  27512. /** @hidden */
  27513. _onDataLayoutChanged: Observable<void>;
  27514. /**
  27515. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  27516. */
  27517. get influence(): number;
  27518. set influence(influence: number);
  27519. /**
  27520. * Gets or sets the id of the morph Target
  27521. */
  27522. id: string;
  27523. private _animationPropertiesOverride;
  27524. /**
  27525. * Gets or sets the animation properties override
  27526. */
  27527. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  27528. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  27529. /**
  27530. * Creates a new MorphTarget
  27531. * @param name defines the name of the target
  27532. * @param influence defines the influence to use
  27533. * @param scene defines the scene the morphtarget belongs to
  27534. */
  27535. constructor(
  27536. /** defines the name of the target */
  27537. name: string, influence?: number, scene?: Nullable<Scene>);
  27538. /**
  27539. * Gets the unique ID of this manager
  27540. */
  27541. get uniqueId(): number;
  27542. /**
  27543. * Gets a boolean defining if the target contains position data
  27544. */
  27545. get hasPositions(): boolean;
  27546. /**
  27547. * Gets a boolean defining if the target contains normal data
  27548. */
  27549. get hasNormals(): boolean;
  27550. /**
  27551. * Gets a boolean defining if the target contains tangent data
  27552. */
  27553. get hasTangents(): boolean;
  27554. /**
  27555. * Gets a boolean defining if the target contains texture coordinates data
  27556. */
  27557. get hasUVs(): boolean;
  27558. /**
  27559. * Affects position data to this target
  27560. * @param data defines the position data to use
  27561. */
  27562. setPositions(data: Nullable<FloatArray>): void;
  27563. /**
  27564. * Gets the position data stored in this target
  27565. * @returns a FloatArray containing the position data (or null if not present)
  27566. */
  27567. getPositions(): Nullable<FloatArray>;
  27568. /**
  27569. * Affects normal data to this target
  27570. * @param data defines the normal data to use
  27571. */
  27572. setNormals(data: Nullable<FloatArray>): void;
  27573. /**
  27574. * Gets the normal data stored in this target
  27575. * @returns a FloatArray containing the normal data (or null if not present)
  27576. */
  27577. getNormals(): Nullable<FloatArray>;
  27578. /**
  27579. * Affects tangent data to this target
  27580. * @param data defines the tangent data to use
  27581. */
  27582. setTangents(data: Nullable<FloatArray>): void;
  27583. /**
  27584. * Gets the tangent data stored in this target
  27585. * @returns a FloatArray containing the tangent data (or null if not present)
  27586. */
  27587. getTangents(): Nullable<FloatArray>;
  27588. /**
  27589. * Affects texture coordinates data to this target
  27590. * @param data defines the texture coordinates data to use
  27591. */
  27592. setUVs(data: Nullable<FloatArray>): void;
  27593. /**
  27594. * Gets the texture coordinates data stored in this target
  27595. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  27596. */
  27597. getUVs(): Nullable<FloatArray>;
  27598. /**
  27599. * Clone the current target
  27600. * @returns a new MorphTarget
  27601. */
  27602. clone(): MorphTarget;
  27603. /**
  27604. * Serializes the current target into a Serialization object
  27605. * @returns the serialized object
  27606. */
  27607. serialize(): any;
  27608. /**
  27609. * Returns the string "MorphTarget"
  27610. * @returns "MorphTarget"
  27611. */
  27612. getClassName(): string;
  27613. /**
  27614. * Creates a new target from serialized data
  27615. * @param serializationObject defines the serialized data to use
  27616. * @returns a new MorphTarget
  27617. */
  27618. static Parse(serializationObject: any): MorphTarget;
  27619. /**
  27620. * Creates a MorphTarget from mesh data
  27621. * @param mesh defines the source mesh
  27622. * @param name defines the name to use for the new target
  27623. * @param influence defines the influence to attach to the target
  27624. * @returns a new MorphTarget
  27625. */
  27626. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  27627. }
  27628. }
  27629. declare module "babylonjs/Morph/morphTargetManager" {
  27630. import { Nullable } from "babylonjs/types";
  27631. import { Scene } from "babylonjs/scene";
  27632. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  27633. /**
  27634. * This class is used to deform meshes using morphing between different targets
  27635. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  27636. */
  27637. export class MorphTargetManager {
  27638. private _targets;
  27639. private _targetInfluenceChangedObservers;
  27640. private _targetDataLayoutChangedObservers;
  27641. private _activeTargets;
  27642. private _scene;
  27643. private _influences;
  27644. private _supportsNormals;
  27645. private _supportsTangents;
  27646. private _supportsUVs;
  27647. private _vertexCount;
  27648. private _uniqueId;
  27649. private _tempInfluences;
  27650. /**
  27651. * Gets or sets a boolean indicating if normals must be morphed
  27652. */
  27653. enableNormalMorphing: boolean;
  27654. /**
  27655. * Gets or sets a boolean indicating if tangents must be morphed
  27656. */
  27657. enableTangentMorphing: boolean;
  27658. /**
  27659. * Gets or sets a boolean indicating if UV must be morphed
  27660. */
  27661. enableUVMorphing: boolean;
  27662. /**
  27663. * Creates a new MorphTargetManager
  27664. * @param scene defines the current scene
  27665. */
  27666. constructor(scene?: Nullable<Scene>);
  27667. /**
  27668. * Gets the unique ID of this manager
  27669. */
  27670. get uniqueId(): number;
  27671. /**
  27672. * Gets the number of vertices handled by this manager
  27673. */
  27674. get vertexCount(): number;
  27675. /**
  27676. * Gets a boolean indicating if this manager supports morphing of normals
  27677. */
  27678. get supportsNormals(): boolean;
  27679. /**
  27680. * Gets a boolean indicating if this manager supports morphing of tangents
  27681. */
  27682. get supportsTangents(): boolean;
  27683. /**
  27684. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  27685. */
  27686. get supportsUVs(): boolean;
  27687. /**
  27688. * Gets the number of targets stored in this manager
  27689. */
  27690. get numTargets(): number;
  27691. /**
  27692. * Gets the number of influencers (ie. the number of targets with influences > 0)
  27693. */
  27694. get numInfluencers(): number;
  27695. /**
  27696. * Gets the list of influences (one per target)
  27697. */
  27698. get influences(): Float32Array;
  27699. /**
  27700. * Gets the active target at specified index. An active target is a target with an influence > 0
  27701. * @param index defines the index to check
  27702. * @returns the requested target
  27703. */
  27704. getActiveTarget(index: number): MorphTarget;
  27705. /**
  27706. * Gets the target at specified index
  27707. * @param index defines the index to check
  27708. * @returns the requested target
  27709. */
  27710. getTarget(index: number): MorphTarget;
  27711. /**
  27712. * Add a new target to this manager
  27713. * @param target defines the target to add
  27714. */
  27715. addTarget(target: MorphTarget): void;
  27716. /**
  27717. * Removes a target from the manager
  27718. * @param target defines the target to remove
  27719. */
  27720. removeTarget(target: MorphTarget): void;
  27721. /**
  27722. * Clone the current manager
  27723. * @returns a new MorphTargetManager
  27724. */
  27725. clone(): MorphTargetManager;
  27726. /**
  27727. * Serializes the current manager into a Serialization object
  27728. * @returns the serialized object
  27729. */
  27730. serialize(): any;
  27731. private _syncActiveTargets;
  27732. /**
  27733. * Syncrhonize the targets with all the meshes using this morph target manager
  27734. */
  27735. synchronize(): void;
  27736. /**
  27737. * Creates a new MorphTargetManager from serialized data
  27738. * @param serializationObject defines the serialized data
  27739. * @param scene defines the hosting scene
  27740. * @returns the new MorphTargetManager
  27741. */
  27742. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  27743. }
  27744. }
  27745. declare module "babylonjs/Meshes/meshLODLevel" {
  27746. import { Mesh } from "babylonjs/Meshes/mesh";
  27747. import { Nullable } from "babylonjs/types";
  27748. /**
  27749. * Class used to represent a specific level of detail of a mesh
  27750. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  27751. */
  27752. export class MeshLODLevel {
  27753. /** Defines the distance where this level should start being displayed */
  27754. distance: number;
  27755. /** Defines the mesh to use to render this level */
  27756. mesh: Nullable<Mesh>;
  27757. /**
  27758. * Creates a new LOD level
  27759. * @param distance defines the distance where this level should star being displayed
  27760. * @param mesh defines the mesh to use to render this level
  27761. */
  27762. constructor(
  27763. /** Defines the distance where this level should start being displayed */
  27764. distance: number,
  27765. /** Defines the mesh to use to render this level */
  27766. mesh: Nullable<Mesh>);
  27767. }
  27768. }
  27769. declare module "babylonjs/Misc/canvasGenerator" {
  27770. /**
  27771. * Helper class used to generate a canvas to manipulate images
  27772. */
  27773. export class CanvasGenerator {
  27774. /**
  27775. * Create a new canvas (or offscreen canvas depending on the context)
  27776. * @param width defines the expected width
  27777. * @param height defines the expected height
  27778. * @return a new canvas or offscreen canvas
  27779. */
  27780. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  27781. }
  27782. }
  27783. declare module "babylonjs/Meshes/groundMesh" {
  27784. import { Scene } from "babylonjs/scene";
  27785. import { Vector3 } from "babylonjs/Maths/math.vector";
  27786. import { Mesh } from "babylonjs/Meshes/mesh";
  27787. /**
  27788. * Mesh representing the gorund
  27789. */
  27790. export class GroundMesh extends Mesh {
  27791. /** If octree should be generated */
  27792. generateOctree: boolean;
  27793. private _heightQuads;
  27794. /** @hidden */
  27795. _subdivisionsX: number;
  27796. /** @hidden */
  27797. _subdivisionsY: number;
  27798. /** @hidden */
  27799. _width: number;
  27800. /** @hidden */
  27801. _height: number;
  27802. /** @hidden */
  27803. _minX: number;
  27804. /** @hidden */
  27805. _maxX: number;
  27806. /** @hidden */
  27807. _minZ: number;
  27808. /** @hidden */
  27809. _maxZ: number;
  27810. constructor(name: string, scene: Scene);
  27811. /**
  27812. * "GroundMesh"
  27813. * @returns "GroundMesh"
  27814. */
  27815. getClassName(): string;
  27816. /**
  27817. * The minimum of x and y subdivisions
  27818. */
  27819. get subdivisions(): number;
  27820. /**
  27821. * X subdivisions
  27822. */
  27823. get subdivisionsX(): number;
  27824. /**
  27825. * Y subdivisions
  27826. */
  27827. get subdivisionsY(): number;
  27828. /**
  27829. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  27830. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  27831. * @param chunksCount the number of subdivisions for x and y
  27832. * @param octreeBlocksSize (Default: 32)
  27833. */
  27834. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  27835. /**
  27836. * Returns a height (y) value in the Worl system :
  27837. * the ground altitude at the coordinates (x, z) expressed in the World system.
  27838. * @param x x coordinate
  27839. * @param z z coordinate
  27840. * @returns the ground y position if (x, z) are outside the ground surface.
  27841. */
  27842. getHeightAtCoordinates(x: number, z: number): number;
  27843. /**
  27844. * Returns a normalized vector (Vector3) orthogonal to the ground
  27845. * at the ground coordinates (x, z) expressed in the World system.
  27846. * @param x x coordinate
  27847. * @param z z coordinate
  27848. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  27849. */
  27850. getNormalAtCoordinates(x: number, z: number): Vector3;
  27851. /**
  27852. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  27853. * at the ground coordinates (x, z) expressed in the World system.
  27854. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  27855. * @param x x coordinate
  27856. * @param z z coordinate
  27857. * @param ref vector to store the result
  27858. * @returns the GroundMesh.
  27859. */
  27860. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  27861. /**
  27862. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  27863. * if the ground has been updated.
  27864. * This can be used in the render loop.
  27865. * @returns the GroundMesh.
  27866. */
  27867. updateCoordinateHeights(): GroundMesh;
  27868. private _getFacetAt;
  27869. private _initHeightQuads;
  27870. private _computeHeightQuads;
  27871. /**
  27872. * Serializes this ground mesh
  27873. * @param serializationObject object to write serialization to
  27874. */
  27875. serialize(serializationObject: any): void;
  27876. /**
  27877. * Parses a serialized ground mesh
  27878. * @param parsedMesh the serialized mesh
  27879. * @param scene the scene to create the ground mesh in
  27880. * @returns the created ground mesh
  27881. */
  27882. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  27883. }
  27884. }
  27885. declare module "babylonjs/Physics/physicsJoint" {
  27886. import { Vector3 } from "babylonjs/Maths/math.vector";
  27887. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  27888. /**
  27889. * Interface for Physics-Joint data
  27890. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27891. */
  27892. export interface PhysicsJointData {
  27893. /**
  27894. * The main pivot of the joint
  27895. */
  27896. mainPivot?: Vector3;
  27897. /**
  27898. * The connected pivot of the joint
  27899. */
  27900. connectedPivot?: Vector3;
  27901. /**
  27902. * The main axis of the joint
  27903. */
  27904. mainAxis?: Vector3;
  27905. /**
  27906. * The connected axis of the joint
  27907. */
  27908. connectedAxis?: Vector3;
  27909. /**
  27910. * The collision of the joint
  27911. */
  27912. collision?: boolean;
  27913. /**
  27914. * Native Oimo/Cannon/Energy data
  27915. */
  27916. nativeParams?: any;
  27917. }
  27918. /**
  27919. * This is a holder class for the physics joint created by the physics plugin
  27920. * It holds a set of functions to control the underlying joint
  27921. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27922. */
  27923. export class PhysicsJoint {
  27924. /**
  27925. * The type of the physics joint
  27926. */
  27927. type: number;
  27928. /**
  27929. * The data for the physics joint
  27930. */
  27931. jointData: PhysicsJointData;
  27932. private _physicsJoint;
  27933. protected _physicsPlugin: IPhysicsEnginePlugin;
  27934. /**
  27935. * Initializes the physics joint
  27936. * @param type The type of the physics joint
  27937. * @param jointData The data for the physics joint
  27938. */
  27939. constructor(
  27940. /**
  27941. * The type of the physics joint
  27942. */
  27943. type: number,
  27944. /**
  27945. * The data for the physics joint
  27946. */
  27947. jointData: PhysicsJointData);
  27948. /**
  27949. * Gets the physics joint
  27950. */
  27951. get physicsJoint(): any;
  27952. /**
  27953. * Sets the physics joint
  27954. */
  27955. set physicsJoint(newJoint: any);
  27956. /**
  27957. * Sets the physics plugin
  27958. */
  27959. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  27960. /**
  27961. * Execute a function that is physics-plugin specific.
  27962. * @param {Function} func the function that will be executed.
  27963. * It accepts two parameters: the physics world and the physics joint
  27964. */
  27965. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  27966. /**
  27967. * Distance-Joint type
  27968. */
  27969. static DistanceJoint: number;
  27970. /**
  27971. * Hinge-Joint type
  27972. */
  27973. static HingeJoint: number;
  27974. /**
  27975. * Ball-and-Socket joint type
  27976. */
  27977. static BallAndSocketJoint: number;
  27978. /**
  27979. * Wheel-Joint type
  27980. */
  27981. static WheelJoint: number;
  27982. /**
  27983. * Slider-Joint type
  27984. */
  27985. static SliderJoint: number;
  27986. /**
  27987. * Prismatic-Joint type
  27988. */
  27989. static PrismaticJoint: number;
  27990. /**
  27991. * Universal-Joint type
  27992. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  27993. */
  27994. static UniversalJoint: number;
  27995. /**
  27996. * Hinge-Joint 2 type
  27997. */
  27998. static Hinge2Joint: number;
  27999. /**
  28000. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  28001. */
  28002. static PointToPointJoint: number;
  28003. /**
  28004. * Spring-Joint type
  28005. */
  28006. static SpringJoint: number;
  28007. /**
  28008. * Lock-Joint type
  28009. */
  28010. static LockJoint: number;
  28011. }
  28012. /**
  28013. * A class representing a physics distance joint
  28014. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28015. */
  28016. export class DistanceJoint extends PhysicsJoint {
  28017. /**
  28018. *
  28019. * @param jointData The data for the Distance-Joint
  28020. */
  28021. constructor(jointData: DistanceJointData);
  28022. /**
  28023. * Update the predefined distance.
  28024. * @param maxDistance The maximum preferred distance
  28025. * @param minDistance The minimum preferred distance
  28026. */
  28027. updateDistance(maxDistance: number, minDistance?: number): void;
  28028. }
  28029. /**
  28030. * Represents a Motor-Enabled Joint
  28031. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28032. */
  28033. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  28034. /**
  28035. * Initializes the Motor-Enabled Joint
  28036. * @param type The type of the joint
  28037. * @param jointData The physica joint data for the joint
  28038. */
  28039. constructor(type: number, jointData: PhysicsJointData);
  28040. /**
  28041. * Set the motor values.
  28042. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28043. * @param force the force to apply
  28044. * @param maxForce max force for this motor.
  28045. */
  28046. setMotor(force?: number, maxForce?: number): void;
  28047. /**
  28048. * Set the motor's limits.
  28049. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28050. * @param upperLimit The upper limit of the motor
  28051. * @param lowerLimit The lower limit of the motor
  28052. */
  28053. setLimit(upperLimit: number, lowerLimit?: number): void;
  28054. }
  28055. /**
  28056. * This class represents a single physics Hinge-Joint
  28057. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28058. */
  28059. export class HingeJoint extends MotorEnabledJoint {
  28060. /**
  28061. * Initializes the Hinge-Joint
  28062. * @param jointData The joint data for the Hinge-Joint
  28063. */
  28064. constructor(jointData: PhysicsJointData);
  28065. /**
  28066. * Set the motor values.
  28067. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28068. * @param {number} force the force to apply
  28069. * @param {number} maxForce max force for this motor.
  28070. */
  28071. setMotor(force?: number, maxForce?: number): void;
  28072. /**
  28073. * Set the motor's limits.
  28074. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28075. * @param upperLimit The upper limit of the motor
  28076. * @param lowerLimit The lower limit of the motor
  28077. */
  28078. setLimit(upperLimit: number, lowerLimit?: number): void;
  28079. }
  28080. /**
  28081. * This class represents a dual hinge physics joint (same as wheel joint)
  28082. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28083. */
  28084. export class Hinge2Joint extends MotorEnabledJoint {
  28085. /**
  28086. * Initializes the Hinge2-Joint
  28087. * @param jointData The joint data for the Hinge2-Joint
  28088. */
  28089. constructor(jointData: PhysicsJointData);
  28090. /**
  28091. * Set the motor values.
  28092. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28093. * @param {number} targetSpeed the speed the motor is to reach
  28094. * @param {number} maxForce max force for this motor.
  28095. * @param {motorIndex} the motor's index, 0 or 1.
  28096. */
  28097. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  28098. /**
  28099. * Set the motor limits.
  28100. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28101. * @param {number} upperLimit the upper limit
  28102. * @param {number} lowerLimit lower limit
  28103. * @param {motorIndex} the motor's index, 0 or 1.
  28104. */
  28105. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28106. }
  28107. /**
  28108. * Interface for a motor enabled joint
  28109. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28110. */
  28111. export interface IMotorEnabledJoint {
  28112. /**
  28113. * Physics joint
  28114. */
  28115. physicsJoint: any;
  28116. /**
  28117. * Sets the motor of the motor-enabled joint
  28118. * @param force The force of the motor
  28119. * @param maxForce The maximum force of the motor
  28120. * @param motorIndex The index of the motor
  28121. */
  28122. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  28123. /**
  28124. * Sets the limit of the motor
  28125. * @param upperLimit The upper limit of the motor
  28126. * @param lowerLimit The lower limit of the motor
  28127. * @param motorIndex The index of the motor
  28128. */
  28129. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28130. }
  28131. /**
  28132. * Joint data for a Distance-Joint
  28133. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28134. */
  28135. export interface DistanceJointData extends PhysicsJointData {
  28136. /**
  28137. * Max distance the 2 joint objects can be apart
  28138. */
  28139. maxDistance: number;
  28140. }
  28141. /**
  28142. * Joint data from a spring joint
  28143. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28144. */
  28145. export interface SpringJointData extends PhysicsJointData {
  28146. /**
  28147. * Length of the spring
  28148. */
  28149. length: number;
  28150. /**
  28151. * Stiffness of the spring
  28152. */
  28153. stiffness: number;
  28154. /**
  28155. * Damping of the spring
  28156. */
  28157. damping: number;
  28158. /** this callback will be called when applying the force to the impostors. */
  28159. forceApplicationCallback: () => void;
  28160. }
  28161. }
  28162. declare module "babylonjs/Physics/physicsRaycastResult" {
  28163. import { Vector3 } from "babylonjs/Maths/math.vector";
  28164. /**
  28165. * Holds the data for the raycast result
  28166. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28167. */
  28168. export class PhysicsRaycastResult {
  28169. private _hasHit;
  28170. private _hitDistance;
  28171. private _hitNormalWorld;
  28172. private _hitPointWorld;
  28173. private _rayFromWorld;
  28174. private _rayToWorld;
  28175. /**
  28176. * Gets if there was a hit
  28177. */
  28178. get hasHit(): boolean;
  28179. /**
  28180. * Gets the distance from the hit
  28181. */
  28182. get hitDistance(): number;
  28183. /**
  28184. * Gets the hit normal/direction in the world
  28185. */
  28186. get hitNormalWorld(): Vector3;
  28187. /**
  28188. * Gets the hit point in the world
  28189. */
  28190. get hitPointWorld(): Vector3;
  28191. /**
  28192. * Gets the ray "start point" of the ray in the world
  28193. */
  28194. get rayFromWorld(): Vector3;
  28195. /**
  28196. * Gets the ray "end point" of the ray in the world
  28197. */
  28198. get rayToWorld(): Vector3;
  28199. /**
  28200. * Sets the hit data (normal & point in world space)
  28201. * @param hitNormalWorld defines the normal in world space
  28202. * @param hitPointWorld defines the point in world space
  28203. */
  28204. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  28205. /**
  28206. * Sets the distance from the start point to the hit point
  28207. * @param distance
  28208. */
  28209. setHitDistance(distance: number): void;
  28210. /**
  28211. * Calculates the distance manually
  28212. */
  28213. calculateHitDistance(): void;
  28214. /**
  28215. * Resets all the values to default
  28216. * @param from The from point on world space
  28217. * @param to The to point on world space
  28218. */
  28219. reset(from?: Vector3, to?: Vector3): void;
  28220. }
  28221. /**
  28222. * Interface for the size containing width and height
  28223. */
  28224. interface IXYZ {
  28225. /**
  28226. * X
  28227. */
  28228. x: number;
  28229. /**
  28230. * Y
  28231. */
  28232. y: number;
  28233. /**
  28234. * Z
  28235. */
  28236. z: number;
  28237. }
  28238. }
  28239. declare module "babylonjs/Physics/IPhysicsEngine" {
  28240. import { Nullable } from "babylonjs/types";
  28241. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  28242. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28243. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  28244. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  28245. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  28246. /**
  28247. * Interface used to describe a physics joint
  28248. */
  28249. export interface PhysicsImpostorJoint {
  28250. /** Defines the main impostor to which the joint is linked */
  28251. mainImpostor: PhysicsImpostor;
  28252. /** Defines the impostor that is connected to the main impostor using this joint */
  28253. connectedImpostor: PhysicsImpostor;
  28254. /** Defines the joint itself */
  28255. joint: PhysicsJoint;
  28256. }
  28257. /** @hidden */
  28258. export interface IPhysicsEnginePlugin {
  28259. world: any;
  28260. name: string;
  28261. setGravity(gravity: Vector3): void;
  28262. setTimeStep(timeStep: number): void;
  28263. getTimeStep(): number;
  28264. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  28265. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  28266. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  28267. generatePhysicsBody(impostor: PhysicsImpostor): void;
  28268. removePhysicsBody(impostor: PhysicsImpostor): void;
  28269. generateJoint(joint: PhysicsImpostorJoint): void;
  28270. removeJoint(joint: PhysicsImpostorJoint): void;
  28271. isSupported(): boolean;
  28272. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  28273. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  28274. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  28275. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  28276. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  28277. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  28278. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  28279. getBodyMass(impostor: PhysicsImpostor): number;
  28280. getBodyFriction(impostor: PhysicsImpostor): number;
  28281. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  28282. getBodyRestitution(impostor: PhysicsImpostor): number;
  28283. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  28284. getBodyPressure?(impostor: PhysicsImpostor): number;
  28285. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  28286. getBodyStiffness?(impostor: PhysicsImpostor): number;
  28287. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  28288. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  28289. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  28290. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  28291. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  28292. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  28293. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  28294. sleepBody(impostor: PhysicsImpostor): void;
  28295. wakeUpBody(impostor: PhysicsImpostor): void;
  28296. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  28297. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  28298. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  28299. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28300. getRadius(impostor: PhysicsImpostor): number;
  28301. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  28302. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  28303. dispose(): void;
  28304. }
  28305. /**
  28306. * Interface used to define a physics engine
  28307. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28308. */
  28309. export interface IPhysicsEngine {
  28310. /**
  28311. * Gets the gravity vector used by the simulation
  28312. */
  28313. gravity: Vector3;
  28314. /**
  28315. * Sets the gravity vector used by the simulation
  28316. * @param gravity defines the gravity vector to use
  28317. */
  28318. setGravity(gravity: Vector3): void;
  28319. /**
  28320. * Set the time step of the physics engine.
  28321. * Default is 1/60.
  28322. * To slow it down, enter 1/600 for example.
  28323. * To speed it up, 1/30
  28324. * @param newTimeStep the new timestep to apply to this world.
  28325. */
  28326. setTimeStep(newTimeStep: number): void;
  28327. /**
  28328. * Get the time step of the physics engine.
  28329. * @returns the current time step
  28330. */
  28331. getTimeStep(): number;
  28332. /**
  28333. * Set the sub time step of the physics engine.
  28334. * Default is 0 meaning there is no sub steps
  28335. * To increase physics resolution precision, set a small value (like 1 ms)
  28336. * @param subTimeStep defines the new sub timestep used for physics resolution.
  28337. */
  28338. setSubTimeStep(subTimeStep: number): void;
  28339. /**
  28340. * Get the sub time step of the physics engine.
  28341. * @returns the current sub time step
  28342. */
  28343. getSubTimeStep(): number;
  28344. /**
  28345. * Release all resources
  28346. */
  28347. dispose(): void;
  28348. /**
  28349. * Gets the name of the current physics plugin
  28350. * @returns the name of the plugin
  28351. */
  28352. getPhysicsPluginName(): string;
  28353. /**
  28354. * Adding a new impostor for the impostor tracking.
  28355. * This will be done by the impostor itself.
  28356. * @param impostor the impostor to add
  28357. */
  28358. addImpostor(impostor: PhysicsImpostor): void;
  28359. /**
  28360. * Remove an impostor from the engine.
  28361. * This impostor and its mesh will not longer be updated by the physics engine.
  28362. * @param impostor the impostor to remove
  28363. */
  28364. removeImpostor(impostor: PhysicsImpostor): void;
  28365. /**
  28366. * Add a joint to the physics engine
  28367. * @param mainImpostor defines the main impostor to which the joint is added.
  28368. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  28369. * @param joint defines the joint that will connect both impostors.
  28370. */
  28371. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  28372. /**
  28373. * Removes a joint from the simulation
  28374. * @param mainImpostor defines the impostor used with the joint
  28375. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  28376. * @param joint defines the joint to remove
  28377. */
  28378. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  28379. /**
  28380. * Gets the current plugin used to run the simulation
  28381. * @returns current plugin
  28382. */
  28383. getPhysicsPlugin(): IPhysicsEnginePlugin;
  28384. /**
  28385. * Gets the list of physic impostors
  28386. * @returns an array of PhysicsImpostor
  28387. */
  28388. getImpostors(): Array<PhysicsImpostor>;
  28389. /**
  28390. * Gets the impostor for a physics enabled object
  28391. * @param object defines the object impersonated by the impostor
  28392. * @returns the PhysicsImpostor or null if not found
  28393. */
  28394. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  28395. /**
  28396. * Gets the impostor for a physics body object
  28397. * @param body defines physics body used by the impostor
  28398. * @returns the PhysicsImpostor or null if not found
  28399. */
  28400. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  28401. /**
  28402. * Does a raycast in the physics world
  28403. * @param from when should the ray start?
  28404. * @param to when should the ray end?
  28405. * @returns PhysicsRaycastResult
  28406. */
  28407. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  28408. /**
  28409. * Called by the scene. No need to call it.
  28410. * @param delta defines the timespam between frames
  28411. */
  28412. _step(delta: number): void;
  28413. }
  28414. }
  28415. declare module "babylonjs/Physics/physicsImpostor" {
  28416. import { Nullable, IndicesArray } from "babylonjs/types";
  28417. import { Vector3, Matrix, Quaternion } from "babylonjs/Maths/math.vector";
  28418. import { TransformNode } from "babylonjs/Meshes/transformNode";
  28419. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28420. import { Scene } from "babylonjs/scene";
  28421. import { Bone } from "babylonjs/Bones/bone";
  28422. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  28423. import { PhysicsJoint, PhysicsJointData } from "babylonjs/Physics/physicsJoint";
  28424. import { Space } from "babylonjs/Maths/math.axis";
  28425. /**
  28426. * The interface for the physics imposter parameters
  28427. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28428. */
  28429. export interface PhysicsImpostorParameters {
  28430. /**
  28431. * The mass of the physics imposter
  28432. */
  28433. mass: number;
  28434. /**
  28435. * The friction of the physics imposter
  28436. */
  28437. friction?: number;
  28438. /**
  28439. * The coefficient of restitution of the physics imposter
  28440. */
  28441. restitution?: number;
  28442. /**
  28443. * The native options of the physics imposter
  28444. */
  28445. nativeOptions?: any;
  28446. /**
  28447. * Specifies if the parent should be ignored
  28448. */
  28449. ignoreParent?: boolean;
  28450. /**
  28451. * Specifies if bi-directional transformations should be disabled
  28452. */
  28453. disableBidirectionalTransformation?: boolean;
  28454. /**
  28455. * The pressure inside the physics imposter, soft object only
  28456. */
  28457. pressure?: number;
  28458. /**
  28459. * The stiffness the physics imposter, soft object only
  28460. */
  28461. stiffness?: number;
  28462. /**
  28463. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  28464. */
  28465. velocityIterations?: number;
  28466. /**
  28467. * The number of iterations used in maintaining consistent vertex positions, soft object only
  28468. */
  28469. positionIterations?: number;
  28470. /**
  28471. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  28472. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  28473. * Add to fix multiple points
  28474. */
  28475. fixedPoints?: number;
  28476. /**
  28477. * The collision margin around a soft object
  28478. */
  28479. margin?: number;
  28480. /**
  28481. * The collision margin around a soft object
  28482. */
  28483. damping?: number;
  28484. /**
  28485. * The path for a rope based on an extrusion
  28486. */
  28487. path?: any;
  28488. /**
  28489. * The shape of an extrusion used for a rope based on an extrusion
  28490. */
  28491. shape?: any;
  28492. }
  28493. /**
  28494. * Interface for a physics-enabled object
  28495. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28496. */
  28497. export interface IPhysicsEnabledObject {
  28498. /**
  28499. * The position of the physics-enabled object
  28500. */
  28501. position: Vector3;
  28502. /**
  28503. * The rotation of the physics-enabled object
  28504. */
  28505. rotationQuaternion: Nullable<Quaternion>;
  28506. /**
  28507. * The scale of the physics-enabled object
  28508. */
  28509. scaling: Vector3;
  28510. /**
  28511. * The rotation of the physics-enabled object
  28512. */
  28513. rotation?: Vector3;
  28514. /**
  28515. * The parent of the physics-enabled object
  28516. */
  28517. parent?: any;
  28518. /**
  28519. * The bounding info of the physics-enabled object
  28520. * @returns The bounding info of the physics-enabled object
  28521. */
  28522. getBoundingInfo(): BoundingInfo;
  28523. /**
  28524. * Computes the world matrix
  28525. * @param force Specifies if the world matrix should be computed by force
  28526. * @returns A world matrix
  28527. */
  28528. computeWorldMatrix(force: boolean): Matrix;
  28529. /**
  28530. * Gets the world matrix
  28531. * @returns A world matrix
  28532. */
  28533. getWorldMatrix?(): Matrix;
  28534. /**
  28535. * Gets the child meshes
  28536. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  28537. * @returns An array of abstract meshes
  28538. */
  28539. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  28540. /**
  28541. * Gets the vertex data
  28542. * @param kind The type of vertex data
  28543. * @returns A nullable array of numbers, or a float32 array
  28544. */
  28545. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  28546. /**
  28547. * Gets the indices from the mesh
  28548. * @returns A nullable array of index arrays
  28549. */
  28550. getIndices?(): Nullable<IndicesArray>;
  28551. /**
  28552. * Gets the scene from the mesh
  28553. * @returns the indices array or null
  28554. */
  28555. getScene?(): Scene;
  28556. /**
  28557. * Gets the absolute position from the mesh
  28558. * @returns the absolute position
  28559. */
  28560. getAbsolutePosition(): Vector3;
  28561. /**
  28562. * Gets the absolute pivot point from the mesh
  28563. * @returns the absolute pivot point
  28564. */
  28565. getAbsolutePivotPoint(): Vector3;
  28566. /**
  28567. * Rotates the mesh
  28568. * @param axis The axis of rotation
  28569. * @param amount The amount of rotation
  28570. * @param space The space of the rotation
  28571. * @returns The rotation transform node
  28572. */
  28573. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  28574. /**
  28575. * Translates the mesh
  28576. * @param axis The axis of translation
  28577. * @param distance The distance of translation
  28578. * @param space The space of the translation
  28579. * @returns The transform node
  28580. */
  28581. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  28582. /**
  28583. * Sets the absolute position of the mesh
  28584. * @param absolutePosition The absolute position of the mesh
  28585. * @returns The transform node
  28586. */
  28587. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  28588. /**
  28589. * Gets the class name of the mesh
  28590. * @returns The class name
  28591. */
  28592. getClassName(): string;
  28593. }
  28594. /**
  28595. * Represents a physics imposter
  28596. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28597. */
  28598. export class PhysicsImpostor {
  28599. /**
  28600. * The physics-enabled object used as the physics imposter
  28601. */
  28602. object: IPhysicsEnabledObject;
  28603. /**
  28604. * The type of the physics imposter
  28605. */
  28606. type: number;
  28607. private _options;
  28608. private _scene?;
  28609. /**
  28610. * The default object size of the imposter
  28611. */
  28612. static DEFAULT_OBJECT_SIZE: Vector3;
  28613. /**
  28614. * The identity quaternion of the imposter
  28615. */
  28616. static IDENTITY_QUATERNION: Quaternion;
  28617. /** @hidden */
  28618. _pluginData: any;
  28619. private _physicsEngine;
  28620. private _physicsBody;
  28621. private _bodyUpdateRequired;
  28622. private _onBeforePhysicsStepCallbacks;
  28623. private _onAfterPhysicsStepCallbacks;
  28624. /** @hidden */
  28625. _onPhysicsCollideCallbacks: Array<{
  28626. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  28627. otherImpostors: Array<PhysicsImpostor>;
  28628. }>;
  28629. private _deltaPosition;
  28630. private _deltaRotation;
  28631. private _deltaRotationConjugated;
  28632. /** @hidden */
  28633. _isFromLine: boolean;
  28634. private _parent;
  28635. private _isDisposed;
  28636. private static _tmpVecs;
  28637. private static _tmpQuat;
  28638. /**
  28639. * Specifies if the physics imposter is disposed
  28640. */
  28641. get isDisposed(): boolean;
  28642. /**
  28643. * Gets the mass of the physics imposter
  28644. */
  28645. get mass(): number;
  28646. set mass(value: number);
  28647. /**
  28648. * Gets the coefficient of friction
  28649. */
  28650. get friction(): number;
  28651. /**
  28652. * Sets the coefficient of friction
  28653. */
  28654. set friction(value: number);
  28655. /**
  28656. * Gets the coefficient of restitution
  28657. */
  28658. get restitution(): number;
  28659. /**
  28660. * Sets the coefficient of restitution
  28661. */
  28662. set restitution(value: number);
  28663. /**
  28664. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  28665. */
  28666. get pressure(): number;
  28667. /**
  28668. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  28669. */
  28670. set pressure(value: number);
  28671. /**
  28672. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  28673. */
  28674. get stiffness(): number;
  28675. /**
  28676. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  28677. */
  28678. set stiffness(value: number);
  28679. /**
  28680. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  28681. */
  28682. get velocityIterations(): number;
  28683. /**
  28684. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  28685. */
  28686. set velocityIterations(value: number);
  28687. /**
  28688. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  28689. */
  28690. get positionIterations(): number;
  28691. /**
  28692. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  28693. */
  28694. set positionIterations(value: number);
  28695. /**
  28696. * The unique id of the physics imposter
  28697. * set by the physics engine when adding this impostor to the array
  28698. */
  28699. uniqueId: number;
  28700. /**
  28701. * @hidden
  28702. */
  28703. soft: boolean;
  28704. /**
  28705. * @hidden
  28706. */
  28707. segments: number;
  28708. private _joints;
  28709. /**
  28710. * Initializes the physics imposter
  28711. * @param object The physics-enabled object used as the physics imposter
  28712. * @param type The type of the physics imposter
  28713. * @param _options The options for the physics imposter
  28714. * @param _scene The Babylon scene
  28715. */
  28716. constructor(
  28717. /**
  28718. * The physics-enabled object used as the physics imposter
  28719. */
  28720. object: IPhysicsEnabledObject,
  28721. /**
  28722. * The type of the physics imposter
  28723. */
  28724. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  28725. /**
  28726. * This function will completly initialize this impostor.
  28727. * It will create a new body - but only if this mesh has no parent.
  28728. * If it has, this impostor will not be used other than to define the impostor
  28729. * of the child mesh.
  28730. * @hidden
  28731. */
  28732. _init(): void;
  28733. private _getPhysicsParent;
  28734. /**
  28735. * Should a new body be generated.
  28736. * @returns boolean specifying if body initialization is required
  28737. */
  28738. isBodyInitRequired(): boolean;
  28739. /**
  28740. * Sets the updated scaling
  28741. * @param updated Specifies if the scaling is updated
  28742. */
  28743. setScalingUpdated(): void;
  28744. /**
  28745. * Force a regeneration of this or the parent's impostor's body.
  28746. * Use under cautious - This will remove all joints already implemented.
  28747. */
  28748. forceUpdate(): void;
  28749. /**
  28750. * Gets the body that holds this impostor. Either its own, or its parent.
  28751. */
  28752. get physicsBody(): any;
  28753. /**
  28754. * Get the parent of the physics imposter
  28755. * @returns Physics imposter or null
  28756. */
  28757. get parent(): Nullable<PhysicsImpostor>;
  28758. /**
  28759. * Sets the parent of the physics imposter
  28760. */
  28761. set parent(value: Nullable<PhysicsImpostor>);
  28762. /**
  28763. * Set the physics body. Used mainly by the physics engine/plugin
  28764. */
  28765. set physicsBody(physicsBody: any);
  28766. /**
  28767. * Resets the update flags
  28768. */
  28769. resetUpdateFlags(): void;
  28770. /**
  28771. * Gets the object extend size
  28772. * @returns the object extend size
  28773. */
  28774. getObjectExtendSize(): Vector3;
  28775. /**
  28776. * Gets the object center
  28777. * @returns The object center
  28778. */
  28779. getObjectCenter(): Vector3;
  28780. /**
  28781. * Get a specific parameter from the options parameters
  28782. * @param paramName The object parameter name
  28783. * @returns The object parameter
  28784. */
  28785. getParam(paramName: string): any;
  28786. /**
  28787. * Sets a specific parameter in the options given to the physics plugin
  28788. * @param paramName The parameter name
  28789. * @param value The value of the parameter
  28790. */
  28791. setParam(paramName: string, value: number): void;
  28792. /**
  28793. * Specifically change the body's mass option. Won't recreate the physics body object
  28794. * @param mass The mass of the physics imposter
  28795. */
  28796. setMass(mass: number): void;
  28797. /**
  28798. * Gets the linear velocity
  28799. * @returns linear velocity or null
  28800. */
  28801. getLinearVelocity(): Nullable<Vector3>;
  28802. /**
  28803. * Sets the linear velocity
  28804. * @param velocity linear velocity or null
  28805. */
  28806. setLinearVelocity(velocity: Nullable<Vector3>): void;
  28807. /**
  28808. * Gets the angular velocity
  28809. * @returns angular velocity or null
  28810. */
  28811. getAngularVelocity(): Nullable<Vector3>;
  28812. /**
  28813. * Sets the angular velocity
  28814. * @param velocity The velocity or null
  28815. */
  28816. setAngularVelocity(velocity: Nullable<Vector3>): void;
  28817. /**
  28818. * Execute a function with the physics plugin native code
  28819. * Provide a function the will have two variables - the world object and the physics body object
  28820. * @param func The function to execute with the physics plugin native code
  28821. */
  28822. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  28823. /**
  28824. * Register a function that will be executed before the physics world is stepping forward
  28825. * @param func The function to execute before the physics world is stepped forward
  28826. */
  28827. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28828. /**
  28829. * Unregister a function that will be executed before the physics world is stepping forward
  28830. * @param func The function to execute before the physics world is stepped forward
  28831. */
  28832. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28833. /**
  28834. * Register a function that will be executed after the physics step
  28835. * @param func The function to execute after physics step
  28836. */
  28837. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28838. /**
  28839. * Unregisters a function that will be executed after the physics step
  28840. * @param func The function to execute after physics step
  28841. */
  28842. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28843. /**
  28844. * register a function that will be executed when this impostor collides against a different body
  28845. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  28846. * @param func Callback that is executed on collision
  28847. */
  28848. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  28849. /**
  28850. * Unregisters the physics imposter on contact
  28851. * @param collideAgainst The physics object to collide against
  28852. * @param func Callback to execute on collision
  28853. */
  28854. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  28855. private _tmpQuat;
  28856. private _tmpQuat2;
  28857. /**
  28858. * Get the parent rotation
  28859. * @returns The parent rotation
  28860. */
  28861. getParentsRotation(): Quaternion;
  28862. /**
  28863. * this function is executed by the physics engine.
  28864. */
  28865. beforeStep: () => void;
  28866. /**
  28867. * this function is executed by the physics engine
  28868. */
  28869. afterStep: () => void;
  28870. /**
  28871. * Legacy collision detection event support
  28872. */
  28873. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  28874. /**
  28875. * event and body object due to cannon's event-based architecture.
  28876. */
  28877. onCollide: (e: {
  28878. body: any;
  28879. }) => void;
  28880. /**
  28881. * Apply a force
  28882. * @param force The force to apply
  28883. * @param contactPoint The contact point for the force
  28884. * @returns The physics imposter
  28885. */
  28886. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  28887. /**
  28888. * Apply an impulse
  28889. * @param force The impulse force
  28890. * @param contactPoint The contact point for the impulse force
  28891. * @returns The physics imposter
  28892. */
  28893. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  28894. /**
  28895. * A help function to create a joint
  28896. * @param otherImpostor A physics imposter used to create a joint
  28897. * @param jointType The type of joint
  28898. * @param jointData The data for the joint
  28899. * @returns The physics imposter
  28900. */
  28901. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  28902. /**
  28903. * Add a joint to this impostor with a different impostor
  28904. * @param otherImpostor A physics imposter used to add a joint
  28905. * @param joint The joint to add
  28906. * @returns The physics imposter
  28907. */
  28908. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  28909. /**
  28910. * Add an anchor to a cloth impostor
  28911. * @param otherImpostor rigid impostor to anchor to
  28912. * @param width ratio across width from 0 to 1
  28913. * @param height ratio up height from 0 to 1
  28914. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  28915. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  28916. * @returns impostor the soft imposter
  28917. */
  28918. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  28919. /**
  28920. * Add a hook to a rope impostor
  28921. * @param otherImpostor rigid impostor to anchor to
  28922. * @param length ratio across rope from 0 to 1
  28923. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  28924. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  28925. * @returns impostor the rope imposter
  28926. */
  28927. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  28928. /**
  28929. * Will keep this body still, in a sleep mode.
  28930. * @returns the physics imposter
  28931. */
  28932. sleep(): PhysicsImpostor;
  28933. /**
  28934. * Wake the body up.
  28935. * @returns The physics imposter
  28936. */
  28937. wakeUp(): PhysicsImpostor;
  28938. /**
  28939. * Clones the physics imposter
  28940. * @param newObject The physics imposter clones to this physics-enabled object
  28941. * @returns A nullable physics imposter
  28942. */
  28943. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  28944. /**
  28945. * Disposes the physics imposter
  28946. */
  28947. dispose(): void;
  28948. /**
  28949. * Sets the delta position
  28950. * @param position The delta position amount
  28951. */
  28952. setDeltaPosition(position: Vector3): void;
  28953. /**
  28954. * Sets the delta rotation
  28955. * @param rotation The delta rotation amount
  28956. */
  28957. setDeltaRotation(rotation: Quaternion): void;
  28958. /**
  28959. * Gets the box size of the physics imposter and stores the result in the input parameter
  28960. * @param result Stores the box size
  28961. * @returns The physics imposter
  28962. */
  28963. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  28964. /**
  28965. * Gets the radius of the physics imposter
  28966. * @returns Radius of the physics imposter
  28967. */
  28968. getRadius(): number;
  28969. /**
  28970. * Sync a bone with this impostor
  28971. * @param bone The bone to sync to the impostor.
  28972. * @param boneMesh The mesh that the bone is influencing.
  28973. * @param jointPivot The pivot of the joint / bone in local space.
  28974. * @param distToJoint Optional distance from the impostor to the joint.
  28975. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  28976. */
  28977. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  28978. /**
  28979. * Sync impostor to a bone
  28980. * @param bone The bone that the impostor will be synced to.
  28981. * @param boneMesh The mesh that the bone is influencing.
  28982. * @param jointPivot The pivot of the joint / bone in local space.
  28983. * @param distToJoint Optional distance from the impostor to the joint.
  28984. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  28985. * @param boneAxis Optional vector3 axis the bone is aligned with
  28986. */
  28987. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  28988. /**
  28989. * No-Imposter type
  28990. */
  28991. static NoImpostor: number;
  28992. /**
  28993. * Sphere-Imposter type
  28994. */
  28995. static SphereImpostor: number;
  28996. /**
  28997. * Box-Imposter type
  28998. */
  28999. static BoxImpostor: number;
  29000. /**
  29001. * Plane-Imposter type
  29002. */
  29003. static PlaneImpostor: number;
  29004. /**
  29005. * Mesh-imposter type
  29006. */
  29007. static MeshImpostor: number;
  29008. /**
  29009. * Capsule-Impostor type (Ammo.js plugin only)
  29010. */
  29011. static CapsuleImpostor: number;
  29012. /**
  29013. * Cylinder-Imposter type
  29014. */
  29015. static CylinderImpostor: number;
  29016. /**
  29017. * Particle-Imposter type
  29018. */
  29019. static ParticleImpostor: number;
  29020. /**
  29021. * Heightmap-Imposter type
  29022. */
  29023. static HeightmapImpostor: number;
  29024. /**
  29025. * ConvexHull-Impostor type (Ammo.js plugin only)
  29026. */
  29027. static ConvexHullImpostor: number;
  29028. /**
  29029. * Custom-Imposter type (Ammo.js plugin only)
  29030. */
  29031. static CustomImpostor: number;
  29032. /**
  29033. * Rope-Imposter type
  29034. */
  29035. static RopeImpostor: number;
  29036. /**
  29037. * Cloth-Imposter type
  29038. */
  29039. static ClothImpostor: number;
  29040. /**
  29041. * Softbody-Imposter type
  29042. */
  29043. static SoftbodyImpostor: number;
  29044. }
  29045. }
  29046. declare module "babylonjs/Meshes/mesh" {
  29047. import { Observable } from "babylonjs/Misc/observable";
  29048. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  29049. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  29050. import { Camera } from "babylonjs/Cameras/camera";
  29051. import { Scene } from "babylonjs/scene";
  29052. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  29053. import { Color4 } from "babylonjs/Maths/math.color";
  29054. import { Engine } from "babylonjs/Engines/engine";
  29055. import { Node } from "babylonjs/node";
  29056. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  29057. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  29058. import { Buffer } from "babylonjs/Meshes/buffer";
  29059. import { Geometry } from "babylonjs/Meshes/geometry";
  29060. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  29061. import { SubMesh } from "babylonjs/Meshes/subMesh";
  29062. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  29063. import { Effect } from "babylonjs/Materials/effect";
  29064. import { Material } from "babylonjs/Materials/material";
  29065. import { Skeleton } from "babylonjs/Bones/skeleton";
  29066. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  29067. import { MeshLODLevel } from "babylonjs/Meshes/meshLODLevel";
  29068. import { Path3D } from "babylonjs/Maths/math.path";
  29069. import { Plane } from "babylonjs/Maths/math.plane";
  29070. import { TransformNode } from "babylonjs/Meshes/transformNode";
  29071. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  29072. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  29073. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  29074. import { IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  29075. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  29076. /**
  29077. * @hidden
  29078. **/
  29079. export class _CreationDataStorage {
  29080. closePath?: boolean;
  29081. closeArray?: boolean;
  29082. idx: number[];
  29083. dashSize: number;
  29084. gapSize: number;
  29085. path3D: Path3D;
  29086. pathArray: Vector3[][];
  29087. arc: number;
  29088. radius: number;
  29089. cap: number;
  29090. tessellation: number;
  29091. }
  29092. /**
  29093. * @hidden
  29094. **/
  29095. class _InstanceDataStorage {
  29096. visibleInstances: any;
  29097. batchCache: _InstancesBatch;
  29098. instancesBufferSize: number;
  29099. instancesBuffer: Nullable<Buffer>;
  29100. instancesData: Float32Array;
  29101. overridenInstanceCount: number;
  29102. isFrozen: boolean;
  29103. previousBatch: Nullable<_InstancesBatch>;
  29104. hardwareInstancedRendering: boolean;
  29105. sideOrientation: number;
  29106. manualUpdate: boolean;
  29107. }
  29108. /**
  29109. * @hidden
  29110. **/
  29111. export class _InstancesBatch {
  29112. mustReturn: boolean;
  29113. visibleInstances: Nullable<import("babylonjs/Meshes/instancedMesh").InstancedMesh[]>[];
  29114. renderSelf: boolean[];
  29115. hardwareInstancedRendering: boolean[];
  29116. }
  29117. /**
  29118. * @hidden
  29119. **/
  29120. class _ThinInstanceDataStorage {
  29121. instancesCount: number;
  29122. matrixBuffer: Nullable<Buffer>;
  29123. matrixBufferSize: number;
  29124. matrixData: Nullable<Float32Array>;
  29125. boundingVectors: Array<Vector3>;
  29126. worldMatrices: Nullable<Matrix[]>;
  29127. }
  29128. /**
  29129. * Class used to represent renderable models
  29130. */
  29131. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  29132. /**
  29133. * Mesh side orientation : usually the external or front surface
  29134. */
  29135. static readonly FRONTSIDE: number;
  29136. /**
  29137. * Mesh side orientation : usually the internal or back surface
  29138. */
  29139. static readonly BACKSIDE: number;
  29140. /**
  29141. * Mesh side orientation : both internal and external or front and back surfaces
  29142. */
  29143. static readonly DOUBLESIDE: number;
  29144. /**
  29145. * Mesh side orientation : by default, `FRONTSIDE`
  29146. */
  29147. static readonly DEFAULTSIDE: number;
  29148. /**
  29149. * Mesh cap setting : no cap
  29150. */
  29151. static readonly NO_CAP: number;
  29152. /**
  29153. * Mesh cap setting : one cap at the beginning of the mesh
  29154. */
  29155. static readonly CAP_START: number;
  29156. /**
  29157. * Mesh cap setting : one cap at the end of the mesh
  29158. */
  29159. static readonly CAP_END: number;
  29160. /**
  29161. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  29162. */
  29163. static readonly CAP_ALL: number;
  29164. /**
  29165. * Mesh pattern setting : no flip or rotate
  29166. */
  29167. static readonly NO_FLIP: number;
  29168. /**
  29169. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  29170. */
  29171. static readonly FLIP_TILE: number;
  29172. /**
  29173. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  29174. */
  29175. static readonly ROTATE_TILE: number;
  29176. /**
  29177. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  29178. */
  29179. static readonly FLIP_ROW: number;
  29180. /**
  29181. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  29182. */
  29183. static readonly ROTATE_ROW: number;
  29184. /**
  29185. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  29186. */
  29187. static readonly FLIP_N_ROTATE_TILE: number;
  29188. /**
  29189. * Mesh pattern setting : rotate pattern and rotate
  29190. */
  29191. static readonly FLIP_N_ROTATE_ROW: number;
  29192. /**
  29193. * Mesh tile positioning : part tiles same on left/right or top/bottom
  29194. */
  29195. static readonly CENTER: number;
  29196. /**
  29197. * Mesh tile positioning : part tiles on left
  29198. */
  29199. static readonly LEFT: number;
  29200. /**
  29201. * Mesh tile positioning : part tiles on right
  29202. */
  29203. static readonly RIGHT: number;
  29204. /**
  29205. * Mesh tile positioning : part tiles on top
  29206. */
  29207. static readonly TOP: number;
  29208. /**
  29209. * Mesh tile positioning : part tiles on bottom
  29210. */
  29211. static readonly BOTTOM: number;
  29212. /**
  29213. * Gets the default side orientation.
  29214. * @param orientation the orientation to value to attempt to get
  29215. * @returns the default orientation
  29216. * @hidden
  29217. */
  29218. static _GetDefaultSideOrientation(orientation?: number): number;
  29219. private _internalMeshDataInfo;
  29220. get computeBonesUsingShaders(): boolean;
  29221. set computeBonesUsingShaders(value: boolean);
  29222. /**
  29223. * An event triggered before rendering the mesh
  29224. */
  29225. get onBeforeRenderObservable(): Observable<Mesh>;
  29226. /**
  29227. * An event triggered before binding the mesh
  29228. */
  29229. get onBeforeBindObservable(): Observable<Mesh>;
  29230. /**
  29231. * An event triggered after rendering the mesh
  29232. */
  29233. get onAfterRenderObservable(): Observable<Mesh>;
  29234. /**
  29235. * An event triggered before drawing the mesh
  29236. */
  29237. get onBeforeDrawObservable(): Observable<Mesh>;
  29238. private _onBeforeDrawObserver;
  29239. /**
  29240. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  29241. */
  29242. set onBeforeDraw(callback: () => void);
  29243. get hasInstances(): boolean;
  29244. get hasThinInstances(): boolean;
  29245. /**
  29246. * Gets the delay loading state of the mesh (when delay loading is turned on)
  29247. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  29248. */
  29249. delayLoadState: number;
  29250. /**
  29251. * Gets the list of instances created from this mesh
  29252. * it is not supposed to be modified manually.
  29253. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  29254. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  29255. */
  29256. instances: import("babylonjs/Meshes/instancedMesh").InstancedMesh[];
  29257. /**
  29258. * Gets the file containing delay loading data for this mesh
  29259. */
  29260. delayLoadingFile: string;
  29261. /** @hidden */
  29262. _binaryInfo: any;
  29263. /**
  29264. * User defined function used to change how LOD level selection is done
  29265. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29266. */
  29267. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  29268. /**
  29269. * Gets or sets the morph target manager
  29270. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  29271. */
  29272. get morphTargetManager(): Nullable<MorphTargetManager>;
  29273. set morphTargetManager(value: Nullable<MorphTargetManager>);
  29274. /** @hidden */
  29275. _creationDataStorage: Nullable<_CreationDataStorage>;
  29276. /** @hidden */
  29277. _geometry: Nullable<Geometry>;
  29278. /** @hidden */
  29279. _delayInfo: Array<string>;
  29280. /** @hidden */
  29281. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  29282. /** @hidden */
  29283. _instanceDataStorage: _InstanceDataStorage;
  29284. /** @hidden */
  29285. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  29286. private _effectiveMaterial;
  29287. /** @hidden */
  29288. _shouldGenerateFlatShading: boolean;
  29289. /** @hidden */
  29290. _originalBuilderSideOrientation: number;
  29291. /**
  29292. * Use this property to change the original side orientation defined at construction time
  29293. */
  29294. overrideMaterialSideOrientation: Nullable<number>;
  29295. /**
  29296. * Gets the source mesh (the one used to clone this one from)
  29297. */
  29298. get source(): Nullable<Mesh>;
  29299. /**
  29300. * Gets or sets a boolean indicating that this mesh does not use index buffer
  29301. */
  29302. get isUnIndexed(): boolean;
  29303. set isUnIndexed(value: boolean);
  29304. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  29305. get worldMatrixInstancedBuffer(): Float32Array;
  29306. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  29307. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  29308. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  29309. /**
  29310. * @constructor
  29311. * @param name The value used by scene.getMeshByName() to do a lookup.
  29312. * @param scene The scene to add this mesh to.
  29313. * @param parent The parent of this mesh, if it has one
  29314. * @param source An optional Mesh from which geometry is shared, cloned.
  29315. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  29316. * When false, achieved by calling a clone(), also passing False.
  29317. * This will make creation of children, recursive.
  29318. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  29319. */
  29320. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  29321. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  29322. doNotInstantiate: boolean;
  29323. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  29324. /**
  29325. * Gets the class name
  29326. * @returns the string "Mesh".
  29327. */
  29328. getClassName(): string;
  29329. /** @hidden */
  29330. get _isMesh(): boolean;
  29331. /**
  29332. * Returns a description of this mesh
  29333. * @param fullDetails define if full details about this mesh must be used
  29334. * @returns a descriptive string representing this mesh
  29335. */
  29336. toString(fullDetails?: boolean): string;
  29337. /** @hidden */
  29338. _unBindEffect(): void;
  29339. /**
  29340. * Gets a boolean indicating if this mesh has LOD
  29341. */
  29342. get hasLODLevels(): boolean;
  29343. /**
  29344. * Gets the list of MeshLODLevel associated with the current mesh
  29345. * @returns an array of MeshLODLevel
  29346. */
  29347. getLODLevels(): MeshLODLevel[];
  29348. private _sortLODLevels;
  29349. /**
  29350. * Add a mesh as LOD level triggered at the given distance.
  29351. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29352. * @param distance The distance from the center of the object to show this level
  29353. * @param mesh The mesh to be added as LOD level (can be null)
  29354. * @return This mesh (for chaining)
  29355. */
  29356. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  29357. /**
  29358. * Returns the LOD level mesh at the passed distance or null if not found.
  29359. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29360. * @param distance The distance from the center of the object to show this level
  29361. * @returns a Mesh or `null`
  29362. */
  29363. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  29364. /**
  29365. * Remove a mesh from the LOD array
  29366. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29367. * @param mesh defines the mesh to be removed
  29368. * @return This mesh (for chaining)
  29369. */
  29370. removeLODLevel(mesh: Mesh): Mesh;
  29371. /**
  29372. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  29373. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29374. * @param camera defines the camera to use to compute distance
  29375. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  29376. * @return This mesh (for chaining)
  29377. */
  29378. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  29379. /**
  29380. * Gets the mesh internal Geometry object
  29381. */
  29382. get geometry(): Nullable<Geometry>;
  29383. /**
  29384. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  29385. * @returns the total number of vertices
  29386. */
  29387. getTotalVertices(): number;
  29388. /**
  29389. * Returns the content of an associated vertex buffer
  29390. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29391. * - VertexBuffer.PositionKind
  29392. * - VertexBuffer.UVKind
  29393. * - VertexBuffer.UV2Kind
  29394. * - VertexBuffer.UV3Kind
  29395. * - VertexBuffer.UV4Kind
  29396. * - VertexBuffer.UV5Kind
  29397. * - VertexBuffer.UV6Kind
  29398. * - VertexBuffer.ColorKind
  29399. * - VertexBuffer.MatricesIndicesKind
  29400. * - VertexBuffer.MatricesIndicesExtraKind
  29401. * - VertexBuffer.MatricesWeightsKind
  29402. * - VertexBuffer.MatricesWeightsExtraKind
  29403. * @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
  29404. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  29405. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  29406. */
  29407. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  29408. /**
  29409. * Returns the mesh VertexBuffer object from the requested `kind`
  29410. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29411. * - VertexBuffer.PositionKind
  29412. * - VertexBuffer.NormalKind
  29413. * - VertexBuffer.UVKind
  29414. * - VertexBuffer.UV2Kind
  29415. * - VertexBuffer.UV3Kind
  29416. * - VertexBuffer.UV4Kind
  29417. * - VertexBuffer.UV5Kind
  29418. * - VertexBuffer.UV6Kind
  29419. * - VertexBuffer.ColorKind
  29420. * - VertexBuffer.MatricesIndicesKind
  29421. * - VertexBuffer.MatricesIndicesExtraKind
  29422. * - VertexBuffer.MatricesWeightsKind
  29423. * - VertexBuffer.MatricesWeightsExtraKind
  29424. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  29425. */
  29426. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  29427. /**
  29428. * Tests if a specific vertex buffer is associated with this mesh
  29429. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  29430. * - VertexBuffer.PositionKind
  29431. * - VertexBuffer.NormalKind
  29432. * - VertexBuffer.UVKind
  29433. * - VertexBuffer.UV2Kind
  29434. * - VertexBuffer.UV3Kind
  29435. * - VertexBuffer.UV4Kind
  29436. * - VertexBuffer.UV5Kind
  29437. * - VertexBuffer.UV6Kind
  29438. * - VertexBuffer.ColorKind
  29439. * - VertexBuffer.MatricesIndicesKind
  29440. * - VertexBuffer.MatricesIndicesExtraKind
  29441. * - VertexBuffer.MatricesWeightsKind
  29442. * - VertexBuffer.MatricesWeightsExtraKind
  29443. * @returns a boolean
  29444. */
  29445. isVerticesDataPresent(kind: string): boolean;
  29446. /**
  29447. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  29448. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  29449. * - VertexBuffer.PositionKind
  29450. * - VertexBuffer.UVKind
  29451. * - VertexBuffer.UV2Kind
  29452. * - VertexBuffer.UV3Kind
  29453. * - VertexBuffer.UV4Kind
  29454. * - VertexBuffer.UV5Kind
  29455. * - VertexBuffer.UV6Kind
  29456. * - VertexBuffer.ColorKind
  29457. * - VertexBuffer.MatricesIndicesKind
  29458. * - VertexBuffer.MatricesIndicesExtraKind
  29459. * - VertexBuffer.MatricesWeightsKind
  29460. * - VertexBuffer.MatricesWeightsExtraKind
  29461. * @returns a boolean
  29462. */
  29463. isVertexBufferUpdatable(kind: string): boolean;
  29464. /**
  29465. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  29466. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29467. * - VertexBuffer.PositionKind
  29468. * - VertexBuffer.NormalKind
  29469. * - VertexBuffer.UVKind
  29470. * - VertexBuffer.UV2Kind
  29471. * - VertexBuffer.UV3Kind
  29472. * - VertexBuffer.UV4Kind
  29473. * - VertexBuffer.UV5Kind
  29474. * - VertexBuffer.UV6Kind
  29475. * - VertexBuffer.ColorKind
  29476. * - VertexBuffer.MatricesIndicesKind
  29477. * - VertexBuffer.MatricesIndicesExtraKind
  29478. * - VertexBuffer.MatricesWeightsKind
  29479. * - VertexBuffer.MatricesWeightsExtraKind
  29480. * @returns an array of strings
  29481. */
  29482. getVerticesDataKinds(): string[];
  29483. /**
  29484. * Returns a positive integer : the total number of indices in this mesh geometry.
  29485. * @returns the numner of indices or zero if the mesh has no geometry.
  29486. */
  29487. getTotalIndices(): number;
  29488. /**
  29489. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  29490. * @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.
  29491. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  29492. * @returns the indices array or an empty array if the mesh has no geometry
  29493. */
  29494. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  29495. get isBlocked(): boolean;
  29496. /**
  29497. * Determine if the current mesh is ready to be rendered
  29498. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  29499. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  29500. * @returns true if all associated assets are ready (material, textures, shaders)
  29501. */
  29502. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  29503. /**
  29504. * 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.
  29505. */
  29506. get areNormalsFrozen(): boolean;
  29507. /**
  29508. * 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.
  29509. * @returns the current mesh
  29510. */
  29511. freezeNormals(): Mesh;
  29512. /**
  29513. * 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
  29514. * @returns the current mesh
  29515. */
  29516. unfreezeNormals(): Mesh;
  29517. /**
  29518. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  29519. */
  29520. set overridenInstanceCount(count: number);
  29521. /** @hidden */
  29522. _preActivate(): Mesh;
  29523. /** @hidden */
  29524. _preActivateForIntermediateRendering(renderId: number): Mesh;
  29525. /** @hidden */
  29526. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  29527. protected _afterComputeWorldMatrix(): void;
  29528. /** @hidden */
  29529. _postActivate(): void;
  29530. /**
  29531. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  29532. * This means the mesh underlying bounding box and sphere are recomputed.
  29533. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  29534. * @returns the current mesh
  29535. */
  29536. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  29537. /** @hidden */
  29538. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  29539. /**
  29540. * This function will subdivide the mesh into multiple submeshes
  29541. * @param count defines the expected number of submeshes
  29542. */
  29543. subdivide(count: number): void;
  29544. /**
  29545. * Copy a FloatArray into a specific associated vertex buffer
  29546. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  29547. * - VertexBuffer.PositionKind
  29548. * - VertexBuffer.UVKind
  29549. * - VertexBuffer.UV2Kind
  29550. * - VertexBuffer.UV3Kind
  29551. * - VertexBuffer.UV4Kind
  29552. * - VertexBuffer.UV5Kind
  29553. * - VertexBuffer.UV6Kind
  29554. * - VertexBuffer.ColorKind
  29555. * - VertexBuffer.MatricesIndicesKind
  29556. * - VertexBuffer.MatricesIndicesExtraKind
  29557. * - VertexBuffer.MatricesWeightsKind
  29558. * - VertexBuffer.MatricesWeightsExtraKind
  29559. * @param data defines the data source
  29560. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  29561. * @param stride defines the data stride size (can be null)
  29562. * @returns the current mesh
  29563. */
  29564. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  29565. /**
  29566. * Delete a vertex buffer associated with this mesh
  29567. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  29568. * - VertexBuffer.PositionKind
  29569. * - VertexBuffer.UVKind
  29570. * - VertexBuffer.UV2Kind
  29571. * - VertexBuffer.UV3Kind
  29572. * - VertexBuffer.UV4Kind
  29573. * - VertexBuffer.UV5Kind
  29574. * - VertexBuffer.UV6Kind
  29575. * - VertexBuffer.ColorKind
  29576. * - VertexBuffer.MatricesIndicesKind
  29577. * - VertexBuffer.MatricesIndicesExtraKind
  29578. * - VertexBuffer.MatricesWeightsKind
  29579. * - VertexBuffer.MatricesWeightsExtraKind
  29580. */
  29581. removeVerticesData(kind: string): void;
  29582. /**
  29583. * Flags an associated vertex buffer as updatable
  29584. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  29585. * - VertexBuffer.PositionKind
  29586. * - VertexBuffer.UVKind
  29587. * - VertexBuffer.UV2Kind
  29588. * - VertexBuffer.UV3Kind
  29589. * - VertexBuffer.UV4Kind
  29590. * - VertexBuffer.UV5Kind
  29591. * - VertexBuffer.UV6Kind
  29592. * - VertexBuffer.ColorKind
  29593. * - VertexBuffer.MatricesIndicesKind
  29594. * - VertexBuffer.MatricesIndicesExtraKind
  29595. * - VertexBuffer.MatricesWeightsKind
  29596. * - VertexBuffer.MatricesWeightsExtraKind
  29597. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  29598. */
  29599. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  29600. /**
  29601. * Sets the mesh global Vertex Buffer
  29602. * @param buffer defines the buffer to use
  29603. * @returns the current mesh
  29604. */
  29605. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  29606. /**
  29607. * Update a specific associated vertex buffer
  29608. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  29609. * - VertexBuffer.PositionKind
  29610. * - VertexBuffer.UVKind
  29611. * - VertexBuffer.UV2Kind
  29612. * - VertexBuffer.UV3Kind
  29613. * - VertexBuffer.UV4Kind
  29614. * - VertexBuffer.UV5Kind
  29615. * - VertexBuffer.UV6Kind
  29616. * - VertexBuffer.ColorKind
  29617. * - VertexBuffer.MatricesIndicesKind
  29618. * - VertexBuffer.MatricesIndicesExtraKind
  29619. * - VertexBuffer.MatricesWeightsKind
  29620. * - VertexBuffer.MatricesWeightsExtraKind
  29621. * @param data defines the data source
  29622. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  29623. * @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)
  29624. * @returns the current mesh
  29625. */
  29626. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  29627. /**
  29628. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  29629. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  29630. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  29631. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  29632. * @returns the current mesh
  29633. */
  29634. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  29635. /**
  29636. * Creates a un-shared specific occurence of the geometry for the mesh.
  29637. * @returns the current mesh
  29638. */
  29639. makeGeometryUnique(): Mesh;
  29640. /**
  29641. * Set the index buffer of this mesh
  29642. * @param indices defines the source data
  29643. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  29644. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  29645. * @returns the current mesh
  29646. */
  29647. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  29648. /**
  29649. * Update the current index buffer
  29650. * @param indices defines the source data
  29651. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  29652. * @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)
  29653. * @returns the current mesh
  29654. */
  29655. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  29656. /**
  29657. * Invert the geometry to move from a right handed system to a left handed one.
  29658. * @returns the current mesh
  29659. */
  29660. toLeftHanded(): Mesh;
  29661. /** @hidden */
  29662. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  29663. /** @hidden */
  29664. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  29665. /**
  29666. * Registers for this mesh a javascript function called just before the rendering process
  29667. * @param func defines the function to call before rendering this mesh
  29668. * @returns the current mesh
  29669. */
  29670. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  29671. /**
  29672. * Disposes a previously registered javascript function called before the rendering
  29673. * @param func defines the function to remove
  29674. * @returns the current mesh
  29675. */
  29676. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  29677. /**
  29678. * Registers for this mesh a javascript function called just after the rendering is complete
  29679. * @param func defines the function to call after rendering this mesh
  29680. * @returns the current mesh
  29681. */
  29682. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  29683. /**
  29684. * Disposes a previously registered javascript function called after the rendering.
  29685. * @param func defines the function to remove
  29686. * @returns the current mesh
  29687. */
  29688. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  29689. /** @hidden */
  29690. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  29691. /** @hidden */
  29692. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  29693. /** @hidden */
  29694. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  29695. /** @hidden */
  29696. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  29697. /** @hidden */
  29698. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  29699. /** @hidden */
  29700. _rebuild(): void;
  29701. /** @hidden */
  29702. _freeze(): void;
  29703. /** @hidden */
  29704. _unFreeze(): void;
  29705. /**
  29706. * 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
  29707. * @param subMesh defines the subMesh to render
  29708. * @param enableAlphaMode defines if alpha mode can be changed
  29709. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  29710. * @returns the current mesh
  29711. */
  29712. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  29713. private _onBeforeDraw;
  29714. /**
  29715. * Renormalize the mesh and patch it up if there are no weights
  29716. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  29717. * However in the case of zero weights then we set just a single influence to 1.
  29718. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  29719. */
  29720. cleanMatrixWeights(): void;
  29721. private normalizeSkinFourWeights;
  29722. private normalizeSkinWeightsAndExtra;
  29723. /**
  29724. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  29725. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  29726. * the user know there was an issue with importing the mesh
  29727. * @returns a validation object with skinned, valid and report string
  29728. */
  29729. validateSkinning(): {
  29730. skinned: boolean;
  29731. valid: boolean;
  29732. report: string;
  29733. };
  29734. /** @hidden */
  29735. _checkDelayState(): Mesh;
  29736. private _queueLoad;
  29737. /**
  29738. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  29739. * A mesh is in the frustum if its bounding box intersects the frustum
  29740. * @param frustumPlanes defines the frustum to test
  29741. * @returns true if the mesh is in the frustum planes
  29742. */
  29743. isInFrustum(frustumPlanes: Plane[]): boolean;
  29744. /**
  29745. * Sets the mesh material by the material or multiMaterial `id` property
  29746. * @param id is a string identifying the material or the multiMaterial
  29747. * @returns the current mesh
  29748. */
  29749. setMaterialByID(id: string): Mesh;
  29750. /**
  29751. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  29752. * @returns an array of IAnimatable
  29753. */
  29754. getAnimatables(): IAnimatable[];
  29755. /**
  29756. * Modifies the mesh geometry according to the passed transformation matrix.
  29757. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  29758. * The mesh normals are modified using the same transformation.
  29759. * Note that, under the hood, this method sets a new VertexBuffer each call.
  29760. * @param transform defines the transform matrix to use
  29761. * @see https://doc.babylonjs.com/resources/baking_transformations
  29762. * @returns the current mesh
  29763. */
  29764. bakeTransformIntoVertices(transform: Matrix): Mesh;
  29765. /**
  29766. * Modifies the mesh geometry according to its own current World Matrix.
  29767. * The mesh World Matrix is then reset.
  29768. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  29769. * Note that, under the hood, this method sets a new VertexBuffer each call.
  29770. * @see https://doc.babylonjs.com/resources/baking_transformations
  29771. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  29772. * @returns the current mesh
  29773. */
  29774. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  29775. /** @hidden */
  29776. get _positions(): Nullable<Vector3[]>;
  29777. /** @hidden */
  29778. _resetPointsArrayCache(): Mesh;
  29779. /** @hidden */
  29780. _generatePointsArray(): boolean;
  29781. /**
  29782. * Returns a new Mesh object generated from the current mesh properties.
  29783. * This method must not get confused with createInstance()
  29784. * @param name is a string, the name given to the new mesh
  29785. * @param newParent can be any Node object (default `null`)
  29786. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  29787. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  29788. * @returns a new mesh
  29789. */
  29790. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  29791. /**
  29792. * Releases resources associated with this mesh.
  29793. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  29794. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  29795. */
  29796. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  29797. /** @hidden */
  29798. _disposeInstanceSpecificData(): void;
  29799. /** @hidden */
  29800. _disposeThinInstanceSpecificData(): void;
  29801. /**
  29802. * Modifies the mesh geometry according to a displacement map.
  29803. * 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.
  29804. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  29805. * @param url is a string, the URL from the image file is to be downloaded.
  29806. * @param minHeight is the lower limit of the displacement.
  29807. * @param maxHeight is the upper limit of the displacement.
  29808. * @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.
  29809. * @param uvOffset is an optional vector2 used to offset UV.
  29810. * @param uvScale is an optional vector2 used to scale UV.
  29811. * @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.
  29812. * @returns the Mesh.
  29813. */
  29814. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  29815. /**
  29816. * Modifies the mesh geometry according to a displacementMap buffer.
  29817. * 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.
  29818. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  29819. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  29820. * @param heightMapWidth is the width of the buffer image.
  29821. * @param heightMapHeight is the height of the buffer image.
  29822. * @param minHeight is the lower limit of the displacement.
  29823. * @param maxHeight is the upper limit of the displacement.
  29824. * @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.
  29825. * @param uvOffset is an optional vector2 used to offset UV.
  29826. * @param uvScale is an optional vector2 used to scale UV.
  29827. * @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.
  29828. * @returns the Mesh.
  29829. */
  29830. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  29831. /**
  29832. * Modify the mesh to get a flat shading rendering.
  29833. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  29834. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  29835. * @returns current mesh
  29836. */
  29837. convertToFlatShadedMesh(): Mesh;
  29838. /**
  29839. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  29840. * In other words, more vertices, no more indices and a single bigger VBO.
  29841. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  29842. * @returns current mesh
  29843. */
  29844. convertToUnIndexedMesh(): Mesh;
  29845. /**
  29846. * Inverses facet orientations.
  29847. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29848. * @param flipNormals will also inverts the normals
  29849. * @returns current mesh
  29850. */
  29851. flipFaces(flipNormals?: boolean): Mesh;
  29852. /**
  29853. * Increase the number of facets and hence vertices in a mesh
  29854. * Vertex normals are interpolated from existing vertex normals
  29855. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29856. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  29857. */
  29858. increaseVertices(numberPerEdge: number): void;
  29859. /**
  29860. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  29861. * This will undo any application of covertToFlatShadedMesh
  29862. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29863. */
  29864. forceSharedVertices(): void;
  29865. /** @hidden */
  29866. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  29867. /** @hidden */
  29868. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  29869. /**
  29870. * Creates a new InstancedMesh object from the mesh model.
  29871. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  29872. * @param name defines the name of the new instance
  29873. * @returns a new InstancedMesh
  29874. */
  29875. createInstance(name: string): InstancedMesh;
  29876. /**
  29877. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  29878. * After this call, all the mesh instances have the same submeshes than the current mesh.
  29879. * @returns the current mesh
  29880. */
  29881. synchronizeInstances(): Mesh;
  29882. /**
  29883. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  29884. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  29885. * This should be used together with the simplification to avoid disappearing triangles.
  29886. * @param successCallback an optional success callback to be called after the optimization finished.
  29887. * @returns the current mesh
  29888. */
  29889. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  29890. /**
  29891. * Serialize current mesh
  29892. * @param serializationObject defines the object which will receive the serialization data
  29893. */
  29894. serialize(serializationObject: any): void;
  29895. /** @hidden */
  29896. _syncGeometryWithMorphTargetManager(): void;
  29897. /** @hidden */
  29898. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  29899. /**
  29900. * Returns a new Mesh object parsed from the source provided.
  29901. * @param parsedMesh is the source
  29902. * @param scene defines the hosting scene
  29903. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  29904. * @returns a new Mesh
  29905. */
  29906. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  29907. /**
  29908. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  29909. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  29910. * @param name defines the name of the mesh to create
  29911. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  29912. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  29913. * @param closePath creates a seam between the first and the last points of each path of the path array
  29914. * @param offset is taken in account only if the `pathArray` is containing a single path
  29915. * @param scene defines the hosting scene
  29916. * @param updatable defines if the mesh must be flagged as updatable
  29917. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29918. * @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)
  29919. * @returns a new Mesh
  29920. */
  29921. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  29922. /**
  29923. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  29924. * @param name defines the name of the mesh to create
  29925. * @param radius sets the radius size (float) of the polygon (default 0.5)
  29926. * @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
  29927. * @param scene defines the hosting scene
  29928. * @param updatable defines if the mesh must be flagged as updatable
  29929. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29930. * @returns a new Mesh
  29931. */
  29932. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  29933. /**
  29934. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  29935. * @param name defines the name of the mesh to create
  29936. * @param size sets the size (float) of each box side (default 1)
  29937. * @param scene defines the hosting scene
  29938. * @param updatable defines if the mesh must be flagged as updatable
  29939. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29940. * @returns a new Mesh
  29941. */
  29942. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  29943. /**
  29944. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  29945. * @param name defines the name of the mesh to create
  29946. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  29947. * @param diameter sets the diameter size (float) of the sphere (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 CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29954. /**
  29955. * Creates a hemisphere 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. * @returns a new Mesh
  29961. */
  29962. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  29963. /**
  29964. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  29965. * @param name defines the name of the mesh to create
  29966. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  29967. * @param diameterTop set the top cap diameter (floats, default 1)
  29968. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  29969. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  29970. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  29971. * @param scene defines the hosting scene
  29972. * @param updatable defines if the mesh must be flagged as updatable
  29973. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29974. * @returns a new Mesh
  29975. */
  29976. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  29977. /**
  29978. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  29979. * @param name defines the name of the mesh to create
  29980. * @param diameter sets the diameter size (float) of the torus (default 1)
  29981. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  29982. * @param tessellation sets the number of torus sides (postive integer, default 16)
  29983. * @param scene defines the hosting scene
  29984. * @param updatable defines if the mesh must be flagged as updatable
  29985. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29986. * @returns a new Mesh
  29987. */
  29988. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29989. /**
  29990. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  29991. * @param name defines the name of the mesh to create
  29992. * @param radius sets the global radius size (float) of the torus knot (default 2)
  29993. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  29994. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  29995. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  29996. * @param p the number of windings on X axis (positive integers, default 2)
  29997. * @param q the number of windings on Y axis (positive integers, default 3)
  29998. * @param scene defines the hosting scene
  29999. * @param updatable defines if the mesh must be flagged as updatable
  30000. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30001. * @returns a new Mesh
  30002. */
  30003. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30004. /**
  30005. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  30006. * @param name defines the name of the mesh to create
  30007. * @param points is an array successive Vector3
  30008. * @param scene defines the hosting scene
  30009. * @param updatable defines if the mesh must be flagged as updatable
  30010. * @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).
  30011. * @returns a new Mesh
  30012. */
  30013. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  30014. /**
  30015. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  30016. * @param name defines the name of the mesh to create
  30017. * @param points is an array successive Vector3
  30018. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  30019. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  30020. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  30021. * @param scene defines the hosting scene
  30022. * @param updatable defines if the mesh must be flagged as updatable
  30023. * @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)
  30024. * @returns a new Mesh
  30025. */
  30026. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  30027. /**
  30028. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  30029. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  30030. * 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.
  30031. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30032. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  30033. * Remember you can only change the shape positions, not their number when updating a polygon.
  30034. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  30035. * @param name defines the name of the mesh to create
  30036. * @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
  30037. * @param scene defines the hosting scene
  30038. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  30039. * @param updatable defines if the mesh must be flagged as updatable
  30040. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30041. * @param earcutInjection can be used to inject your own earcut reference
  30042. * @returns a new Mesh
  30043. */
  30044. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  30045. /**
  30046. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  30047. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  30048. * @param name defines the name of the mesh to create
  30049. * @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
  30050. * @param depth defines the height of extrusion
  30051. * @param scene defines the hosting scene
  30052. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  30053. * @param updatable defines if the mesh must be flagged as updatable
  30054. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30055. * @param earcutInjection can be used to inject your own earcut reference
  30056. * @returns a new Mesh
  30057. */
  30058. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  30059. /**
  30060. * Creates an extruded shape mesh.
  30061. * 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
  30062. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  30063. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  30064. * @param name defines the name of the mesh to create
  30065. * @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
  30066. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  30067. * @param scale is the value to scale the shape
  30068. * @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
  30069. * @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
  30070. * @param scene defines the hosting scene
  30071. * @param updatable defines if the mesh must be flagged as updatable
  30072. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30073. * @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)
  30074. * @returns a new Mesh
  30075. */
  30076. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30077. /**
  30078. * Creates an custom extruded shape mesh.
  30079. * The custom extrusion is a parametric shape.
  30080. * It has no predefined shape. Its final shape will depend on the input parameters.
  30081. * Please consider using the same method from the MeshBuilder class instead
  30082. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  30083. * @param name defines the name of the mesh to create
  30084. * @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
  30085. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  30086. * @param scaleFunction is a custom Javascript function called on each path point
  30087. * @param rotationFunction is a custom Javascript function called on each path point
  30088. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  30089. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  30090. * @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
  30091. * @param scene defines the hosting scene
  30092. * @param updatable defines if the mesh must be flagged as updatable
  30093. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30094. * @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)
  30095. * @returns a new Mesh
  30096. */
  30097. 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;
  30098. /**
  30099. * Creates lathe mesh.
  30100. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  30101. * Please consider using the same method from the MeshBuilder class instead
  30102. * @param name defines the name of the mesh to create
  30103. * @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
  30104. * @param radius is the radius value of the lathe
  30105. * @param tessellation is the side number of the lathe.
  30106. * @param scene defines the hosting scene
  30107. * @param updatable defines if the mesh must be flagged as updatable
  30108. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30109. * @returns a new Mesh
  30110. */
  30111. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30112. /**
  30113. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  30114. * @param name defines the name of the mesh to create
  30115. * @param size sets the size (float) of both sides of the plane at once (default 1)
  30116. * @param scene defines the hosting scene
  30117. * @param updatable defines if the mesh must be flagged as updatable
  30118. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30119. * @returns a new Mesh
  30120. */
  30121. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30122. /**
  30123. * Creates a ground mesh.
  30124. * Please consider using the same method from the MeshBuilder class instead
  30125. * @param name defines the name of the mesh to create
  30126. * @param width set the width of the ground
  30127. * @param height set the height of the ground
  30128. * @param subdivisions sets the number of subdivisions per side
  30129. * @param scene defines the hosting scene
  30130. * @param updatable defines if the mesh must be flagged as updatable
  30131. * @returns a new Mesh
  30132. */
  30133. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  30134. /**
  30135. * Creates a tiled ground mesh.
  30136. * Please consider using the same method from the MeshBuilder class instead
  30137. * @param name defines the name of the mesh to create
  30138. * @param xmin set the ground minimum X coordinate
  30139. * @param zmin set the ground minimum Y coordinate
  30140. * @param xmax set the ground maximum X coordinate
  30141. * @param zmax set the ground maximum Z coordinate
  30142. * @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
  30143. * @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
  30144. * @param scene defines the hosting scene
  30145. * @param updatable defines if the mesh must be flagged as updatable
  30146. * @returns a new Mesh
  30147. */
  30148. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  30149. w: number;
  30150. h: number;
  30151. }, precision: {
  30152. w: number;
  30153. h: number;
  30154. }, scene: Scene, updatable?: boolean): Mesh;
  30155. /**
  30156. * Creates a ground mesh from a height map.
  30157. * Please consider using the same method from the MeshBuilder class instead
  30158. * @see https://doc.babylonjs.com/babylon101/height_map
  30159. * @param name defines the name of the mesh to create
  30160. * @param url sets the URL of the height map image resource
  30161. * @param width set the ground width size
  30162. * @param height set the ground height size
  30163. * @param subdivisions sets the number of subdivision per side
  30164. * @param minHeight is the minimum altitude on the ground
  30165. * @param maxHeight is the maximum altitude on the ground
  30166. * @param scene defines the hosting scene
  30167. * @param updatable defines if the mesh must be flagged as updatable
  30168. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  30169. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  30170. * @returns a new Mesh
  30171. */
  30172. 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;
  30173. /**
  30174. * Creates a tube mesh.
  30175. * The tube is a parametric shape.
  30176. * It has no predefined shape. Its final shape will depend on the input parameters.
  30177. * Please consider using the same method from the MeshBuilder class instead
  30178. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  30179. * @param name defines the name of the mesh to create
  30180. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  30181. * @param radius sets the tube radius size
  30182. * @param tessellation is the number of sides on the tubular surface
  30183. * @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
  30184. * @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
  30185. * @param scene defines the hosting scene
  30186. * @param updatable defines if the mesh must be flagged as updatable
  30187. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30188. * @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)
  30189. * @returns a new Mesh
  30190. */
  30191. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  30192. (i: number, distance: number): number;
  30193. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30194. /**
  30195. * Creates a polyhedron mesh.
  30196. * Please consider using the same method from the MeshBuilder class instead.
  30197. * * 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
  30198. * * The parameter `size` (positive float, default 1) sets the polygon size
  30199. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  30200. * * 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`
  30201. * * 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
  30202. * * 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)`)
  30203. * * 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
  30204. * * 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
  30205. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30206. * * 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
  30207. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30208. * @param name defines the name of the mesh to create
  30209. * @param options defines the options used to create the mesh
  30210. * @param scene defines the hosting scene
  30211. * @returns a new Mesh
  30212. */
  30213. static CreatePolyhedron(name: string, options: {
  30214. type?: number;
  30215. size?: number;
  30216. sizeX?: number;
  30217. sizeY?: number;
  30218. sizeZ?: number;
  30219. custom?: any;
  30220. faceUV?: Vector4[];
  30221. faceColors?: Color4[];
  30222. updatable?: boolean;
  30223. sideOrientation?: number;
  30224. }, scene: Scene): Mesh;
  30225. /**
  30226. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  30227. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  30228. * * 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`)
  30229. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  30230. * * 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
  30231. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30232. * * 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
  30233. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30234. * @param name defines the name of the mesh
  30235. * @param options defines the options used to create the mesh
  30236. * @param scene defines the hosting scene
  30237. * @returns a new Mesh
  30238. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  30239. */
  30240. static CreateIcoSphere(name: string, options: {
  30241. radius?: number;
  30242. flat?: boolean;
  30243. subdivisions?: number;
  30244. sideOrientation?: number;
  30245. updatable?: boolean;
  30246. }, scene: Scene): Mesh;
  30247. /**
  30248. * Creates a decal mesh.
  30249. * Please consider using the same method from the MeshBuilder class instead.
  30250. * A decal is a mesh usually applied as a model onto the surface of another mesh
  30251. * @param name defines the name of the mesh
  30252. * @param sourceMesh defines the mesh receiving the decal
  30253. * @param position sets the position of the decal in world coordinates
  30254. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  30255. * @param size sets the decal scaling
  30256. * @param angle sets the angle to rotate the decal
  30257. * @returns a new Mesh
  30258. */
  30259. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  30260. /**
  30261. * Prepare internal position array for software CPU skinning
  30262. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  30263. */
  30264. setPositionsForCPUSkinning(): Float32Array;
  30265. /**
  30266. * Prepare internal normal array for software CPU skinning
  30267. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  30268. */
  30269. setNormalsForCPUSkinning(): Float32Array;
  30270. /**
  30271. * Updates the vertex buffer by applying transformation from the bones
  30272. * @param skeleton defines the skeleton to apply to current mesh
  30273. * @returns the current mesh
  30274. */
  30275. applySkeleton(skeleton: Skeleton): Mesh;
  30276. /**
  30277. * 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
  30278. * @param meshes defines the list of meshes to scan
  30279. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  30280. */
  30281. static MinMax(meshes: AbstractMesh[]): {
  30282. min: Vector3;
  30283. max: Vector3;
  30284. };
  30285. /**
  30286. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  30287. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  30288. * @returns a vector3
  30289. */
  30290. static Center(meshesOrMinMaxVector: {
  30291. min: Vector3;
  30292. max: Vector3;
  30293. } | AbstractMesh[]): Vector3;
  30294. /**
  30295. * Merge the array of meshes into a single mesh for performance reasons.
  30296. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  30297. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  30298. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  30299. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  30300. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  30301. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  30302. * @returns a new mesh
  30303. */
  30304. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  30305. /** @hidden */
  30306. addInstance(instance: InstancedMesh): void;
  30307. /** @hidden */
  30308. removeInstance(instance: InstancedMesh): void;
  30309. }
  30310. }
  30311. declare module "babylonjs/Cameras/camera" {
  30312. import { SmartArray } from "babylonjs/Misc/smartArray";
  30313. import { Observable } from "babylonjs/Misc/observable";
  30314. import { Nullable } from "babylonjs/types";
  30315. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  30316. import { Scene } from "babylonjs/scene";
  30317. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  30318. import { Node } from "babylonjs/node";
  30319. import { Mesh } from "babylonjs/Meshes/mesh";
  30320. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  30321. import { ICullable } from "babylonjs/Culling/boundingInfo";
  30322. import { Viewport } from "babylonjs/Maths/math.viewport";
  30323. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  30324. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  30325. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  30326. import { Ray } from "babylonjs/Culling/ray";
  30327. /**
  30328. * This is the base class of all the camera used in the application.
  30329. * @see https://doc.babylonjs.com/features/cameras
  30330. */
  30331. export class Camera extends Node {
  30332. /** @hidden */
  30333. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  30334. /**
  30335. * This is the default projection mode used by the cameras.
  30336. * It helps recreating a feeling of perspective and better appreciate depth.
  30337. * This is the best way to simulate real life cameras.
  30338. */
  30339. static readonly PERSPECTIVE_CAMERA: number;
  30340. /**
  30341. * This helps creating camera with an orthographic mode.
  30342. * 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.
  30343. */
  30344. static readonly ORTHOGRAPHIC_CAMERA: number;
  30345. /**
  30346. * This is the default FOV mode for perspective cameras.
  30347. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  30348. */
  30349. static readonly FOVMODE_VERTICAL_FIXED: number;
  30350. /**
  30351. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  30352. */
  30353. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  30354. /**
  30355. * This specifies ther is no need for a camera rig.
  30356. * Basically only one eye is rendered corresponding to the camera.
  30357. */
  30358. static readonly RIG_MODE_NONE: number;
  30359. /**
  30360. * Simulates a camera Rig with one blue eye and one red eye.
  30361. * This can be use with 3d blue and red glasses.
  30362. */
  30363. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  30364. /**
  30365. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  30366. */
  30367. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  30368. /**
  30369. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  30370. */
  30371. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  30372. /**
  30373. * Defines that both eyes of the camera will be rendered over under each other.
  30374. */
  30375. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  30376. /**
  30377. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  30378. */
  30379. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  30380. /**
  30381. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  30382. */
  30383. static readonly RIG_MODE_VR: number;
  30384. /**
  30385. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  30386. */
  30387. static readonly RIG_MODE_WEBVR: number;
  30388. /**
  30389. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  30390. */
  30391. static readonly RIG_MODE_CUSTOM: number;
  30392. /**
  30393. * Defines if by default attaching controls should prevent the default javascript event to continue.
  30394. */
  30395. static ForceAttachControlToAlwaysPreventDefault: boolean;
  30396. /**
  30397. * Define the input manager associated with the camera.
  30398. */
  30399. inputs: CameraInputsManager<Camera>;
  30400. /** @hidden */
  30401. _position: Vector3;
  30402. /**
  30403. * Define the current local position of the camera in the scene
  30404. */
  30405. get position(): Vector3;
  30406. set position(newPosition: Vector3);
  30407. protected _upVector: Vector3;
  30408. /**
  30409. * The vector the camera should consider as up.
  30410. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  30411. */
  30412. set upVector(vec: Vector3);
  30413. get upVector(): Vector3;
  30414. /**
  30415. * Define the current limit on the left side for an orthographic camera
  30416. * In scene unit
  30417. */
  30418. orthoLeft: Nullable<number>;
  30419. /**
  30420. * Define the current limit on the right side for an orthographic camera
  30421. * In scene unit
  30422. */
  30423. orthoRight: Nullable<number>;
  30424. /**
  30425. * Define the current limit on the bottom side for an orthographic camera
  30426. * In scene unit
  30427. */
  30428. orthoBottom: Nullable<number>;
  30429. /**
  30430. * Define the current limit on the top side for an orthographic camera
  30431. * In scene unit
  30432. */
  30433. orthoTop: Nullable<number>;
  30434. /**
  30435. * Field Of View is set in Radians. (default is 0.8)
  30436. */
  30437. fov: number;
  30438. /**
  30439. * Define the minimum distance the camera can see from.
  30440. * This is important to note that the depth buffer are not infinite and the closer it starts
  30441. * the more your scene might encounter depth fighting issue.
  30442. */
  30443. minZ: number;
  30444. /**
  30445. * Define the maximum distance the camera can see to.
  30446. * This is important to note that the depth buffer are not infinite and the further it end
  30447. * the more your scene might encounter depth fighting issue.
  30448. */
  30449. maxZ: number;
  30450. /**
  30451. * Define the default inertia of the camera.
  30452. * This helps giving a smooth feeling to the camera movement.
  30453. */
  30454. inertia: number;
  30455. /**
  30456. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  30457. */
  30458. mode: number;
  30459. /**
  30460. * Define whether the camera is intermediate.
  30461. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  30462. */
  30463. isIntermediate: boolean;
  30464. /**
  30465. * Define the viewport of the camera.
  30466. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  30467. */
  30468. viewport: Viewport;
  30469. /**
  30470. * Restricts the camera to viewing objects with the same layerMask.
  30471. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  30472. */
  30473. layerMask: number;
  30474. /**
  30475. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  30476. */
  30477. fovMode: number;
  30478. /**
  30479. * Rig mode of the camera.
  30480. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  30481. * This is normally controlled byt the camera themselves as internal use.
  30482. */
  30483. cameraRigMode: number;
  30484. /**
  30485. * Defines the distance between both "eyes" in case of a RIG
  30486. */
  30487. interaxialDistance: number;
  30488. /**
  30489. * Defines if stereoscopic rendering is done side by side or over under.
  30490. */
  30491. isStereoscopicSideBySide: boolean;
  30492. /**
  30493. * 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
  30494. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  30495. * else in the scene. (Eg. security camera)
  30496. *
  30497. * 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)
  30498. */
  30499. customRenderTargets: import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture[];
  30500. /**
  30501. * When set, the camera will render to this render target instead of the default canvas
  30502. *
  30503. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  30504. */
  30505. outputRenderTarget: Nullable<RenderTargetTexture>;
  30506. /**
  30507. * Observable triggered when the camera view matrix has changed.
  30508. */
  30509. onViewMatrixChangedObservable: Observable<Camera>;
  30510. /**
  30511. * Observable triggered when the camera Projection matrix has changed.
  30512. */
  30513. onProjectionMatrixChangedObservable: Observable<Camera>;
  30514. /**
  30515. * Observable triggered when the inputs have been processed.
  30516. */
  30517. onAfterCheckInputsObservable: Observable<Camera>;
  30518. /**
  30519. * Observable triggered when reset has been called and applied to the camera.
  30520. */
  30521. onRestoreStateObservable: Observable<Camera>;
  30522. /**
  30523. * Is this camera a part of a rig system?
  30524. */
  30525. isRigCamera: boolean;
  30526. /**
  30527. * If isRigCamera set to true this will be set with the parent camera.
  30528. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  30529. */
  30530. rigParent?: Camera;
  30531. /** @hidden */
  30532. _cameraRigParams: any;
  30533. /** @hidden */
  30534. _rigCameras: Camera[];
  30535. /** @hidden */
  30536. _rigPostProcess: Nullable<PostProcess>;
  30537. protected _webvrViewMatrix: Matrix;
  30538. /** @hidden */
  30539. _skipRendering: boolean;
  30540. /** @hidden */
  30541. _projectionMatrix: Matrix;
  30542. /** @hidden */
  30543. _postProcesses: Nullable<import("babylonjs/PostProcesses/postProcess").PostProcess>[];
  30544. /** @hidden */
  30545. _activeMeshes: SmartArray<AbstractMesh>;
  30546. protected _globalPosition: Vector3;
  30547. /** @hidden */
  30548. _computedViewMatrix: Matrix;
  30549. private _doNotComputeProjectionMatrix;
  30550. private _transformMatrix;
  30551. private _frustumPlanes;
  30552. private _refreshFrustumPlanes;
  30553. private _storedFov;
  30554. private _stateStored;
  30555. /**
  30556. * Instantiates a new camera object.
  30557. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  30558. * @see https://doc.babylonjs.com/features/cameras
  30559. * @param name Defines the name of the camera in the scene
  30560. * @param position Defines the position of the camera
  30561. * @param scene Defines the scene the camera belongs too
  30562. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  30563. */
  30564. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  30565. /**
  30566. * Store current camera state (fov, position, etc..)
  30567. * @returns the camera
  30568. */
  30569. storeState(): Camera;
  30570. /**
  30571. * Restores the camera state values if it has been stored. You must call storeState() first
  30572. */
  30573. protected _restoreStateValues(): boolean;
  30574. /**
  30575. * Restored camera state. You must call storeState() first.
  30576. * @returns true if restored and false otherwise
  30577. */
  30578. restoreState(): boolean;
  30579. /**
  30580. * Gets the class name of the camera.
  30581. * @returns the class name
  30582. */
  30583. getClassName(): string;
  30584. /** @hidden */
  30585. readonly _isCamera: boolean;
  30586. /**
  30587. * Gets a string representation of the camera useful for debug purpose.
  30588. * @param fullDetails Defines that a more verboe level of logging is required
  30589. * @returns the string representation
  30590. */
  30591. toString(fullDetails?: boolean): string;
  30592. /**
  30593. * Gets the current world space position of the camera.
  30594. */
  30595. get globalPosition(): Vector3;
  30596. /**
  30597. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  30598. * @returns the active meshe list
  30599. */
  30600. getActiveMeshes(): SmartArray<AbstractMesh>;
  30601. /**
  30602. * Check whether a mesh is part of the current active mesh list of the camera
  30603. * @param mesh Defines the mesh to check
  30604. * @returns true if active, false otherwise
  30605. */
  30606. isActiveMesh(mesh: Mesh): boolean;
  30607. /**
  30608. * Is this camera ready to be used/rendered
  30609. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  30610. * @return true if the camera is ready
  30611. */
  30612. isReady(completeCheck?: boolean): boolean;
  30613. /** @hidden */
  30614. _initCache(): void;
  30615. /** @hidden */
  30616. _updateCache(ignoreParentClass?: boolean): void;
  30617. /** @hidden */
  30618. _isSynchronized(): boolean;
  30619. /** @hidden */
  30620. _isSynchronizedViewMatrix(): boolean;
  30621. /** @hidden */
  30622. _isSynchronizedProjectionMatrix(): boolean;
  30623. /**
  30624. * Attach the input controls to a specific dom element to get the input from.
  30625. * @param element Defines the element the controls should be listened from
  30626. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  30627. */
  30628. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  30629. /**
  30630. * Detach the current controls from the specified dom element.
  30631. * @param element Defines the element to stop listening the inputs from
  30632. */
  30633. detachControl(element: HTMLElement): void;
  30634. /**
  30635. * Update the camera state according to the different inputs gathered during the frame.
  30636. */
  30637. update(): void;
  30638. /** @hidden */
  30639. _checkInputs(): void;
  30640. /** @hidden */
  30641. get rigCameras(): Camera[];
  30642. /**
  30643. * Gets the post process used by the rig cameras
  30644. */
  30645. get rigPostProcess(): Nullable<PostProcess>;
  30646. /**
  30647. * Internal, gets the first post proces.
  30648. * @returns the first post process to be run on this camera.
  30649. */
  30650. _getFirstPostProcess(): Nullable<PostProcess>;
  30651. private _cascadePostProcessesToRigCams;
  30652. /**
  30653. * Attach a post process to the camera.
  30654. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  30655. * @param postProcess The post process to attach to the camera
  30656. * @param insertAt The position of the post process in case several of them are in use in the scene
  30657. * @returns the position the post process has been inserted at
  30658. */
  30659. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  30660. /**
  30661. * Detach a post process to the camera.
  30662. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  30663. * @param postProcess The post process to detach from the camera
  30664. */
  30665. detachPostProcess(postProcess: PostProcess): void;
  30666. /**
  30667. * Gets the current world matrix of the camera
  30668. */
  30669. getWorldMatrix(): Matrix;
  30670. /** @hidden */
  30671. _getViewMatrix(): Matrix;
  30672. /**
  30673. * Gets the current view matrix of the camera.
  30674. * @param force forces the camera to recompute the matrix without looking at the cached state
  30675. * @returns the view matrix
  30676. */
  30677. getViewMatrix(force?: boolean): Matrix;
  30678. /**
  30679. * Freeze the projection matrix.
  30680. * It will prevent the cache check of the camera projection compute and can speed up perf
  30681. * if no parameter of the camera are meant to change
  30682. * @param projection Defines manually a projection if necessary
  30683. */
  30684. freezeProjectionMatrix(projection?: Matrix): void;
  30685. /**
  30686. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  30687. */
  30688. unfreezeProjectionMatrix(): void;
  30689. /**
  30690. * Gets the current projection matrix of the camera.
  30691. * @param force forces the camera to recompute the matrix without looking at the cached state
  30692. * @returns the projection matrix
  30693. */
  30694. getProjectionMatrix(force?: boolean): Matrix;
  30695. /**
  30696. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  30697. * @returns a Matrix
  30698. */
  30699. getTransformationMatrix(): Matrix;
  30700. private _updateFrustumPlanes;
  30701. /**
  30702. * Checks if a cullable object (mesh...) is in the camera frustum
  30703. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  30704. * @param target The object to check
  30705. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  30706. * @returns true if the object is in frustum otherwise false
  30707. */
  30708. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  30709. /**
  30710. * Checks if a cullable object (mesh...) is in the camera frustum
  30711. * Unlike isInFrustum this cheks the full bounding box
  30712. * @param target The object to check
  30713. * @returns true if the object is in frustum otherwise false
  30714. */
  30715. isCompletelyInFrustum(target: ICullable): boolean;
  30716. /**
  30717. * Gets a ray in the forward direction from the camera.
  30718. * @param length Defines the length of the ray to create
  30719. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  30720. * @param origin Defines the start point of the ray which defaults to the camera position
  30721. * @returns the forward ray
  30722. */
  30723. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  30724. /**
  30725. * Gets a ray in the forward direction from the camera.
  30726. * @param refRay the ray to (re)use when setting the values
  30727. * @param length Defines the length of the ray to create
  30728. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  30729. * @param origin Defines the start point of the ray which defaults to the camera position
  30730. * @returns the forward ray
  30731. */
  30732. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  30733. /**
  30734. * Releases resources associated with this node.
  30735. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  30736. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  30737. */
  30738. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  30739. /** @hidden */
  30740. _isLeftCamera: boolean;
  30741. /**
  30742. * Gets the left camera of a rig setup in case of Rigged Camera
  30743. */
  30744. get isLeftCamera(): boolean;
  30745. /** @hidden */
  30746. _isRightCamera: boolean;
  30747. /**
  30748. * Gets the right camera of a rig setup in case of Rigged Camera
  30749. */
  30750. get isRightCamera(): boolean;
  30751. /**
  30752. * Gets the left camera of a rig setup in case of Rigged Camera
  30753. */
  30754. get leftCamera(): Nullable<FreeCamera>;
  30755. /**
  30756. * Gets the right camera of a rig setup in case of Rigged Camera
  30757. */
  30758. get rightCamera(): Nullable<FreeCamera>;
  30759. /**
  30760. * Gets the left camera target of a rig setup in case of Rigged Camera
  30761. * @returns the target position
  30762. */
  30763. getLeftTarget(): Nullable<Vector3>;
  30764. /**
  30765. * Gets the right camera target of a rig setup in case of Rigged Camera
  30766. * @returns the target position
  30767. */
  30768. getRightTarget(): Nullable<Vector3>;
  30769. /**
  30770. * @hidden
  30771. */
  30772. setCameraRigMode(mode: number, rigParams: any): void;
  30773. /** @hidden */
  30774. static _setStereoscopicRigMode(camera: Camera): void;
  30775. /** @hidden */
  30776. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  30777. /** @hidden */
  30778. static _setVRRigMode(camera: Camera, rigParams: any): void;
  30779. /** @hidden */
  30780. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  30781. /** @hidden */
  30782. _getVRProjectionMatrix(): Matrix;
  30783. protected _updateCameraRotationMatrix(): void;
  30784. protected _updateWebVRCameraRotationMatrix(): void;
  30785. /**
  30786. * This function MUST be overwritten by the different WebVR cameras available.
  30787. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  30788. * @hidden
  30789. */
  30790. _getWebVRProjectionMatrix(): Matrix;
  30791. /**
  30792. * This function MUST be overwritten by the different WebVR cameras available.
  30793. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  30794. * @hidden
  30795. */
  30796. _getWebVRViewMatrix(): Matrix;
  30797. /** @hidden */
  30798. setCameraRigParameter(name: string, value: any): void;
  30799. /**
  30800. * needs to be overridden by children so sub has required properties to be copied
  30801. * @hidden
  30802. */
  30803. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  30804. /**
  30805. * May need to be overridden by children
  30806. * @hidden
  30807. */
  30808. _updateRigCameras(): void;
  30809. /** @hidden */
  30810. _setupInputs(): void;
  30811. /**
  30812. * Serialiaze the camera setup to a json represention
  30813. * @returns the JSON representation
  30814. */
  30815. serialize(): any;
  30816. /**
  30817. * Clones the current camera.
  30818. * @param name The cloned camera name
  30819. * @returns the cloned camera
  30820. */
  30821. clone(name: string): Camera;
  30822. /**
  30823. * Gets the direction of the camera relative to a given local axis.
  30824. * @param localAxis Defines the reference axis to provide a relative direction.
  30825. * @return the direction
  30826. */
  30827. getDirection(localAxis: Vector3): Vector3;
  30828. /**
  30829. * Returns the current camera absolute rotation
  30830. */
  30831. get absoluteRotation(): Quaternion;
  30832. /**
  30833. * Gets the direction of the camera relative to a given local axis into a passed vector.
  30834. * @param localAxis Defines the reference axis to provide a relative direction.
  30835. * @param result Defines the vector to store the result in
  30836. */
  30837. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  30838. /**
  30839. * Gets a camera constructor for a given camera type
  30840. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  30841. * @param name The name of the camera the result will be able to instantiate
  30842. * @param scene The scene the result will construct the camera in
  30843. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  30844. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  30845. * @returns a factory method to construc the camera
  30846. */
  30847. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  30848. /**
  30849. * Compute the world matrix of the camera.
  30850. * @returns the camera world matrix
  30851. */
  30852. computeWorldMatrix(): Matrix;
  30853. /**
  30854. * Parse a JSON and creates the camera from the parsed information
  30855. * @param parsedCamera The JSON to parse
  30856. * @param scene The scene to instantiate the camera in
  30857. * @returns the newly constructed camera
  30858. */
  30859. static Parse(parsedCamera: any, scene: Scene): Camera;
  30860. }
  30861. }
  30862. declare module "babylonjs/Meshes/Builders/discBuilder" {
  30863. import { Nullable } from "babylonjs/types";
  30864. import { Scene } from "babylonjs/scene";
  30865. import { Vector4 } from "babylonjs/Maths/math.vector";
  30866. import { Mesh } from "babylonjs/Meshes/mesh";
  30867. /**
  30868. * Class containing static functions to help procedurally build meshes
  30869. */
  30870. export class DiscBuilder {
  30871. /**
  30872. * Creates a plane polygonal mesh. By default, this is a disc
  30873. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  30874. * * 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
  30875. * * 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
  30876. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  30877. * * 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
  30878. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30879. * @param name defines the name of the mesh
  30880. * @param options defines the options used to create the mesh
  30881. * @param scene defines the hosting scene
  30882. * @returns the plane polygonal mesh
  30883. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  30884. */
  30885. static CreateDisc(name: string, options: {
  30886. radius?: number;
  30887. tessellation?: number;
  30888. arc?: number;
  30889. updatable?: boolean;
  30890. sideOrientation?: number;
  30891. frontUVs?: Vector4;
  30892. backUVs?: Vector4;
  30893. }, scene?: Nullable<Scene>): Mesh;
  30894. }
  30895. }
  30896. declare module "babylonjs/Materials/fresnelParameters" {
  30897. import { DeepImmutable } from "babylonjs/types";
  30898. import { Color3 } from "babylonjs/Maths/math.color";
  30899. /**
  30900. * Options to be used when creating a FresnelParameters.
  30901. */
  30902. export type IFresnelParametersCreationOptions = {
  30903. /**
  30904. * Define the color used on edges (grazing angle)
  30905. */
  30906. leftColor?: Color3;
  30907. /**
  30908. * Define the color used on center
  30909. */
  30910. rightColor?: Color3;
  30911. /**
  30912. * Define bias applied to computed fresnel term
  30913. */
  30914. bias?: number;
  30915. /**
  30916. * Defined the power exponent applied to fresnel term
  30917. */
  30918. power?: number;
  30919. /**
  30920. * Define if the fresnel effect is enable or not.
  30921. */
  30922. isEnabled?: boolean;
  30923. };
  30924. /**
  30925. * Serialized format for FresnelParameters.
  30926. */
  30927. export type IFresnelParametersSerialized = {
  30928. /**
  30929. * Define the color used on edges (grazing angle) [as an array]
  30930. */
  30931. leftColor: number[];
  30932. /**
  30933. * Define the color used on center [as an array]
  30934. */
  30935. rightColor: number[];
  30936. /**
  30937. * Define bias applied to computed fresnel term
  30938. */
  30939. bias: number;
  30940. /**
  30941. * Defined the power exponent applied to fresnel term
  30942. */
  30943. power?: number;
  30944. /**
  30945. * Define if the fresnel effect is enable or not.
  30946. */
  30947. isEnabled: boolean;
  30948. };
  30949. /**
  30950. * This represents all the required information to add a fresnel effect on a material:
  30951. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  30952. */
  30953. export class FresnelParameters {
  30954. private _isEnabled;
  30955. /**
  30956. * Define if the fresnel effect is enable or not.
  30957. */
  30958. get isEnabled(): boolean;
  30959. set isEnabled(value: boolean);
  30960. /**
  30961. * Define the color used on edges (grazing angle)
  30962. */
  30963. leftColor: Color3;
  30964. /**
  30965. * Define the color used on center
  30966. */
  30967. rightColor: Color3;
  30968. /**
  30969. * Define bias applied to computed fresnel term
  30970. */
  30971. bias: number;
  30972. /**
  30973. * Defined the power exponent applied to fresnel term
  30974. */
  30975. power: number;
  30976. /**
  30977. * Creates a new FresnelParameters object.
  30978. *
  30979. * @param options provide your own settings to optionally to override defaults
  30980. */
  30981. constructor(options?: IFresnelParametersCreationOptions);
  30982. /**
  30983. * Clones the current fresnel and its valuues
  30984. * @returns a clone fresnel configuration
  30985. */
  30986. clone(): FresnelParameters;
  30987. /**
  30988. * Determines equality between FresnelParameters objects
  30989. * @param otherFresnelParameters defines the second operand
  30990. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  30991. */
  30992. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  30993. /**
  30994. * Serializes the current fresnel parameters to a JSON representation.
  30995. * @return the JSON serialization
  30996. */
  30997. serialize(): IFresnelParametersSerialized;
  30998. /**
  30999. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  31000. * @param parsedFresnelParameters Define the JSON representation
  31001. * @returns the parsed parameters
  31002. */
  31003. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  31004. }
  31005. }
  31006. declare module "babylonjs/Materials/materialFlags" {
  31007. /**
  31008. * This groups all the flags used to control the materials channel.
  31009. */
  31010. export class MaterialFlags {
  31011. private static _DiffuseTextureEnabled;
  31012. /**
  31013. * Are diffuse textures enabled in the application.
  31014. */
  31015. static get DiffuseTextureEnabled(): boolean;
  31016. static set DiffuseTextureEnabled(value: boolean);
  31017. private static _DetailTextureEnabled;
  31018. /**
  31019. * Are detail textures enabled in the application.
  31020. */
  31021. static get DetailTextureEnabled(): boolean;
  31022. static set DetailTextureEnabled(value: boolean);
  31023. private static _AmbientTextureEnabled;
  31024. /**
  31025. * Are ambient textures enabled in the application.
  31026. */
  31027. static get AmbientTextureEnabled(): boolean;
  31028. static set AmbientTextureEnabled(value: boolean);
  31029. private static _OpacityTextureEnabled;
  31030. /**
  31031. * Are opacity textures enabled in the application.
  31032. */
  31033. static get OpacityTextureEnabled(): boolean;
  31034. static set OpacityTextureEnabled(value: boolean);
  31035. private static _ReflectionTextureEnabled;
  31036. /**
  31037. * Are reflection textures enabled in the application.
  31038. */
  31039. static get ReflectionTextureEnabled(): boolean;
  31040. static set ReflectionTextureEnabled(value: boolean);
  31041. private static _EmissiveTextureEnabled;
  31042. /**
  31043. * Are emissive textures enabled in the application.
  31044. */
  31045. static get EmissiveTextureEnabled(): boolean;
  31046. static set EmissiveTextureEnabled(value: boolean);
  31047. private static _SpecularTextureEnabled;
  31048. /**
  31049. * Are specular textures enabled in the application.
  31050. */
  31051. static get SpecularTextureEnabled(): boolean;
  31052. static set SpecularTextureEnabled(value: boolean);
  31053. private static _BumpTextureEnabled;
  31054. /**
  31055. * Are bump textures enabled in the application.
  31056. */
  31057. static get BumpTextureEnabled(): boolean;
  31058. static set BumpTextureEnabled(value: boolean);
  31059. private static _LightmapTextureEnabled;
  31060. /**
  31061. * Are lightmap textures enabled in the application.
  31062. */
  31063. static get LightmapTextureEnabled(): boolean;
  31064. static set LightmapTextureEnabled(value: boolean);
  31065. private static _RefractionTextureEnabled;
  31066. /**
  31067. * Are refraction textures enabled in the application.
  31068. */
  31069. static get RefractionTextureEnabled(): boolean;
  31070. static set RefractionTextureEnabled(value: boolean);
  31071. private static _ColorGradingTextureEnabled;
  31072. /**
  31073. * Are color grading textures enabled in the application.
  31074. */
  31075. static get ColorGradingTextureEnabled(): boolean;
  31076. static set ColorGradingTextureEnabled(value: boolean);
  31077. private static _FresnelEnabled;
  31078. /**
  31079. * Are fresnels enabled in the application.
  31080. */
  31081. static get FresnelEnabled(): boolean;
  31082. static set FresnelEnabled(value: boolean);
  31083. private static _ClearCoatTextureEnabled;
  31084. /**
  31085. * Are clear coat textures enabled in the application.
  31086. */
  31087. static get ClearCoatTextureEnabled(): boolean;
  31088. static set ClearCoatTextureEnabled(value: boolean);
  31089. private static _ClearCoatBumpTextureEnabled;
  31090. /**
  31091. * Are clear coat bump textures enabled in the application.
  31092. */
  31093. static get ClearCoatBumpTextureEnabled(): boolean;
  31094. static set ClearCoatBumpTextureEnabled(value: boolean);
  31095. private static _ClearCoatTintTextureEnabled;
  31096. /**
  31097. * Are clear coat tint textures enabled in the application.
  31098. */
  31099. static get ClearCoatTintTextureEnabled(): boolean;
  31100. static set ClearCoatTintTextureEnabled(value: boolean);
  31101. private static _SheenTextureEnabled;
  31102. /**
  31103. * Are sheen textures enabled in the application.
  31104. */
  31105. static get SheenTextureEnabled(): boolean;
  31106. static set SheenTextureEnabled(value: boolean);
  31107. private static _AnisotropicTextureEnabled;
  31108. /**
  31109. * Are anisotropic textures enabled in the application.
  31110. */
  31111. static get AnisotropicTextureEnabled(): boolean;
  31112. static set AnisotropicTextureEnabled(value: boolean);
  31113. private static _ThicknessTextureEnabled;
  31114. /**
  31115. * Are thickness textures enabled in the application.
  31116. */
  31117. static get ThicknessTextureEnabled(): boolean;
  31118. static set ThicknessTextureEnabled(value: boolean);
  31119. }
  31120. }
  31121. declare module "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration" {
  31122. /** @hidden */
  31123. export var defaultFragmentDeclaration: {
  31124. name: string;
  31125. shader: string;
  31126. };
  31127. }
  31128. declare module "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration" {
  31129. /** @hidden */
  31130. export var defaultUboDeclaration: {
  31131. name: string;
  31132. shader: string;
  31133. };
  31134. }
  31135. declare module "babylonjs/Shaders/ShadersInclude/prePassDeclaration" {
  31136. /** @hidden */
  31137. export var prePassDeclaration: {
  31138. name: string;
  31139. shader: string;
  31140. };
  31141. }
  31142. declare module "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration" {
  31143. /** @hidden */
  31144. export var lightFragmentDeclaration: {
  31145. name: string;
  31146. shader: string;
  31147. };
  31148. }
  31149. declare module "babylonjs/Shaders/ShadersInclude/lightUboDeclaration" {
  31150. /** @hidden */
  31151. export var lightUboDeclaration: {
  31152. name: string;
  31153. shader: string;
  31154. };
  31155. }
  31156. declare module "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions" {
  31157. /** @hidden */
  31158. export var lightsFragmentFunctions: {
  31159. name: string;
  31160. shader: string;
  31161. };
  31162. }
  31163. declare module "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions" {
  31164. /** @hidden */
  31165. export var shadowsFragmentFunctions: {
  31166. name: string;
  31167. shader: string;
  31168. };
  31169. }
  31170. declare module "babylonjs/Shaders/ShadersInclude/fresnelFunction" {
  31171. /** @hidden */
  31172. export var fresnelFunction: {
  31173. name: string;
  31174. shader: string;
  31175. };
  31176. }
  31177. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions" {
  31178. /** @hidden */
  31179. export var bumpFragmentMainFunctions: {
  31180. name: string;
  31181. shader: string;
  31182. };
  31183. }
  31184. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions" {
  31185. /** @hidden */
  31186. export var bumpFragmentFunctions: {
  31187. name: string;
  31188. shader: string;
  31189. };
  31190. }
  31191. declare module "babylonjs/Shaders/ShadersInclude/logDepthDeclaration" {
  31192. /** @hidden */
  31193. export var logDepthDeclaration: {
  31194. name: string;
  31195. shader: string;
  31196. };
  31197. }
  31198. declare module "babylonjs/Shaders/ShadersInclude/bumpFragment" {
  31199. /** @hidden */
  31200. export var bumpFragment: {
  31201. name: string;
  31202. shader: string;
  31203. };
  31204. }
  31205. declare module "babylonjs/Shaders/ShadersInclude/depthPrePass" {
  31206. /** @hidden */
  31207. export var depthPrePass: {
  31208. name: string;
  31209. shader: string;
  31210. };
  31211. }
  31212. declare module "babylonjs/Shaders/ShadersInclude/lightFragment" {
  31213. /** @hidden */
  31214. export var lightFragment: {
  31215. name: string;
  31216. shader: string;
  31217. };
  31218. }
  31219. declare module "babylonjs/Shaders/ShadersInclude/logDepthFragment" {
  31220. /** @hidden */
  31221. export var logDepthFragment: {
  31222. name: string;
  31223. shader: string;
  31224. };
  31225. }
  31226. declare module "babylonjs/Shaders/default.fragment" {
  31227. import "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration";
  31228. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  31229. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  31230. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  31231. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  31232. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  31233. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  31234. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  31235. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  31236. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  31237. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  31238. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  31239. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  31240. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  31241. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  31242. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  31243. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  31244. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  31245. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  31246. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  31247. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  31248. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  31249. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  31250. /** @hidden */
  31251. export var defaultPixelShader: {
  31252. name: string;
  31253. shader: string;
  31254. };
  31255. }
  31256. declare module "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration" {
  31257. /** @hidden */
  31258. export var defaultVertexDeclaration: {
  31259. name: string;
  31260. shader: string;
  31261. };
  31262. }
  31263. declare module "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration" {
  31264. /** @hidden */
  31265. export var bumpVertexDeclaration: {
  31266. name: string;
  31267. shader: string;
  31268. };
  31269. }
  31270. declare module "babylonjs/Shaders/ShadersInclude/bumpVertex" {
  31271. /** @hidden */
  31272. export var bumpVertex: {
  31273. name: string;
  31274. shader: string;
  31275. };
  31276. }
  31277. declare module "babylonjs/Shaders/ShadersInclude/fogVertex" {
  31278. /** @hidden */
  31279. export var fogVertex: {
  31280. name: string;
  31281. shader: string;
  31282. };
  31283. }
  31284. declare module "babylonjs/Shaders/ShadersInclude/shadowsVertex" {
  31285. /** @hidden */
  31286. export var shadowsVertex: {
  31287. name: string;
  31288. shader: string;
  31289. };
  31290. }
  31291. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertex" {
  31292. /** @hidden */
  31293. export var pointCloudVertex: {
  31294. name: string;
  31295. shader: string;
  31296. };
  31297. }
  31298. declare module "babylonjs/Shaders/ShadersInclude/logDepthVertex" {
  31299. /** @hidden */
  31300. export var logDepthVertex: {
  31301. name: string;
  31302. shader: string;
  31303. };
  31304. }
  31305. declare module "babylonjs/Shaders/default.vertex" {
  31306. import "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration";
  31307. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  31308. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  31309. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  31310. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  31311. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  31312. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  31313. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  31314. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  31315. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  31316. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  31317. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  31318. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  31319. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  31320. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  31321. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  31322. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  31323. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  31324. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  31325. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  31326. import "babylonjs/Shaders/ShadersInclude/pointCloudVertex";
  31327. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  31328. /** @hidden */
  31329. export var defaultVertexShader: {
  31330. name: string;
  31331. shader: string;
  31332. };
  31333. }
  31334. declare module "babylonjs/Materials/material.detailMapConfiguration" {
  31335. import { Nullable } from "babylonjs/types";
  31336. import { Scene } from "babylonjs/scene";
  31337. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31338. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  31339. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  31340. /**
  31341. * @hidden
  31342. */
  31343. export interface IMaterialDetailMapDefines {
  31344. DETAIL: boolean;
  31345. DETAILDIRECTUV: number;
  31346. DETAIL_NORMALBLENDMETHOD: number;
  31347. /** @hidden */
  31348. _areTexturesDirty: boolean;
  31349. }
  31350. /**
  31351. * Define the code related to the detail map parameters of a material
  31352. *
  31353. * Inspired from:
  31354. * 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
  31355. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  31356. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  31357. */
  31358. export class DetailMapConfiguration {
  31359. private _texture;
  31360. /**
  31361. * The detail texture of the material.
  31362. */
  31363. texture: Nullable<BaseTexture>;
  31364. /**
  31365. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  31366. * Bigger values mean stronger blending
  31367. */
  31368. diffuseBlendLevel: number;
  31369. /**
  31370. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  31371. * Bigger values mean stronger blending. Only used with PBR materials
  31372. */
  31373. roughnessBlendLevel: number;
  31374. /**
  31375. * Defines how strong the bump effect from the detail map is
  31376. * Bigger values mean stronger effect
  31377. */
  31378. bumpLevel: number;
  31379. private _normalBlendMethod;
  31380. /**
  31381. * The method used to blend the bump and detail normals together
  31382. */
  31383. normalBlendMethod: number;
  31384. private _isEnabled;
  31385. /**
  31386. * Enable or disable the detail map on this material
  31387. */
  31388. isEnabled: boolean;
  31389. /** @hidden */
  31390. private _internalMarkAllSubMeshesAsTexturesDirty;
  31391. /** @hidden */
  31392. _markAllSubMeshesAsTexturesDirty(): void;
  31393. /**
  31394. * Instantiate a new detail map
  31395. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  31396. */
  31397. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  31398. /**
  31399. * Gets whether the submesh is ready to be used or not.
  31400. * @param defines the list of "defines" to update.
  31401. * @param scene defines the scene the material belongs to.
  31402. * @returns - boolean indicating that the submesh is ready or not.
  31403. */
  31404. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  31405. /**
  31406. * Update the defines for detail map usage
  31407. * @param defines the list of "defines" to update.
  31408. * @param scene defines the scene the material belongs to.
  31409. */
  31410. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  31411. /**
  31412. * Binds the material data.
  31413. * @param uniformBuffer defines the Uniform buffer to fill in.
  31414. * @param scene defines the scene the material belongs to.
  31415. * @param isFrozen defines whether the material is frozen or not.
  31416. */
  31417. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  31418. /**
  31419. * Checks to see if a texture is used in the material.
  31420. * @param texture - Base texture to use.
  31421. * @returns - Boolean specifying if a texture is used in the material.
  31422. */
  31423. hasTexture(texture: BaseTexture): boolean;
  31424. /**
  31425. * Returns an array of the actively used textures.
  31426. * @param activeTextures Array of BaseTextures
  31427. */
  31428. getActiveTextures(activeTextures: BaseTexture[]): void;
  31429. /**
  31430. * Returns the animatable textures.
  31431. * @param animatables Array of animatable textures.
  31432. */
  31433. getAnimatables(animatables: IAnimatable[]): void;
  31434. /**
  31435. * Disposes the resources of the material.
  31436. * @param forceDisposeTextures - Forces the disposal of all textures.
  31437. */
  31438. dispose(forceDisposeTextures?: boolean): void;
  31439. /**
  31440. * Get the current class name useful for serialization or dynamic coding.
  31441. * @returns "DetailMap"
  31442. */
  31443. getClassName(): string;
  31444. /**
  31445. * Add the required uniforms to the current list.
  31446. * @param uniforms defines the current uniform list.
  31447. */
  31448. static AddUniforms(uniforms: string[]): void;
  31449. /**
  31450. * Add the required samplers to the current list.
  31451. * @param samplers defines the current sampler list.
  31452. */
  31453. static AddSamplers(samplers: string[]): void;
  31454. /**
  31455. * Add the required uniforms to the current buffer.
  31456. * @param uniformBuffer defines the current uniform buffer.
  31457. */
  31458. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  31459. /**
  31460. * Makes a duplicate of the current instance into another one.
  31461. * @param detailMap define the instance where to copy the info
  31462. */
  31463. copyTo(detailMap: DetailMapConfiguration): void;
  31464. /**
  31465. * Serializes this detail map instance
  31466. * @returns - An object with the serialized instance.
  31467. */
  31468. serialize(): any;
  31469. /**
  31470. * Parses a detail map setting from a serialized object.
  31471. * @param source - Serialized object.
  31472. * @param scene Defines the scene we are parsing for
  31473. * @param rootUrl Defines the rootUrl to load from
  31474. */
  31475. parse(source: any, scene: Scene, rootUrl: string): void;
  31476. }
  31477. }
  31478. declare module "babylonjs/Materials/standardMaterial" {
  31479. import { SmartArray } from "babylonjs/Misc/smartArray";
  31480. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  31481. import { Nullable } from "babylonjs/types";
  31482. import { Scene } from "babylonjs/scene";
  31483. import { Matrix } from "babylonjs/Maths/math.vector";
  31484. import { Color3 } from "babylonjs/Maths/math.color";
  31485. import { SubMesh } from "babylonjs/Meshes/subMesh";
  31486. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  31487. import { Mesh } from "babylonjs/Meshes/mesh";
  31488. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  31489. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  31490. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  31491. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  31492. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  31493. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31494. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  31495. import "babylonjs/Shaders/default.fragment";
  31496. import "babylonjs/Shaders/default.vertex";
  31497. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  31498. /** @hidden */
  31499. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  31500. MAINUV1: boolean;
  31501. MAINUV2: boolean;
  31502. DIFFUSE: boolean;
  31503. DIFFUSEDIRECTUV: number;
  31504. DETAIL: boolean;
  31505. DETAILDIRECTUV: number;
  31506. DETAIL_NORMALBLENDMETHOD: number;
  31507. AMBIENT: boolean;
  31508. AMBIENTDIRECTUV: number;
  31509. OPACITY: boolean;
  31510. OPACITYDIRECTUV: number;
  31511. OPACITYRGB: boolean;
  31512. REFLECTION: boolean;
  31513. EMISSIVE: boolean;
  31514. EMISSIVEDIRECTUV: number;
  31515. SPECULAR: boolean;
  31516. SPECULARDIRECTUV: number;
  31517. BUMP: boolean;
  31518. BUMPDIRECTUV: number;
  31519. PARALLAX: boolean;
  31520. PARALLAXOCCLUSION: boolean;
  31521. SPECULAROVERALPHA: boolean;
  31522. CLIPPLANE: boolean;
  31523. CLIPPLANE2: boolean;
  31524. CLIPPLANE3: boolean;
  31525. CLIPPLANE4: boolean;
  31526. CLIPPLANE5: boolean;
  31527. CLIPPLANE6: boolean;
  31528. ALPHATEST: boolean;
  31529. DEPTHPREPASS: boolean;
  31530. ALPHAFROMDIFFUSE: boolean;
  31531. POINTSIZE: boolean;
  31532. FOG: boolean;
  31533. SPECULARTERM: boolean;
  31534. DIFFUSEFRESNEL: boolean;
  31535. OPACITYFRESNEL: boolean;
  31536. REFLECTIONFRESNEL: boolean;
  31537. REFRACTIONFRESNEL: boolean;
  31538. EMISSIVEFRESNEL: boolean;
  31539. FRESNEL: boolean;
  31540. NORMAL: boolean;
  31541. UV1: boolean;
  31542. UV2: boolean;
  31543. VERTEXCOLOR: boolean;
  31544. VERTEXALPHA: boolean;
  31545. NUM_BONE_INFLUENCERS: number;
  31546. BonesPerMesh: number;
  31547. BONETEXTURE: boolean;
  31548. INSTANCES: boolean;
  31549. THIN_INSTANCES: boolean;
  31550. GLOSSINESS: boolean;
  31551. ROUGHNESS: boolean;
  31552. EMISSIVEASILLUMINATION: boolean;
  31553. LINKEMISSIVEWITHDIFFUSE: boolean;
  31554. REFLECTIONFRESNELFROMSPECULAR: boolean;
  31555. LIGHTMAP: boolean;
  31556. LIGHTMAPDIRECTUV: number;
  31557. OBJECTSPACE_NORMALMAP: boolean;
  31558. USELIGHTMAPASSHADOWMAP: boolean;
  31559. REFLECTIONMAP_3D: boolean;
  31560. REFLECTIONMAP_SPHERICAL: boolean;
  31561. REFLECTIONMAP_PLANAR: boolean;
  31562. REFLECTIONMAP_CUBIC: boolean;
  31563. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  31564. REFLECTIONMAP_PROJECTION: boolean;
  31565. REFLECTIONMAP_SKYBOX: boolean;
  31566. REFLECTIONMAP_EXPLICIT: boolean;
  31567. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  31568. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  31569. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  31570. INVERTCUBICMAP: boolean;
  31571. LOGARITHMICDEPTH: boolean;
  31572. REFRACTION: boolean;
  31573. REFRACTIONMAP_3D: boolean;
  31574. REFLECTIONOVERALPHA: boolean;
  31575. TWOSIDEDLIGHTING: boolean;
  31576. SHADOWFLOAT: boolean;
  31577. MORPHTARGETS: boolean;
  31578. MORPHTARGETS_NORMAL: boolean;
  31579. MORPHTARGETS_TANGENT: boolean;
  31580. MORPHTARGETS_UV: boolean;
  31581. NUM_MORPH_INFLUENCERS: number;
  31582. NONUNIFORMSCALING: boolean;
  31583. PREMULTIPLYALPHA: boolean;
  31584. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  31585. ALPHABLEND: boolean;
  31586. PREPASS: boolean;
  31587. SCENE_MRT_COUNT: number;
  31588. RGBDLIGHTMAP: boolean;
  31589. RGBDREFLECTION: boolean;
  31590. RGBDREFRACTION: boolean;
  31591. IMAGEPROCESSING: boolean;
  31592. VIGNETTE: boolean;
  31593. VIGNETTEBLENDMODEMULTIPLY: boolean;
  31594. VIGNETTEBLENDMODEOPAQUE: boolean;
  31595. TONEMAPPING: boolean;
  31596. TONEMAPPING_ACES: boolean;
  31597. CONTRAST: boolean;
  31598. COLORCURVES: boolean;
  31599. COLORGRADING: boolean;
  31600. COLORGRADING3D: boolean;
  31601. SAMPLER3DGREENDEPTH: boolean;
  31602. SAMPLER3DBGRMAP: boolean;
  31603. IMAGEPROCESSINGPOSTPROCESS: boolean;
  31604. MULTIVIEW: boolean;
  31605. /**
  31606. * If the reflection texture on this material is in linear color space
  31607. * @hidden
  31608. */
  31609. IS_REFLECTION_LINEAR: boolean;
  31610. /**
  31611. * If the refraction texture on this material is in linear color space
  31612. * @hidden
  31613. */
  31614. IS_REFRACTION_LINEAR: boolean;
  31615. EXPOSURE: boolean;
  31616. constructor();
  31617. setReflectionMode(modeToEnable: string): void;
  31618. }
  31619. /**
  31620. * This is the default material used in Babylon. It is the best trade off between quality
  31621. * and performances.
  31622. * @see https://doc.babylonjs.com/babylon101/materials
  31623. */
  31624. export class StandardMaterial extends PushMaterial {
  31625. private _diffuseTexture;
  31626. /**
  31627. * The basic texture of the material as viewed under a light.
  31628. */
  31629. diffuseTexture: Nullable<BaseTexture>;
  31630. private _ambientTexture;
  31631. /**
  31632. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  31633. */
  31634. ambientTexture: Nullable<BaseTexture>;
  31635. private _opacityTexture;
  31636. /**
  31637. * Define the transparency of the material from a texture.
  31638. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  31639. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  31640. */
  31641. opacityTexture: Nullable<BaseTexture>;
  31642. private _reflectionTexture;
  31643. /**
  31644. * Define the texture used to display the reflection.
  31645. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31646. */
  31647. reflectionTexture: Nullable<BaseTexture>;
  31648. private _emissiveTexture;
  31649. /**
  31650. * Define texture of the material as if self lit.
  31651. * This will be mixed in the final result even in the absence of light.
  31652. */
  31653. emissiveTexture: Nullable<BaseTexture>;
  31654. private _specularTexture;
  31655. /**
  31656. * Define how the color and intensity of the highlight given by the light in the material.
  31657. */
  31658. specularTexture: Nullable<BaseTexture>;
  31659. private _bumpTexture;
  31660. /**
  31661. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  31662. * 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.
  31663. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  31664. */
  31665. bumpTexture: Nullable<BaseTexture>;
  31666. private _lightmapTexture;
  31667. /**
  31668. * Complex lighting can be computationally expensive to compute at runtime.
  31669. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  31670. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  31671. */
  31672. lightmapTexture: Nullable<BaseTexture>;
  31673. private _refractionTexture;
  31674. /**
  31675. * Define the texture used to display the refraction.
  31676. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31677. */
  31678. refractionTexture: Nullable<BaseTexture>;
  31679. /**
  31680. * The color of the material lit by the environmental background lighting.
  31681. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  31682. */
  31683. ambientColor: Color3;
  31684. /**
  31685. * The basic color of the material as viewed under a light.
  31686. */
  31687. diffuseColor: Color3;
  31688. /**
  31689. * Define how the color and intensity of the highlight given by the light in the material.
  31690. */
  31691. specularColor: Color3;
  31692. /**
  31693. * Define the color of the material as if self lit.
  31694. * This will be mixed in the final result even in the absence of light.
  31695. */
  31696. emissiveColor: Color3;
  31697. /**
  31698. * Defines how sharp are the highlights in the material.
  31699. * The bigger the value the sharper giving a more glossy feeling to the result.
  31700. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  31701. */
  31702. specularPower: number;
  31703. private _useAlphaFromDiffuseTexture;
  31704. /**
  31705. * Does the transparency come from the diffuse texture alpha channel.
  31706. */
  31707. useAlphaFromDiffuseTexture: boolean;
  31708. private _useEmissiveAsIllumination;
  31709. /**
  31710. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  31711. */
  31712. useEmissiveAsIllumination: boolean;
  31713. private _linkEmissiveWithDiffuse;
  31714. /**
  31715. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  31716. * the emissive level when the final color is close to one.
  31717. */
  31718. linkEmissiveWithDiffuse: boolean;
  31719. private _useSpecularOverAlpha;
  31720. /**
  31721. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  31722. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  31723. */
  31724. useSpecularOverAlpha: boolean;
  31725. private _useReflectionOverAlpha;
  31726. /**
  31727. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  31728. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  31729. */
  31730. useReflectionOverAlpha: boolean;
  31731. private _disableLighting;
  31732. /**
  31733. * Does lights from the scene impacts this material.
  31734. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  31735. */
  31736. disableLighting: boolean;
  31737. private _useObjectSpaceNormalMap;
  31738. /**
  31739. * Allows using an object space normal map (instead of tangent space).
  31740. */
  31741. useObjectSpaceNormalMap: boolean;
  31742. private _useParallax;
  31743. /**
  31744. * Is parallax enabled or not.
  31745. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  31746. */
  31747. useParallax: boolean;
  31748. private _useParallaxOcclusion;
  31749. /**
  31750. * Is parallax occlusion enabled or not.
  31751. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  31752. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  31753. */
  31754. useParallaxOcclusion: boolean;
  31755. /**
  31756. * 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.
  31757. */
  31758. parallaxScaleBias: number;
  31759. private _roughness;
  31760. /**
  31761. * Helps to define how blurry the reflections should appears in the material.
  31762. */
  31763. roughness: number;
  31764. /**
  31765. * In case of refraction, define the value of the index of refraction.
  31766. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31767. */
  31768. indexOfRefraction: number;
  31769. /**
  31770. * Invert the refraction texture alongside the y axis.
  31771. * It can be useful with procedural textures or probe for instance.
  31772. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31773. */
  31774. invertRefractionY: boolean;
  31775. /**
  31776. * Defines the alpha limits in alpha test mode.
  31777. */
  31778. alphaCutOff: number;
  31779. private _useLightmapAsShadowmap;
  31780. /**
  31781. * In case of light mapping, define whether the map contains light or shadow informations.
  31782. */
  31783. useLightmapAsShadowmap: boolean;
  31784. private _diffuseFresnelParameters;
  31785. /**
  31786. * Define the diffuse fresnel parameters of the material.
  31787. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31788. */
  31789. diffuseFresnelParameters: FresnelParameters;
  31790. private _opacityFresnelParameters;
  31791. /**
  31792. * Define the opacity fresnel parameters of the material.
  31793. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31794. */
  31795. opacityFresnelParameters: FresnelParameters;
  31796. private _reflectionFresnelParameters;
  31797. /**
  31798. * Define the reflection fresnel parameters of the material.
  31799. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31800. */
  31801. reflectionFresnelParameters: FresnelParameters;
  31802. private _refractionFresnelParameters;
  31803. /**
  31804. * Define the refraction fresnel parameters of the material.
  31805. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31806. */
  31807. refractionFresnelParameters: FresnelParameters;
  31808. private _emissiveFresnelParameters;
  31809. /**
  31810. * Define the emissive fresnel parameters of the material.
  31811. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31812. */
  31813. emissiveFresnelParameters: FresnelParameters;
  31814. private _useReflectionFresnelFromSpecular;
  31815. /**
  31816. * If true automatically deducts the fresnels values from the material specularity.
  31817. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31818. */
  31819. useReflectionFresnelFromSpecular: boolean;
  31820. private _useGlossinessFromSpecularMapAlpha;
  31821. /**
  31822. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  31823. */
  31824. useGlossinessFromSpecularMapAlpha: boolean;
  31825. private _maxSimultaneousLights;
  31826. /**
  31827. * Defines the maximum number of lights that can be used in the material
  31828. */
  31829. maxSimultaneousLights: number;
  31830. private _invertNormalMapX;
  31831. /**
  31832. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  31833. */
  31834. invertNormalMapX: boolean;
  31835. private _invertNormalMapY;
  31836. /**
  31837. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  31838. */
  31839. invertNormalMapY: boolean;
  31840. private _twoSidedLighting;
  31841. /**
  31842. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  31843. */
  31844. twoSidedLighting: boolean;
  31845. /**
  31846. * Default configuration related to image processing available in the standard Material.
  31847. */
  31848. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  31849. /**
  31850. * Gets the image processing configuration used either in this material.
  31851. */
  31852. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  31853. /**
  31854. * Sets the Default image processing configuration used either in the this material.
  31855. *
  31856. * If sets to null, the scene one is in use.
  31857. */
  31858. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  31859. /**
  31860. * Keep track of the image processing observer to allow dispose and replace.
  31861. */
  31862. private _imageProcessingObserver;
  31863. /**
  31864. * Attaches a new image processing configuration to the Standard Material.
  31865. * @param configuration
  31866. */
  31867. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  31868. /**
  31869. * Gets wether the color curves effect is enabled.
  31870. */
  31871. get cameraColorCurvesEnabled(): boolean;
  31872. /**
  31873. * Sets wether the color curves effect is enabled.
  31874. */
  31875. set cameraColorCurvesEnabled(value: boolean);
  31876. /**
  31877. * Gets wether the color grading effect is enabled.
  31878. */
  31879. get cameraColorGradingEnabled(): boolean;
  31880. /**
  31881. * Gets wether the color grading effect is enabled.
  31882. */
  31883. set cameraColorGradingEnabled(value: boolean);
  31884. /**
  31885. * Gets wether tonemapping is enabled or not.
  31886. */
  31887. get cameraToneMappingEnabled(): boolean;
  31888. /**
  31889. * Sets wether tonemapping is enabled or not
  31890. */
  31891. set cameraToneMappingEnabled(value: boolean);
  31892. /**
  31893. * The camera exposure used on this material.
  31894. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  31895. * This corresponds to a photographic exposure.
  31896. */
  31897. get cameraExposure(): number;
  31898. /**
  31899. * The camera exposure used on this material.
  31900. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  31901. * This corresponds to a photographic exposure.
  31902. */
  31903. set cameraExposure(value: number);
  31904. /**
  31905. * Gets The camera contrast used on this material.
  31906. */
  31907. get cameraContrast(): number;
  31908. /**
  31909. * Sets The camera contrast used on this material.
  31910. */
  31911. set cameraContrast(value: number);
  31912. /**
  31913. * Gets the Color Grading 2D Lookup Texture.
  31914. */
  31915. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  31916. /**
  31917. * Sets the Color Grading 2D Lookup Texture.
  31918. */
  31919. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  31920. /**
  31921. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  31922. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  31923. * 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;
  31924. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  31925. */
  31926. get cameraColorCurves(): Nullable<ColorCurves>;
  31927. /**
  31928. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  31929. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  31930. * 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;
  31931. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  31932. */
  31933. set cameraColorCurves(value: Nullable<ColorCurves>);
  31934. /**
  31935. * Can this material render to several textures at once
  31936. */
  31937. get canRenderToMRT(): boolean;
  31938. /**
  31939. * Defines the detail map parameters for the material.
  31940. */
  31941. readonly detailMap: DetailMapConfiguration;
  31942. protected _renderTargets: SmartArray<RenderTargetTexture>;
  31943. protected _worldViewProjectionMatrix: Matrix;
  31944. protected _globalAmbientColor: Color3;
  31945. protected _useLogarithmicDepth: boolean;
  31946. protected _rebuildInParallel: boolean;
  31947. /**
  31948. * Instantiates a new standard material.
  31949. * This is the default material used in Babylon. It is the best trade off between quality
  31950. * and performances.
  31951. * @see https://doc.babylonjs.com/babylon101/materials
  31952. * @param name Define the name of the material in the scene
  31953. * @param scene Define the scene the material belong to
  31954. */
  31955. constructor(name: string, scene: Scene);
  31956. /**
  31957. * Gets a boolean indicating that current material needs to register RTT
  31958. */
  31959. get hasRenderTargetTextures(): boolean;
  31960. /**
  31961. * Gets the current class name of the material e.g. "StandardMaterial"
  31962. * Mainly use in serialization.
  31963. * @returns the class name
  31964. */
  31965. getClassName(): string;
  31966. /**
  31967. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  31968. * You can try switching to logarithmic depth.
  31969. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  31970. */
  31971. get useLogarithmicDepth(): boolean;
  31972. set useLogarithmicDepth(value: boolean);
  31973. /**
  31974. * Specifies if the material will require alpha blending
  31975. * @returns a boolean specifying if alpha blending is needed
  31976. */
  31977. needAlphaBlending(): boolean;
  31978. /**
  31979. * Specifies if this material should be rendered in alpha test mode
  31980. * @returns a boolean specifying if an alpha test is needed.
  31981. */
  31982. needAlphaTesting(): boolean;
  31983. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  31984. /**
  31985. * Get the texture used for alpha test purpose.
  31986. * @returns the diffuse texture in case of the standard material.
  31987. */
  31988. getAlphaTestTexture(): Nullable<BaseTexture>;
  31989. /**
  31990. * Get if the submesh is ready to be used and all its information available.
  31991. * Child classes can use it to update shaders
  31992. * @param mesh defines the mesh to check
  31993. * @param subMesh defines which submesh to check
  31994. * @param useInstances specifies that instances should be used
  31995. * @returns a boolean indicating that the submesh is ready or not
  31996. */
  31997. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  31998. /**
  31999. * Builds the material UBO layouts.
  32000. * Used internally during the effect preparation.
  32001. */
  32002. buildUniformLayout(): void;
  32003. /**
  32004. * Unbinds the material from the mesh
  32005. */
  32006. unbind(): void;
  32007. /**
  32008. * Binds the submesh to this material by preparing the effect and shader to draw
  32009. * @param world defines the world transformation matrix
  32010. * @param mesh defines the mesh containing the submesh
  32011. * @param subMesh defines the submesh to bind the material to
  32012. */
  32013. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  32014. /**
  32015. * Get the list of animatables in the material.
  32016. * @returns the list of animatables object used in the material
  32017. */
  32018. getAnimatables(): IAnimatable[];
  32019. /**
  32020. * Gets the active textures from the material
  32021. * @returns an array of textures
  32022. */
  32023. getActiveTextures(): BaseTexture[];
  32024. /**
  32025. * Specifies if the material uses a texture
  32026. * @param texture defines the texture to check against the material
  32027. * @returns a boolean specifying if the material uses the texture
  32028. */
  32029. hasTexture(texture: BaseTexture): boolean;
  32030. /**
  32031. * Disposes the material
  32032. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  32033. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  32034. */
  32035. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  32036. /**
  32037. * Makes a duplicate of the material, and gives it a new name
  32038. * @param name defines the new name for the duplicated material
  32039. * @returns the cloned material
  32040. */
  32041. clone(name: string): StandardMaterial;
  32042. /**
  32043. * Serializes this material in a JSON representation
  32044. * @returns the serialized material object
  32045. */
  32046. serialize(): any;
  32047. /**
  32048. * Creates a standard material from parsed material data
  32049. * @param source defines the JSON representation of the material
  32050. * @param scene defines the hosting scene
  32051. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  32052. * @returns a new standard material
  32053. */
  32054. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  32055. /**
  32056. * Are diffuse textures enabled in the application.
  32057. */
  32058. static get DiffuseTextureEnabled(): boolean;
  32059. static set DiffuseTextureEnabled(value: boolean);
  32060. /**
  32061. * Are detail textures enabled in the application.
  32062. */
  32063. static get DetailTextureEnabled(): boolean;
  32064. static set DetailTextureEnabled(value: boolean);
  32065. /**
  32066. * Are ambient textures enabled in the application.
  32067. */
  32068. static get AmbientTextureEnabled(): boolean;
  32069. static set AmbientTextureEnabled(value: boolean);
  32070. /**
  32071. * Are opacity textures enabled in the application.
  32072. */
  32073. static get OpacityTextureEnabled(): boolean;
  32074. static set OpacityTextureEnabled(value: boolean);
  32075. /**
  32076. * Are reflection textures enabled in the application.
  32077. */
  32078. static get ReflectionTextureEnabled(): boolean;
  32079. static set ReflectionTextureEnabled(value: boolean);
  32080. /**
  32081. * Are emissive textures enabled in the application.
  32082. */
  32083. static get EmissiveTextureEnabled(): boolean;
  32084. static set EmissiveTextureEnabled(value: boolean);
  32085. /**
  32086. * Are specular textures enabled in the application.
  32087. */
  32088. static get SpecularTextureEnabled(): boolean;
  32089. static set SpecularTextureEnabled(value: boolean);
  32090. /**
  32091. * Are bump textures enabled in the application.
  32092. */
  32093. static get BumpTextureEnabled(): boolean;
  32094. static set BumpTextureEnabled(value: boolean);
  32095. /**
  32096. * Are lightmap textures enabled in the application.
  32097. */
  32098. static get LightmapTextureEnabled(): boolean;
  32099. static set LightmapTextureEnabled(value: boolean);
  32100. /**
  32101. * Are refraction textures enabled in the application.
  32102. */
  32103. static get RefractionTextureEnabled(): boolean;
  32104. static set RefractionTextureEnabled(value: boolean);
  32105. /**
  32106. * Are color grading textures enabled in the application.
  32107. */
  32108. static get ColorGradingTextureEnabled(): boolean;
  32109. static set ColorGradingTextureEnabled(value: boolean);
  32110. /**
  32111. * Are fresnels enabled in the application.
  32112. */
  32113. static get FresnelEnabled(): boolean;
  32114. static set FresnelEnabled(value: boolean);
  32115. }
  32116. }
  32117. declare module "babylonjs/Particles/solidParticleSystem" {
  32118. import { Nullable } from "babylonjs/types";
  32119. import { Mesh } from "babylonjs/Meshes/mesh";
  32120. import { Scene, IDisposable } from "babylonjs/scene";
  32121. import { DepthSortedParticle, SolidParticle, SolidParticleVertex } from "babylonjs/Particles/solidParticle";
  32122. import { Material } from "babylonjs/Materials/material";
  32123. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  32124. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  32125. /**
  32126. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  32127. *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.
  32128. * The SPS is also a particle system. It provides some methods to manage the particles.
  32129. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  32130. *
  32131. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  32132. */
  32133. export class SolidParticleSystem implements IDisposable {
  32134. /**
  32135. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  32136. * Example : var p = SPS.particles[i];
  32137. */
  32138. particles: SolidParticle[];
  32139. /**
  32140. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  32141. */
  32142. nbParticles: number;
  32143. /**
  32144. * If the particles must ever face the camera (default false). Useful for planar particles.
  32145. */
  32146. billboard: boolean;
  32147. /**
  32148. * Recompute normals when adding a shape
  32149. */
  32150. recomputeNormals: boolean;
  32151. /**
  32152. * This a counter ofr your own usage. It's not set by any SPS functions.
  32153. */
  32154. counter: number;
  32155. /**
  32156. * The SPS name. This name is also given to the underlying mesh.
  32157. */
  32158. name: string;
  32159. /**
  32160. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  32161. */
  32162. mesh: Mesh;
  32163. /**
  32164. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  32165. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  32166. */
  32167. vars: any;
  32168. /**
  32169. * This array is populated when the SPS is set as 'pickable'.
  32170. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  32171. * Each element of this array is an object `{idx: int, faceId: int}`.
  32172. * `idx` is the picked particle index in the `SPS.particles` array
  32173. * `faceId` is the picked face index counted within this particle.
  32174. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  32175. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  32176. * Use the method SPS.pickedParticle(pickingInfo) instead.
  32177. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  32178. */
  32179. pickedParticles: {
  32180. idx: number;
  32181. faceId: number;
  32182. }[];
  32183. /**
  32184. * This array is populated when the SPS is set as 'pickable'
  32185. * Each key of this array is a submesh index.
  32186. * Each element of this array is a second array defined like this :
  32187. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  32188. * Each element of this second array is an object `{idx: int, faceId: int}`.
  32189. * `idx` is the picked particle index in the `SPS.particles` array
  32190. * `faceId` is the picked face index counted within this particle.
  32191. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  32192. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  32193. */
  32194. pickedBySubMesh: {
  32195. idx: number;
  32196. faceId: number;
  32197. }[][];
  32198. /**
  32199. * This array is populated when `enableDepthSort` is set to true.
  32200. * Each element of this array is an instance of the class DepthSortedParticle.
  32201. */
  32202. depthSortedParticles: DepthSortedParticle[];
  32203. /**
  32204. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  32205. * @hidden
  32206. */
  32207. _bSphereOnly: boolean;
  32208. /**
  32209. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  32210. * @hidden
  32211. */
  32212. _bSphereRadiusFactor: number;
  32213. private _scene;
  32214. private _positions;
  32215. private _indices;
  32216. private _normals;
  32217. private _colors;
  32218. private _uvs;
  32219. private _indices32;
  32220. private _positions32;
  32221. private _normals32;
  32222. private _fixedNormal32;
  32223. private _colors32;
  32224. private _uvs32;
  32225. private _index;
  32226. private _updatable;
  32227. private _pickable;
  32228. private _isVisibilityBoxLocked;
  32229. private _alwaysVisible;
  32230. private _depthSort;
  32231. private _expandable;
  32232. private _shapeCounter;
  32233. private _copy;
  32234. private _color;
  32235. private _computeParticleColor;
  32236. private _computeParticleTexture;
  32237. private _computeParticleRotation;
  32238. private _computeParticleVertex;
  32239. private _computeBoundingBox;
  32240. private _depthSortParticles;
  32241. private _camera;
  32242. private _mustUnrotateFixedNormals;
  32243. private _particlesIntersect;
  32244. private _needs32Bits;
  32245. private _isNotBuilt;
  32246. private _lastParticleId;
  32247. private _idxOfId;
  32248. private _multimaterialEnabled;
  32249. private _useModelMaterial;
  32250. private _indicesByMaterial;
  32251. private _materialIndexes;
  32252. private _depthSortFunction;
  32253. private _materialSortFunction;
  32254. private _materials;
  32255. private _multimaterial;
  32256. private _materialIndexesById;
  32257. private _defaultMaterial;
  32258. private _autoUpdateSubMeshes;
  32259. private _tmpVertex;
  32260. /**
  32261. * Creates a SPS (Solid Particle System) object.
  32262. * @param name (String) is the SPS name, this will be the underlying mesh name.
  32263. * @param scene (Scene) is the scene in which the SPS is added.
  32264. * @param options defines the options of the sps e.g.
  32265. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  32266. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  32267. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  32268. * * 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.
  32269. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  32270. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  32271. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  32272. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  32273. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  32274. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  32275. */
  32276. constructor(name: string, scene: Scene, options?: {
  32277. updatable?: boolean;
  32278. isPickable?: boolean;
  32279. enableDepthSort?: boolean;
  32280. particleIntersection?: boolean;
  32281. boundingSphereOnly?: boolean;
  32282. bSphereRadiusFactor?: number;
  32283. expandable?: boolean;
  32284. useModelMaterial?: boolean;
  32285. enableMultiMaterial?: boolean;
  32286. });
  32287. /**
  32288. * Builds the SPS underlying mesh. Returns a standard Mesh.
  32289. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  32290. * @returns the created mesh
  32291. */
  32292. buildMesh(): Mesh;
  32293. /**
  32294. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  32295. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  32296. * Thus the particles generated from `digest()` have their property `position` set yet.
  32297. * @param mesh ( Mesh ) is the mesh to be digested
  32298. * @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
  32299. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  32300. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  32301. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  32302. * @returns the current SPS
  32303. */
  32304. digest(mesh: Mesh, options?: {
  32305. facetNb?: number;
  32306. number?: number;
  32307. delta?: number;
  32308. storage?: [];
  32309. }): SolidParticleSystem;
  32310. /**
  32311. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  32312. * @hidden
  32313. */
  32314. private _unrotateFixedNormals;
  32315. /**
  32316. * Resets the temporary working copy particle
  32317. * @hidden
  32318. */
  32319. private _resetCopy;
  32320. /**
  32321. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  32322. * @param p the current index in the positions array to be updated
  32323. * @param ind the current index in the indices array
  32324. * @param shape a Vector3 array, the shape geometry
  32325. * @param positions the positions array to be updated
  32326. * @param meshInd the shape indices array
  32327. * @param indices the indices array to be updated
  32328. * @param meshUV the shape uv array
  32329. * @param uvs the uv array to be updated
  32330. * @param meshCol the shape color array
  32331. * @param colors the color array to be updated
  32332. * @param meshNor the shape normals array
  32333. * @param normals the normals array to be updated
  32334. * @param idx the particle index
  32335. * @param idxInShape the particle index in its shape
  32336. * @param options the addShape() method passed options
  32337. * @model the particle model
  32338. * @hidden
  32339. */
  32340. private _meshBuilder;
  32341. /**
  32342. * Returns a shape Vector3 array from positions float array
  32343. * @param positions float array
  32344. * @returns a vector3 array
  32345. * @hidden
  32346. */
  32347. private _posToShape;
  32348. /**
  32349. * Returns a shapeUV array from a float uvs (array deep copy)
  32350. * @param uvs as a float array
  32351. * @returns a shapeUV array
  32352. * @hidden
  32353. */
  32354. private _uvsToShapeUV;
  32355. /**
  32356. * Adds a new particle object in the particles array
  32357. * @param idx particle index in particles array
  32358. * @param id particle id
  32359. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  32360. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  32361. * @param model particle ModelShape object
  32362. * @param shapeId model shape identifier
  32363. * @param idxInShape index of the particle in the current model
  32364. * @param bInfo model bounding info object
  32365. * @param storage target storage array, if any
  32366. * @hidden
  32367. */
  32368. private _addParticle;
  32369. /**
  32370. * Adds some particles to the SPS from the model shape. Returns the shape id.
  32371. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  32372. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  32373. * @param nb (positive integer) the number of particles to be created from this model
  32374. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  32375. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  32376. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  32377. * @returns the number of shapes in the system
  32378. */
  32379. addShape(mesh: Mesh, nb: number, options?: {
  32380. positionFunction?: any;
  32381. vertexFunction?: any;
  32382. storage?: [];
  32383. }): number;
  32384. /**
  32385. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  32386. * @hidden
  32387. */
  32388. private _rebuildParticle;
  32389. /**
  32390. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  32391. * @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.
  32392. * @returns the SPS.
  32393. */
  32394. rebuildMesh(reset?: boolean): SolidParticleSystem;
  32395. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  32396. * Returns an array with the removed particles.
  32397. * 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.
  32398. * The SPS can't be empty so at least one particle needs to remain in place.
  32399. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  32400. * @param start index of the first particle to remove
  32401. * @param end index of the last particle to remove (included)
  32402. * @returns an array populated with the removed particles
  32403. */
  32404. removeParticles(start: number, end: number): SolidParticle[];
  32405. /**
  32406. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  32407. * @param solidParticleArray an array populated with Solid Particles objects
  32408. * @returns the SPS
  32409. */
  32410. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  32411. /**
  32412. * Creates a new particle and modifies the SPS mesh geometry :
  32413. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  32414. * - calls _addParticle() to populate the particle array
  32415. * factorized code from addShape() and insertParticlesFromArray()
  32416. * @param idx particle index in the particles array
  32417. * @param i particle index in its shape
  32418. * @param modelShape particle ModelShape object
  32419. * @param shape shape vertex array
  32420. * @param meshInd shape indices array
  32421. * @param meshUV shape uv array
  32422. * @param meshCol shape color array
  32423. * @param meshNor shape normals array
  32424. * @param bbInfo shape bounding info
  32425. * @param storage target particle storage
  32426. * @options addShape() passed options
  32427. * @hidden
  32428. */
  32429. private _insertNewParticle;
  32430. /**
  32431. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  32432. * This method calls `updateParticle()` for each particle of the SPS.
  32433. * For an animated SPS, it is usually called within the render loop.
  32434. * 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.
  32435. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  32436. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  32437. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  32438. * @returns the SPS.
  32439. */
  32440. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  32441. /**
  32442. * Disposes the SPS.
  32443. */
  32444. dispose(): void;
  32445. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  32446. * idx is the particle index in the SPS
  32447. * faceId is the picked face index counted within this particle.
  32448. * Returns null if the pickInfo can't identify a picked particle.
  32449. * @param pickingInfo (PickingInfo object)
  32450. * @returns {idx: number, faceId: number} or null
  32451. */
  32452. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  32453. idx: number;
  32454. faceId: number;
  32455. }>;
  32456. /**
  32457. * Returns a SolidParticle object from its identifier : particle.id
  32458. * @param id (integer) the particle Id
  32459. * @returns the searched particle or null if not found in the SPS.
  32460. */
  32461. getParticleById(id: number): Nullable<SolidParticle>;
  32462. /**
  32463. * Returns a new array populated with the particles having the passed shapeId.
  32464. * @param shapeId (integer) the shape identifier
  32465. * @returns a new solid particle array
  32466. */
  32467. getParticlesByShapeId(shapeId: number): SolidParticle[];
  32468. /**
  32469. * Populates the passed array "ref" with the particles having the passed shapeId.
  32470. * @param shapeId the shape identifier
  32471. * @returns the SPS
  32472. * @param ref
  32473. */
  32474. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  32475. /**
  32476. * Computes the required SubMeshes according the materials assigned to the particles.
  32477. * @returns the solid particle system.
  32478. * Does nothing if called before the SPS mesh is built.
  32479. */
  32480. computeSubMeshes(): SolidParticleSystem;
  32481. /**
  32482. * Sorts the solid particles by material when MultiMaterial is enabled.
  32483. * Updates the indices32 array.
  32484. * Updates the indicesByMaterial array.
  32485. * Updates the mesh indices array.
  32486. * @returns the SPS
  32487. * @hidden
  32488. */
  32489. private _sortParticlesByMaterial;
  32490. /**
  32491. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  32492. * @hidden
  32493. */
  32494. private _setMaterialIndexesById;
  32495. /**
  32496. * Returns an array with unique values of Materials from the passed array
  32497. * @param array the material array to be checked and filtered
  32498. * @hidden
  32499. */
  32500. private _filterUniqueMaterialId;
  32501. /**
  32502. * Sets a new Standard Material as _defaultMaterial if not already set.
  32503. * @hidden
  32504. */
  32505. private _setDefaultMaterial;
  32506. /**
  32507. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  32508. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32509. * @returns the SPS.
  32510. */
  32511. refreshVisibleSize(): SolidParticleSystem;
  32512. /**
  32513. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  32514. * @param size the size (float) of the visibility box
  32515. * note : this doesn't lock the SPS mesh bounding box.
  32516. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32517. */
  32518. setVisibilityBox(size: number): void;
  32519. /**
  32520. * Gets whether the SPS as always visible or not
  32521. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32522. */
  32523. get isAlwaysVisible(): boolean;
  32524. /**
  32525. * Sets the SPS as always visible or not
  32526. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32527. */
  32528. set isAlwaysVisible(val: boolean);
  32529. /**
  32530. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  32531. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32532. */
  32533. set isVisibilityBoxLocked(val: boolean);
  32534. /**
  32535. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  32536. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32537. */
  32538. get isVisibilityBoxLocked(): boolean;
  32539. /**
  32540. * Tells to `setParticles()` to compute the particle rotations or not.
  32541. * Default value : true. The SPS is faster when it's set to false.
  32542. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  32543. */
  32544. set computeParticleRotation(val: boolean);
  32545. /**
  32546. * Tells to `setParticles()` to compute the particle colors or not.
  32547. * Default value : true. The SPS is faster when it's set to false.
  32548. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  32549. */
  32550. set computeParticleColor(val: boolean);
  32551. set computeParticleTexture(val: boolean);
  32552. /**
  32553. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  32554. * Default value : false. The SPS is faster when it's set to false.
  32555. * Note : the particle custom vertex positions aren't stored values.
  32556. */
  32557. set computeParticleVertex(val: boolean);
  32558. /**
  32559. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  32560. */
  32561. set computeBoundingBox(val: boolean);
  32562. /**
  32563. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  32564. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  32565. * Default : `true`
  32566. */
  32567. set depthSortParticles(val: boolean);
  32568. /**
  32569. * Gets if `setParticles()` computes the particle rotations or not.
  32570. * Default value : true. The SPS is faster when it's set to false.
  32571. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  32572. */
  32573. get computeParticleRotation(): boolean;
  32574. /**
  32575. * Gets if `setParticles()` computes the particle colors or not.
  32576. * Default value : true. The SPS is faster when it's set to false.
  32577. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  32578. */
  32579. get computeParticleColor(): boolean;
  32580. /**
  32581. * Gets if `setParticles()` computes the particle textures or not.
  32582. * Default value : true. The SPS is faster when it's set to false.
  32583. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  32584. */
  32585. get computeParticleTexture(): boolean;
  32586. /**
  32587. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  32588. * Default value : false. The SPS is faster when it's set to false.
  32589. * Note : the particle custom vertex positions aren't stored values.
  32590. */
  32591. get computeParticleVertex(): boolean;
  32592. /**
  32593. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  32594. */
  32595. get computeBoundingBox(): boolean;
  32596. /**
  32597. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  32598. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  32599. * Default : `true`
  32600. */
  32601. get depthSortParticles(): boolean;
  32602. /**
  32603. * Gets if the SPS is created as expandable at construction time.
  32604. * Default : `false`
  32605. */
  32606. get expandable(): boolean;
  32607. /**
  32608. * Gets if the SPS supports the Multi Materials
  32609. */
  32610. get multimaterialEnabled(): boolean;
  32611. /**
  32612. * Gets if the SPS uses the model materials for its own multimaterial.
  32613. */
  32614. get useModelMaterial(): boolean;
  32615. /**
  32616. * The SPS used material array.
  32617. */
  32618. get materials(): Material[];
  32619. /**
  32620. * Sets the SPS MultiMaterial from the passed materials.
  32621. * Note : the passed array is internally copied and not used then by reference.
  32622. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  32623. */
  32624. setMultiMaterial(materials: Material[]): void;
  32625. /**
  32626. * The SPS computed multimaterial object
  32627. */
  32628. get multimaterial(): MultiMaterial;
  32629. set multimaterial(mm: MultiMaterial);
  32630. /**
  32631. * If the subMeshes must be updated on the next call to setParticles()
  32632. */
  32633. get autoUpdateSubMeshes(): boolean;
  32634. set autoUpdateSubMeshes(val: boolean);
  32635. /**
  32636. * This function does nothing. It may be overwritten to set all the particle first values.
  32637. * The SPS doesn't call this function, you may have to call it by your own.
  32638. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32639. */
  32640. initParticles(): void;
  32641. /**
  32642. * This function does nothing. It may be overwritten to recycle a particle.
  32643. * The SPS doesn't call this function, you may have to call it by your own.
  32644. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32645. * @param particle The particle to recycle
  32646. * @returns the recycled particle
  32647. */
  32648. recycleParticle(particle: SolidParticle): SolidParticle;
  32649. /**
  32650. * Updates a particle : this function should be overwritten by the user.
  32651. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  32652. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32653. * @example : just set a particle position or velocity and recycle conditions
  32654. * @param particle The particle to update
  32655. * @returns the updated particle
  32656. */
  32657. updateParticle(particle: SolidParticle): SolidParticle;
  32658. /**
  32659. * Updates a vertex of a particle : it can be overwritten by the user.
  32660. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  32661. * @param particle the current particle
  32662. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  32663. * @param pt the index of the current vertex in the particle shape
  32664. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  32665. * @example : just set a vertex particle position or color
  32666. * @returns the sps
  32667. */
  32668. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  32669. /**
  32670. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  32671. * This does nothing and may be overwritten by the user.
  32672. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32673. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32674. * @param update the boolean update value actually passed to setParticles()
  32675. */
  32676. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  32677. /**
  32678. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  32679. * This will be passed three parameters.
  32680. * This does nothing and may be overwritten by the user.
  32681. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32682. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32683. * @param update the boolean update value actually passed to setParticles()
  32684. */
  32685. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  32686. }
  32687. }
  32688. declare module "babylonjs/Particles/solidParticle" {
  32689. import { Nullable } from "babylonjs/types";
  32690. import { Vector3, Matrix, Quaternion, Vector4, Vector2 } from "babylonjs/Maths/math.vector";
  32691. import { Color4 } from "babylonjs/Maths/math.color";
  32692. import { Mesh } from "babylonjs/Meshes/mesh";
  32693. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  32694. import { SolidParticleSystem } from "babylonjs/Particles/solidParticleSystem";
  32695. import { Plane } from "babylonjs/Maths/math.plane";
  32696. import { Material } from "babylonjs/Materials/material";
  32697. /**
  32698. * Represents one particle of a solid particle system.
  32699. */
  32700. export class SolidParticle {
  32701. /**
  32702. * particle global index
  32703. */
  32704. idx: number;
  32705. /**
  32706. * particle identifier
  32707. */
  32708. id: number;
  32709. /**
  32710. * The color of the particle
  32711. */
  32712. color: Nullable<Color4>;
  32713. /**
  32714. * The world space position of the particle.
  32715. */
  32716. position: Vector3;
  32717. /**
  32718. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  32719. */
  32720. rotation: Vector3;
  32721. /**
  32722. * The world space rotation quaternion of the particle.
  32723. */
  32724. rotationQuaternion: Nullable<Quaternion>;
  32725. /**
  32726. * The scaling of the particle.
  32727. */
  32728. scaling: Vector3;
  32729. /**
  32730. * The uvs of the particle.
  32731. */
  32732. uvs: Vector4;
  32733. /**
  32734. * The current speed of the particle.
  32735. */
  32736. velocity: Vector3;
  32737. /**
  32738. * The pivot point in the particle local space.
  32739. */
  32740. pivot: Vector3;
  32741. /**
  32742. * Must the particle be translated from its pivot point in its local space ?
  32743. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  32744. * Default : false
  32745. */
  32746. translateFromPivot: boolean;
  32747. /**
  32748. * Is the particle active or not ?
  32749. */
  32750. alive: boolean;
  32751. /**
  32752. * Is the particle visible or not ?
  32753. */
  32754. isVisible: boolean;
  32755. /**
  32756. * Index of this particle in the global "positions" array (Internal use)
  32757. * @hidden
  32758. */
  32759. _pos: number;
  32760. /**
  32761. * @hidden Index of this particle in the global "indices" array (Internal use)
  32762. */
  32763. _ind: number;
  32764. /**
  32765. * @hidden ModelShape of this particle (Internal use)
  32766. */
  32767. _model: ModelShape;
  32768. /**
  32769. * ModelShape id of this particle
  32770. */
  32771. shapeId: number;
  32772. /**
  32773. * Index of the particle in its shape id
  32774. */
  32775. idxInShape: number;
  32776. /**
  32777. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  32778. */
  32779. _modelBoundingInfo: BoundingInfo;
  32780. /**
  32781. * @hidden Particle BoundingInfo object (Internal use)
  32782. */
  32783. _boundingInfo: BoundingInfo;
  32784. /**
  32785. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  32786. */
  32787. _sps: SolidParticleSystem;
  32788. /**
  32789. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  32790. */
  32791. _stillInvisible: boolean;
  32792. /**
  32793. * @hidden Last computed particle rotation matrix
  32794. */
  32795. _rotationMatrix: number[];
  32796. /**
  32797. * Parent particle Id, if any.
  32798. * Default null.
  32799. */
  32800. parentId: Nullable<number>;
  32801. /**
  32802. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  32803. */
  32804. materialIndex: Nullable<number>;
  32805. /**
  32806. * Custom object or properties.
  32807. */
  32808. props: Nullable<any>;
  32809. /**
  32810. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  32811. * The possible values are :
  32812. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  32813. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32814. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  32815. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  32816. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32817. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  32818. * */
  32819. cullingStrategy: number;
  32820. /**
  32821. * @hidden Internal global position in the SPS.
  32822. */
  32823. _globalPosition: Vector3;
  32824. /**
  32825. * Creates a Solid Particle object.
  32826. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  32827. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  32828. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  32829. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  32830. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  32831. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  32832. * @param shapeId (integer) is the model shape identifier in the SPS.
  32833. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  32834. * @param sps defines the sps it is associated to
  32835. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  32836. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  32837. */
  32838. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  32839. /**
  32840. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  32841. * @param target the particle target
  32842. * @returns the current particle
  32843. */
  32844. copyToRef(target: SolidParticle): SolidParticle;
  32845. /**
  32846. * Legacy support, changed scale to scaling
  32847. */
  32848. get scale(): Vector3;
  32849. /**
  32850. * Legacy support, changed scale to scaling
  32851. */
  32852. set scale(scale: Vector3);
  32853. /**
  32854. * Legacy support, changed quaternion to rotationQuaternion
  32855. */
  32856. get quaternion(): Nullable<Quaternion>;
  32857. /**
  32858. * Legacy support, changed quaternion to rotationQuaternion
  32859. */
  32860. set quaternion(q: Nullable<Quaternion>);
  32861. /**
  32862. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  32863. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  32864. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  32865. * @returns true if it intersects
  32866. */
  32867. intersectsMesh(target: Mesh | SolidParticle): boolean;
  32868. /**
  32869. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  32870. * A particle is in the frustum if its bounding box intersects the frustum
  32871. * @param frustumPlanes defines the frustum to test
  32872. * @returns true if the particle is in the frustum planes
  32873. */
  32874. isInFrustum(frustumPlanes: Plane[]): boolean;
  32875. /**
  32876. * get the rotation matrix of the particle
  32877. * @hidden
  32878. */
  32879. getRotationMatrix(m: Matrix): void;
  32880. }
  32881. /**
  32882. * Represents the shape of the model used by one particle of a solid particle system.
  32883. * SPS internal tool, don't use it manually.
  32884. */
  32885. export class ModelShape {
  32886. /**
  32887. * The shape id
  32888. * @hidden
  32889. */
  32890. shapeID: number;
  32891. /**
  32892. * flat array of model positions (internal use)
  32893. * @hidden
  32894. */
  32895. _shape: Vector3[];
  32896. /**
  32897. * flat array of model UVs (internal use)
  32898. * @hidden
  32899. */
  32900. _shapeUV: number[];
  32901. /**
  32902. * color array of the model
  32903. * @hidden
  32904. */
  32905. _shapeColors: number[];
  32906. /**
  32907. * indices array of the model
  32908. * @hidden
  32909. */
  32910. _indices: number[];
  32911. /**
  32912. * normals array of the model
  32913. * @hidden
  32914. */
  32915. _normals: number[];
  32916. /**
  32917. * length of the shape in the model indices array (internal use)
  32918. * @hidden
  32919. */
  32920. _indicesLength: number;
  32921. /**
  32922. * Custom position function (internal use)
  32923. * @hidden
  32924. */
  32925. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  32926. /**
  32927. * Custom vertex function (internal use)
  32928. * @hidden
  32929. */
  32930. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  32931. /**
  32932. * Model material (internal use)
  32933. * @hidden
  32934. */
  32935. _material: Nullable<Material>;
  32936. /**
  32937. * 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.
  32938. * SPS internal tool, don't use it manually.
  32939. * @hidden
  32940. */
  32941. 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>);
  32942. }
  32943. /**
  32944. * Represents a Depth Sorted Particle in the solid particle system.
  32945. * @hidden
  32946. */
  32947. export class DepthSortedParticle {
  32948. /**
  32949. * Particle index
  32950. */
  32951. idx: number;
  32952. /**
  32953. * Index of the particle in the "indices" array
  32954. */
  32955. ind: number;
  32956. /**
  32957. * Length of the particle shape in the "indices" array
  32958. */
  32959. indicesLength: number;
  32960. /**
  32961. * Squared distance from the particle to the camera
  32962. */
  32963. sqDistance: number;
  32964. /**
  32965. * Material index when used with MultiMaterials
  32966. */
  32967. materialIndex: number;
  32968. /**
  32969. * Creates a new sorted particle
  32970. * @param materialIndex
  32971. */
  32972. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  32973. }
  32974. /**
  32975. * Represents a solid particle vertex
  32976. */
  32977. export class SolidParticleVertex {
  32978. /**
  32979. * Vertex position
  32980. */
  32981. position: Vector3;
  32982. /**
  32983. * Vertex color
  32984. */
  32985. color: Color4;
  32986. /**
  32987. * Vertex UV
  32988. */
  32989. uv: Vector2;
  32990. /**
  32991. * Creates a new solid particle vertex
  32992. */
  32993. constructor();
  32994. /** Vertex x coordinate */
  32995. get x(): number;
  32996. set x(val: number);
  32997. /** Vertex y coordinate */
  32998. get y(): number;
  32999. set y(val: number);
  33000. /** Vertex z coordinate */
  33001. get z(): number;
  33002. set z(val: number);
  33003. }
  33004. }
  33005. declare module "babylonjs/Collisions/meshCollisionData" {
  33006. import { Collider } from "babylonjs/Collisions/collider";
  33007. import { Vector3 } from "babylonjs/Maths/math.vector";
  33008. import { Nullable } from "babylonjs/types";
  33009. import { Observer } from "babylonjs/Misc/observable";
  33010. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33011. /**
  33012. * @hidden
  33013. */
  33014. export class _MeshCollisionData {
  33015. _checkCollisions: boolean;
  33016. _collisionMask: number;
  33017. _collisionGroup: number;
  33018. _surroundingMeshes: Nullable<AbstractMesh[]>;
  33019. _collider: Nullable<Collider>;
  33020. _oldPositionForCollisions: Vector3;
  33021. _diffPositionForCollisions: Vector3;
  33022. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  33023. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  33024. }
  33025. }
  33026. declare module "babylonjs/Meshes/abstractMesh" {
  33027. import { Observable } from "babylonjs/Misc/observable";
  33028. import { Nullable, FloatArray, IndicesArray, DeepImmutable } from "babylonjs/types";
  33029. import { Camera } from "babylonjs/Cameras/camera";
  33030. import { Scene, IDisposable } from "babylonjs/scene";
  33031. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  33032. import { Node } from "babylonjs/node";
  33033. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  33034. import { TransformNode } from "babylonjs/Meshes/transformNode";
  33035. import { SubMesh } from "babylonjs/Meshes/subMesh";
  33036. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  33037. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  33038. import { Material } from "babylonjs/Materials/material";
  33039. import { Light } from "babylonjs/Lights/light";
  33040. import { Skeleton } from "babylonjs/Bones/skeleton";
  33041. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  33042. import { SolidParticle } from "babylonjs/Particles/solidParticle";
  33043. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  33044. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  33045. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  33046. import { Plane } from "babylonjs/Maths/math.plane";
  33047. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  33048. import { Ray } from "babylonjs/Culling/ray";
  33049. import { Collider } from "babylonjs/Collisions/collider";
  33050. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  33051. import { RenderingGroup } from "babylonjs/Rendering/renderingGroup";
  33052. /** @hidden */
  33053. class _FacetDataStorage {
  33054. facetPositions: Vector3[];
  33055. facetNormals: Vector3[];
  33056. facetPartitioning: number[][];
  33057. facetNb: number;
  33058. partitioningSubdivisions: number;
  33059. partitioningBBoxRatio: number;
  33060. facetDataEnabled: boolean;
  33061. facetParameters: any;
  33062. bbSize: Vector3;
  33063. subDiv: {
  33064. max: number;
  33065. X: number;
  33066. Y: number;
  33067. Z: number;
  33068. };
  33069. facetDepthSort: boolean;
  33070. facetDepthSortEnabled: boolean;
  33071. depthSortedIndices: IndicesArray;
  33072. depthSortedFacets: {
  33073. ind: number;
  33074. sqDistance: number;
  33075. }[];
  33076. facetDepthSortFunction: (f1: {
  33077. ind: number;
  33078. sqDistance: number;
  33079. }, f2: {
  33080. ind: number;
  33081. sqDistance: number;
  33082. }) => number;
  33083. facetDepthSortFrom: Vector3;
  33084. facetDepthSortOrigin: Vector3;
  33085. invertedMatrix: Matrix;
  33086. }
  33087. /**
  33088. * @hidden
  33089. **/
  33090. class _InternalAbstractMeshDataInfo {
  33091. _hasVertexAlpha: boolean;
  33092. _useVertexColors: boolean;
  33093. _numBoneInfluencers: number;
  33094. _applyFog: boolean;
  33095. _receiveShadows: boolean;
  33096. _facetData: _FacetDataStorage;
  33097. _visibility: number;
  33098. _skeleton: Nullable<Skeleton>;
  33099. _layerMask: number;
  33100. _computeBonesUsingShaders: boolean;
  33101. _isActive: boolean;
  33102. _onlyForInstances: boolean;
  33103. _isActiveIntermediate: boolean;
  33104. _onlyForInstancesIntermediate: boolean;
  33105. _actAsRegularMesh: boolean;
  33106. }
  33107. /**
  33108. * Class used to store all common mesh properties
  33109. */
  33110. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  33111. /** No occlusion */
  33112. static OCCLUSION_TYPE_NONE: number;
  33113. /** Occlusion set to optimisitic */
  33114. static OCCLUSION_TYPE_OPTIMISTIC: number;
  33115. /** Occlusion set to strict */
  33116. static OCCLUSION_TYPE_STRICT: number;
  33117. /** Use an accurante occlusion algorithm */
  33118. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  33119. /** Use a conservative occlusion algorithm */
  33120. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  33121. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  33122. * Test order :
  33123. * Is the bounding sphere outside the frustum ?
  33124. * If not, are the bounding box vertices outside the frustum ?
  33125. * It not, then the cullable object is in the frustum.
  33126. */
  33127. static readonly CULLINGSTRATEGY_STANDARD: number;
  33128. /** Culling strategy : Bounding Sphere Only.
  33129. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  33130. * It's also less accurate than the standard because some not visible objects can still be selected.
  33131. * Test : is the bounding sphere outside the frustum ?
  33132. * If not, then the cullable object is in the frustum.
  33133. */
  33134. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  33135. /** Culling strategy : Optimistic Inclusion.
  33136. * This in an inclusion test first, then the standard exclusion test.
  33137. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  33138. * 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.
  33139. * Anyway, it's as accurate as the standard strategy.
  33140. * Test :
  33141. * Is the cullable object bounding sphere center in the frustum ?
  33142. * If not, apply the default culling strategy.
  33143. */
  33144. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  33145. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  33146. * This in an inclusion test first, then the bounding sphere only exclusion test.
  33147. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  33148. * 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.
  33149. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  33150. * Test :
  33151. * Is the cullable object bounding sphere center in the frustum ?
  33152. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  33153. */
  33154. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  33155. /**
  33156. * No billboard
  33157. */
  33158. static get BILLBOARDMODE_NONE(): number;
  33159. /** Billboard on X axis */
  33160. static get BILLBOARDMODE_X(): number;
  33161. /** Billboard on Y axis */
  33162. static get BILLBOARDMODE_Y(): number;
  33163. /** Billboard on Z axis */
  33164. static get BILLBOARDMODE_Z(): number;
  33165. /** Billboard on all axes */
  33166. static get BILLBOARDMODE_ALL(): number;
  33167. /** Billboard on using position instead of orientation */
  33168. static get BILLBOARDMODE_USE_POSITION(): number;
  33169. /** @hidden */
  33170. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  33171. /**
  33172. * The culling strategy to use to check whether the mesh must be rendered or not.
  33173. * This value can be changed at any time and will be used on the next render mesh selection.
  33174. * The possible values are :
  33175. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  33176. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  33177. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  33178. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  33179. * Please read each static variable documentation to get details about the culling process.
  33180. * */
  33181. cullingStrategy: number;
  33182. /**
  33183. * Gets the number of facets in the mesh
  33184. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  33185. */
  33186. get facetNb(): number;
  33187. /**
  33188. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  33189. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  33190. */
  33191. get partitioningSubdivisions(): number;
  33192. set partitioningSubdivisions(nb: number);
  33193. /**
  33194. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  33195. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  33196. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  33197. */
  33198. get partitioningBBoxRatio(): number;
  33199. set partitioningBBoxRatio(ratio: number);
  33200. /**
  33201. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  33202. * Works only for updatable meshes.
  33203. * Doesn't work with multi-materials
  33204. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  33205. */
  33206. get mustDepthSortFacets(): boolean;
  33207. set mustDepthSortFacets(sort: boolean);
  33208. /**
  33209. * The location (Vector3) where the facet depth sort must be computed from.
  33210. * By default, the active camera position.
  33211. * Used only when facet depth sort is enabled
  33212. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  33213. */
  33214. get facetDepthSortFrom(): Vector3;
  33215. set facetDepthSortFrom(location: Vector3);
  33216. /**
  33217. * gets a boolean indicating if facetData is enabled
  33218. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  33219. */
  33220. get isFacetDataEnabled(): boolean;
  33221. /** @hidden */
  33222. _updateNonUniformScalingState(value: boolean): boolean;
  33223. /**
  33224. * An event triggered when this mesh collides with another one
  33225. */
  33226. onCollideObservable: Observable<AbstractMesh>;
  33227. /** Set a function to call when this mesh collides with another one */
  33228. set onCollide(callback: () => void);
  33229. /**
  33230. * An event triggered when the collision's position changes
  33231. */
  33232. onCollisionPositionChangeObservable: Observable<Vector3>;
  33233. /** Set a function to call when the collision's position changes */
  33234. set onCollisionPositionChange(callback: () => void);
  33235. /**
  33236. * An event triggered when material is changed
  33237. */
  33238. onMaterialChangedObservable: Observable<AbstractMesh>;
  33239. /**
  33240. * Gets or sets the orientation for POV movement & rotation
  33241. */
  33242. definedFacingForward: boolean;
  33243. /** @hidden */
  33244. _occlusionQuery: Nullable<WebGLQuery>;
  33245. /** @hidden */
  33246. _renderingGroup: Nullable<RenderingGroup>;
  33247. /**
  33248. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  33249. */
  33250. get visibility(): number;
  33251. /**
  33252. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  33253. */
  33254. set visibility(value: number);
  33255. /** Gets or sets the alpha index used to sort transparent meshes
  33256. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  33257. */
  33258. alphaIndex: number;
  33259. /**
  33260. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  33261. */
  33262. isVisible: boolean;
  33263. /**
  33264. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  33265. */
  33266. isPickable: boolean;
  33267. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  33268. showSubMeshesBoundingBox: boolean;
  33269. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  33270. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  33271. */
  33272. isBlocker: boolean;
  33273. /**
  33274. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  33275. */
  33276. enablePointerMoveEvents: boolean;
  33277. private _renderingGroupId;
  33278. /**
  33279. * Specifies the rendering group id for this mesh (0 by default)
  33280. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  33281. */
  33282. get renderingGroupId(): number;
  33283. set renderingGroupId(value: number);
  33284. private _material;
  33285. /** Gets or sets current material */
  33286. get material(): Nullable<Material>;
  33287. set material(value: Nullable<Material>);
  33288. /**
  33289. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  33290. * @see https://doc.babylonjs.com/babylon101/shadows
  33291. */
  33292. get receiveShadows(): boolean;
  33293. set receiveShadows(value: boolean);
  33294. /** Defines color to use when rendering outline */
  33295. outlineColor: Color3;
  33296. /** Define width to use when rendering outline */
  33297. outlineWidth: number;
  33298. /** Defines color to use when rendering overlay */
  33299. overlayColor: Color3;
  33300. /** Defines alpha to use when rendering overlay */
  33301. overlayAlpha: number;
  33302. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  33303. get hasVertexAlpha(): boolean;
  33304. set hasVertexAlpha(value: boolean);
  33305. /** 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) */
  33306. get useVertexColors(): boolean;
  33307. set useVertexColors(value: boolean);
  33308. /**
  33309. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  33310. */
  33311. get computeBonesUsingShaders(): boolean;
  33312. set computeBonesUsingShaders(value: boolean);
  33313. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  33314. get numBoneInfluencers(): number;
  33315. set numBoneInfluencers(value: number);
  33316. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  33317. get applyFog(): boolean;
  33318. set applyFog(value: boolean);
  33319. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  33320. useOctreeForRenderingSelection: boolean;
  33321. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  33322. useOctreeForPicking: boolean;
  33323. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  33324. useOctreeForCollisions: boolean;
  33325. /**
  33326. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  33327. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  33328. */
  33329. get layerMask(): number;
  33330. set layerMask(value: number);
  33331. /**
  33332. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  33333. */
  33334. alwaysSelectAsActiveMesh: boolean;
  33335. /**
  33336. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  33337. */
  33338. doNotSyncBoundingInfo: boolean;
  33339. /**
  33340. * Gets or sets the current action manager
  33341. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  33342. */
  33343. actionManager: Nullable<AbstractActionManager>;
  33344. private _meshCollisionData;
  33345. /**
  33346. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  33347. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33348. */
  33349. ellipsoid: Vector3;
  33350. /**
  33351. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  33352. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33353. */
  33354. ellipsoidOffset: Vector3;
  33355. /**
  33356. * Gets or sets a collision mask used to mask collisions (default is -1).
  33357. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  33358. */
  33359. get collisionMask(): number;
  33360. set collisionMask(mask: number);
  33361. /**
  33362. * Gets or sets the current collision group mask (-1 by default).
  33363. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  33364. */
  33365. get collisionGroup(): number;
  33366. set collisionGroup(mask: number);
  33367. /**
  33368. * Gets or sets current surrounding meshes (null by default).
  33369. *
  33370. * By default collision detection is tested against every mesh in the scene.
  33371. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  33372. * meshes will be tested for the collision.
  33373. *
  33374. * Note: if set to an empty array no collision will happen when this mesh is moved.
  33375. */
  33376. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  33377. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  33378. /**
  33379. * Defines edge width used when edgesRenderer is enabled
  33380. * @see https://www.babylonjs-playground.com/#10OJSG#13
  33381. */
  33382. edgesWidth: number;
  33383. /**
  33384. * Defines edge color used when edgesRenderer is enabled
  33385. * @see https://www.babylonjs-playground.com/#10OJSG#13
  33386. */
  33387. edgesColor: Color4;
  33388. /** @hidden */
  33389. _edgesRenderer: Nullable<IEdgesRenderer>;
  33390. /** @hidden */
  33391. _masterMesh: Nullable<AbstractMesh>;
  33392. /** @hidden */
  33393. _boundingInfo: Nullable<BoundingInfo>;
  33394. /** @hidden */
  33395. _renderId: number;
  33396. /**
  33397. * Gets or sets the list of subMeshes
  33398. * @see https://doc.babylonjs.com/how_to/multi_materials
  33399. */
  33400. subMeshes: SubMesh[];
  33401. /** @hidden */
  33402. _intersectionsInProgress: AbstractMesh[];
  33403. /** @hidden */
  33404. _unIndexed: boolean;
  33405. /** @hidden */
  33406. _lightSources: Light[];
  33407. /** Gets the list of lights affecting that mesh */
  33408. get lightSources(): Light[];
  33409. /** @hidden */
  33410. get _positions(): Nullable<Vector3[]>;
  33411. /** @hidden */
  33412. _waitingData: {
  33413. lods: Nullable<any>;
  33414. actions: Nullable<any>;
  33415. freezeWorldMatrix: Nullable<boolean>;
  33416. };
  33417. /** @hidden */
  33418. _bonesTransformMatrices: Nullable<Float32Array>;
  33419. /** @hidden */
  33420. _transformMatrixTexture: Nullable<RawTexture>;
  33421. /**
  33422. * Gets or sets a skeleton to apply skining transformations
  33423. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  33424. */
  33425. set skeleton(value: Nullable<Skeleton>);
  33426. get skeleton(): Nullable<Skeleton>;
  33427. /**
  33428. * An event triggered when the mesh is rebuilt.
  33429. */
  33430. onRebuildObservable: Observable<AbstractMesh>;
  33431. /**
  33432. * Creates a new AbstractMesh
  33433. * @param name defines the name of the mesh
  33434. * @param scene defines the hosting scene
  33435. */
  33436. constructor(name: string, scene?: Nullable<Scene>);
  33437. /**
  33438. * Returns the string "AbstractMesh"
  33439. * @returns "AbstractMesh"
  33440. */
  33441. getClassName(): string;
  33442. /**
  33443. * Gets a string representation of the current mesh
  33444. * @param fullDetails defines a boolean indicating if full details must be included
  33445. * @returns a string representation of the current mesh
  33446. */
  33447. toString(fullDetails?: boolean): string;
  33448. /**
  33449. * @hidden
  33450. */
  33451. protected _getEffectiveParent(): Nullable<Node>;
  33452. /** @hidden */
  33453. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  33454. /** @hidden */
  33455. _rebuild(): void;
  33456. /** @hidden */
  33457. _resyncLightSources(): void;
  33458. /** @hidden */
  33459. _resyncLightSource(light: Light): void;
  33460. /** @hidden */
  33461. _unBindEffect(): void;
  33462. /** @hidden */
  33463. _removeLightSource(light: Light, dispose: boolean): void;
  33464. private _markSubMeshesAsDirty;
  33465. /** @hidden */
  33466. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  33467. /** @hidden */
  33468. _markSubMeshesAsAttributesDirty(): void;
  33469. /** @hidden */
  33470. _markSubMeshesAsMiscDirty(): void;
  33471. /**
  33472. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  33473. */
  33474. get scaling(): Vector3;
  33475. set scaling(newScaling: Vector3);
  33476. /**
  33477. * Returns true if the mesh is blocked. Implemented by child classes
  33478. */
  33479. get isBlocked(): boolean;
  33480. /**
  33481. * Returns the mesh itself by default. Implemented by child classes
  33482. * @param camera defines the camera to use to pick the right LOD level
  33483. * @returns the currentAbstractMesh
  33484. */
  33485. getLOD(camera: Camera): Nullable<AbstractMesh>;
  33486. /**
  33487. * Returns 0 by default. Implemented by child classes
  33488. * @returns an integer
  33489. */
  33490. getTotalVertices(): number;
  33491. /**
  33492. * Returns a positive integer : the total number of indices in this mesh geometry.
  33493. * @returns the numner of indices or zero if the mesh has no geometry.
  33494. */
  33495. getTotalIndices(): number;
  33496. /**
  33497. * Returns null by default. Implemented by child classes
  33498. * @returns null
  33499. */
  33500. getIndices(): Nullable<IndicesArray>;
  33501. /**
  33502. * Returns the array of the requested vertex data kind. Implemented by child classes
  33503. * @param kind defines the vertex data kind to use
  33504. * @returns null
  33505. */
  33506. getVerticesData(kind: string): Nullable<FloatArray>;
  33507. /**
  33508. * Sets the vertex data of the mesh geometry for the requested `kind`.
  33509. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  33510. * Note that a new underlying VertexBuffer object is created each call.
  33511. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  33512. * @param kind defines vertex data kind:
  33513. * * VertexBuffer.PositionKind
  33514. * * VertexBuffer.UVKind
  33515. * * VertexBuffer.UV2Kind
  33516. * * VertexBuffer.UV3Kind
  33517. * * VertexBuffer.UV4Kind
  33518. * * VertexBuffer.UV5Kind
  33519. * * VertexBuffer.UV6Kind
  33520. * * VertexBuffer.ColorKind
  33521. * * VertexBuffer.MatricesIndicesKind
  33522. * * VertexBuffer.MatricesIndicesExtraKind
  33523. * * VertexBuffer.MatricesWeightsKind
  33524. * * VertexBuffer.MatricesWeightsExtraKind
  33525. * @param data defines the data source
  33526. * @param updatable defines if the data must be flagged as updatable (or static)
  33527. * @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
  33528. * @returns the current mesh
  33529. */
  33530. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  33531. /**
  33532. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  33533. * If the mesh has no geometry, it is simply returned as it is.
  33534. * @param kind defines vertex data kind:
  33535. * * VertexBuffer.PositionKind
  33536. * * VertexBuffer.UVKind
  33537. * * VertexBuffer.UV2Kind
  33538. * * VertexBuffer.UV3Kind
  33539. * * VertexBuffer.UV4Kind
  33540. * * VertexBuffer.UV5Kind
  33541. * * VertexBuffer.UV6Kind
  33542. * * VertexBuffer.ColorKind
  33543. * * VertexBuffer.MatricesIndicesKind
  33544. * * VertexBuffer.MatricesIndicesExtraKind
  33545. * * VertexBuffer.MatricesWeightsKind
  33546. * * VertexBuffer.MatricesWeightsExtraKind
  33547. * @param data defines the data source
  33548. * @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
  33549. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  33550. * @returns the current mesh
  33551. */
  33552. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  33553. /**
  33554. * Sets the mesh indices,
  33555. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  33556. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  33557. * @param totalVertices Defines the total number of vertices
  33558. * @returns the current mesh
  33559. */
  33560. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  33561. /**
  33562. * Gets a boolean indicating if specific vertex data is present
  33563. * @param kind defines the vertex data kind to use
  33564. * @returns true is data kind is present
  33565. */
  33566. isVerticesDataPresent(kind: string): boolean;
  33567. /**
  33568. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  33569. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  33570. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  33571. * @returns a BoundingInfo
  33572. */
  33573. getBoundingInfo(): BoundingInfo;
  33574. /**
  33575. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  33576. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  33577. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  33578. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  33579. * @returns the current mesh
  33580. */
  33581. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  33582. /**
  33583. * Overwrite the current bounding info
  33584. * @param boundingInfo defines the new bounding info
  33585. * @returns the current mesh
  33586. */
  33587. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  33588. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  33589. get useBones(): boolean;
  33590. /** @hidden */
  33591. _preActivate(): void;
  33592. /** @hidden */
  33593. _preActivateForIntermediateRendering(renderId: number): void;
  33594. /** @hidden */
  33595. _activate(renderId: number, intermediateRendering: boolean): boolean;
  33596. /** @hidden */
  33597. _postActivate(): void;
  33598. /** @hidden */
  33599. _freeze(): void;
  33600. /** @hidden */
  33601. _unFreeze(): void;
  33602. /**
  33603. * Gets the current world matrix
  33604. * @returns a Matrix
  33605. */
  33606. getWorldMatrix(): Matrix;
  33607. /** @hidden */
  33608. _getWorldMatrixDeterminant(): number;
  33609. /**
  33610. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  33611. */
  33612. get isAnInstance(): boolean;
  33613. /**
  33614. * Gets a boolean indicating if this mesh has instances
  33615. */
  33616. get hasInstances(): boolean;
  33617. /**
  33618. * Gets a boolean indicating if this mesh has thin instances
  33619. */
  33620. get hasThinInstances(): boolean;
  33621. /**
  33622. * Perform relative position change from the point of view of behind the front of the mesh.
  33623. * This is performed taking into account the meshes current rotation, so you do not have to care.
  33624. * Supports definition of mesh facing forward or backward
  33625. * @param amountRight defines the distance on the right axis
  33626. * @param amountUp defines the distance on the up axis
  33627. * @param amountForward defines the distance on the forward axis
  33628. * @returns the current mesh
  33629. */
  33630. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  33631. /**
  33632. * Calculate relative position change from the point of view of behind the front of the mesh.
  33633. * This is performed taking into account the meshes current rotation, so you do not have to care.
  33634. * Supports definition of mesh facing forward or backward
  33635. * @param amountRight defines the distance on the right axis
  33636. * @param amountUp defines the distance on the up axis
  33637. * @param amountForward defines the distance on the forward axis
  33638. * @returns the new displacement vector
  33639. */
  33640. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  33641. /**
  33642. * Perform relative rotation change from the point of view of behind the front of the mesh.
  33643. * Supports definition of mesh facing forward or backward
  33644. * @param flipBack defines the flip
  33645. * @param twirlClockwise defines the twirl
  33646. * @param tiltRight defines the tilt
  33647. * @returns the current mesh
  33648. */
  33649. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  33650. /**
  33651. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  33652. * Supports definition of mesh facing forward or backward.
  33653. * @param flipBack defines the flip
  33654. * @param twirlClockwise defines the twirl
  33655. * @param tiltRight defines the tilt
  33656. * @returns the new rotation vector
  33657. */
  33658. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  33659. /**
  33660. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  33661. * This means the mesh underlying bounding box and sphere are recomputed.
  33662. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  33663. * @returns the current mesh
  33664. */
  33665. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  33666. /** @hidden */
  33667. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  33668. /** @hidden */
  33669. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  33670. /** @hidden */
  33671. _updateBoundingInfo(): AbstractMesh;
  33672. /** @hidden */
  33673. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  33674. /** @hidden */
  33675. protected _afterComputeWorldMatrix(): void;
  33676. /** @hidden */
  33677. get _effectiveMesh(): AbstractMesh;
  33678. /**
  33679. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  33680. * A mesh is in the frustum if its bounding box intersects the frustum
  33681. * @param frustumPlanes defines the frustum to test
  33682. * @returns true if the mesh is in the frustum planes
  33683. */
  33684. isInFrustum(frustumPlanes: Plane[]): boolean;
  33685. /**
  33686. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  33687. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  33688. * @param frustumPlanes defines the frustum to test
  33689. * @returns true if the mesh is completely in the frustum planes
  33690. */
  33691. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  33692. /**
  33693. * True if the mesh intersects another mesh or a SolidParticle object
  33694. * @param mesh defines a target mesh or SolidParticle to test
  33695. * @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)
  33696. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  33697. * @returns true if there is an intersection
  33698. */
  33699. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  33700. /**
  33701. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  33702. * @param point defines the point to test
  33703. * @returns true if there is an intersection
  33704. */
  33705. intersectsPoint(point: Vector3): boolean;
  33706. /**
  33707. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  33708. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33709. */
  33710. get checkCollisions(): boolean;
  33711. set checkCollisions(collisionEnabled: boolean);
  33712. /**
  33713. * Gets Collider object used to compute collisions (not physics)
  33714. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33715. */
  33716. get collider(): Nullable<Collider>;
  33717. /**
  33718. * Move the mesh using collision engine
  33719. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33720. * @param displacement defines the requested displacement vector
  33721. * @returns the current mesh
  33722. */
  33723. moveWithCollisions(displacement: Vector3): AbstractMesh;
  33724. private _onCollisionPositionChange;
  33725. /** @hidden */
  33726. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  33727. /** @hidden */
  33728. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  33729. /** @hidden */
  33730. _checkCollision(collider: Collider): AbstractMesh;
  33731. /** @hidden */
  33732. _generatePointsArray(): boolean;
  33733. /**
  33734. * Checks if the passed Ray intersects with the mesh
  33735. * @param ray defines the ray to use
  33736. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  33737. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  33738. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  33739. * @param worldToUse defines the world matrix to use to get the world coordinate of the intersection point
  33740. * @returns the picking info
  33741. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  33742. */
  33743. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean, worldToUse?: Matrix): PickingInfo;
  33744. /**
  33745. * Clones the current mesh
  33746. * @param name defines the mesh name
  33747. * @param newParent defines the new mesh parent
  33748. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  33749. * @returns the new mesh
  33750. */
  33751. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  33752. /**
  33753. * Disposes all the submeshes of the current meshnp
  33754. * @returns the current mesh
  33755. */
  33756. releaseSubMeshes(): AbstractMesh;
  33757. /**
  33758. * Releases resources associated with this abstract mesh.
  33759. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  33760. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  33761. */
  33762. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  33763. /**
  33764. * Adds the passed mesh as a child to the current mesh
  33765. * @param mesh defines the child mesh
  33766. * @returns the current mesh
  33767. */
  33768. addChild(mesh: AbstractMesh): AbstractMesh;
  33769. /**
  33770. * Removes the passed mesh from the current mesh children list
  33771. * @param mesh defines the child mesh
  33772. * @returns the current mesh
  33773. */
  33774. removeChild(mesh: AbstractMesh): AbstractMesh;
  33775. /** @hidden */
  33776. private _initFacetData;
  33777. /**
  33778. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  33779. * This method can be called within the render loop.
  33780. * 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
  33781. * @returns the current mesh
  33782. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33783. */
  33784. updateFacetData(): AbstractMesh;
  33785. /**
  33786. * Returns the facetLocalNormals array.
  33787. * The normals are expressed in the mesh local spac
  33788. * @returns an array of Vector3
  33789. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33790. */
  33791. getFacetLocalNormals(): Vector3[];
  33792. /**
  33793. * Returns the facetLocalPositions array.
  33794. * The facet positions are expressed in the mesh local space
  33795. * @returns an array of Vector3
  33796. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33797. */
  33798. getFacetLocalPositions(): Vector3[];
  33799. /**
  33800. * Returns the facetLocalPartioning array
  33801. * @returns an array of array of numbers
  33802. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33803. */
  33804. getFacetLocalPartitioning(): number[][];
  33805. /**
  33806. * Returns the i-th facet position in the world system.
  33807. * This method allocates a new Vector3 per call
  33808. * @param i defines the facet index
  33809. * @returns a new Vector3
  33810. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33811. */
  33812. getFacetPosition(i: number): Vector3;
  33813. /**
  33814. * Sets the reference Vector3 with the i-th facet position in the world system
  33815. * @param i defines the facet index
  33816. * @param ref defines the target vector
  33817. * @returns the current mesh
  33818. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33819. */
  33820. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  33821. /**
  33822. * Returns the i-th facet normal in the world system.
  33823. * This method allocates a new Vector3 per call
  33824. * @param i defines the facet index
  33825. * @returns a new Vector3
  33826. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33827. */
  33828. getFacetNormal(i: number): Vector3;
  33829. /**
  33830. * Sets the reference Vector3 with the i-th facet normal in the world system
  33831. * @param i defines the facet index
  33832. * @param ref defines the target vector
  33833. * @returns the current mesh
  33834. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33835. */
  33836. getFacetNormalToRef(i: number, ref: Vector3): this;
  33837. /**
  33838. * 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)
  33839. * @param x defines x coordinate
  33840. * @param y defines y coordinate
  33841. * @param z defines z coordinate
  33842. * @returns the array of facet indexes
  33843. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33844. */
  33845. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  33846. /**
  33847. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  33848. * @param projected sets as the (x,y,z) world projection on the facet
  33849. * @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
  33850. * @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
  33851. * @param x defines x coordinate
  33852. * @param y defines y coordinate
  33853. * @param z defines z coordinate
  33854. * @returns the face index if found (or null instead)
  33855. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33856. */
  33857. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  33858. /**
  33859. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  33860. * @param projected sets as the (x,y,z) local projection on the facet
  33861. * @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
  33862. * @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
  33863. * @param x defines x coordinate
  33864. * @param y defines y coordinate
  33865. * @param z defines z coordinate
  33866. * @returns the face index if found (or null instead)
  33867. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33868. */
  33869. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  33870. /**
  33871. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  33872. * @returns the parameters
  33873. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33874. */
  33875. getFacetDataParameters(): any;
  33876. /**
  33877. * Disables the feature FacetData and frees the related memory
  33878. * @returns the current mesh
  33879. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33880. */
  33881. disableFacetData(): AbstractMesh;
  33882. /**
  33883. * Updates the AbstractMesh indices array
  33884. * @param indices defines the data source
  33885. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  33886. * @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)
  33887. * @returns the current mesh
  33888. */
  33889. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  33890. /**
  33891. * Creates new normals data for the mesh
  33892. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  33893. * @returns the current mesh
  33894. */
  33895. createNormals(updatable: boolean): AbstractMesh;
  33896. /**
  33897. * Align the mesh with a normal
  33898. * @param normal defines the normal to use
  33899. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  33900. * @returns the current mesh
  33901. */
  33902. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  33903. /** @hidden */
  33904. _checkOcclusionQuery(): boolean;
  33905. /**
  33906. * Disables the mesh edge rendering mode
  33907. * @returns the currentAbstractMesh
  33908. */
  33909. disableEdgesRendering(): AbstractMesh;
  33910. /**
  33911. * Enables the edge rendering mode on the mesh.
  33912. * This mode makes the mesh edges visible
  33913. * @param epsilon defines the maximal distance between two angles to detect a face
  33914. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  33915. * @returns the currentAbstractMesh
  33916. * @see https://www.babylonjs-playground.com/#19O9TU#0
  33917. */
  33918. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  33919. /**
  33920. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  33921. * @returns an array of particle systems in the scene that use the mesh as an emitter
  33922. */
  33923. getConnectedParticleSystems(): IParticleSystem[];
  33924. }
  33925. }
  33926. declare module "babylonjs/Actions/actionEvent" {
  33927. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33928. import { Nullable } from "babylonjs/types";
  33929. import { Sprite } from "babylonjs/Sprites/sprite";
  33930. import { Scene } from "babylonjs/scene";
  33931. import { Vector2 } from "babylonjs/Maths/math.vector";
  33932. /**
  33933. * Interface used to define ActionEvent
  33934. */
  33935. export interface IActionEvent {
  33936. /** The mesh or sprite that triggered the action */
  33937. source: any;
  33938. /** The X mouse cursor position at the time of the event */
  33939. pointerX: number;
  33940. /** The Y mouse cursor position at the time of the event */
  33941. pointerY: number;
  33942. /** The mesh that is currently pointed at (can be null) */
  33943. meshUnderPointer: Nullable<AbstractMesh>;
  33944. /** the original (browser) event that triggered the ActionEvent */
  33945. sourceEvent?: any;
  33946. /** additional data for the event */
  33947. additionalData?: any;
  33948. }
  33949. /**
  33950. * ActionEvent is the event being sent when an action is triggered.
  33951. */
  33952. export class ActionEvent implements IActionEvent {
  33953. /** The mesh or sprite that triggered the action */
  33954. source: any;
  33955. /** The X mouse cursor position at the time of the event */
  33956. pointerX: number;
  33957. /** The Y mouse cursor position at the time of the event */
  33958. pointerY: number;
  33959. /** The mesh that is currently pointed at (can be null) */
  33960. meshUnderPointer: Nullable<AbstractMesh>;
  33961. /** the original (browser) event that triggered the ActionEvent */
  33962. sourceEvent?: any;
  33963. /** additional data for the event */
  33964. additionalData?: any;
  33965. /**
  33966. * Creates a new ActionEvent
  33967. * @param source The mesh or sprite that triggered the action
  33968. * @param pointerX The X mouse cursor position at the time of the event
  33969. * @param pointerY The Y mouse cursor position at the time of the event
  33970. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  33971. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  33972. * @param additionalData additional data for the event
  33973. */
  33974. constructor(
  33975. /** The mesh or sprite that triggered the action */
  33976. source: any,
  33977. /** The X mouse cursor position at the time of the event */
  33978. pointerX: number,
  33979. /** The Y mouse cursor position at the time of the event */
  33980. pointerY: number,
  33981. /** The mesh that is currently pointed at (can be null) */
  33982. meshUnderPointer: Nullable<AbstractMesh>,
  33983. /** the original (browser) event that triggered the ActionEvent */
  33984. sourceEvent?: any,
  33985. /** additional data for the event */
  33986. additionalData?: any);
  33987. /**
  33988. * Helper function to auto-create an ActionEvent from a source mesh.
  33989. * @param source The source mesh that triggered the event
  33990. * @param evt The original (browser) event
  33991. * @param additionalData additional data for the event
  33992. * @returns the new ActionEvent
  33993. */
  33994. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  33995. /**
  33996. * Helper function to auto-create an ActionEvent from a source sprite
  33997. * @param source The source sprite that triggered the event
  33998. * @param scene Scene associated with the sprite
  33999. * @param evt The original (browser) event
  34000. * @param additionalData additional data for the event
  34001. * @returns the new ActionEvent
  34002. */
  34003. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  34004. /**
  34005. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  34006. * @param scene the scene where the event occurred
  34007. * @param evt The original (browser) event
  34008. * @returns the new ActionEvent
  34009. */
  34010. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  34011. /**
  34012. * Helper function to auto-create an ActionEvent from a primitive
  34013. * @param prim defines the target primitive
  34014. * @param pointerPos defines the pointer position
  34015. * @param evt The original (browser) event
  34016. * @param additionalData additional data for the event
  34017. * @returns the new ActionEvent
  34018. */
  34019. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  34020. }
  34021. }
  34022. declare module "babylonjs/Actions/abstractActionManager" {
  34023. import { IDisposable } from "babylonjs/scene";
  34024. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  34025. import { IAction } from "babylonjs/Actions/action";
  34026. import { Nullable } from "babylonjs/types";
  34027. /**
  34028. * Abstract class used to decouple action Manager from scene and meshes.
  34029. * Do not instantiate.
  34030. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  34031. */
  34032. export abstract class AbstractActionManager implements IDisposable {
  34033. /** Gets the list of active triggers */
  34034. static Triggers: {
  34035. [key: string]: number;
  34036. };
  34037. /** Gets the cursor to use when hovering items */
  34038. hoverCursor: string;
  34039. /** Gets the list of actions */
  34040. actions: IAction[];
  34041. /**
  34042. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  34043. */
  34044. isRecursive: boolean;
  34045. /**
  34046. * Releases all associated resources
  34047. */
  34048. abstract dispose(): void;
  34049. /**
  34050. * Does this action manager has pointer triggers
  34051. */
  34052. abstract get hasPointerTriggers(): boolean;
  34053. /**
  34054. * Does this action manager has pick triggers
  34055. */
  34056. abstract get hasPickTriggers(): boolean;
  34057. /**
  34058. * Process a specific trigger
  34059. * @param trigger defines the trigger to process
  34060. * @param evt defines the event details to be processed
  34061. */
  34062. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  34063. /**
  34064. * Does this action manager handles actions of any of the given triggers
  34065. * @param triggers defines the triggers to be tested
  34066. * @return a boolean indicating whether one (or more) of the triggers is handled
  34067. */
  34068. abstract hasSpecificTriggers(triggers: number[]): boolean;
  34069. /**
  34070. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  34071. * speed.
  34072. * @param triggerA defines the trigger to be tested
  34073. * @param triggerB defines the trigger to be tested
  34074. * @return a boolean indicating whether one (or more) of the triggers is handled
  34075. */
  34076. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  34077. /**
  34078. * Does this action manager handles actions of a given trigger
  34079. * @param trigger defines the trigger to be tested
  34080. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  34081. * @return whether the trigger is handled
  34082. */
  34083. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  34084. /**
  34085. * Serialize this manager to a JSON object
  34086. * @param name defines the property name to store this manager
  34087. * @returns a JSON representation of this manager
  34088. */
  34089. abstract serialize(name: string): any;
  34090. /**
  34091. * Registers an action to this action manager
  34092. * @param action defines the action to be registered
  34093. * @return the action amended (prepared) after registration
  34094. */
  34095. abstract registerAction(action: IAction): Nullable<IAction>;
  34096. /**
  34097. * Unregisters an action to this action manager
  34098. * @param action defines the action to be unregistered
  34099. * @return a boolean indicating whether the action has been unregistered
  34100. */
  34101. abstract unregisterAction(action: IAction): Boolean;
  34102. /**
  34103. * Does exist one action manager with at least one trigger
  34104. **/
  34105. static get HasTriggers(): boolean;
  34106. /**
  34107. * Does exist one action manager with at least one pick trigger
  34108. **/
  34109. static get HasPickTriggers(): boolean;
  34110. /**
  34111. * Does exist one action manager that handles actions of a given trigger
  34112. * @param trigger defines the trigger to be tested
  34113. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  34114. **/
  34115. static HasSpecificTrigger(trigger: number): boolean;
  34116. }
  34117. }
  34118. declare module "babylonjs/node" {
  34119. import { Scene } from "babylonjs/scene";
  34120. import { Nullable } from "babylonjs/types";
  34121. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  34122. import { Engine } from "babylonjs/Engines/engine";
  34123. import { IBehaviorAware, Behavior } from "babylonjs/Behaviors/behavior";
  34124. import { Observable } from "babylonjs/Misc/observable";
  34125. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  34126. import { IInspectable } from "babylonjs/Misc/iInspectable";
  34127. import { Animatable } from "babylonjs/Animations/animatable";
  34128. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  34129. import { Animation } from "babylonjs/Animations/animation";
  34130. import { AnimationRange } from "babylonjs/Animations/animationRange";
  34131. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  34132. /**
  34133. * Defines how a node can be built from a string name.
  34134. */
  34135. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  34136. /**
  34137. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  34138. */
  34139. export class Node implements IBehaviorAware<Node> {
  34140. /** @hidden */
  34141. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  34142. private static _NodeConstructors;
  34143. /**
  34144. * Add a new node constructor
  34145. * @param type defines the type name of the node to construct
  34146. * @param constructorFunc defines the constructor function
  34147. */
  34148. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  34149. /**
  34150. * Returns a node constructor based on type name
  34151. * @param type defines the type name
  34152. * @param name defines the new node name
  34153. * @param scene defines the hosting scene
  34154. * @param options defines optional options to transmit to constructors
  34155. * @returns the new constructor or null
  34156. */
  34157. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  34158. /**
  34159. * Gets or sets the name of the node
  34160. */
  34161. name: string;
  34162. /**
  34163. * Gets or sets the id of the node
  34164. */
  34165. id: string;
  34166. /**
  34167. * Gets or sets the unique id of the node
  34168. */
  34169. uniqueId: number;
  34170. /**
  34171. * Gets or sets a string used to store user defined state for the node
  34172. */
  34173. state: string;
  34174. /**
  34175. * Gets or sets an object used to store user defined information for the node
  34176. */
  34177. metadata: any;
  34178. /**
  34179. * For internal use only. Please do not use.
  34180. */
  34181. reservedDataStore: any;
  34182. /**
  34183. * List of inspectable custom properties (used by the Inspector)
  34184. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  34185. */
  34186. inspectableCustomProperties: IInspectable[];
  34187. private _doNotSerialize;
  34188. /**
  34189. * Gets or sets a boolean used to define if the node must be serialized
  34190. */
  34191. get doNotSerialize(): boolean;
  34192. set doNotSerialize(value: boolean);
  34193. /** @hidden */
  34194. _isDisposed: boolean;
  34195. /**
  34196. * Gets a list of Animations associated with the node
  34197. */
  34198. animations: import("babylonjs/Animations/animation").Animation[];
  34199. protected _ranges: {
  34200. [name: string]: Nullable<AnimationRange>;
  34201. };
  34202. /**
  34203. * Callback raised when the node is ready to be used
  34204. */
  34205. onReady: Nullable<(node: Node) => void>;
  34206. private _isEnabled;
  34207. private _isParentEnabled;
  34208. private _isReady;
  34209. /** @hidden */
  34210. _currentRenderId: number;
  34211. private _parentUpdateId;
  34212. /** @hidden */
  34213. _childUpdateId: number;
  34214. /** @hidden */
  34215. _waitingParentId: Nullable<string>;
  34216. /** @hidden */
  34217. _scene: Scene;
  34218. /** @hidden */
  34219. _cache: any;
  34220. private _parentNode;
  34221. private _children;
  34222. /** @hidden */
  34223. _worldMatrix: Matrix;
  34224. /** @hidden */
  34225. _worldMatrixDeterminant: number;
  34226. /** @hidden */
  34227. _worldMatrixDeterminantIsDirty: boolean;
  34228. /** @hidden */
  34229. private _sceneRootNodesIndex;
  34230. /**
  34231. * Gets a boolean indicating if the node has been disposed
  34232. * @returns true if the node was disposed
  34233. */
  34234. isDisposed(): boolean;
  34235. /**
  34236. * Gets or sets the parent of the node (without keeping the current position in the scene)
  34237. * @see https://doc.babylonjs.com/how_to/parenting
  34238. */
  34239. set parent(parent: Nullable<Node>);
  34240. get parent(): Nullable<Node>;
  34241. /** @hidden */
  34242. _addToSceneRootNodes(): void;
  34243. /** @hidden */
  34244. _removeFromSceneRootNodes(): void;
  34245. private _animationPropertiesOverride;
  34246. /**
  34247. * Gets or sets the animation properties override
  34248. */
  34249. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  34250. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  34251. /**
  34252. * Gets a string identifying the name of the class
  34253. * @returns "Node" string
  34254. */
  34255. getClassName(): string;
  34256. /** @hidden */
  34257. readonly _isNode: boolean;
  34258. /**
  34259. * An event triggered when the mesh is disposed
  34260. */
  34261. onDisposeObservable: Observable<Node>;
  34262. private _onDisposeObserver;
  34263. /**
  34264. * Sets a callback that will be raised when the node will be disposed
  34265. */
  34266. set onDispose(callback: () => void);
  34267. /**
  34268. * Creates a new Node
  34269. * @param name the name and id to be given to this node
  34270. * @param scene the scene this node will be added to
  34271. */
  34272. constructor(name: string, scene?: Nullable<Scene>);
  34273. /**
  34274. * Gets the scene of the node
  34275. * @returns a scene
  34276. */
  34277. getScene(): Scene;
  34278. /**
  34279. * Gets the engine of the node
  34280. * @returns a Engine
  34281. */
  34282. getEngine(): Engine;
  34283. private _behaviors;
  34284. /**
  34285. * Attach a behavior to the node
  34286. * @see https://doc.babylonjs.com/features/behaviour
  34287. * @param behavior defines the behavior to attach
  34288. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  34289. * @returns the current Node
  34290. */
  34291. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  34292. /**
  34293. * Remove an attached behavior
  34294. * @see https://doc.babylonjs.com/features/behaviour
  34295. * @param behavior defines the behavior to attach
  34296. * @returns the current Node
  34297. */
  34298. removeBehavior(behavior: Behavior<Node>): Node;
  34299. /**
  34300. * Gets the list of attached behaviors
  34301. * @see https://doc.babylonjs.com/features/behaviour
  34302. */
  34303. get behaviors(): Behavior<Node>[];
  34304. /**
  34305. * Gets an attached behavior by name
  34306. * @param name defines the name of the behavior to look for
  34307. * @see https://doc.babylonjs.com/features/behaviour
  34308. * @returns null if behavior was not found else the requested behavior
  34309. */
  34310. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  34311. /**
  34312. * Returns the latest update of the World matrix
  34313. * @returns a Matrix
  34314. */
  34315. getWorldMatrix(): Matrix;
  34316. /** @hidden */
  34317. _getWorldMatrixDeterminant(): number;
  34318. /**
  34319. * Returns directly the latest state of the mesh World matrix.
  34320. * A Matrix is returned.
  34321. */
  34322. get worldMatrixFromCache(): Matrix;
  34323. /** @hidden */
  34324. _initCache(): void;
  34325. /** @hidden */
  34326. updateCache(force?: boolean): void;
  34327. /** @hidden */
  34328. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  34329. /** @hidden */
  34330. _updateCache(ignoreParentClass?: boolean): void;
  34331. /** @hidden */
  34332. _isSynchronized(): boolean;
  34333. /** @hidden */
  34334. _markSyncedWithParent(): void;
  34335. /** @hidden */
  34336. isSynchronizedWithParent(): boolean;
  34337. /** @hidden */
  34338. isSynchronized(): boolean;
  34339. /**
  34340. * Is this node ready to be used/rendered
  34341. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  34342. * @return true if the node is ready
  34343. */
  34344. isReady(completeCheck?: boolean): boolean;
  34345. /**
  34346. * Is this node enabled?
  34347. * 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
  34348. * @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
  34349. * @return whether this node (and its parent) is enabled
  34350. */
  34351. isEnabled(checkAncestors?: boolean): boolean;
  34352. /** @hidden */
  34353. protected _syncParentEnabledState(): void;
  34354. /**
  34355. * Set the enabled state of this node
  34356. * @param value defines the new enabled state
  34357. */
  34358. setEnabled(value: boolean): void;
  34359. /**
  34360. * Is this node a descendant of the given node?
  34361. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  34362. * @param ancestor defines the parent node to inspect
  34363. * @returns a boolean indicating if this node is a descendant of the given node
  34364. */
  34365. isDescendantOf(ancestor: Node): boolean;
  34366. /** @hidden */
  34367. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  34368. /**
  34369. * Will return all nodes that have this node as ascendant
  34370. * @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
  34371. * @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
  34372. * @return all children nodes of all types
  34373. */
  34374. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  34375. /**
  34376. * Get all child-meshes of this node
  34377. * @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)
  34378. * @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
  34379. * @returns an array of AbstractMesh
  34380. */
  34381. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  34382. /**
  34383. * Get all direct children of this node
  34384. * @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
  34385. * @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)
  34386. * @returns an array of Node
  34387. */
  34388. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  34389. /** @hidden */
  34390. _setReady(state: boolean): void;
  34391. /**
  34392. * Get an animation by name
  34393. * @param name defines the name of the animation to look for
  34394. * @returns null if not found else the requested animation
  34395. */
  34396. getAnimationByName(name: string): Nullable<Animation>;
  34397. /**
  34398. * Creates an animation range for this node
  34399. * @param name defines the name of the range
  34400. * @param from defines the starting key
  34401. * @param to defines the end key
  34402. */
  34403. createAnimationRange(name: string, from: number, to: number): void;
  34404. /**
  34405. * Delete a specific animation range
  34406. * @param name defines the name of the range to delete
  34407. * @param deleteFrames defines if animation frames from the range must be deleted as well
  34408. */
  34409. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  34410. /**
  34411. * Get an animation range by name
  34412. * @param name defines the name of the animation range to look for
  34413. * @returns null if not found else the requested animation range
  34414. */
  34415. getAnimationRange(name: string): Nullable<AnimationRange>;
  34416. /**
  34417. * Gets the list of all animation ranges defined on this node
  34418. * @returns an array
  34419. */
  34420. getAnimationRanges(): Nullable<AnimationRange>[];
  34421. /**
  34422. * Will start the animation sequence
  34423. * @param name defines the range frames for animation sequence
  34424. * @param loop defines if the animation should loop (false by default)
  34425. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  34426. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  34427. * @returns the object created for this animation. If range does not exist, it will return null
  34428. */
  34429. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  34430. /**
  34431. * Serialize animation ranges into a JSON compatible object
  34432. * @returns serialization object
  34433. */
  34434. serializeAnimationRanges(): any;
  34435. /**
  34436. * Computes the world matrix of the node
  34437. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  34438. * @returns the world matrix
  34439. */
  34440. computeWorldMatrix(force?: boolean): Matrix;
  34441. /**
  34442. * Releases resources associated with this node.
  34443. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  34444. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  34445. */
  34446. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  34447. /**
  34448. * Parse animation range data from a serialization object and store them into a given node
  34449. * @param node defines where to store the animation ranges
  34450. * @param parsedNode defines the serialization object to read data from
  34451. * @param scene defines the hosting scene
  34452. */
  34453. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  34454. /**
  34455. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  34456. * @param includeDescendants Include bounding info from descendants as well (true by default)
  34457. * @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
  34458. * @returns the new bounding vectors
  34459. */
  34460. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  34461. min: Vector3;
  34462. max: Vector3;
  34463. };
  34464. }
  34465. }
  34466. declare module "babylonjs/Animations/animation" {
  34467. import { IEasingFunction, EasingFunction } from "babylonjs/Animations/easing";
  34468. import { Vector3, Quaternion, Vector2, Matrix } from "babylonjs/Maths/math.vector";
  34469. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  34470. import { Nullable } from "babylonjs/types";
  34471. import { Scene } from "babylonjs/scene";
  34472. import { IAnimationKey } from "babylonjs/Animations/animationKey";
  34473. import { AnimationRange } from "babylonjs/Animations/animationRange";
  34474. import { AnimationEvent } from "babylonjs/Animations/animationEvent";
  34475. import { Node } from "babylonjs/node";
  34476. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34477. import { Size } from "babylonjs/Maths/math.size";
  34478. import { Animatable } from "babylonjs/Animations/animatable";
  34479. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  34480. /**
  34481. * @hidden
  34482. */
  34483. export class _IAnimationState {
  34484. key: number;
  34485. repeatCount: number;
  34486. workValue?: any;
  34487. loopMode?: number;
  34488. offsetValue?: any;
  34489. highLimitValue?: any;
  34490. }
  34491. /**
  34492. * Class used to store any kind of animation
  34493. */
  34494. export class Animation {
  34495. /**Name of the animation */
  34496. name: string;
  34497. /**Property to animate */
  34498. targetProperty: string;
  34499. /**The frames per second of the animation */
  34500. framePerSecond: number;
  34501. /**The data type of the animation */
  34502. dataType: number;
  34503. /**The loop mode of the animation */
  34504. loopMode?: number | undefined;
  34505. /**Specifies if blending should be enabled */
  34506. enableBlending?: boolean | undefined;
  34507. /**
  34508. * Use matrix interpolation instead of using direct key value when animating matrices
  34509. */
  34510. static AllowMatricesInterpolation: boolean;
  34511. /**
  34512. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  34513. */
  34514. static AllowMatrixDecomposeForInterpolation: boolean;
  34515. /** Define the Url to load snippets */
  34516. static SnippetUrl: string;
  34517. /** Snippet ID if the animation was created from the snippet server */
  34518. snippetId: string;
  34519. /**
  34520. * Stores the key frames of the animation
  34521. */
  34522. private _keys;
  34523. /**
  34524. * Stores the easing function of the animation
  34525. */
  34526. private _easingFunction;
  34527. /**
  34528. * @hidden Internal use only
  34529. */
  34530. _runtimeAnimations: import("babylonjs/Animations/runtimeAnimation").RuntimeAnimation[];
  34531. /**
  34532. * The set of event that will be linked to this animation
  34533. */
  34534. private _events;
  34535. /**
  34536. * Stores an array of target property paths
  34537. */
  34538. targetPropertyPath: string[];
  34539. /**
  34540. * Stores the blending speed of the animation
  34541. */
  34542. blendingSpeed: number;
  34543. /**
  34544. * Stores the animation ranges for the animation
  34545. */
  34546. private _ranges;
  34547. /**
  34548. * @hidden Internal use
  34549. */
  34550. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  34551. /**
  34552. * Sets up an animation
  34553. * @param property The property to animate
  34554. * @param animationType The animation type to apply
  34555. * @param framePerSecond The frames per second of the animation
  34556. * @param easingFunction The easing function used in the animation
  34557. * @returns The created animation
  34558. */
  34559. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  34560. /**
  34561. * Create and start an animation on a node
  34562. * @param name defines the name of the global animation that will be run on all nodes
  34563. * @param node defines the root node where the animation will take place
  34564. * @param targetProperty defines property to animate
  34565. * @param framePerSecond defines the number of frame per second yo use
  34566. * @param totalFrame defines the number of frames in total
  34567. * @param from defines the initial value
  34568. * @param to defines the final value
  34569. * @param loopMode defines which loop mode you want to use (off by default)
  34570. * @param easingFunction defines the easing function to use (linear by default)
  34571. * @param onAnimationEnd defines the callback to call when animation end
  34572. * @returns the animatable created for this animation
  34573. */
  34574. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  34575. /**
  34576. * Create and start an animation on a node and its descendants
  34577. * @param name defines the name of the global animation that will be run on all nodes
  34578. * @param node defines the root node where the animation will take place
  34579. * @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
  34580. * @param targetProperty defines property to animate
  34581. * @param framePerSecond defines the number of frame per second to use
  34582. * @param totalFrame defines the number of frames in total
  34583. * @param from defines the initial value
  34584. * @param to defines the final value
  34585. * @param loopMode defines which loop mode you want to use (off by default)
  34586. * @param easingFunction defines the easing function to use (linear by default)
  34587. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  34588. * @returns the list of animatables created for all nodes
  34589. * @example https://www.babylonjs-playground.com/#MH0VLI
  34590. */
  34591. 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[]>;
  34592. /**
  34593. * Creates a new animation, merges it with the existing animations and starts it
  34594. * @param name Name of the animation
  34595. * @param node Node which contains the scene that begins the animations
  34596. * @param targetProperty Specifies which property to animate
  34597. * @param framePerSecond The frames per second of the animation
  34598. * @param totalFrame The total number of frames
  34599. * @param from The frame at the beginning of the animation
  34600. * @param to The frame at the end of the animation
  34601. * @param loopMode Specifies the loop mode of the animation
  34602. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  34603. * @param onAnimationEnd Callback to run once the animation is complete
  34604. * @returns Nullable animation
  34605. */
  34606. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  34607. /**
  34608. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  34609. * @param sourceAnimation defines the Animation containing keyframes to convert
  34610. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  34611. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  34612. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  34613. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  34614. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  34615. */
  34616. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  34617. /**
  34618. * Transition property of an host to the target Value
  34619. * @param property The property to transition
  34620. * @param targetValue The target Value of the property
  34621. * @param host The object where the property to animate belongs
  34622. * @param scene Scene used to run the animation
  34623. * @param frameRate Framerate (in frame/s) to use
  34624. * @param transition The transition type we want to use
  34625. * @param duration The duration of the animation, in milliseconds
  34626. * @param onAnimationEnd Callback trigger at the end of the animation
  34627. * @returns Nullable animation
  34628. */
  34629. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  34630. /**
  34631. * Return the array of runtime animations currently using this animation
  34632. */
  34633. get runtimeAnimations(): RuntimeAnimation[];
  34634. /**
  34635. * Specifies if any of the runtime animations are currently running
  34636. */
  34637. get hasRunningRuntimeAnimations(): boolean;
  34638. /**
  34639. * Initializes the animation
  34640. * @param name Name of the animation
  34641. * @param targetProperty Property to animate
  34642. * @param framePerSecond The frames per second of the animation
  34643. * @param dataType The data type of the animation
  34644. * @param loopMode The loop mode of the animation
  34645. * @param enableBlending Specifies if blending should be enabled
  34646. */
  34647. constructor(
  34648. /**Name of the animation */
  34649. name: string,
  34650. /**Property to animate */
  34651. targetProperty: string,
  34652. /**The frames per second of the animation */
  34653. framePerSecond: number,
  34654. /**The data type of the animation */
  34655. dataType: number,
  34656. /**The loop mode of the animation */
  34657. loopMode?: number | undefined,
  34658. /**Specifies if blending should be enabled */
  34659. enableBlending?: boolean | undefined);
  34660. /**
  34661. * Converts the animation to a string
  34662. * @param fullDetails support for multiple levels of logging within scene loading
  34663. * @returns String form of the animation
  34664. */
  34665. toString(fullDetails?: boolean): string;
  34666. /**
  34667. * Add an event to this animation
  34668. * @param event Event to add
  34669. */
  34670. addEvent(event: AnimationEvent): void;
  34671. /**
  34672. * Remove all events found at the given frame
  34673. * @param frame The frame to remove events from
  34674. */
  34675. removeEvents(frame: number): void;
  34676. /**
  34677. * Retrieves all the events from the animation
  34678. * @returns Events from the animation
  34679. */
  34680. getEvents(): AnimationEvent[];
  34681. /**
  34682. * Creates an animation range
  34683. * @param name Name of the animation range
  34684. * @param from Starting frame of the animation range
  34685. * @param to Ending frame of the animation
  34686. */
  34687. createRange(name: string, from: number, to: number): void;
  34688. /**
  34689. * Deletes an animation range by name
  34690. * @param name Name of the animation range to delete
  34691. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  34692. */
  34693. deleteRange(name: string, deleteFrames?: boolean): void;
  34694. /**
  34695. * Gets the animation range by name, or null if not defined
  34696. * @param name Name of the animation range
  34697. * @returns Nullable animation range
  34698. */
  34699. getRange(name: string): Nullable<AnimationRange>;
  34700. /**
  34701. * Gets the key frames from the animation
  34702. * @returns The key frames of the animation
  34703. */
  34704. getKeys(): Array<IAnimationKey>;
  34705. /**
  34706. * Gets the highest frame rate of the animation
  34707. * @returns Highest frame rate of the animation
  34708. */
  34709. getHighestFrame(): number;
  34710. /**
  34711. * Gets the easing function of the animation
  34712. * @returns Easing function of the animation
  34713. */
  34714. getEasingFunction(): IEasingFunction;
  34715. /**
  34716. * Sets the easing function of the animation
  34717. * @param easingFunction A custom mathematical formula for animation
  34718. */
  34719. setEasingFunction(easingFunction: EasingFunction): void;
  34720. /**
  34721. * Interpolates a scalar linearly
  34722. * @param startValue Start value of the animation curve
  34723. * @param endValue End value of the animation curve
  34724. * @param gradient Scalar amount to interpolate
  34725. * @returns Interpolated scalar value
  34726. */
  34727. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  34728. /**
  34729. * Interpolates a scalar cubically
  34730. * @param startValue Start value of the animation curve
  34731. * @param outTangent End tangent of the animation
  34732. * @param endValue End value of the animation curve
  34733. * @param inTangent Start tangent of the animation curve
  34734. * @param gradient Scalar amount to interpolate
  34735. * @returns Interpolated scalar value
  34736. */
  34737. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  34738. /**
  34739. * Interpolates a quaternion using a spherical linear interpolation
  34740. * @param startValue Start value of the animation curve
  34741. * @param endValue End value of the animation curve
  34742. * @param gradient Scalar amount to interpolate
  34743. * @returns Interpolated quaternion value
  34744. */
  34745. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  34746. /**
  34747. * Interpolates a quaternion cubically
  34748. * @param startValue Start value of the animation curve
  34749. * @param outTangent End tangent of the animation curve
  34750. * @param endValue End value of the animation curve
  34751. * @param inTangent Start tangent of the animation curve
  34752. * @param gradient Scalar amount to interpolate
  34753. * @returns Interpolated quaternion value
  34754. */
  34755. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  34756. /**
  34757. * Interpolates a Vector3 linearl
  34758. * @param startValue Start value of the animation curve
  34759. * @param endValue End value of the animation curve
  34760. * @param gradient Scalar amount to interpolate
  34761. * @returns Interpolated scalar value
  34762. */
  34763. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  34764. /**
  34765. * Interpolates a Vector3 cubically
  34766. * @param startValue Start value of the animation curve
  34767. * @param outTangent End tangent of the animation
  34768. * @param endValue End value of the animation curve
  34769. * @param inTangent Start tangent of the animation curve
  34770. * @param gradient Scalar amount to interpolate
  34771. * @returns InterpolatedVector3 value
  34772. */
  34773. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  34774. /**
  34775. * Interpolates a Vector2 linearly
  34776. * @param startValue Start value of the animation curve
  34777. * @param endValue End value of the animation curve
  34778. * @param gradient Scalar amount to interpolate
  34779. * @returns Interpolated Vector2 value
  34780. */
  34781. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  34782. /**
  34783. * Interpolates a Vector2 cubically
  34784. * @param startValue Start value of the animation curve
  34785. * @param outTangent End tangent of the animation
  34786. * @param endValue End value of the animation curve
  34787. * @param inTangent Start tangent of the animation curve
  34788. * @param gradient Scalar amount to interpolate
  34789. * @returns Interpolated Vector2 value
  34790. */
  34791. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  34792. /**
  34793. * Interpolates a size linearly
  34794. * @param startValue Start value of the animation curve
  34795. * @param endValue End value of the animation curve
  34796. * @param gradient Scalar amount to interpolate
  34797. * @returns Interpolated Size value
  34798. */
  34799. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  34800. /**
  34801. * Interpolates a Color3 linearly
  34802. * @param startValue Start value of the animation curve
  34803. * @param endValue End value of the animation curve
  34804. * @param gradient Scalar amount to interpolate
  34805. * @returns Interpolated Color3 value
  34806. */
  34807. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  34808. /**
  34809. * Interpolates a Color4 linearly
  34810. * @param startValue Start value of the animation curve
  34811. * @param endValue End value of the animation curve
  34812. * @param gradient Scalar amount to interpolate
  34813. * @returns Interpolated Color3 value
  34814. */
  34815. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  34816. /**
  34817. * @hidden Internal use only
  34818. */
  34819. _getKeyValue(value: any): any;
  34820. /**
  34821. * @hidden Internal use only
  34822. */
  34823. _interpolate(currentFrame: number, state: _IAnimationState): any;
  34824. /**
  34825. * Defines the function to use to interpolate matrices
  34826. * @param startValue defines the start matrix
  34827. * @param endValue defines the end matrix
  34828. * @param gradient defines the gradient between both matrices
  34829. * @param result defines an optional target matrix where to store the interpolation
  34830. * @returns the interpolated matrix
  34831. */
  34832. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  34833. /**
  34834. * Makes a copy of the animation
  34835. * @returns Cloned animation
  34836. */
  34837. clone(): Animation;
  34838. /**
  34839. * Sets the key frames of the animation
  34840. * @param values The animation key frames to set
  34841. */
  34842. setKeys(values: Array<IAnimationKey>): void;
  34843. /**
  34844. * Serializes the animation to an object
  34845. * @returns Serialized object
  34846. */
  34847. serialize(): any;
  34848. /**
  34849. * Float animation type
  34850. */
  34851. static readonly ANIMATIONTYPE_FLOAT: number;
  34852. /**
  34853. * Vector3 animation type
  34854. */
  34855. static readonly ANIMATIONTYPE_VECTOR3: number;
  34856. /**
  34857. * Quaternion animation type
  34858. */
  34859. static readonly ANIMATIONTYPE_QUATERNION: number;
  34860. /**
  34861. * Matrix animation type
  34862. */
  34863. static readonly ANIMATIONTYPE_MATRIX: number;
  34864. /**
  34865. * Color3 animation type
  34866. */
  34867. static readonly ANIMATIONTYPE_COLOR3: number;
  34868. /**
  34869. * Color3 animation type
  34870. */
  34871. static readonly ANIMATIONTYPE_COLOR4: number;
  34872. /**
  34873. * Vector2 animation type
  34874. */
  34875. static readonly ANIMATIONTYPE_VECTOR2: number;
  34876. /**
  34877. * Size animation type
  34878. */
  34879. static readonly ANIMATIONTYPE_SIZE: number;
  34880. /**
  34881. * Relative Loop Mode
  34882. */
  34883. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  34884. /**
  34885. * Cycle Loop Mode
  34886. */
  34887. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  34888. /**
  34889. * Constant Loop Mode
  34890. */
  34891. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  34892. /** @hidden */
  34893. static _UniversalLerp(left: any, right: any, amount: number): any;
  34894. /**
  34895. * Parses an animation object and creates an animation
  34896. * @param parsedAnimation Parsed animation object
  34897. * @returns Animation object
  34898. */
  34899. static Parse(parsedAnimation: any): Animation;
  34900. /**
  34901. * Appends the serialized animations from the source animations
  34902. * @param source Source containing the animations
  34903. * @param destination Target to store the animations
  34904. */
  34905. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  34906. /**
  34907. * Creates a new animation or an array of animations from a snippet saved in a remote file
  34908. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  34909. * @param url defines the url to load from
  34910. * @returns a promise that will resolve to the new animation or an array of animations
  34911. */
  34912. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  34913. /**
  34914. * Creates an animation or an array of animations from a snippet saved by the Inspector
  34915. * @param snippetId defines the snippet to load
  34916. * @returns a promise that will resolve to the new animation or a new array of animations
  34917. */
  34918. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  34919. }
  34920. }
  34921. declare module "babylonjs/Animations/animatable.interface" {
  34922. import { Nullable } from "babylonjs/types";
  34923. import { Animation } from "babylonjs/Animations/animation";
  34924. /**
  34925. * Interface containing an array of animations
  34926. */
  34927. export interface IAnimatable {
  34928. /**
  34929. * Array of animations
  34930. */
  34931. animations: Nullable<Array<Animation>>;
  34932. }
  34933. }
  34934. declare module "babylonjs/Misc/decorators" {
  34935. import { Nullable } from "babylonjs/types";
  34936. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34937. import { Scene } from "babylonjs/scene";
  34938. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  34939. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  34940. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  34941. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  34942. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  34943. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34944. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34945. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34946. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34947. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34948. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34949. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34950. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34951. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34952. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34953. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34954. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34955. /**
  34956. * Decorator used to define property that can be serialized as reference to a camera
  34957. * @param sourceName defines the name of the property to decorate
  34958. */
  34959. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34960. /**
  34961. * Class used to help serialization objects
  34962. */
  34963. export class SerializationHelper {
  34964. /** @hidden */
  34965. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  34966. /** @hidden */
  34967. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  34968. /** @hidden */
  34969. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  34970. /** @hidden */
  34971. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  34972. /**
  34973. * Appends the serialized animations from the source animations
  34974. * @param source Source containing the animations
  34975. * @param destination Target to store the animations
  34976. */
  34977. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  34978. /**
  34979. * Static function used to serialized a specific entity
  34980. * @param entity defines the entity to serialize
  34981. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  34982. * @returns a JSON compatible object representing the serialization of the entity
  34983. */
  34984. static Serialize<T>(entity: T, serializationObject?: any): any;
  34985. /**
  34986. * Creates a new entity from a serialization data object
  34987. * @param creationFunction defines a function used to instanciated the new entity
  34988. * @param source defines the source serialization data
  34989. * @param scene defines the hosting scene
  34990. * @param rootUrl defines the root url for resources
  34991. * @returns a new entity
  34992. */
  34993. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  34994. /**
  34995. * Clones an object
  34996. * @param creationFunction defines the function used to instanciate the new object
  34997. * @param source defines the source object
  34998. * @returns the cloned object
  34999. */
  35000. static Clone<T>(creationFunction: () => T, source: T): T;
  35001. /**
  35002. * Instanciates a new object based on a source one (some data will be shared between both object)
  35003. * @param creationFunction defines the function used to instanciate the new object
  35004. * @param source defines the source object
  35005. * @returns the new object
  35006. */
  35007. static Instanciate<T>(creationFunction: () => T, source: T): T;
  35008. }
  35009. }
  35010. declare module "babylonjs/Materials/Textures/baseTexture" {
  35011. import { Observable } from "babylonjs/Misc/observable";
  35012. import { Nullable } from "babylonjs/types";
  35013. import { Scene } from "babylonjs/scene";
  35014. import { Matrix } from "babylonjs/Maths/math.vector";
  35015. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35016. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  35017. import { ISize } from "babylonjs/Maths/math.size";
  35018. import "babylonjs/Misc/fileTools";
  35019. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  35020. /**
  35021. * Base class of all the textures in babylon.
  35022. * It groups all the common properties the materials, post process, lights... might need
  35023. * in order to make a correct use of the texture.
  35024. */
  35025. export class BaseTexture implements IAnimatable {
  35026. /**
  35027. * Default anisotropic filtering level for the application.
  35028. * It is set to 4 as a good tradeoff between perf and quality.
  35029. */
  35030. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  35031. /**
  35032. * Gets or sets the unique id of the texture
  35033. */
  35034. uniqueId: number;
  35035. /**
  35036. * Define the name of the texture.
  35037. */
  35038. name: string;
  35039. /**
  35040. * Gets or sets an object used to store user defined information.
  35041. */
  35042. metadata: any;
  35043. /**
  35044. * For internal use only. Please do not use.
  35045. */
  35046. reservedDataStore: any;
  35047. private _hasAlpha;
  35048. /**
  35049. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  35050. */
  35051. set hasAlpha(value: boolean);
  35052. get hasAlpha(): boolean;
  35053. /**
  35054. * Defines if the alpha value should be determined via the rgb values.
  35055. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  35056. */
  35057. getAlphaFromRGB: boolean;
  35058. /**
  35059. * Intensity or strength of the texture.
  35060. * It is commonly used by materials to fine tune the intensity of the texture
  35061. */
  35062. level: number;
  35063. /**
  35064. * Define the UV chanel to use starting from 0 and defaulting to 0.
  35065. * This is part of the texture as textures usually maps to one uv set.
  35066. */
  35067. coordinatesIndex: number;
  35068. protected _coordinatesMode: number;
  35069. /**
  35070. * How a texture is mapped.
  35071. *
  35072. * | Value | Type | Description |
  35073. * | ----- | ----------------------------------- | ----------- |
  35074. * | 0 | EXPLICIT_MODE | |
  35075. * | 1 | SPHERICAL_MODE | |
  35076. * | 2 | PLANAR_MODE | |
  35077. * | 3 | CUBIC_MODE | |
  35078. * | 4 | PROJECTION_MODE | |
  35079. * | 5 | SKYBOX_MODE | |
  35080. * | 6 | INVCUBIC_MODE | |
  35081. * | 7 | EQUIRECTANGULAR_MODE | |
  35082. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  35083. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  35084. */
  35085. set coordinatesMode(value: number);
  35086. get coordinatesMode(): number;
  35087. private _wrapU;
  35088. /**
  35089. * | Value | Type | Description |
  35090. * | ----- | ------------------ | ----------- |
  35091. * | 0 | CLAMP_ADDRESSMODE | |
  35092. * | 1 | WRAP_ADDRESSMODE | |
  35093. * | 2 | MIRROR_ADDRESSMODE | |
  35094. */
  35095. get wrapU(): number;
  35096. set wrapU(value: number);
  35097. private _wrapV;
  35098. /**
  35099. * | Value | Type | Description |
  35100. * | ----- | ------------------ | ----------- |
  35101. * | 0 | CLAMP_ADDRESSMODE | |
  35102. * | 1 | WRAP_ADDRESSMODE | |
  35103. * | 2 | MIRROR_ADDRESSMODE | |
  35104. */
  35105. get wrapV(): number;
  35106. set wrapV(value: number);
  35107. /**
  35108. * | Value | Type | Description |
  35109. * | ----- | ------------------ | ----------- |
  35110. * | 0 | CLAMP_ADDRESSMODE | |
  35111. * | 1 | WRAP_ADDRESSMODE | |
  35112. * | 2 | MIRROR_ADDRESSMODE | |
  35113. */
  35114. wrapR: number;
  35115. /**
  35116. * With compliant hardware and browser (supporting anisotropic filtering)
  35117. * this defines the level of anisotropic filtering in the texture.
  35118. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  35119. */
  35120. anisotropicFilteringLevel: number;
  35121. /**
  35122. * Define if the texture is a cube texture or if false a 2d texture.
  35123. */
  35124. get isCube(): boolean;
  35125. set isCube(value: boolean);
  35126. /**
  35127. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  35128. */
  35129. get is3D(): boolean;
  35130. set is3D(value: boolean);
  35131. /**
  35132. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  35133. */
  35134. get is2DArray(): boolean;
  35135. set is2DArray(value: boolean);
  35136. /**
  35137. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  35138. * HDR texture are usually stored in linear space.
  35139. * This only impacts the PBR and Background materials
  35140. */
  35141. gammaSpace: boolean;
  35142. /**
  35143. * Gets or sets whether or not the texture contains RGBD data.
  35144. */
  35145. get isRGBD(): boolean;
  35146. set isRGBD(value: boolean);
  35147. /**
  35148. * Is Z inverted in the texture (useful in a cube texture).
  35149. */
  35150. invertZ: boolean;
  35151. /**
  35152. * Are mip maps generated for this texture or not.
  35153. */
  35154. get noMipmap(): boolean;
  35155. /**
  35156. * @hidden
  35157. */
  35158. lodLevelInAlpha: boolean;
  35159. /**
  35160. * With prefiltered texture, defined the offset used during the prefiltering steps.
  35161. */
  35162. get lodGenerationOffset(): number;
  35163. set lodGenerationOffset(value: number);
  35164. /**
  35165. * With prefiltered texture, defined the scale used during the prefiltering steps.
  35166. */
  35167. get lodGenerationScale(): number;
  35168. set lodGenerationScale(value: number);
  35169. /**
  35170. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  35171. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  35172. * average roughness values.
  35173. */
  35174. get linearSpecularLOD(): boolean;
  35175. set linearSpecularLOD(value: boolean);
  35176. /**
  35177. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  35178. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  35179. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  35180. */
  35181. get irradianceTexture(): Nullable<BaseTexture>;
  35182. set irradianceTexture(value: Nullable<BaseTexture>);
  35183. /**
  35184. * Define if the texture is a render target.
  35185. */
  35186. isRenderTarget: boolean;
  35187. /**
  35188. * Define the unique id of the texture in the scene.
  35189. */
  35190. get uid(): string;
  35191. /** @hidden */
  35192. _prefiltered: boolean;
  35193. /**
  35194. * Return a string representation of the texture.
  35195. * @returns the texture as a string
  35196. */
  35197. toString(): string;
  35198. /**
  35199. * Get the class name of the texture.
  35200. * @returns "BaseTexture"
  35201. */
  35202. getClassName(): string;
  35203. /**
  35204. * Define the list of animation attached to the texture.
  35205. */
  35206. animations: import("babylonjs/Animations/animation").Animation[];
  35207. /**
  35208. * An event triggered when the texture is disposed.
  35209. */
  35210. onDisposeObservable: Observable<BaseTexture>;
  35211. private _onDisposeObserver;
  35212. /**
  35213. * Callback triggered when the texture has been disposed.
  35214. * Kept for back compatibility, you can use the onDisposeObservable instead.
  35215. */
  35216. set onDispose(callback: () => void);
  35217. /**
  35218. * Define the current state of the loading sequence when in delayed load mode.
  35219. */
  35220. delayLoadState: number;
  35221. protected _scene: Nullable<Scene>;
  35222. protected _engine: Nullable<ThinEngine>;
  35223. /** @hidden */
  35224. _texture: Nullable<InternalTexture>;
  35225. private _uid;
  35226. /**
  35227. * Define if the texture is preventinga material to render or not.
  35228. * If not and the texture is not ready, the engine will use a default black texture instead.
  35229. */
  35230. get isBlocking(): boolean;
  35231. /**
  35232. * Instantiates a new BaseTexture.
  35233. * Base class of all the textures in babylon.
  35234. * It groups all the common properties the materials, post process, lights... might need
  35235. * in order to make a correct use of the texture.
  35236. * @param sceneOrEngine Define the scene or engine the texture blongs to
  35237. */
  35238. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  35239. /**
  35240. * Get the scene the texture belongs to.
  35241. * @returns the scene or null if undefined
  35242. */
  35243. getScene(): Nullable<Scene>;
  35244. /** @hidden */
  35245. protected _getEngine(): Nullable<ThinEngine>;
  35246. /**
  35247. * Get the texture transform matrix used to offset tile the texture for istance.
  35248. * @returns the transformation matrix
  35249. */
  35250. getTextureMatrix(): Matrix;
  35251. /**
  35252. * Get the texture reflection matrix used to rotate/transform the reflection.
  35253. * @returns the reflection matrix
  35254. */
  35255. getReflectionTextureMatrix(): Matrix;
  35256. /**
  35257. * Get the underlying lower level texture from Babylon.
  35258. * @returns the insternal texture
  35259. */
  35260. getInternalTexture(): Nullable<InternalTexture>;
  35261. /**
  35262. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  35263. * @returns true if ready or not blocking
  35264. */
  35265. isReadyOrNotBlocking(): boolean;
  35266. /**
  35267. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  35268. * @returns true if fully ready
  35269. */
  35270. isReady(): boolean;
  35271. private _cachedSize;
  35272. /**
  35273. * Get the size of the texture.
  35274. * @returns the texture size.
  35275. */
  35276. getSize(): ISize;
  35277. /**
  35278. * Get the base size of the texture.
  35279. * It can be different from the size if the texture has been resized for POT for instance
  35280. * @returns the base size
  35281. */
  35282. getBaseSize(): ISize;
  35283. /**
  35284. * Update the sampling mode of the texture.
  35285. * Default is Trilinear mode.
  35286. *
  35287. * | Value | Type | Description |
  35288. * | ----- | ------------------ | ----------- |
  35289. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  35290. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  35291. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  35292. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  35293. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  35294. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  35295. * | 7 | NEAREST_LINEAR | |
  35296. * | 8 | NEAREST_NEAREST | |
  35297. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  35298. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  35299. * | 11 | LINEAR_LINEAR | |
  35300. * | 12 | LINEAR_NEAREST | |
  35301. *
  35302. * > _mag_: magnification filter (close to the viewer)
  35303. * > _min_: minification filter (far from the viewer)
  35304. * > _mip_: filter used between mip map levels
  35305. *@param samplingMode Define the new sampling mode of the texture
  35306. */
  35307. updateSamplingMode(samplingMode: number): void;
  35308. /**
  35309. * Scales the texture if is `canRescale()`
  35310. * @param ratio the resize factor we want to use to rescale
  35311. */
  35312. scale(ratio: number): void;
  35313. /**
  35314. * Get if the texture can rescale.
  35315. */
  35316. get canRescale(): boolean;
  35317. /** @hidden */
  35318. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  35319. /** @hidden */
  35320. _rebuild(): void;
  35321. /**
  35322. * Triggers the load sequence in delayed load mode.
  35323. */
  35324. delayLoad(): void;
  35325. /**
  35326. * Clones the texture.
  35327. * @returns the cloned texture
  35328. */
  35329. clone(): Nullable<BaseTexture>;
  35330. /**
  35331. * Get the texture underlying type (INT, FLOAT...)
  35332. */
  35333. get textureType(): number;
  35334. /**
  35335. * Get the texture underlying format (RGB, RGBA...)
  35336. */
  35337. get textureFormat(): number;
  35338. /**
  35339. * Indicates that textures need to be re-calculated for all materials
  35340. */
  35341. protected _markAllSubMeshesAsTexturesDirty(): void;
  35342. /**
  35343. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  35344. * This will returns an RGBA array buffer containing either in values (0-255) or
  35345. * float values (0-1) depending of the underlying buffer type.
  35346. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  35347. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  35348. * @param buffer defines a user defined buffer to fill with data (can be null)
  35349. * @returns The Array buffer containing the pixels data.
  35350. */
  35351. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  35352. /**
  35353. * Release and destroy the underlying lower level texture aka internalTexture.
  35354. */
  35355. releaseInternalTexture(): void;
  35356. /** @hidden */
  35357. get _lodTextureHigh(): Nullable<BaseTexture>;
  35358. /** @hidden */
  35359. get _lodTextureMid(): Nullable<BaseTexture>;
  35360. /** @hidden */
  35361. get _lodTextureLow(): Nullable<BaseTexture>;
  35362. /**
  35363. * Dispose the texture and release its associated resources.
  35364. */
  35365. dispose(): void;
  35366. /**
  35367. * Serialize the texture into a JSON representation that can be parsed later on.
  35368. * @returns the JSON representation of the texture
  35369. */
  35370. serialize(): any;
  35371. /**
  35372. * Helper function to be called back once a list of texture contains only ready textures.
  35373. * @param textures Define the list of textures to wait for
  35374. * @param callback Define the callback triggered once the entire list will be ready
  35375. */
  35376. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  35377. private static _isScene;
  35378. }
  35379. }
  35380. declare module "babylonjs/Materials/effect" {
  35381. import { Observable } from "babylonjs/Misc/observable";
  35382. import { Nullable } from "babylonjs/types";
  35383. import { IDisposable } from "babylonjs/scene";
  35384. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  35385. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  35386. import { IMatrixLike, IVector2Like, IVector3Like, IVector4Like, IColor3Like, IColor4Like } from "babylonjs/Maths/math.like";
  35387. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  35388. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  35389. import { Engine } from "babylonjs/Engines/engine";
  35390. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35391. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  35392. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  35393. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  35394. /**
  35395. * Options to be used when creating an effect.
  35396. */
  35397. export interface IEffectCreationOptions {
  35398. /**
  35399. * Atrributes that will be used in the shader.
  35400. */
  35401. attributes: string[];
  35402. /**
  35403. * Uniform varible names that will be set in the shader.
  35404. */
  35405. uniformsNames: string[];
  35406. /**
  35407. * Uniform buffer variable names that will be set in the shader.
  35408. */
  35409. uniformBuffersNames: string[];
  35410. /**
  35411. * Sampler texture variable names that will be set in the shader.
  35412. */
  35413. samplers: string[];
  35414. /**
  35415. * Define statements that will be set in the shader.
  35416. */
  35417. defines: any;
  35418. /**
  35419. * Possible fallbacks for this effect to improve performance when needed.
  35420. */
  35421. fallbacks: Nullable<IEffectFallbacks>;
  35422. /**
  35423. * Callback that will be called when the shader is compiled.
  35424. */
  35425. onCompiled: Nullable<(effect: Effect) => void>;
  35426. /**
  35427. * Callback that will be called if an error occurs during shader compilation.
  35428. */
  35429. onError: Nullable<(effect: Effect, errors: string) => void>;
  35430. /**
  35431. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  35432. */
  35433. indexParameters?: any;
  35434. /**
  35435. * Max number of lights that can be used in the shader.
  35436. */
  35437. maxSimultaneousLights?: number;
  35438. /**
  35439. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  35440. */
  35441. transformFeedbackVaryings?: Nullable<string[]>;
  35442. /**
  35443. * 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
  35444. */
  35445. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  35446. /**
  35447. * Is this effect rendering to several color attachments ?
  35448. */
  35449. multiTarget?: boolean;
  35450. }
  35451. /**
  35452. * Effect containing vertex and fragment shader that can be executed on an object.
  35453. */
  35454. export class Effect implements IDisposable {
  35455. /**
  35456. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  35457. */
  35458. static ShadersRepository: string;
  35459. /**
  35460. * Enable logging of the shader code when a compilation error occurs
  35461. */
  35462. static LogShaderCodeOnCompilationError: boolean;
  35463. /**
  35464. * Name of the effect.
  35465. */
  35466. name: any;
  35467. /**
  35468. * String container all the define statements that should be set on the shader.
  35469. */
  35470. defines: string;
  35471. /**
  35472. * Callback that will be called when the shader is compiled.
  35473. */
  35474. onCompiled: Nullable<(effect: Effect) => void>;
  35475. /**
  35476. * Callback that will be called if an error occurs during shader compilation.
  35477. */
  35478. onError: Nullable<(effect: Effect, errors: string) => void>;
  35479. /**
  35480. * Callback that will be called when effect is bound.
  35481. */
  35482. onBind: Nullable<(effect: Effect) => void>;
  35483. /**
  35484. * Unique ID of the effect.
  35485. */
  35486. uniqueId: number;
  35487. /**
  35488. * Observable that will be called when the shader is compiled.
  35489. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  35490. */
  35491. onCompileObservable: Observable<Effect>;
  35492. /**
  35493. * Observable that will be called if an error occurs during shader compilation.
  35494. */
  35495. onErrorObservable: Observable<Effect>;
  35496. /** @hidden */
  35497. _onBindObservable: Nullable<Observable<Effect>>;
  35498. /**
  35499. * @hidden
  35500. * Specifies if the effect was previously ready
  35501. */
  35502. _wasPreviouslyReady: boolean;
  35503. /**
  35504. * Observable that will be called when effect is bound.
  35505. */
  35506. get onBindObservable(): Observable<Effect>;
  35507. /** @hidden */
  35508. _bonesComputationForcedToCPU: boolean;
  35509. /** @hidden */
  35510. _multiTarget: boolean;
  35511. private static _uniqueIdSeed;
  35512. private _engine;
  35513. private _uniformBuffersNames;
  35514. private _uniformBuffersNamesList;
  35515. private _uniformsNames;
  35516. private _samplerList;
  35517. private _samplers;
  35518. private _isReady;
  35519. private _compilationError;
  35520. private _allFallbacksProcessed;
  35521. private _attributesNames;
  35522. private _attributes;
  35523. private _attributeLocationByName;
  35524. private _uniforms;
  35525. /**
  35526. * Key for the effect.
  35527. * @hidden
  35528. */
  35529. _key: string;
  35530. private _indexParameters;
  35531. private _fallbacks;
  35532. private _vertexSourceCode;
  35533. private _fragmentSourceCode;
  35534. private _vertexSourceCodeOverride;
  35535. private _fragmentSourceCodeOverride;
  35536. private _transformFeedbackVaryings;
  35537. /**
  35538. * Compiled shader to webGL program.
  35539. * @hidden
  35540. */
  35541. _pipelineContext: Nullable<IPipelineContext>;
  35542. private _valueCache;
  35543. private static _baseCache;
  35544. /**
  35545. * Instantiates an effect.
  35546. * An effect can be used to create/manage/execute vertex and fragment shaders.
  35547. * @param baseName Name of the effect.
  35548. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  35549. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  35550. * @param samplers List of sampler variables that will be passed to the shader.
  35551. * @param engine Engine to be used to render the effect
  35552. * @param defines Define statements to be added to the shader.
  35553. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  35554. * @param onCompiled Callback that will be called when the shader is compiled.
  35555. * @param onError Callback that will be called if an error occurs during shader compilation.
  35556. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  35557. */
  35558. 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);
  35559. private _useFinalCode;
  35560. /**
  35561. * Unique key for this effect
  35562. */
  35563. get key(): string;
  35564. /**
  35565. * If the effect has been compiled and prepared.
  35566. * @returns if the effect is compiled and prepared.
  35567. */
  35568. isReady(): boolean;
  35569. private _isReadyInternal;
  35570. /**
  35571. * The engine the effect was initialized with.
  35572. * @returns the engine.
  35573. */
  35574. getEngine(): Engine;
  35575. /**
  35576. * The pipeline context for this effect
  35577. * @returns the associated pipeline context
  35578. */
  35579. getPipelineContext(): Nullable<IPipelineContext>;
  35580. /**
  35581. * The set of names of attribute variables for the shader.
  35582. * @returns An array of attribute names.
  35583. */
  35584. getAttributesNames(): string[];
  35585. /**
  35586. * Returns the attribute at the given index.
  35587. * @param index The index of the attribute.
  35588. * @returns The location of the attribute.
  35589. */
  35590. getAttributeLocation(index: number): number;
  35591. /**
  35592. * Returns the attribute based on the name of the variable.
  35593. * @param name of the attribute to look up.
  35594. * @returns the attribute location.
  35595. */
  35596. getAttributeLocationByName(name: string): number;
  35597. /**
  35598. * The number of attributes.
  35599. * @returns the numnber of attributes.
  35600. */
  35601. getAttributesCount(): number;
  35602. /**
  35603. * Gets the index of a uniform variable.
  35604. * @param uniformName of the uniform to look up.
  35605. * @returns the index.
  35606. */
  35607. getUniformIndex(uniformName: string): number;
  35608. /**
  35609. * Returns the attribute based on the name of the variable.
  35610. * @param uniformName of the uniform to look up.
  35611. * @returns the location of the uniform.
  35612. */
  35613. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  35614. /**
  35615. * Returns an array of sampler variable names
  35616. * @returns The array of sampler variable names.
  35617. */
  35618. getSamplers(): string[];
  35619. /**
  35620. * Returns an array of uniform variable names
  35621. * @returns The array of uniform variable names.
  35622. */
  35623. getUniformNames(): string[];
  35624. /**
  35625. * Returns an array of uniform buffer variable names
  35626. * @returns The array of uniform buffer variable names.
  35627. */
  35628. getUniformBuffersNames(): string[];
  35629. /**
  35630. * Returns the index parameters used to create the effect
  35631. * @returns The index parameters object
  35632. */
  35633. getIndexParameters(): any;
  35634. /**
  35635. * The error from the last compilation.
  35636. * @returns the error string.
  35637. */
  35638. getCompilationError(): string;
  35639. /**
  35640. * Gets a boolean indicating that all fallbacks were used during compilation
  35641. * @returns true if all fallbacks were used
  35642. */
  35643. allFallbacksProcessed(): boolean;
  35644. /**
  35645. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  35646. * @param func The callback to be used.
  35647. */
  35648. executeWhenCompiled(func: (effect: Effect) => void): void;
  35649. private _checkIsReady;
  35650. private _loadShader;
  35651. /**
  35652. * Gets the vertex shader source code of this effect
  35653. */
  35654. get vertexSourceCode(): string;
  35655. /**
  35656. * Gets the fragment shader source code of this effect
  35657. */
  35658. get fragmentSourceCode(): string;
  35659. /**
  35660. * Recompiles the webGL program
  35661. * @param vertexSourceCode The source code for the vertex shader.
  35662. * @param fragmentSourceCode The source code for the fragment shader.
  35663. * @param onCompiled Callback called when completed.
  35664. * @param onError Callback called on error.
  35665. * @hidden
  35666. */
  35667. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  35668. /**
  35669. * Prepares the effect
  35670. * @hidden
  35671. */
  35672. _prepareEffect(): void;
  35673. private _getShaderCodeAndErrorLine;
  35674. private _processCompilationErrors;
  35675. /**
  35676. * Checks if the effect is supported. (Must be called after compilation)
  35677. */
  35678. get isSupported(): boolean;
  35679. /**
  35680. * Binds a texture to the engine to be used as output of the shader.
  35681. * @param channel Name of the output variable.
  35682. * @param texture Texture to bind.
  35683. * @hidden
  35684. */
  35685. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  35686. /**
  35687. * Sets a texture on the engine to be used in the shader.
  35688. * @param channel Name of the sampler variable.
  35689. * @param texture Texture to set.
  35690. */
  35691. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  35692. /**
  35693. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  35694. * @param channel Name of the sampler variable.
  35695. * @param texture Texture to set.
  35696. */
  35697. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  35698. /**
  35699. * Sets an array of textures on the engine to be used in the shader.
  35700. * @param channel Name of the variable.
  35701. * @param textures Textures to set.
  35702. */
  35703. setTextureArray(channel: string, textures: BaseTexture[]): void;
  35704. /**
  35705. * 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)
  35706. * @param channel Name of the sampler variable.
  35707. * @param postProcess Post process to get the input texture from.
  35708. */
  35709. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  35710. /**
  35711. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  35712. * 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)
  35713. * @param channel Name of the sampler variable.
  35714. * @param postProcess Post process to get the output texture from.
  35715. */
  35716. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  35717. /** @hidden */
  35718. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  35719. /** @hidden */
  35720. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  35721. /** @hidden */
  35722. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  35723. /** @hidden */
  35724. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  35725. /**
  35726. * Binds a buffer to a uniform.
  35727. * @param buffer Buffer to bind.
  35728. * @param name Name of the uniform variable to bind to.
  35729. */
  35730. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  35731. /**
  35732. * Binds block to a uniform.
  35733. * @param blockName Name of the block to bind.
  35734. * @param index Index to bind.
  35735. */
  35736. bindUniformBlock(blockName: string, index: number): void;
  35737. /**
  35738. * Sets an interger value on a uniform variable.
  35739. * @param uniformName Name of the variable.
  35740. * @param value Value to be set.
  35741. * @returns this effect.
  35742. */
  35743. setInt(uniformName: string, value: number): Effect;
  35744. /**
  35745. * Sets an int array on a uniform variable.
  35746. * @param uniformName Name of the variable.
  35747. * @param array array to be set.
  35748. * @returns this effect.
  35749. */
  35750. setIntArray(uniformName: string, array: Int32Array): Effect;
  35751. /**
  35752. * 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)
  35753. * @param uniformName Name of the variable.
  35754. * @param array array to be set.
  35755. * @returns this effect.
  35756. */
  35757. setIntArray2(uniformName: string, array: Int32Array): Effect;
  35758. /**
  35759. * 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)
  35760. * @param uniformName Name of the variable.
  35761. * @param array array to be set.
  35762. * @returns this effect.
  35763. */
  35764. setIntArray3(uniformName: string, array: Int32Array): Effect;
  35765. /**
  35766. * 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)
  35767. * @param uniformName Name of the variable.
  35768. * @param array array to be set.
  35769. * @returns this effect.
  35770. */
  35771. setIntArray4(uniformName: string, array: Int32Array): Effect;
  35772. /**
  35773. * Sets an float array on a uniform variable.
  35774. * @param uniformName Name of the variable.
  35775. * @param array array to be set.
  35776. * @returns this effect.
  35777. */
  35778. setFloatArray(uniformName: string, array: Float32Array): Effect;
  35779. /**
  35780. * 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)
  35781. * @param uniformName Name of the variable.
  35782. * @param array array to be set.
  35783. * @returns this effect.
  35784. */
  35785. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  35786. /**
  35787. * 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)
  35788. * @param uniformName Name of the variable.
  35789. * @param array array to be set.
  35790. * @returns this effect.
  35791. */
  35792. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  35793. /**
  35794. * 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)
  35795. * @param uniformName Name of the variable.
  35796. * @param array array to be set.
  35797. * @returns this effect.
  35798. */
  35799. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  35800. /**
  35801. * Sets an array on a uniform variable.
  35802. * @param uniformName Name of the variable.
  35803. * @param array array to be set.
  35804. * @returns this effect.
  35805. */
  35806. setArray(uniformName: string, array: number[]): Effect;
  35807. /**
  35808. * 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)
  35809. * @param uniformName Name of the variable.
  35810. * @param array array to be set.
  35811. * @returns this effect.
  35812. */
  35813. setArray2(uniformName: string, array: number[]): Effect;
  35814. /**
  35815. * 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)
  35816. * @param uniformName Name of the variable.
  35817. * @param array array to be set.
  35818. * @returns this effect.
  35819. */
  35820. setArray3(uniformName: string, array: number[]): Effect;
  35821. /**
  35822. * 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)
  35823. * @param uniformName Name of the variable.
  35824. * @param array array to be set.
  35825. * @returns this effect.
  35826. */
  35827. setArray4(uniformName: string, array: number[]): Effect;
  35828. /**
  35829. * Sets matrices on a uniform variable.
  35830. * @param uniformName Name of the variable.
  35831. * @param matrices matrices to be set.
  35832. * @returns this effect.
  35833. */
  35834. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  35835. /**
  35836. * Sets matrix on a uniform variable.
  35837. * @param uniformName Name of the variable.
  35838. * @param matrix matrix to be set.
  35839. * @returns this effect.
  35840. */
  35841. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  35842. /**
  35843. * 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)
  35844. * @param uniformName Name of the variable.
  35845. * @param matrix matrix to be set.
  35846. * @returns this effect.
  35847. */
  35848. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  35849. /**
  35850. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  35851. * @param uniformName Name of the variable.
  35852. * @param matrix matrix to be set.
  35853. * @returns this effect.
  35854. */
  35855. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  35856. /**
  35857. * Sets a float on a uniform variable.
  35858. * @param uniformName Name of the variable.
  35859. * @param value value to be set.
  35860. * @returns this effect.
  35861. */
  35862. setFloat(uniformName: string, value: number): Effect;
  35863. /**
  35864. * Sets a boolean on a uniform variable.
  35865. * @param uniformName Name of the variable.
  35866. * @param bool value to be set.
  35867. * @returns this effect.
  35868. */
  35869. setBool(uniformName: string, bool: boolean): Effect;
  35870. /**
  35871. * Sets a Vector2 on a uniform variable.
  35872. * @param uniformName Name of the variable.
  35873. * @param vector2 vector2 to be set.
  35874. * @returns this effect.
  35875. */
  35876. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  35877. /**
  35878. * Sets a float2 on a uniform variable.
  35879. * @param uniformName Name of the variable.
  35880. * @param x First float in float2.
  35881. * @param y Second float in float2.
  35882. * @returns this effect.
  35883. */
  35884. setFloat2(uniformName: string, x: number, y: number): Effect;
  35885. /**
  35886. * Sets a Vector3 on a uniform variable.
  35887. * @param uniformName Name of the variable.
  35888. * @param vector3 Value to be set.
  35889. * @returns this effect.
  35890. */
  35891. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  35892. /**
  35893. * Sets a float3 on a uniform variable.
  35894. * @param uniformName Name of the variable.
  35895. * @param x First float in float3.
  35896. * @param y Second float in float3.
  35897. * @param z Third float in float3.
  35898. * @returns this effect.
  35899. */
  35900. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  35901. /**
  35902. * Sets a Vector4 on a uniform variable.
  35903. * @param uniformName Name of the variable.
  35904. * @param vector4 Value to be set.
  35905. * @returns this effect.
  35906. */
  35907. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  35908. /**
  35909. * Sets a float4 on a uniform variable.
  35910. * @param uniformName Name of the variable.
  35911. * @param x First float in float4.
  35912. * @param y Second float in float4.
  35913. * @param z Third float in float4.
  35914. * @param w Fourth float in float4.
  35915. * @returns this effect.
  35916. */
  35917. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  35918. /**
  35919. * Sets a Color3 on a uniform variable.
  35920. * @param uniformName Name of the variable.
  35921. * @param color3 Value to be set.
  35922. * @returns this effect.
  35923. */
  35924. setColor3(uniformName: string, color3: IColor3Like): Effect;
  35925. /**
  35926. * Sets a Color4 on a uniform variable.
  35927. * @param uniformName Name of the variable.
  35928. * @param color3 Value to be set.
  35929. * @param alpha Alpha value to be set.
  35930. * @returns this effect.
  35931. */
  35932. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  35933. /**
  35934. * Sets a Color4 on a uniform variable
  35935. * @param uniformName defines the name of the variable
  35936. * @param color4 defines the value to be set
  35937. * @returns this effect.
  35938. */
  35939. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  35940. /** Release all associated resources */
  35941. dispose(): void;
  35942. /**
  35943. * This function will add a new shader to the shader store
  35944. * @param name the name of the shader
  35945. * @param pixelShader optional pixel shader content
  35946. * @param vertexShader optional vertex shader content
  35947. */
  35948. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  35949. /**
  35950. * Store of each shader (The can be looked up using effect.key)
  35951. */
  35952. static ShadersStore: {
  35953. [key: string]: string;
  35954. };
  35955. /**
  35956. * Store of each included file for a shader (The can be looked up using effect.key)
  35957. */
  35958. static IncludesShadersStore: {
  35959. [key: string]: string;
  35960. };
  35961. /**
  35962. * Resets the cache of effects.
  35963. */
  35964. static ResetCache(): void;
  35965. }
  35966. }
  35967. declare module "babylonjs/Engines/engineCapabilities" {
  35968. /**
  35969. * Interface used to describe the capabilities of the engine relatively to the current browser
  35970. */
  35971. export interface EngineCapabilities {
  35972. /** Maximum textures units per fragment shader */
  35973. maxTexturesImageUnits: number;
  35974. /** Maximum texture units per vertex shader */
  35975. maxVertexTextureImageUnits: number;
  35976. /** Maximum textures units in the entire pipeline */
  35977. maxCombinedTexturesImageUnits: number;
  35978. /** Maximum texture size */
  35979. maxTextureSize: number;
  35980. /** Maximum texture samples */
  35981. maxSamples?: number;
  35982. /** Maximum cube texture size */
  35983. maxCubemapTextureSize: number;
  35984. /** Maximum render texture size */
  35985. maxRenderTextureSize: number;
  35986. /** Maximum number of vertex attributes */
  35987. maxVertexAttribs: number;
  35988. /** Maximum number of varyings */
  35989. maxVaryingVectors: number;
  35990. /** Maximum number of uniforms per vertex shader */
  35991. maxVertexUniformVectors: number;
  35992. /** Maximum number of uniforms per fragment shader */
  35993. maxFragmentUniformVectors: number;
  35994. /** Defines if standard derivates (dx/dy) are supported */
  35995. standardDerivatives: boolean;
  35996. /** Defines if s3tc texture compression is supported */
  35997. s3tc?: WEBGL_compressed_texture_s3tc;
  35998. /** Defines if pvrtc texture compression is supported */
  35999. pvrtc: any;
  36000. /** Defines if etc1 texture compression is supported */
  36001. etc1: any;
  36002. /** Defines if etc2 texture compression is supported */
  36003. etc2: any;
  36004. /** Defines if astc texture compression is supported */
  36005. astc: any;
  36006. /** Defines if float textures are supported */
  36007. textureFloat: boolean;
  36008. /** Defines if vertex array objects are supported */
  36009. vertexArrayObject: boolean;
  36010. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  36011. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  36012. /** Gets the maximum level of anisotropy supported */
  36013. maxAnisotropy: number;
  36014. /** Defines if instancing is supported */
  36015. instancedArrays: boolean;
  36016. /** Defines if 32 bits indices are supported */
  36017. uintIndices: boolean;
  36018. /** Defines if high precision shaders are supported */
  36019. highPrecisionShaderSupported: boolean;
  36020. /** Defines if depth reading in the fragment shader is supported */
  36021. fragmentDepthSupported: boolean;
  36022. /** Defines if float texture linear filtering is supported*/
  36023. textureFloatLinearFiltering: boolean;
  36024. /** Defines if rendering to float textures is supported */
  36025. textureFloatRender: boolean;
  36026. /** Defines if half float textures are supported*/
  36027. textureHalfFloat: boolean;
  36028. /** Defines if half float texture linear filtering is supported*/
  36029. textureHalfFloatLinearFiltering: boolean;
  36030. /** Defines if rendering to half float textures is supported */
  36031. textureHalfFloatRender: boolean;
  36032. /** Defines if textureLOD shader command is supported */
  36033. textureLOD: boolean;
  36034. /** Defines if draw buffers extension is supported */
  36035. drawBuffersExtension: boolean;
  36036. /** Defines if depth textures are supported */
  36037. depthTextureExtension: boolean;
  36038. /** Defines if float color buffer are supported */
  36039. colorBufferFloat: boolean;
  36040. /** Gets disjoint timer query extension (null if not supported) */
  36041. timerQuery?: EXT_disjoint_timer_query;
  36042. /** Defines if timestamp can be used with timer query */
  36043. canUseTimestampForTimerQuery: boolean;
  36044. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  36045. multiview?: any;
  36046. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  36047. oculusMultiview?: any;
  36048. /** Function used to let the system compiles shaders in background */
  36049. parallelShaderCompile?: {
  36050. COMPLETION_STATUS_KHR: number;
  36051. };
  36052. /** Max number of texture samples for MSAA */
  36053. maxMSAASamples: number;
  36054. /** Defines if the blend min max extension is supported */
  36055. blendMinMax: boolean;
  36056. }
  36057. }
  36058. declare module "babylonjs/States/depthCullingState" {
  36059. import { Nullable } from "babylonjs/types";
  36060. /**
  36061. * @hidden
  36062. **/
  36063. export class DepthCullingState {
  36064. private _isDepthTestDirty;
  36065. private _isDepthMaskDirty;
  36066. private _isDepthFuncDirty;
  36067. private _isCullFaceDirty;
  36068. private _isCullDirty;
  36069. private _isZOffsetDirty;
  36070. private _isFrontFaceDirty;
  36071. private _depthTest;
  36072. private _depthMask;
  36073. private _depthFunc;
  36074. private _cull;
  36075. private _cullFace;
  36076. private _zOffset;
  36077. private _frontFace;
  36078. /**
  36079. * Initializes the state.
  36080. */
  36081. constructor();
  36082. get isDirty(): boolean;
  36083. get zOffset(): number;
  36084. set zOffset(value: number);
  36085. get cullFace(): Nullable<number>;
  36086. set cullFace(value: Nullable<number>);
  36087. get cull(): Nullable<boolean>;
  36088. set cull(value: Nullable<boolean>);
  36089. get depthFunc(): Nullable<number>;
  36090. set depthFunc(value: Nullable<number>);
  36091. get depthMask(): boolean;
  36092. set depthMask(value: boolean);
  36093. get depthTest(): boolean;
  36094. set depthTest(value: boolean);
  36095. get frontFace(): Nullable<number>;
  36096. set frontFace(value: Nullable<number>);
  36097. reset(): void;
  36098. apply(gl: WebGLRenderingContext): void;
  36099. }
  36100. }
  36101. declare module "babylonjs/States/stencilState" {
  36102. /**
  36103. * @hidden
  36104. **/
  36105. export class StencilState {
  36106. /** 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 */
  36107. static readonly ALWAYS: number;
  36108. /** Passed to stencilOperation to specify that stencil value must be kept */
  36109. static readonly KEEP: number;
  36110. /** Passed to stencilOperation to specify that stencil value must be replaced */
  36111. static readonly REPLACE: number;
  36112. private _isStencilTestDirty;
  36113. private _isStencilMaskDirty;
  36114. private _isStencilFuncDirty;
  36115. private _isStencilOpDirty;
  36116. private _stencilTest;
  36117. private _stencilMask;
  36118. private _stencilFunc;
  36119. private _stencilFuncRef;
  36120. private _stencilFuncMask;
  36121. private _stencilOpStencilFail;
  36122. private _stencilOpDepthFail;
  36123. private _stencilOpStencilDepthPass;
  36124. get isDirty(): boolean;
  36125. get stencilFunc(): number;
  36126. set stencilFunc(value: number);
  36127. get stencilFuncRef(): number;
  36128. set stencilFuncRef(value: number);
  36129. get stencilFuncMask(): number;
  36130. set stencilFuncMask(value: number);
  36131. get stencilOpStencilFail(): number;
  36132. set stencilOpStencilFail(value: number);
  36133. get stencilOpDepthFail(): number;
  36134. set stencilOpDepthFail(value: number);
  36135. get stencilOpStencilDepthPass(): number;
  36136. set stencilOpStencilDepthPass(value: number);
  36137. get stencilMask(): number;
  36138. set stencilMask(value: number);
  36139. get stencilTest(): boolean;
  36140. set stencilTest(value: boolean);
  36141. constructor();
  36142. reset(): void;
  36143. apply(gl: WebGLRenderingContext): void;
  36144. }
  36145. }
  36146. declare module "babylonjs/States/alphaCullingState" {
  36147. /**
  36148. * @hidden
  36149. **/
  36150. export class AlphaState {
  36151. private _isAlphaBlendDirty;
  36152. private _isBlendFunctionParametersDirty;
  36153. private _isBlendEquationParametersDirty;
  36154. private _isBlendConstantsDirty;
  36155. private _alphaBlend;
  36156. private _blendFunctionParameters;
  36157. private _blendEquationParameters;
  36158. private _blendConstants;
  36159. /**
  36160. * Initializes the state.
  36161. */
  36162. constructor();
  36163. get isDirty(): boolean;
  36164. get alphaBlend(): boolean;
  36165. set alphaBlend(value: boolean);
  36166. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  36167. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  36168. setAlphaEquationParameters(rgb: number, alpha: number): void;
  36169. reset(): void;
  36170. apply(gl: WebGLRenderingContext): void;
  36171. }
  36172. }
  36173. declare module "babylonjs/Engines/WebGL/webGL2ShaderProcessors" {
  36174. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  36175. /** @hidden */
  36176. export class WebGL2ShaderProcessor implements IShaderProcessor {
  36177. attributeProcessor(attribute: string): string;
  36178. varyingProcessor(varying: string, isFragment: boolean): string;
  36179. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  36180. }
  36181. }
  36182. declare module "babylonjs/Engines/instancingAttributeInfo" {
  36183. /**
  36184. * Interface for attribute information associated with buffer instanciation
  36185. */
  36186. export interface InstancingAttributeInfo {
  36187. /**
  36188. * Name of the GLSL attribute
  36189. * if attribute index is not specified, this is used to retrieve the index from the effect
  36190. */
  36191. attributeName: string;
  36192. /**
  36193. * Index/offset of the attribute in the vertex shader
  36194. * if not specified, this will be computes from the name.
  36195. */
  36196. index?: number;
  36197. /**
  36198. * size of the attribute, 1, 2, 3 or 4
  36199. */
  36200. attributeSize: number;
  36201. /**
  36202. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  36203. */
  36204. offset: number;
  36205. /**
  36206. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  36207. * default to 1
  36208. */
  36209. divisor?: number;
  36210. /**
  36211. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  36212. * default is FLOAT
  36213. */
  36214. attributeType?: number;
  36215. /**
  36216. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  36217. */
  36218. normalized?: boolean;
  36219. }
  36220. }
  36221. declare module "babylonjs/Engines/Extensions/engine.videoTexture" {
  36222. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36223. import { Nullable } from "babylonjs/types";
  36224. module "babylonjs/Engines/thinEngine" {
  36225. interface ThinEngine {
  36226. /**
  36227. * Update a video texture
  36228. * @param texture defines the texture to update
  36229. * @param video defines the video element to use
  36230. * @param invertY defines if data must be stored with Y axis inverted
  36231. */
  36232. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  36233. }
  36234. }
  36235. }
  36236. declare module "babylonjs/Engines/Extensions/engine.dynamicTexture" {
  36237. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36238. import { Nullable } from "babylonjs/types";
  36239. module "babylonjs/Engines/thinEngine" {
  36240. interface ThinEngine {
  36241. /**
  36242. * Creates a dynamic texture
  36243. * @param width defines the width of the texture
  36244. * @param height defines the height of the texture
  36245. * @param generateMipMaps defines if the engine should generate the mip levels
  36246. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  36247. * @returns the dynamic texture inside an InternalTexture
  36248. */
  36249. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  36250. /**
  36251. * Update the content of a dynamic texture
  36252. * @param texture defines the texture to update
  36253. * @param canvas defines the canvas containing the source
  36254. * @param invertY defines if data must be stored with Y axis inverted
  36255. * @param premulAlpha defines if alpha is stored as premultiplied
  36256. * @param format defines the format of the data
  36257. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  36258. */
  36259. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  36260. }
  36261. }
  36262. }
  36263. declare module "babylonjs/Materials/Textures/videoTexture" {
  36264. import { Observable } from "babylonjs/Misc/observable";
  36265. import { Nullable } from "babylonjs/types";
  36266. import { Scene } from "babylonjs/scene";
  36267. import { Texture } from "babylonjs/Materials/Textures/texture";
  36268. import "babylonjs/Engines/Extensions/engine.videoTexture";
  36269. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  36270. /**
  36271. * Settings for finer control over video usage
  36272. */
  36273. export interface VideoTextureSettings {
  36274. /**
  36275. * Applies `autoplay` to video, if specified
  36276. */
  36277. autoPlay?: boolean;
  36278. /**
  36279. * Applies `loop` to video, if specified
  36280. */
  36281. loop?: boolean;
  36282. /**
  36283. * Automatically updates internal texture from video at every frame in the render loop
  36284. */
  36285. autoUpdateTexture: boolean;
  36286. /**
  36287. * Image src displayed during the video loading or until the user interacts with the video.
  36288. */
  36289. poster?: string;
  36290. }
  36291. /**
  36292. * If you want to display a video in your scene, this is the special texture for that.
  36293. * This special texture works similar to other textures, with the exception of a few parameters.
  36294. * @see https://doc.babylonjs.com/how_to/video_texture
  36295. */
  36296. export class VideoTexture extends Texture {
  36297. /**
  36298. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  36299. */
  36300. readonly autoUpdateTexture: boolean;
  36301. /**
  36302. * The video instance used by the texture internally
  36303. */
  36304. readonly video: HTMLVideoElement;
  36305. private _onUserActionRequestedObservable;
  36306. /**
  36307. * Event triggerd when a dom action is required by the user to play the video.
  36308. * This happens due to recent changes in browser policies preventing video to auto start.
  36309. */
  36310. get onUserActionRequestedObservable(): Observable<Texture>;
  36311. private _generateMipMaps;
  36312. private _stillImageCaptured;
  36313. private _displayingPosterTexture;
  36314. private _settings;
  36315. private _createInternalTextureOnEvent;
  36316. private _frameId;
  36317. private _currentSrc;
  36318. /**
  36319. * Creates a video texture.
  36320. * If you want to display a video in your scene, this is the special texture for that.
  36321. * This special texture works similar to other textures, with the exception of a few parameters.
  36322. * @see https://doc.babylonjs.com/how_to/video_texture
  36323. * @param name optional name, will detect from video source, if not defined
  36324. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  36325. * @param scene is obviously the current scene.
  36326. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  36327. * @param invertY is false by default but can be used to invert video on Y axis
  36328. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  36329. * @param settings allows finer control over video usage
  36330. */
  36331. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  36332. private _getName;
  36333. private _getVideo;
  36334. private _createInternalTexture;
  36335. private reset;
  36336. /**
  36337. * @hidden Internal method to initiate `update`.
  36338. */
  36339. _rebuild(): void;
  36340. /**
  36341. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  36342. */
  36343. update(): void;
  36344. /**
  36345. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  36346. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  36347. */
  36348. updateTexture(isVisible: boolean): void;
  36349. protected _updateInternalTexture: () => void;
  36350. /**
  36351. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  36352. * @param url New url.
  36353. */
  36354. updateURL(url: string): void;
  36355. /**
  36356. * Clones the texture.
  36357. * @returns the cloned texture
  36358. */
  36359. clone(): VideoTexture;
  36360. /**
  36361. * Dispose the texture and release its associated resources.
  36362. */
  36363. dispose(): void;
  36364. /**
  36365. * Creates a video texture straight from a stream.
  36366. * @param scene Define the scene the texture should be created in
  36367. * @param stream Define the stream the texture should be created from
  36368. * @returns The created video texture as a promise
  36369. */
  36370. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  36371. /**
  36372. * Creates a video texture straight from your WebCam video feed.
  36373. * @param scene Define the scene the texture should be created in
  36374. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  36375. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  36376. * @returns The created video texture as a promise
  36377. */
  36378. static CreateFromWebCamAsync(scene: Scene, constraints: {
  36379. minWidth: number;
  36380. maxWidth: number;
  36381. minHeight: number;
  36382. maxHeight: number;
  36383. deviceId: string;
  36384. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  36385. /**
  36386. * Creates a video texture straight from your WebCam video feed.
  36387. * @param scene Define the scene the texture should be created in
  36388. * @param onReady Define a callback to triggered once the texture will be ready
  36389. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  36390. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  36391. */
  36392. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  36393. minWidth: number;
  36394. maxWidth: number;
  36395. minHeight: number;
  36396. maxHeight: number;
  36397. deviceId: string;
  36398. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  36399. }
  36400. }
  36401. declare module "babylonjs/Engines/thinEngine" {
  36402. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  36403. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  36404. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  36405. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  36406. import { Nullable, DataArray, IndicesArray } from "babylonjs/types";
  36407. import { EngineCapabilities } from "babylonjs/Engines/engineCapabilities";
  36408. import { Observable } from "babylonjs/Misc/observable";
  36409. import { DepthCullingState } from "babylonjs/States/depthCullingState";
  36410. import { StencilState } from "babylonjs/States/stencilState";
  36411. import { AlphaState } from "babylonjs/States/alphaCullingState";
  36412. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36413. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  36414. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  36415. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  36416. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  36417. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  36418. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  36419. import { InstancingAttributeInfo } from "babylonjs/Engines/instancingAttributeInfo";
  36420. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  36421. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  36422. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  36423. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  36424. import { WebRequest } from "babylonjs/Misc/webRequest";
  36425. import { LoadFileError } from "babylonjs/Misc/fileTools";
  36426. /**
  36427. * Defines the interface used by objects working like Scene
  36428. * @hidden
  36429. */
  36430. export interface ISceneLike {
  36431. _addPendingData(data: any): void;
  36432. _removePendingData(data: any): void;
  36433. offlineProvider: IOfflineProvider;
  36434. }
  36435. /**
  36436. * Information about the current host
  36437. */
  36438. export interface HostInformation {
  36439. /**
  36440. * Defines if the current host is a mobile
  36441. */
  36442. isMobile: boolean;
  36443. }
  36444. /** Interface defining initialization parameters for Engine class */
  36445. export interface EngineOptions extends WebGLContextAttributes {
  36446. /**
  36447. * Defines if the engine should no exceed a specified device ratio
  36448. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  36449. */
  36450. limitDeviceRatio?: number;
  36451. /**
  36452. * Defines if webvr should be enabled automatically
  36453. * @see https://doc.babylonjs.com/how_to/webvr_camera
  36454. */
  36455. autoEnableWebVR?: boolean;
  36456. /**
  36457. * Defines if webgl2 should be turned off even if supported
  36458. * @see https://doc.babylonjs.com/features/webgl2
  36459. */
  36460. disableWebGL2Support?: boolean;
  36461. /**
  36462. * Defines if webaudio should be initialized as well
  36463. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  36464. */
  36465. audioEngine?: boolean;
  36466. /**
  36467. * Defines if animations should run using a deterministic lock step
  36468. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  36469. */
  36470. deterministicLockstep?: boolean;
  36471. /** Defines the maximum steps to use with deterministic lock step mode */
  36472. lockstepMaxSteps?: number;
  36473. /** Defines the seconds between each deterministic lock step */
  36474. timeStep?: number;
  36475. /**
  36476. * Defines that engine should ignore context lost events
  36477. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  36478. */
  36479. doNotHandleContextLost?: boolean;
  36480. /**
  36481. * Defines that engine should ignore modifying touch action attribute and style
  36482. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  36483. */
  36484. doNotHandleTouchAction?: boolean;
  36485. /**
  36486. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  36487. */
  36488. useHighPrecisionFloats?: boolean;
  36489. /**
  36490. * Make the canvas XR Compatible for XR sessions
  36491. */
  36492. xrCompatible?: boolean;
  36493. /**
  36494. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  36495. */
  36496. useHighPrecisionMatrix?: boolean;
  36497. }
  36498. /**
  36499. * The base engine class (root of all engines)
  36500. */
  36501. export class ThinEngine {
  36502. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  36503. static ExceptionList: ({
  36504. key: string;
  36505. capture: string;
  36506. captureConstraint: number;
  36507. targets: string[];
  36508. } | {
  36509. key: string;
  36510. capture: null;
  36511. captureConstraint: null;
  36512. targets: string[];
  36513. })[];
  36514. /** @hidden */
  36515. static _TextureLoaders: IInternalTextureLoader[];
  36516. /**
  36517. * Returns the current npm package of the sdk
  36518. */
  36519. static get NpmPackage(): string;
  36520. /**
  36521. * Returns the current version of the framework
  36522. */
  36523. static get Version(): string;
  36524. /**
  36525. * Returns a string describing the current engine
  36526. */
  36527. get description(): string;
  36528. /**
  36529. * Gets or sets the epsilon value used by collision engine
  36530. */
  36531. static CollisionsEpsilon: number;
  36532. /**
  36533. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  36534. */
  36535. static get ShadersRepository(): string;
  36536. static set ShadersRepository(value: string);
  36537. /** @hidden */
  36538. _shaderProcessor: IShaderProcessor;
  36539. /**
  36540. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  36541. */
  36542. forcePOTTextures: boolean;
  36543. /**
  36544. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  36545. */
  36546. isFullscreen: boolean;
  36547. /**
  36548. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  36549. */
  36550. cullBackFaces: boolean;
  36551. /**
  36552. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  36553. */
  36554. renderEvenInBackground: boolean;
  36555. /**
  36556. * Gets or sets a boolean indicating that cache can be kept between frames
  36557. */
  36558. preventCacheWipeBetweenFrames: boolean;
  36559. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  36560. validateShaderPrograms: boolean;
  36561. /**
  36562. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  36563. * This can provide greater z depth for distant objects.
  36564. */
  36565. useReverseDepthBuffer: boolean;
  36566. /**
  36567. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  36568. */
  36569. disableUniformBuffers: boolean;
  36570. /** @hidden */
  36571. _uniformBuffers: UniformBuffer[];
  36572. /**
  36573. * Gets a boolean indicating that the engine supports uniform buffers
  36574. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  36575. */
  36576. get supportsUniformBuffers(): boolean;
  36577. /** @hidden */
  36578. _gl: WebGLRenderingContext;
  36579. /** @hidden */
  36580. _webGLVersion: number;
  36581. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  36582. protected _windowIsBackground: boolean;
  36583. protected _creationOptions: EngineOptions;
  36584. protected _highPrecisionShadersAllowed: boolean;
  36585. /** @hidden */
  36586. get _shouldUseHighPrecisionShader(): boolean;
  36587. /**
  36588. * Gets a boolean indicating that only power of 2 textures are supported
  36589. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  36590. */
  36591. get needPOTTextures(): boolean;
  36592. /** @hidden */
  36593. _badOS: boolean;
  36594. /** @hidden */
  36595. _badDesktopOS: boolean;
  36596. private _hardwareScalingLevel;
  36597. /** @hidden */
  36598. _caps: EngineCapabilities;
  36599. private _isStencilEnable;
  36600. private _glVersion;
  36601. private _glRenderer;
  36602. private _glVendor;
  36603. /** @hidden */
  36604. _videoTextureSupported: boolean;
  36605. protected _renderingQueueLaunched: boolean;
  36606. protected _activeRenderLoops: (() => void)[];
  36607. /**
  36608. * Observable signaled when a context lost event is raised
  36609. */
  36610. onContextLostObservable: Observable<ThinEngine>;
  36611. /**
  36612. * Observable signaled when a context restored event is raised
  36613. */
  36614. onContextRestoredObservable: Observable<ThinEngine>;
  36615. private _onContextLost;
  36616. private _onContextRestored;
  36617. protected _contextWasLost: boolean;
  36618. /** @hidden */
  36619. _doNotHandleContextLost: boolean;
  36620. /**
  36621. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  36622. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  36623. */
  36624. get doNotHandleContextLost(): boolean;
  36625. set doNotHandleContextLost(value: boolean);
  36626. /**
  36627. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  36628. */
  36629. disableVertexArrayObjects: boolean;
  36630. /** @hidden */
  36631. protected _colorWrite: boolean;
  36632. /** @hidden */
  36633. protected _colorWriteChanged: boolean;
  36634. /** @hidden */
  36635. protected _depthCullingState: DepthCullingState;
  36636. /** @hidden */
  36637. protected _stencilState: StencilState;
  36638. /** @hidden */
  36639. _alphaState: AlphaState;
  36640. /** @hidden */
  36641. _alphaMode: number;
  36642. /** @hidden */
  36643. _alphaEquation: number;
  36644. /** @hidden */
  36645. _internalTexturesCache: InternalTexture[];
  36646. /** @hidden */
  36647. protected _activeChannel: number;
  36648. private _currentTextureChannel;
  36649. /** @hidden */
  36650. protected _boundTexturesCache: {
  36651. [key: string]: Nullable<InternalTexture>;
  36652. };
  36653. /** @hidden */
  36654. protected _currentEffect: Nullable<Effect>;
  36655. /** @hidden */
  36656. protected _currentProgram: Nullable<WebGLProgram>;
  36657. private _compiledEffects;
  36658. private _vertexAttribArraysEnabled;
  36659. /** @hidden */
  36660. protected _cachedViewport: Nullable<IViewportLike>;
  36661. private _cachedVertexArrayObject;
  36662. /** @hidden */
  36663. protected _cachedVertexBuffers: any;
  36664. /** @hidden */
  36665. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  36666. /** @hidden */
  36667. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  36668. /** @hidden */
  36669. _currentRenderTarget: Nullable<InternalTexture>;
  36670. private _uintIndicesCurrentlySet;
  36671. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  36672. /** @hidden */
  36673. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  36674. /** @hidden */
  36675. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  36676. private _currentBufferPointers;
  36677. private _currentInstanceLocations;
  36678. private _currentInstanceBuffers;
  36679. private _textureUnits;
  36680. /** @hidden */
  36681. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  36682. /** @hidden */
  36683. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  36684. /** @hidden */
  36685. _boundRenderFunction: any;
  36686. private _vaoRecordInProgress;
  36687. private _mustWipeVertexAttributes;
  36688. private _emptyTexture;
  36689. private _emptyCubeTexture;
  36690. private _emptyTexture3D;
  36691. private _emptyTexture2DArray;
  36692. /** @hidden */
  36693. _frameHandler: number;
  36694. private _nextFreeTextureSlots;
  36695. private _maxSimultaneousTextures;
  36696. private _activeRequests;
  36697. /** @hidden */
  36698. _transformTextureUrl: Nullable<(url: string) => string>;
  36699. /**
  36700. * Gets information about the current host
  36701. */
  36702. hostInformation: HostInformation;
  36703. protected get _supportsHardwareTextureRescaling(): boolean;
  36704. private _framebufferDimensionsObject;
  36705. /**
  36706. * sets the object from which width and height will be taken from when getting render width and height
  36707. * Will fallback to the gl object
  36708. * @param dimensions the framebuffer width and height that will be used.
  36709. */
  36710. set framebufferDimensionsObject(dimensions: Nullable<{
  36711. framebufferWidth: number;
  36712. framebufferHeight: number;
  36713. }>);
  36714. /**
  36715. * Gets the current viewport
  36716. */
  36717. get currentViewport(): Nullable<IViewportLike>;
  36718. /**
  36719. * Gets the default empty texture
  36720. */
  36721. get emptyTexture(): InternalTexture;
  36722. /**
  36723. * Gets the default empty 3D texture
  36724. */
  36725. get emptyTexture3D(): InternalTexture;
  36726. /**
  36727. * Gets the default empty 2D array texture
  36728. */
  36729. get emptyTexture2DArray(): InternalTexture;
  36730. /**
  36731. * Gets the default empty cube texture
  36732. */
  36733. get emptyCubeTexture(): InternalTexture;
  36734. /**
  36735. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  36736. */
  36737. readonly premultipliedAlpha: boolean;
  36738. /**
  36739. * Observable event triggered before each texture is initialized
  36740. */
  36741. onBeforeTextureInitObservable: Observable<import("babylonjs/Materials/Textures/texture").Texture>;
  36742. /**
  36743. * Creates a new engine
  36744. * @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
  36745. * @param antialias defines enable antialiasing (default: false)
  36746. * @param options defines further options to be sent to the getContext() function
  36747. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  36748. */
  36749. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  36750. private _rebuildInternalTextures;
  36751. private _rebuildEffects;
  36752. /**
  36753. * Gets a boolean indicating if all created effects are ready
  36754. * @returns true if all effects are ready
  36755. */
  36756. areAllEffectsReady(): boolean;
  36757. protected _rebuildBuffers(): void;
  36758. protected _initGLContext(): void;
  36759. /**
  36760. * Gets version of the current webGL context
  36761. */
  36762. get webGLVersion(): number;
  36763. /**
  36764. * Gets a string identifying the name of the class
  36765. * @returns "Engine" string
  36766. */
  36767. getClassName(): string;
  36768. /**
  36769. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  36770. */
  36771. get isStencilEnable(): boolean;
  36772. /** @hidden */
  36773. _prepareWorkingCanvas(): void;
  36774. /**
  36775. * Reset the texture cache to empty state
  36776. */
  36777. resetTextureCache(): void;
  36778. /**
  36779. * Gets an object containing information about the current webGL context
  36780. * @returns an object containing the vender, the renderer and the version of the current webGL context
  36781. */
  36782. getGlInfo(): {
  36783. vendor: string;
  36784. renderer: string;
  36785. version: string;
  36786. };
  36787. /**
  36788. * Defines the hardware scaling level.
  36789. * By default the hardware scaling level is computed from the window device ratio.
  36790. * 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.
  36791. * @param level defines the level to use
  36792. */
  36793. setHardwareScalingLevel(level: number): void;
  36794. /**
  36795. * Gets the current hardware scaling level.
  36796. * By default the hardware scaling level is computed from the window device ratio.
  36797. * 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.
  36798. * @returns a number indicating the current hardware scaling level
  36799. */
  36800. getHardwareScalingLevel(): number;
  36801. /**
  36802. * Gets the list of loaded textures
  36803. * @returns an array containing all loaded textures
  36804. */
  36805. getLoadedTexturesCache(): InternalTexture[];
  36806. /**
  36807. * Gets the object containing all engine capabilities
  36808. * @returns the EngineCapabilities object
  36809. */
  36810. getCaps(): EngineCapabilities;
  36811. /**
  36812. * stop executing a render loop function and remove it from the execution array
  36813. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  36814. */
  36815. stopRenderLoop(renderFunction?: () => void): void;
  36816. /** @hidden */
  36817. _renderLoop(): void;
  36818. /**
  36819. * Gets the HTML canvas attached with the current webGL context
  36820. * @returns a HTML canvas
  36821. */
  36822. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  36823. /**
  36824. * Gets host window
  36825. * @returns the host window object
  36826. */
  36827. getHostWindow(): Nullable<Window>;
  36828. /**
  36829. * Gets the current render width
  36830. * @param useScreen defines if screen size must be used (or the current render target if any)
  36831. * @returns a number defining the current render width
  36832. */
  36833. getRenderWidth(useScreen?: boolean): number;
  36834. /**
  36835. * Gets the current render height
  36836. * @param useScreen defines if screen size must be used (or the current render target if any)
  36837. * @returns a number defining the current render height
  36838. */
  36839. getRenderHeight(useScreen?: boolean): number;
  36840. /**
  36841. * Can be used to override the current requestAnimationFrame requester.
  36842. * @hidden
  36843. */
  36844. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  36845. /**
  36846. * Register and execute a render loop. The engine can have more than one render function
  36847. * @param renderFunction defines the function to continuously execute
  36848. */
  36849. runRenderLoop(renderFunction: () => void): void;
  36850. /**
  36851. * Clear the current render buffer or the current render target (if any is set up)
  36852. * @param color defines the color to use
  36853. * @param backBuffer defines if the back buffer must be cleared
  36854. * @param depth defines if the depth buffer must be cleared
  36855. * @param stencil defines if the stencil buffer must be cleared
  36856. */
  36857. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  36858. private _viewportCached;
  36859. /** @hidden */
  36860. _viewport(x: number, y: number, width: number, height: number): void;
  36861. /**
  36862. * Set the WebGL's viewport
  36863. * @param viewport defines the viewport element to be used
  36864. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  36865. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  36866. */
  36867. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  36868. /**
  36869. * Begin a new frame
  36870. */
  36871. beginFrame(): void;
  36872. /**
  36873. * Enf the current frame
  36874. */
  36875. endFrame(): void;
  36876. /**
  36877. * Resize the view according to the canvas' size
  36878. */
  36879. resize(): void;
  36880. /**
  36881. * Force a specific size of the canvas
  36882. * @param width defines the new canvas' width
  36883. * @param height defines the new canvas' height
  36884. * @returns true if the size was changed
  36885. */
  36886. setSize(width: number, height: number): boolean;
  36887. /**
  36888. * Binds the frame buffer to the specified texture.
  36889. * @param texture The texture to render to or null for the default canvas
  36890. * @param faceIndex The face of the texture to render to in case of cube texture
  36891. * @param requiredWidth The width of the target to render to
  36892. * @param requiredHeight The height of the target to render to
  36893. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  36894. * @param lodLevel defines the lod level to bind to the frame buffer
  36895. * @param layer defines the 2d array index to bind to frame buffer to
  36896. */
  36897. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  36898. /** @hidden */
  36899. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  36900. /**
  36901. * Unbind the current render target texture from the webGL context
  36902. * @param texture defines the render target texture to unbind
  36903. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  36904. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  36905. */
  36906. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  36907. /**
  36908. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  36909. */
  36910. flushFramebuffer(): void;
  36911. /**
  36912. * Unbind the current render target and bind the default framebuffer
  36913. */
  36914. restoreDefaultFramebuffer(): void;
  36915. /** @hidden */
  36916. protected _resetVertexBufferBinding(): void;
  36917. /**
  36918. * Creates a vertex buffer
  36919. * @param data the data for the vertex buffer
  36920. * @returns the new WebGL static buffer
  36921. */
  36922. createVertexBuffer(data: DataArray): DataBuffer;
  36923. private _createVertexBuffer;
  36924. /**
  36925. * Creates a dynamic vertex buffer
  36926. * @param data the data for the dynamic vertex buffer
  36927. * @returns the new WebGL dynamic buffer
  36928. */
  36929. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  36930. protected _resetIndexBufferBinding(): void;
  36931. /**
  36932. * Creates a new index buffer
  36933. * @param indices defines the content of the index buffer
  36934. * @param updatable defines if the index buffer must be updatable
  36935. * @returns a new webGL buffer
  36936. */
  36937. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  36938. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  36939. /**
  36940. * Bind a webGL buffer to the webGL context
  36941. * @param buffer defines the buffer to bind
  36942. */
  36943. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  36944. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  36945. private bindBuffer;
  36946. /**
  36947. * update the bound buffer with the given data
  36948. * @param data defines the data to update
  36949. */
  36950. updateArrayBuffer(data: Float32Array): void;
  36951. private _vertexAttribPointer;
  36952. /** @hidden */
  36953. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  36954. private _bindVertexBuffersAttributes;
  36955. /**
  36956. * Records a vertex array object
  36957. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  36958. * @param vertexBuffers defines the list of vertex buffers to store
  36959. * @param indexBuffer defines the index buffer to store
  36960. * @param effect defines the effect to store
  36961. * @returns the new vertex array object
  36962. */
  36963. recordVertexArrayObject(vertexBuffers: {
  36964. [key: string]: VertexBuffer;
  36965. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  36966. /**
  36967. * Bind a specific vertex array object
  36968. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  36969. * @param vertexArrayObject defines the vertex array object to bind
  36970. * @param indexBuffer defines the index buffer to bind
  36971. */
  36972. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  36973. /**
  36974. * Bind webGl buffers directly to the webGL context
  36975. * @param vertexBuffer defines the vertex buffer to bind
  36976. * @param indexBuffer defines the index buffer to bind
  36977. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  36978. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  36979. * @param effect defines the effect associated with the vertex buffer
  36980. */
  36981. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  36982. private _unbindVertexArrayObject;
  36983. /**
  36984. * Bind a list of vertex buffers to the webGL context
  36985. * @param vertexBuffers defines the list of vertex buffers to bind
  36986. * @param indexBuffer defines the index buffer to bind
  36987. * @param effect defines the effect associated with the vertex buffers
  36988. */
  36989. bindBuffers(vertexBuffers: {
  36990. [key: string]: Nullable<VertexBuffer>;
  36991. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  36992. /**
  36993. * Unbind all instance attributes
  36994. */
  36995. unbindInstanceAttributes(): void;
  36996. /**
  36997. * Release and free the memory of a vertex array object
  36998. * @param vao defines the vertex array object to delete
  36999. */
  37000. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  37001. /** @hidden */
  37002. _releaseBuffer(buffer: DataBuffer): boolean;
  37003. protected _deleteBuffer(buffer: DataBuffer): void;
  37004. /**
  37005. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  37006. * @param instancesBuffer defines the webGL buffer to update and bind
  37007. * @param data defines the data to store in the buffer
  37008. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  37009. */
  37010. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  37011. /**
  37012. * Bind the content of a webGL buffer used with instantiation
  37013. * @param instancesBuffer defines the webGL buffer to bind
  37014. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  37015. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  37016. */
  37017. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  37018. /**
  37019. * Disable the instance attribute corresponding to the name in parameter
  37020. * @param name defines the name of the attribute to disable
  37021. */
  37022. disableInstanceAttributeByName(name: string): void;
  37023. /**
  37024. * Disable the instance attribute corresponding to the location in parameter
  37025. * @param attributeLocation defines the attribute location of the attribute to disable
  37026. */
  37027. disableInstanceAttribute(attributeLocation: number): void;
  37028. /**
  37029. * Disable the attribute corresponding to the location in parameter
  37030. * @param attributeLocation defines the attribute location of the attribute to disable
  37031. */
  37032. disableAttributeByIndex(attributeLocation: number): void;
  37033. /**
  37034. * Send a draw order
  37035. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  37036. * @param indexStart defines the starting index
  37037. * @param indexCount defines the number of index to draw
  37038. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37039. */
  37040. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  37041. /**
  37042. * Draw a list of points
  37043. * @param verticesStart defines the index of first vertex to draw
  37044. * @param verticesCount defines the count of vertices to draw
  37045. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37046. */
  37047. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37048. /**
  37049. * Draw a list of unindexed primitives
  37050. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  37051. * @param verticesStart defines the index of first vertex to draw
  37052. * @param verticesCount defines the count of vertices to draw
  37053. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37054. */
  37055. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37056. /**
  37057. * Draw a list of indexed primitives
  37058. * @param fillMode defines the primitive to use
  37059. * @param indexStart defines the starting index
  37060. * @param indexCount defines the number of index to draw
  37061. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37062. */
  37063. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  37064. /**
  37065. * Draw a list of unindexed primitives
  37066. * @param fillMode defines the primitive to use
  37067. * @param verticesStart defines the index of first vertex to draw
  37068. * @param verticesCount defines the count of vertices to draw
  37069. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37070. */
  37071. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37072. private _drawMode;
  37073. /** @hidden */
  37074. protected _reportDrawCall(): void;
  37075. /** @hidden */
  37076. _releaseEffect(effect: Effect): void;
  37077. /** @hidden */
  37078. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  37079. /**
  37080. * Create a new effect (used to store vertex/fragment shaders)
  37081. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  37082. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  37083. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  37084. * @param samplers defines an array of string used to represent textures
  37085. * @param defines defines the string containing the defines to use to compile the shaders
  37086. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  37087. * @param onCompiled defines a function to call when the effect creation is successful
  37088. * @param onError defines a function to call when the effect creation has failed
  37089. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  37090. * @returns the new Effect
  37091. */
  37092. 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;
  37093. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  37094. private _compileShader;
  37095. private _compileRawShader;
  37096. /** @hidden */
  37097. _getShaderSource(shader: WebGLShader): Nullable<string>;
  37098. /**
  37099. * Directly creates a webGL program
  37100. * @param pipelineContext defines the pipeline context to attach to
  37101. * @param vertexCode defines the vertex shader code to use
  37102. * @param fragmentCode defines the fragment shader code to use
  37103. * @param context defines the webGL context to use (if not set, the current one will be used)
  37104. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  37105. * @returns the new webGL program
  37106. */
  37107. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37108. /**
  37109. * Creates a webGL program
  37110. * @param pipelineContext defines the pipeline context to attach to
  37111. * @param vertexCode defines the vertex shader code to use
  37112. * @param fragmentCode defines the fragment shader code to use
  37113. * @param defines defines the string containing the defines to use to compile the shaders
  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. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37119. /**
  37120. * Creates a new pipeline context
  37121. * @returns the new pipeline
  37122. */
  37123. createPipelineContext(): IPipelineContext;
  37124. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37125. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  37126. /** @hidden */
  37127. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  37128. /** @hidden */
  37129. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  37130. /** @hidden */
  37131. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  37132. /**
  37133. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  37134. * @param pipelineContext defines the pipeline context to use
  37135. * @param uniformsNames defines the list of uniform names
  37136. * @returns an array of webGL uniform locations
  37137. */
  37138. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  37139. /**
  37140. * Gets the lsit of active attributes for a given webGL program
  37141. * @param pipelineContext defines the pipeline context to use
  37142. * @param attributesNames defines the list of attribute names to get
  37143. * @returns an array of indices indicating the offset of each attribute
  37144. */
  37145. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  37146. /**
  37147. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  37148. * @param effect defines the effect to activate
  37149. */
  37150. enableEffect(effect: Nullable<Effect>): void;
  37151. /**
  37152. * Set the value of an uniform to a number (int)
  37153. * @param uniform defines the webGL uniform location where to store the value
  37154. * @param value defines the int number to store
  37155. */
  37156. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  37157. /**
  37158. * Set the value of an uniform to an array of int32
  37159. * @param uniform defines the webGL uniform location where to store the value
  37160. * @param array defines the array of int32 to store
  37161. */
  37162. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37163. /**
  37164. * Set the value of an uniform to an array of int32 (stored as vec2)
  37165. * @param uniform defines the webGL uniform location where to store the value
  37166. * @param array defines the array of int32 to store
  37167. */
  37168. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37169. /**
  37170. * Set the value of an uniform to an array of int32 (stored as vec3)
  37171. * @param uniform defines the webGL uniform location where to store the value
  37172. * @param array defines the array of int32 to store
  37173. */
  37174. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37175. /**
  37176. * Set the value of an uniform to an array of int32 (stored as vec4)
  37177. * @param uniform defines the webGL uniform location where to store the value
  37178. * @param array defines the array of int32 to store
  37179. */
  37180. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37181. /**
  37182. * Set the value of an uniform to an array of number
  37183. * @param uniform defines the webGL uniform location where to store the value
  37184. * @param array defines the array of number to store
  37185. */
  37186. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37187. /**
  37188. * Set the value of an uniform to an array of number (stored as vec2)
  37189. * @param uniform defines the webGL uniform location where to store the value
  37190. * @param array defines the array of number to store
  37191. */
  37192. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37193. /**
  37194. * Set the value of an uniform to an array of number (stored as vec3)
  37195. * @param uniform defines the webGL uniform location where to store the value
  37196. * @param array defines the array of number to store
  37197. */
  37198. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37199. /**
  37200. * Set the value of an uniform to an array of number (stored as vec4)
  37201. * @param uniform defines the webGL uniform location where to store the value
  37202. * @param array defines the array of number to store
  37203. */
  37204. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37205. /**
  37206. * Set the value of an uniform to an array of float32 (stored as matrices)
  37207. * @param uniform defines the webGL uniform location where to store the value
  37208. * @param matrices defines the array of float32 to store
  37209. */
  37210. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  37211. /**
  37212. * Set the value of an uniform to a matrix (3x3)
  37213. * @param uniform defines the webGL uniform location where to store the value
  37214. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  37215. */
  37216. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  37217. /**
  37218. * Set the value of an uniform to a matrix (2x2)
  37219. * @param uniform defines the webGL uniform location where to store the value
  37220. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  37221. */
  37222. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  37223. /**
  37224. * Set the value of an uniform to a number (float)
  37225. * @param uniform defines the webGL uniform location where to store the value
  37226. * @param value defines the float number to store
  37227. */
  37228. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  37229. /**
  37230. * Set the value of an uniform to a vec2
  37231. * @param uniform defines the webGL uniform location where to store the value
  37232. * @param x defines the 1st component of the value
  37233. * @param y defines the 2nd component of the value
  37234. */
  37235. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  37236. /**
  37237. * Set the value of an uniform to a vec3
  37238. * @param uniform defines the webGL uniform location where to store the value
  37239. * @param x defines the 1st component of the value
  37240. * @param y defines the 2nd component of the value
  37241. * @param z defines the 3rd component of the value
  37242. */
  37243. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  37244. /**
  37245. * Set the value of an uniform to a vec4
  37246. * @param uniform defines the webGL uniform location where to store the value
  37247. * @param x defines the 1st component of the value
  37248. * @param y defines the 2nd component of the value
  37249. * @param z defines the 3rd component of the value
  37250. * @param w defines the 4th component of the value
  37251. */
  37252. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  37253. /**
  37254. * Apply all cached states (depth, culling, stencil and alpha)
  37255. */
  37256. applyStates(): void;
  37257. /**
  37258. * Enable or disable color writing
  37259. * @param enable defines the state to set
  37260. */
  37261. setColorWrite(enable: boolean): void;
  37262. /**
  37263. * Gets a boolean indicating if color writing is enabled
  37264. * @returns the current color writing state
  37265. */
  37266. getColorWrite(): boolean;
  37267. /**
  37268. * Gets the depth culling state manager
  37269. */
  37270. get depthCullingState(): DepthCullingState;
  37271. /**
  37272. * Gets the alpha state manager
  37273. */
  37274. get alphaState(): AlphaState;
  37275. /**
  37276. * Gets the stencil state manager
  37277. */
  37278. get stencilState(): StencilState;
  37279. /**
  37280. * Clears the list of texture accessible through engine.
  37281. * This can help preventing texture load conflict due to name collision.
  37282. */
  37283. clearInternalTexturesCache(): void;
  37284. /**
  37285. * Force the entire cache to be cleared
  37286. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  37287. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  37288. */
  37289. wipeCaches(bruteForce?: boolean): void;
  37290. /** @hidden */
  37291. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  37292. min: number;
  37293. mag: number;
  37294. };
  37295. /** @hidden */
  37296. _createTexture(): WebGLTexture;
  37297. /**
  37298. * Usually called from Texture.ts.
  37299. * Passed information to create a WebGLTexture
  37300. * @param url defines a value which contains one of the following:
  37301. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  37302. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  37303. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  37304. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  37305. * @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)
  37306. * @param scene needed for loading to the correct scene
  37307. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  37308. * @param onLoad optional callback to be called upon successful completion
  37309. * @param onError optional callback to be called upon failure
  37310. * @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
  37311. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  37312. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  37313. * @param forcedExtension defines the extension to use to pick the right loader
  37314. * @param mimeType defines an optional mime type
  37315. * @returns a InternalTexture for assignment back into BABYLON.Texture
  37316. */
  37317. 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;
  37318. /**
  37319. * Loads an image as an HTMLImageElement.
  37320. * @param input url string, ArrayBuffer, or Blob to load
  37321. * @param onLoad callback called when the image successfully loads
  37322. * @param onError callback called when the image fails to load
  37323. * @param offlineProvider offline provider for caching
  37324. * @param mimeType optional mime type
  37325. * @returns the HTMLImageElement of the loaded image
  37326. * @hidden
  37327. */
  37328. 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>;
  37329. /**
  37330. * @hidden
  37331. */
  37332. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  37333. private _unpackFlipYCached;
  37334. /**
  37335. * In case you are sharing the context with other applications, it might
  37336. * be interested to not cache the unpack flip y state to ensure a consistent
  37337. * value would be set.
  37338. */
  37339. enableUnpackFlipYCached: boolean;
  37340. /** @hidden */
  37341. _unpackFlipY(value: boolean): void;
  37342. /** @hidden */
  37343. _getUnpackAlignement(): number;
  37344. private _getTextureTarget;
  37345. /**
  37346. * Update the sampling mode of a given texture
  37347. * @param samplingMode defines the required sampling mode
  37348. * @param texture defines the texture to update
  37349. * @param generateMipMaps defines whether to generate mipmaps for the texture
  37350. */
  37351. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  37352. /**
  37353. * Update the sampling mode of a given texture
  37354. * @param texture defines the texture to update
  37355. * @param wrapU defines the texture wrap mode of the u coordinates
  37356. * @param wrapV defines the texture wrap mode of the v coordinates
  37357. * @param wrapR defines the texture wrap mode of the r coordinates
  37358. */
  37359. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  37360. /** @hidden */
  37361. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  37362. width: number;
  37363. height: number;
  37364. layers?: number;
  37365. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  37366. /** @hidden */
  37367. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  37368. /** @hidden */
  37369. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  37370. /**
  37371. * Update a portion of an internal texture
  37372. * @param texture defines the texture to update
  37373. * @param imageData defines the data to store into the texture
  37374. * @param xOffset defines the x coordinates of the update rectangle
  37375. * @param yOffset defines the y coordinates of the update rectangle
  37376. * @param width defines the width of the update rectangle
  37377. * @param height defines the height of the update rectangle
  37378. * @param faceIndex defines the face index if texture is a cube (0 by default)
  37379. * @param lod defines the lod level to update (0 by default)
  37380. */
  37381. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  37382. /** @hidden */
  37383. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  37384. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  37385. private _prepareWebGLTexture;
  37386. /** @hidden */
  37387. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  37388. private _getDepthStencilBuffer;
  37389. /** @hidden */
  37390. _releaseFramebufferObjects(texture: InternalTexture): void;
  37391. /** @hidden */
  37392. _releaseTexture(texture: InternalTexture): void;
  37393. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  37394. protected _setProgram(program: WebGLProgram): void;
  37395. protected _boundUniforms: {
  37396. [key: number]: WebGLUniformLocation;
  37397. };
  37398. /**
  37399. * Binds an effect to the webGL context
  37400. * @param effect defines the effect to bind
  37401. */
  37402. bindSamplers(effect: Effect): void;
  37403. private _activateCurrentTexture;
  37404. /** @hidden */
  37405. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  37406. /** @hidden */
  37407. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  37408. /**
  37409. * Unbind all textures from the webGL context
  37410. */
  37411. unbindAllTextures(): void;
  37412. /**
  37413. * Sets a texture to the according uniform.
  37414. * @param channel The texture channel
  37415. * @param uniform The uniform to set
  37416. * @param texture The texture to apply
  37417. */
  37418. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  37419. private _bindSamplerUniformToChannel;
  37420. private _getTextureWrapMode;
  37421. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  37422. /**
  37423. * Sets an array of texture to the webGL context
  37424. * @param channel defines the channel where the texture array must be set
  37425. * @param uniform defines the associated uniform location
  37426. * @param textures defines the array of textures to bind
  37427. */
  37428. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  37429. /** @hidden */
  37430. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  37431. private _setTextureParameterFloat;
  37432. private _setTextureParameterInteger;
  37433. /**
  37434. * Unbind all vertex attributes from the webGL context
  37435. */
  37436. unbindAllAttributes(): void;
  37437. /**
  37438. * 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
  37439. */
  37440. releaseEffects(): void;
  37441. /**
  37442. * Dispose and release all associated resources
  37443. */
  37444. dispose(): void;
  37445. /**
  37446. * Attach a new callback raised when context lost event is fired
  37447. * @param callback defines the callback to call
  37448. */
  37449. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  37450. /**
  37451. * Attach a new callback raised when context restored event is fired
  37452. * @param callback defines the callback to call
  37453. */
  37454. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  37455. /**
  37456. * Get the current error code of the webGL context
  37457. * @returns the error code
  37458. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  37459. */
  37460. getError(): number;
  37461. private _canRenderToFloatFramebuffer;
  37462. private _canRenderToHalfFloatFramebuffer;
  37463. private _canRenderToFramebuffer;
  37464. /** @hidden */
  37465. _getWebGLTextureType(type: number): number;
  37466. /** @hidden */
  37467. _getInternalFormat(format: number): number;
  37468. /** @hidden */
  37469. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  37470. /** @hidden */
  37471. _getRGBAMultiSampleBufferFormat(type: number): number;
  37472. /** @hidden */
  37473. _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;
  37474. /**
  37475. * Loads a file from a url
  37476. * @param url url to load
  37477. * @param onSuccess callback called when the file successfully loads
  37478. * @param onProgress callback called while file is loading (if the server supports this mode)
  37479. * @param offlineProvider defines the offline provider for caching
  37480. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  37481. * @param onError callback called when the file fails to load
  37482. * @returns a file request object
  37483. * @hidden
  37484. */
  37485. 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;
  37486. /**
  37487. * Reads pixels from the current frame buffer. Please note that this function can be slow
  37488. * @param x defines the x coordinate of the rectangle where pixels must be read
  37489. * @param y defines the y coordinate of the rectangle where pixels must be read
  37490. * @param width defines the width of the rectangle where pixels must be read
  37491. * @param height defines the height of the rectangle where pixels must be read
  37492. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  37493. * @returns a Uint8Array containing RGBA colors
  37494. */
  37495. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  37496. private static _isSupported;
  37497. /**
  37498. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  37499. * @returns true if the engine can be created
  37500. * @ignorenaming
  37501. */
  37502. static isSupported(): boolean;
  37503. /**
  37504. * Find the next highest power of two.
  37505. * @param x Number to start search from.
  37506. * @return Next highest power of two.
  37507. */
  37508. static CeilingPOT(x: number): number;
  37509. /**
  37510. * Find the next lowest power of two.
  37511. * @param x Number to start search from.
  37512. * @return Next lowest power of two.
  37513. */
  37514. static FloorPOT(x: number): number;
  37515. /**
  37516. * Find the nearest power of two.
  37517. * @param x Number to start search from.
  37518. * @return Next nearest power of two.
  37519. */
  37520. static NearestPOT(x: number): number;
  37521. /**
  37522. * Get the closest exponent of two
  37523. * @param value defines the value to approximate
  37524. * @param max defines the maximum value to return
  37525. * @param mode defines how to define the closest value
  37526. * @returns closest exponent of two of the given value
  37527. */
  37528. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  37529. /**
  37530. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  37531. * @param func - the function to be called
  37532. * @param requester - the object that will request the next frame. Falls back to window.
  37533. * @returns frame number
  37534. */
  37535. static QueueNewFrame(func: () => void, requester?: any): number;
  37536. /**
  37537. * Gets host document
  37538. * @returns the host document object
  37539. */
  37540. getHostDocument(): Nullable<Document>;
  37541. }
  37542. }
  37543. declare module "babylonjs/Maths/sphericalPolynomial" {
  37544. import { Vector3 } from "babylonjs/Maths/math.vector";
  37545. import { Color3 } from "babylonjs/Maths/math.color";
  37546. /**
  37547. * Class representing spherical harmonics coefficients to the 3rd degree
  37548. */
  37549. export class SphericalHarmonics {
  37550. /**
  37551. * Defines whether or not the harmonics have been prescaled for rendering.
  37552. */
  37553. preScaled: boolean;
  37554. /**
  37555. * The l0,0 coefficients of the spherical harmonics
  37556. */
  37557. l00: Vector3;
  37558. /**
  37559. * The l1,-1 coefficients of the spherical harmonics
  37560. */
  37561. l1_1: Vector3;
  37562. /**
  37563. * The l1,0 coefficients of the spherical harmonics
  37564. */
  37565. l10: Vector3;
  37566. /**
  37567. * The l1,1 coefficients of the spherical harmonics
  37568. */
  37569. l11: Vector3;
  37570. /**
  37571. * The l2,-2 coefficients of the spherical harmonics
  37572. */
  37573. l2_2: Vector3;
  37574. /**
  37575. * The l2,-1 coefficients of the spherical harmonics
  37576. */
  37577. l2_1: Vector3;
  37578. /**
  37579. * The l2,0 coefficients of the spherical harmonics
  37580. */
  37581. l20: Vector3;
  37582. /**
  37583. * The l2,1 coefficients of the spherical harmonics
  37584. */
  37585. l21: Vector3;
  37586. /**
  37587. * The l2,2 coefficients of the spherical harmonics
  37588. */
  37589. l22: Vector3;
  37590. /**
  37591. * Adds a light to the spherical harmonics
  37592. * @param direction the direction of the light
  37593. * @param color the color of the light
  37594. * @param deltaSolidAngle the delta solid angle of the light
  37595. */
  37596. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  37597. /**
  37598. * Scales the spherical harmonics by the given amount
  37599. * @param scale the amount to scale
  37600. */
  37601. scaleInPlace(scale: number): void;
  37602. /**
  37603. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  37604. *
  37605. * ```
  37606. * E_lm = A_l * L_lm
  37607. * ```
  37608. *
  37609. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  37610. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  37611. * the scaling factors are given in equation 9.
  37612. */
  37613. convertIncidentRadianceToIrradiance(): void;
  37614. /**
  37615. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  37616. *
  37617. * ```
  37618. * L = (1/pi) * E * rho
  37619. * ```
  37620. *
  37621. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  37622. */
  37623. convertIrradianceToLambertianRadiance(): void;
  37624. /**
  37625. * Integrates the reconstruction coefficients directly in to the SH preventing further
  37626. * required operations at run time.
  37627. *
  37628. * This is simply done by scaling back the SH with Ylm constants parameter.
  37629. * The trigonometric part being applied by the shader at run time.
  37630. */
  37631. preScaleForRendering(): void;
  37632. /**
  37633. * Constructs a spherical harmonics from an array.
  37634. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  37635. * @returns the spherical harmonics
  37636. */
  37637. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  37638. /**
  37639. * Gets the spherical harmonics from polynomial
  37640. * @param polynomial the spherical polynomial
  37641. * @returns the spherical harmonics
  37642. */
  37643. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  37644. }
  37645. /**
  37646. * Class representing spherical polynomial coefficients to the 3rd degree
  37647. */
  37648. export class SphericalPolynomial {
  37649. private _harmonics;
  37650. /**
  37651. * The spherical harmonics used to create the polynomials.
  37652. */
  37653. get preScaledHarmonics(): SphericalHarmonics;
  37654. /**
  37655. * The x coefficients of the spherical polynomial
  37656. */
  37657. x: Vector3;
  37658. /**
  37659. * The y coefficients of the spherical polynomial
  37660. */
  37661. y: Vector3;
  37662. /**
  37663. * The z coefficients of the spherical polynomial
  37664. */
  37665. z: Vector3;
  37666. /**
  37667. * The xx coefficients of the spherical polynomial
  37668. */
  37669. xx: Vector3;
  37670. /**
  37671. * The yy coefficients of the spherical polynomial
  37672. */
  37673. yy: Vector3;
  37674. /**
  37675. * The zz coefficients of the spherical polynomial
  37676. */
  37677. zz: Vector3;
  37678. /**
  37679. * The xy coefficients of the spherical polynomial
  37680. */
  37681. xy: Vector3;
  37682. /**
  37683. * The yz coefficients of the spherical polynomial
  37684. */
  37685. yz: Vector3;
  37686. /**
  37687. * The zx coefficients of the spherical polynomial
  37688. */
  37689. zx: Vector3;
  37690. /**
  37691. * Adds an ambient color to the spherical polynomial
  37692. * @param color the color to add
  37693. */
  37694. addAmbient(color: Color3): void;
  37695. /**
  37696. * Scales the spherical polynomial by the given amount
  37697. * @param scale the amount to scale
  37698. */
  37699. scaleInPlace(scale: number): void;
  37700. /**
  37701. * Gets the spherical polynomial from harmonics
  37702. * @param harmonics the spherical harmonics
  37703. * @returns the spherical polynomial
  37704. */
  37705. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  37706. /**
  37707. * Constructs a spherical polynomial from an array.
  37708. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  37709. * @returns the spherical polynomial
  37710. */
  37711. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  37712. }
  37713. }
  37714. declare module "babylonjs/Materials/Textures/internalTexture" {
  37715. import { Observable } from "babylonjs/Misc/observable";
  37716. import { Nullable, int } from "babylonjs/types";
  37717. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  37718. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  37719. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  37720. /**
  37721. * Defines the source of the internal texture
  37722. */
  37723. export enum InternalTextureSource {
  37724. /**
  37725. * The source of the texture data is unknown
  37726. */
  37727. Unknown = 0,
  37728. /**
  37729. * Texture data comes from an URL
  37730. */
  37731. Url = 1,
  37732. /**
  37733. * Texture data is only used for temporary storage
  37734. */
  37735. Temp = 2,
  37736. /**
  37737. * Texture data comes from raw data (ArrayBuffer)
  37738. */
  37739. Raw = 3,
  37740. /**
  37741. * Texture content is dynamic (video or dynamic texture)
  37742. */
  37743. Dynamic = 4,
  37744. /**
  37745. * Texture content is generated by rendering to it
  37746. */
  37747. RenderTarget = 5,
  37748. /**
  37749. * Texture content is part of a multi render target process
  37750. */
  37751. MultiRenderTarget = 6,
  37752. /**
  37753. * Texture data comes from a cube data file
  37754. */
  37755. Cube = 7,
  37756. /**
  37757. * Texture data comes from a raw cube data
  37758. */
  37759. CubeRaw = 8,
  37760. /**
  37761. * Texture data come from a prefiltered cube data file
  37762. */
  37763. CubePrefiltered = 9,
  37764. /**
  37765. * Texture content is raw 3D data
  37766. */
  37767. Raw3D = 10,
  37768. /**
  37769. * Texture content is raw 2D array data
  37770. */
  37771. Raw2DArray = 11,
  37772. /**
  37773. * Texture content is a depth texture
  37774. */
  37775. Depth = 12,
  37776. /**
  37777. * Texture data comes from a raw cube data encoded with RGBD
  37778. */
  37779. CubeRawRGBD = 13
  37780. }
  37781. /**
  37782. * Class used to store data associated with WebGL texture data for the engine
  37783. * This class should not be used directly
  37784. */
  37785. export class InternalTexture {
  37786. /** @hidden */
  37787. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  37788. /**
  37789. * Defines if the texture is ready
  37790. */
  37791. isReady: boolean;
  37792. /**
  37793. * Defines if the texture is a cube texture
  37794. */
  37795. isCube: boolean;
  37796. /**
  37797. * Defines if the texture contains 3D data
  37798. */
  37799. is3D: boolean;
  37800. /**
  37801. * Defines if the texture contains 2D array data
  37802. */
  37803. is2DArray: boolean;
  37804. /**
  37805. * Defines if the texture contains multiview data
  37806. */
  37807. isMultiview: boolean;
  37808. /**
  37809. * Gets the URL used to load this texture
  37810. */
  37811. url: string;
  37812. /**
  37813. * Gets the sampling mode of the texture
  37814. */
  37815. samplingMode: number;
  37816. /**
  37817. * Gets a boolean indicating if the texture needs mipmaps generation
  37818. */
  37819. generateMipMaps: boolean;
  37820. /**
  37821. * Gets the number of samples used by the texture (WebGL2+ only)
  37822. */
  37823. samples: number;
  37824. /**
  37825. * Gets the type of the texture (int, float...)
  37826. */
  37827. type: number;
  37828. /**
  37829. * Gets the format of the texture (RGB, RGBA...)
  37830. */
  37831. format: number;
  37832. /**
  37833. * Observable called when the texture is loaded
  37834. */
  37835. onLoadedObservable: Observable<InternalTexture>;
  37836. /**
  37837. * Gets the width of the texture
  37838. */
  37839. width: number;
  37840. /**
  37841. * Gets the height of the texture
  37842. */
  37843. height: number;
  37844. /**
  37845. * Gets the depth of the texture
  37846. */
  37847. depth: number;
  37848. /**
  37849. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  37850. */
  37851. baseWidth: number;
  37852. /**
  37853. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  37854. */
  37855. baseHeight: number;
  37856. /**
  37857. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  37858. */
  37859. baseDepth: number;
  37860. /**
  37861. * Gets a boolean indicating if the texture is inverted on Y axis
  37862. */
  37863. invertY: boolean;
  37864. /** @hidden */
  37865. _invertVScale: boolean;
  37866. /** @hidden */
  37867. _associatedChannel: number;
  37868. /** @hidden */
  37869. _source: InternalTextureSource;
  37870. /** @hidden */
  37871. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  37872. /** @hidden */
  37873. _bufferView: Nullable<ArrayBufferView>;
  37874. /** @hidden */
  37875. _bufferViewArray: Nullable<ArrayBufferView[]>;
  37876. /** @hidden */
  37877. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  37878. /** @hidden */
  37879. _size: number;
  37880. /** @hidden */
  37881. _extension: string;
  37882. /** @hidden */
  37883. _files: Nullable<string[]>;
  37884. /** @hidden */
  37885. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  37886. /** @hidden */
  37887. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  37888. /** @hidden */
  37889. _framebuffer: Nullable<WebGLFramebuffer>;
  37890. /** @hidden */
  37891. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  37892. /** @hidden */
  37893. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  37894. /** @hidden */
  37895. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  37896. /** @hidden */
  37897. _attachments: Nullable<number[]>;
  37898. /** @hidden */
  37899. _textureArray: Nullable<InternalTexture[]>;
  37900. /** @hidden */
  37901. _cachedCoordinatesMode: Nullable<number>;
  37902. /** @hidden */
  37903. _cachedWrapU: Nullable<number>;
  37904. /** @hidden */
  37905. _cachedWrapV: Nullable<number>;
  37906. /** @hidden */
  37907. _cachedWrapR: Nullable<number>;
  37908. /** @hidden */
  37909. _cachedAnisotropicFilteringLevel: Nullable<number>;
  37910. /** @hidden */
  37911. _isDisabled: boolean;
  37912. /** @hidden */
  37913. _compression: Nullable<string>;
  37914. /** @hidden */
  37915. _generateStencilBuffer: boolean;
  37916. /** @hidden */
  37917. _generateDepthBuffer: boolean;
  37918. /** @hidden */
  37919. _comparisonFunction: number;
  37920. /** @hidden */
  37921. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  37922. /** @hidden */
  37923. _lodGenerationScale: number;
  37924. /** @hidden */
  37925. _lodGenerationOffset: number;
  37926. /** @hidden */
  37927. _depthStencilTexture: Nullable<InternalTexture>;
  37928. /** @hidden */
  37929. _colorTextureArray: Nullable<WebGLTexture>;
  37930. /** @hidden */
  37931. _depthStencilTextureArray: Nullable<WebGLTexture>;
  37932. /** @hidden */
  37933. _lodTextureHigh: Nullable<BaseTexture>;
  37934. /** @hidden */
  37935. _lodTextureMid: Nullable<BaseTexture>;
  37936. /** @hidden */
  37937. _lodTextureLow: Nullable<BaseTexture>;
  37938. /** @hidden */
  37939. _isRGBD: boolean;
  37940. /** @hidden */
  37941. _linearSpecularLOD: boolean;
  37942. /** @hidden */
  37943. _irradianceTexture: Nullable<BaseTexture>;
  37944. /** @hidden */
  37945. _webGLTexture: Nullable<WebGLTexture>;
  37946. /** @hidden */
  37947. _references: number;
  37948. private _engine;
  37949. /**
  37950. * Gets the Engine the texture belongs to.
  37951. * @returns The babylon engine
  37952. */
  37953. getEngine(): ThinEngine;
  37954. /**
  37955. * Gets the data source type of the texture
  37956. */
  37957. get source(): InternalTextureSource;
  37958. /**
  37959. * Creates a new InternalTexture
  37960. * @param engine defines the engine to use
  37961. * @param source defines the type of data that will be used
  37962. * @param delayAllocation if the texture allocation should be delayed (default: false)
  37963. */
  37964. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  37965. /**
  37966. * Increments the number of references (ie. the number of Texture that point to it)
  37967. */
  37968. incrementReferences(): void;
  37969. /**
  37970. * Change the size of the texture (not the size of the content)
  37971. * @param width defines the new width
  37972. * @param height defines the new height
  37973. * @param depth defines the new depth (1 by default)
  37974. */
  37975. updateSize(width: int, height: int, depth?: int): void;
  37976. /** @hidden */
  37977. _rebuild(): void;
  37978. /** @hidden */
  37979. _swapAndDie(target: InternalTexture): void;
  37980. /**
  37981. * Dispose the current allocated resources
  37982. */
  37983. dispose(): void;
  37984. }
  37985. }
  37986. declare module "babylonjs/Audio/analyser" {
  37987. import { Scene } from "babylonjs/scene";
  37988. /**
  37989. * Class used to work with sound analyzer using fast fourier transform (FFT)
  37990. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  37991. */
  37992. export class Analyser {
  37993. /**
  37994. * Gets or sets the smoothing
  37995. * @ignorenaming
  37996. */
  37997. SMOOTHING: number;
  37998. /**
  37999. * Gets or sets the FFT table size
  38000. * @ignorenaming
  38001. */
  38002. FFT_SIZE: number;
  38003. /**
  38004. * Gets or sets the bar graph amplitude
  38005. * @ignorenaming
  38006. */
  38007. BARGRAPHAMPLITUDE: number;
  38008. /**
  38009. * Gets or sets the position of the debug canvas
  38010. * @ignorenaming
  38011. */
  38012. DEBUGCANVASPOS: {
  38013. x: number;
  38014. y: number;
  38015. };
  38016. /**
  38017. * Gets or sets the debug canvas size
  38018. * @ignorenaming
  38019. */
  38020. DEBUGCANVASSIZE: {
  38021. width: number;
  38022. height: number;
  38023. };
  38024. private _byteFreqs;
  38025. private _byteTime;
  38026. private _floatFreqs;
  38027. private _webAudioAnalyser;
  38028. private _debugCanvas;
  38029. private _debugCanvasContext;
  38030. private _scene;
  38031. private _registerFunc;
  38032. private _audioEngine;
  38033. /**
  38034. * Creates a new analyser
  38035. * @param scene defines hosting scene
  38036. */
  38037. constructor(scene: Scene);
  38038. /**
  38039. * Get the number of data values you will have to play with for the visualization
  38040. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  38041. * @returns a number
  38042. */
  38043. getFrequencyBinCount(): number;
  38044. /**
  38045. * Gets the current frequency data as a byte array
  38046. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  38047. * @returns a Uint8Array
  38048. */
  38049. getByteFrequencyData(): Uint8Array;
  38050. /**
  38051. * Gets the current waveform as a byte array
  38052. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  38053. * @returns a Uint8Array
  38054. */
  38055. getByteTimeDomainData(): Uint8Array;
  38056. /**
  38057. * Gets the current frequency data as a float array
  38058. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  38059. * @returns a Float32Array
  38060. */
  38061. getFloatFrequencyData(): Float32Array;
  38062. /**
  38063. * Renders the debug canvas
  38064. */
  38065. drawDebugCanvas(): void;
  38066. /**
  38067. * Stops rendering the debug canvas and removes it
  38068. */
  38069. stopDebugCanvas(): void;
  38070. /**
  38071. * Connects two audio nodes
  38072. * @param inputAudioNode defines first node to connect
  38073. * @param outputAudioNode defines second node to connect
  38074. */
  38075. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  38076. /**
  38077. * Releases all associated resources
  38078. */
  38079. dispose(): void;
  38080. }
  38081. }
  38082. declare module "babylonjs/Audio/audioEngine" {
  38083. import { IDisposable } from "babylonjs/scene";
  38084. import { Analyser } from "babylonjs/Audio/analyser";
  38085. import { Nullable } from "babylonjs/types";
  38086. import { Observable } from "babylonjs/Misc/observable";
  38087. /**
  38088. * This represents an audio engine and it is responsible
  38089. * to play, synchronize and analyse sounds throughout the application.
  38090. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38091. */
  38092. export interface IAudioEngine extends IDisposable {
  38093. /**
  38094. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  38095. */
  38096. readonly canUseWebAudio: boolean;
  38097. /**
  38098. * Gets the current AudioContext if available.
  38099. */
  38100. readonly audioContext: Nullable<AudioContext>;
  38101. /**
  38102. * The master gain node defines the global audio volume of your audio engine.
  38103. */
  38104. readonly masterGain: GainNode;
  38105. /**
  38106. * Gets whether or not mp3 are supported by your browser.
  38107. */
  38108. readonly isMP3supported: boolean;
  38109. /**
  38110. * Gets whether or not ogg are supported by your browser.
  38111. */
  38112. readonly isOGGsupported: boolean;
  38113. /**
  38114. * Defines if Babylon should emit a warning if WebAudio is not supported.
  38115. * @ignoreNaming
  38116. */
  38117. WarnedWebAudioUnsupported: boolean;
  38118. /**
  38119. * Defines if the audio engine relies on a custom unlocked button.
  38120. * In this case, the embedded button will not be displayed.
  38121. */
  38122. useCustomUnlockedButton: boolean;
  38123. /**
  38124. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  38125. */
  38126. readonly unlocked: boolean;
  38127. /**
  38128. * Event raised when audio has been unlocked on the browser.
  38129. */
  38130. onAudioUnlockedObservable: Observable<AudioEngine>;
  38131. /**
  38132. * Event raised when audio has been locked on the browser.
  38133. */
  38134. onAudioLockedObservable: Observable<AudioEngine>;
  38135. /**
  38136. * Flags the audio engine in Locked state.
  38137. * This happens due to new browser policies preventing audio to autoplay.
  38138. */
  38139. lock(): void;
  38140. /**
  38141. * Unlocks the audio engine once a user action has been done on the dom.
  38142. * This is helpful to resume play once browser policies have been satisfied.
  38143. */
  38144. unlock(): void;
  38145. /**
  38146. * Gets the global volume sets on the master gain.
  38147. * @returns the global volume if set or -1 otherwise
  38148. */
  38149. getGlobalVolume(): number;
  38150. /**
  38151. * Sets the global volume of your experience (sets on the master gain).
  38152. * @param newVolume Defines the new global volume of the application
  38153. */
  38154. setGlobalVolume(newVolume: number): void;
  38155. /**
  38156. * Connect the audio engine to an audio analyser allowing some amazing
  38157. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  38158. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  38159. * @param analyser The analyser to connect to the engine
  38160. */
  38161. connectToAnalyser(analyser: Analyser): void;
  38162. }
  38163. /**
  38164. * This represents the default audio engine used in babylon.
  38165. * It is responsible to play, synchronize and analyse sounds throughout the application.
  38166. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38167. */
  38168. export class AudioEngine implements IAudioEngine {
  38169. private _audioContext;
  38170. private _audioContextInitialized;
  38171. private _muteButton;
  38172. private _hostElement;
  38173. /**
  38174. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  38175. */
  38176. canUseWebAudio: boolean;
  38177. /**
  38178. * The master gain node defines the global audio volume of your audio engine.
  38179. */
  38180. masterGain: GainNode;
  38181. /**
  38182. * Defines if Babylon should emit a warning if WebAudio is not supported.
  38183. * @ignoreNaming
  38184. */
  38185. WarnedWebAudioUnsupported: boolean;
  38186. /**
  38187. * Gets whether or not mp3 are supported by your browser.
  38188. */
  38189. isMP3supported: boolean;
  38190. /**
  38191. * Gets whether or not ogg are supported by your browser.
  38192. */
  38193. isOGGsupported: boolean;
  38194. /**
  38195. * Gets whether audio has been unlocked on the device.
  38196. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  38197. * a user interaction has happened.
  38198. */
  38199. unlocked: boolean;
  38200. /**
  38201. * Defines if the audio engine relies on a custom unlocked button.
  38202. * In this case, the embedded button will not be displayed.
  38203. */
  38204. useCustomUnlockedButton: boolean;
  38205. /**
  38206. * Event raised when audio has been unlocked on the browser.
  38207. */
  38208. onAudioUnlockedObservable: Observable<AudioEngine>;
  38209. /**
  38210. * Event raised when audio has been locked on the browser.
  38211. */
  38212. onAudioLockedObservable: Observable<AudioEngine>;
  38213. /**
  38214. * Gets the current AudioContext if available.
  38215. */
  38216. get audioContext(): Nullable<AudioContext>;
  38217. private _connectedAnalyser;
  38218. /**
  38219. * Instantiates a new audio engine.
  38220. *
  38221. * There should be only one per page as some browsers restrict the number
  38222. * of audio contexts you can create.
  38223. * @param hostElement defines the host element where to display the mute icon if necessary
  38224. */
  38225. constructor(hostElement?: Nullable<HTMLElement>);
  38226. /**
  38227. * Flags the audio engine in Locked state.
  38228. * This happens due to new browser policies preventing audio to autoplay.
  38229. */
  38230. lock(): void;
  38231. /**
  38232. * Unlocks the audio engine once a user action has been done on the dom.
  38233. * This is helpful to resume play once browser policies have been satisfied.
  38234. */
  38235. unlock(): void;
  38236. private _resumeAudioContext;
  38237. private _initializeAudioContext;
  38238. private _tryToRun;
  38239. private _triggerRunningState;
  38240. private _triggerSuspendedState;
  38241. private _displayMuteButton;
  38242. private _moveButtonToTopLeft;
  38243. private _onResize;
  38244. private _hideMuteButton;
  38245. /**
  38246. * Destroy and release the resources associated with the audio ccontext.
  38247. */
  38248. dispose(): void;
  38249. /**
  38250. * Gets the global volume sets on the master gain.
  38251. * @returns the global volume if set or -1 otherwise
  38252. */
  38253. getGlobalVolume(): number;
  38254. /**
  38255. * Sets the global volume of your experience (sets on the master gain).
  38256. * @param newVolume Defines the new global volume of the application
  38257. */
  38258. setGlobalVolume(newVolume: number): void;
  38259. /**
  38260. * Connect the audio engine to an audio analyser allowing some amazing
  38261. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  38262. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  38263. * @param analyser The analyser to connect to the engine
  38264. */
  38265. connectToAnalyser(analyser: Analyser): void;
  38266. }
  38267. }
  38268. declare module "babylonjs/Loading/loadingScreen" {
  38269. /**
  38270. * Interface used to present a loading screen while loading a scene
  38271. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38272. */
  38273. export interface ILoadingScreen {
  38274. /**
  38275. * Function called to display the loading screen
  38276. */
  38277. displayLoadingUI: () => void;
  38278. /**
  38279. * Function called to hide the loading screen
  38280. */
  38281. hideLoadingUI: () => void;
  38282. /**
  38283. * Gets or sets the color to use for the background
  38284. */
  38285. loadingUIBackgroundColor: string;
  38286. /**
  38287. * Gets or sets the text to display while loading
  38288. */
  38289. loadingUIText: string;
  38290. }
  38291. /**
  38292. * Class used for the default loading screen
  38293. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38294. */
  38295. export class DefaultLoadingScreen implements ILoadingScreen {
  38296. private _renderingCanvas;
  38297. private _loadingText;
  38298. private _loadingDivBackgroundColor;
  38299. private _loadingDiv;
  38300. private _loadingTextDiv;
  38301. /** Gets or sets the logo url to use for the default loading screen */
  38302. static DefaultLogoUrl: string;
  38303. /** Gets or sets the spinner url to use for the default loading screen */
  38304. static DefaultSpinnerUrl: string;
  38305. /**
  38306. * Creates a new default loading screen
  38307. * @param _renderingCanvas defines the canvas used to render the scene
  38308. * @param _loadingText defines the default text to display
  38309. * @param _loadingDivBackgroundColor defines the default background color
  38310. */
  38311. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  38312. /**
  38313. * Function called to display the loading screen
  38314. */
  38315. displayLoadingUI(): void;
  38316. /**
  38317. * Function called to hide the loading screen
  38318. */
  38319. hideLoadingUI(): void;
  38320. /**
  38321. * Gets or sets the text to display while loading
  38322. */
  38323. set loadingUIText(text: string);
  38324. get loadingUIText(): string;
  38325. /**
  38326. * Gets or sets the color to use for the background
  38327. */
  38328. get loadingUIBackgroundColor(): string;
  38329. set loadingUIBackgroundColor(color: string);
  38330. private _resizeLoadingUI;
  38331. }
  38332. }
  38333. declare module "babylonjs/Misc/customAnimationFrameRequester" {
  38334. /**
  38335. * Interface for any object that can request an animation frame
  38336. */
  38337. export interface ICustomAnimationFrameRequester {
  38338. /**
  38339. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  38340. */
  38341. renderFunction?: Function;
  38342. /**
  38343. * Called to request the next frame to render to
  38344. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  38345. */
  38346. requestAnimationFrame: Function;
  38347. /**
  38348. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  38349. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  38350. */
  38351. requestID?: number;
  38352. }
  38353. }
  38354. declare module "babylonjs/Misc/performanceMonitor" {
  38355. /**
  38356. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  38357. */
  38358. export class PerformanceMonitor {
  38359. private _enabled;
  38360. private _rollingFrameTime;
  38361. private _lastFrameTimeMs;
  38362. /**
  38363. * constructor
  38364. * @param frameSampleSize The number of samples required to saturate the sliding window
  38365. */
  38366. constructor(frameSampleSize?: number);
  38367. /**
  38368. * Samples current frame
  38369. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  38370. */
  38371. sampleFrame(timeMs?: number): void;
  38372. /**
  38373. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  38374. */
  38375. get averageFrameTime(): number;
  38376. /**
  38377. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  38378. */
  38379. get averageFrameTimeVariance(): number;
  38380. /**
  38381. * Returns the frame time of the most recent frame
  38382. */
  38383. get instantaneousFrameTime(): number;
  38384. /**
  38385. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  38386. */
  38387. get averageFPS(): number;
  38388. /**
  38389. * Returns the average framerate in frames per second using the most recent frame time
  38390. */
  38391. get instantaneousFPS(): number;
  38392. /**
  38393. * Returns true if enough samples have been taken to completely fill the sliding window
  38394. */
  38395. get isSaturated(): boolean;
  38396. /**
  38397. * Enables contributions to the sliding window sample set
  38398. */
  38399. enable(): void;
  38400. /**
  38401. * Disables contributions to the sliding window sample set
  38402. * Samples will not be interpolated over the disabled period
  38403. */
  38404. disable(): void;
  38405. /**
  38406. * Returns true if sampling is enabled
  38407. */
  38408. get isEnabled(): boolean;
  38409. /**
  38410. * Resets performance monitor
  38411. */
  38412. reset(): void;
  38413. }
  38414. /**
  38415. * RollingAverage
  38416. *
  38417. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  38418. */
  38419. export class RollingAverage {
  38420. /**
  38421. * Current average
  38422. */
  38423. average: number;
  38424. /**
  38425. * Current variance
  38426. */
  38427. variance: number;
  38428. protected _samples: Array<number>;
  38429. protected _sampleCount: number;
  38430. protected _pos: number;
  38431. protected _m2: number;
  38432. /**
  38433. * constructor
  38434. * @param length The number of samples required to saturate the sliding window
  38435. */
  38436. constructor(length: number);
  38437. /**
  38438. * Adds a sample to the sample set
  38439. * @param v The sample value
  38440. */
  38441. add(v: number): void;
  38442. /**
  38443. * Returns previously added values or null if outside of history or outside the sliding window domain
  38444. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  38445. * @return Value previously recorded with add() or null if outside of range
  38446. */
  38447. history(i: number): number;
  38448. /**
  38449. * Returns true if enough samples have been taken to completely fill the sliding window
  38450. * @return true if sample-set saturated
  38451. */
  38452. isSaturated(): boolean;
  38453. /**
  38454. * Resets the rolling average (equivalent to 0 samples taken so far)
  38455. */
  38456. reset(): void;
  38457. /**
  38458. * Wraps a value around the sample range boundaries
  38459. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  38460. * @return Wrapped position in sample range
  38461. */
  38462. protected _wrapPosition(i: number): number;
  38463. }
  38464. }
  38465. declare module "babylonjs/Misc/perfCounter" {
  38466. /**
  38467. * This class is used to track a performance counter which is number based.
  38468. * The user has access to many properties which give statistics of different nature.
  38469. *
  38470. * The implementer can track two kinds of Performance Counter: time and count.
  38471. * 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.
  38472. * 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.
  38473. */
  38474. export class PerfCounter {
  38475. /**
  38476. * Gets or sets a global boolean to turn on and off all the counters
  38477. */
  38478. static Enabled: boolean;
  38479. /**
  38480. * Returns the smallest value ever
  38481. */
  38482. get min(): number;
  38483. /**
  38484. * Returns the biggest value ever
  38485. */
  38486. get max(): number;
  38487. /**
  38488. * Returns the average value since the performance counter is running
  38489. */
  38490. get average(): number;
  38491. /**
  38492. * Returns the average value of the last second the counter was monitored
  38493. */
  38494. get lastSecAverage(): number;
  38495. /**
  38496. * Returns the current value
  38497. */
  38498. get current(): number;
  38499. /**
  38500. * Gets the accumulated total
  38501. */
  38502. get total(): number;
  38503. /**
  38504. * Gets the total value count
  38505. */
  38506. get count(): number;
  38507. /**
  38508. * Creates a new counter
  38509. */
  38510. constructor();
  38511. /**
  38512. * Call this method to start monitoring a new frame.
  38513. * 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.
  38514. */
  38515. fetchNewFrame(): void;
  38516. /**
  38517. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  38518. * @param newCount the count value to add to the monitored count
  38519. * @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.
  38520. */
  38521. addCount(newCount: number, fetchResult: boolean): void;
  38522. /**
  38523. * Start monitoring this performance counter
  38524. */
  38525. beginMonitoring(): void;
  38526. /**
  38527. * Compute the time lapsed since the previous beginMonitoring() call.
  38528. * @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
  38529. */
  38530. endMonitoring(newFrame?: boolean): void;
  38531. private _fetchResult;
  38532. private _startMonitoringTime;
  38533. private _min;
  38534. private _max;
  38535. private _average;
  38536. private _current;
  38537. private _totalValueCount;
  38538. private _totalAccumulated;
  38539. private _lastSecAverage;
  38540. private _lastSecAccumulated;
  38541. private _lastSecTime;
  38542. private _lastSecValueCount;
  38543. }
  38544. }
  38545. declare module "babylonjs/Engines/Extensions/engine.readTexture" {
  38546. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38547. import { Nullable } from "babylonjs/types";
  38548. module "babylonjs/Engines/thinEngine" {
  38549. interface ThinEngine {
  38550. /** @hidden */
  38551. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  38552. }
  38553. }
  38554. }
  38555. declare module "babylonjs/Engines/engine" {
  38556. import { Observable } from "babylonjs/Misc/observable";
  38557. import { Nullable } from "babylonjs/types";
  38558. import { Scene } from "babylonjs/scene";
  38559. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38560. import { IAudioEngine } from "babylonjs/Audio/audioEngine";
  38561. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  38562. import { ILoadingScreen } from "babylonjs/Loading/loadingScreen";
  38563. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  38564. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  38565. import { ICustomAnimationFrameRequester } from "babylonjs/Misc/customAnimationFrameRequester";
  38566. import { ThinEngine, EngineOptions } from "babylonjs/Engines/thinEngine";
  38567. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  38568. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  38569. import { PerformanceMonitor } from "babylonjs/Misc/performanceMonitor";
  38570. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  38571. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  38572. import "babylonjs/Engines/Extensions/engine.alpha";
  38573. import "babylonjs/Engines/Extensions/engine.readTexture";
  38574. import "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  38575. import { Material } from "babylonjs/Materials/material";
  38576. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  38577. /**
  38578. * Defines the interface used by display changed events
  38579. */
  38580. export interface IDisplayChangedEventArgs {
  38581. /** Gets the vrDisplay object (if any) */
  38582. vrDisplay: Nullable<any>;
  38583. /** Gets a boolean indicating if webVR is supported */
  38584. vrSupported: boolean;
  38585. }
  38586. /**
  38587. * Defines the interface used by objects containing a viewport (like a camera)
  38588. */
  38589. interface IViewportOwnerLike {
  38590. /**
  38591. * Gets or sets the viewport
  38592. */
  38593. viewport: IViewportLike;
  38594. }
  38595. /**
  38596. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  38597. */
  38598. export class Engine extends ThinEngine {
  38599. /** Defines that alpha blending is disabled */
  38600. static readonly ALPHA_DISABLE: number;
  38601. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  38602. static readonly ALPHA_ADD: number;
  38603. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  38604. static readonly ALPHA_COMBINE: number;
  38605. /** Defines that alpha blending to DEST - SRC * DEST */
  38606. static readonly ALPHA_SUBTRACT: number;
  38607. /** Defines that alpha blending to SRC * DEST */
  38608. static readonly ALPHA_MULTIPLY: number;
  38609. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  38610. static readonly ALPHA_MAXIMIZED: number;
  38611. /** Defines that alpha blending to SRC + DEST */
  38612. static readonly ALPHA_ONEONE: number;
  38613. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  38614. static readonly ALPHA_PREMULTIPLIED: number;
  38615. /**
  38616. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  38617. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  38618. */
  38619. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  38620. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  38621. static readonly ALPHA_INTERPOLATE: number;
  38622. /**
  38623. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  38624. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  38625. */
  38626. static readonly ALPHA_SCREENMODE: number;
  38627. /** Defines that the ressource is not delayed*/
  38628. static readonly DELAYLOADSTATE_NONE: number;
  38629. /** Defines that the ressource was successfully delay loaded */
  38630. static readonly DELAYLOADSTATE_LOADED: number;
  38631. /** Defines that the ressource is currently delay loading */
  38632. static readonly DELAYLOADSTATE_LOADING: number;
  38633. /** Defines that the ressource is delayed and has not started loading */
  38634. static readonly DELAYLOADSTATE_NOTLOADED: number;
  38635. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  38636. static readonly NEVER: number;
  38637. /** 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 */
  38638. static readonly ALWAYS: number;
  38639. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  38640. static readonly LESS: number;
  38641. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  38642. static readonly EQUAL: number;
  38643. /** 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 */
  38644. static readonly LEQUAL: number;
  38645. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  38646. static readonly GREATER: number;
  38647. /** 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 */
  38648. static readonly GEQUAL: number;
  38649. /** 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 */
  38650. static readonly NOTEQUAL: number;
  38651. /** Passed to stencilOperation to specify that stencil value must be kept */
  38652. static readonly KEEP: number;
  38653. /** Passed to stencilOperation to specify that stencil value must be replaced */
  38654. static readonly REPLACE: number;
  38655. /** Passed to stencilOperation to specify that stencil value must be incremented */
  38656. static readonly INCR: number;
  38657. /** Passed to stencilOperation to specify that stencil value must be decremented */
  38658. static readonly DECR: number;
  38659. /** Passed to stencilOperation to specify that stencil value must be inverted */
  38660. static readonly INVERT: number;
  38661. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  38662. static readonly INCR_WRAP: number;
  38663. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  38664. static readonly DECR_WRAP: number;
  38665. /** Texture is not repeating outside of 0..1 UVs */
  38666. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  38667. /** Texture is repeating outside of 0..1 UVs */
  38668. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  38669. /** Texture is repeating and mirrored */
  38670. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  38671. /** ALPHA */
  38672. static readonly TEXTUREFORMAT_ALPHA: number;
  38673. /** LUMINANCE */
  38674. static readonly TEXTUREFORMAT_LUMINANCE: number;
  38675. /** LUMINANCE_ALPHA */
  38676. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  38677. /** RGB */
  38678. static readonly TEXTUREFORMAT_RGB: number;
  38679. /** RGBA */
  38680. static readonly TEXTUREFORMAT_RGBA: number;
  38681. /** RED */
  38682. static readonly TEXTUREFORMAT_RED: number;
  38683. /** RED (2nd reference) */
  38684. static readonly TEXTUREFORMAT_R: number;
  38685. /** RG */
  38686. static readonly TEXTUREFORMAT_RG: number;
  38687. /** RED_INTEGER */
  38688. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  38689. /** RED_INTEGER (2nd reference) */
  38690. static readonly TEXTUREFORMAT_R_INTEGER: number;
  38691. /** RG_INTEGER */
  38692. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  38693. /** RGB_INTEGER */
  38694. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  38695. /** RGBA_INTEGER */
  38696. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  38697. /** UNSIGNED_BYTE */
  38698. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  38699. /** UNSIGNED_BYTE (2nd reference) */
  38700. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  38701. /** FLOAT */
  38702. static readonly TEXTURETYPE_FLOAT: number;
  38703. /** HALF_FLOAT */
  38704. static readonly TEXTURETYPE_HALF_FLOAT: number;
  38705. /** BYTE */
  38706. static readonly TEXTURETYPE_BYTE: number;
  38707. /** SHORT */
  38708. static readonly TEXTURETYPE_SHORT: number;
  38709. /** UNSIGNED_SHORT */
  38710. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  38711. /** INT */
  38712. static readonly TEXTURETYPE_INT: number;
  38713. /** UNSIGNED_INT */
  38714. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  38715. /** UNSIGNED_SHORT_4_4_4_4 */
  38716. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  38717. /** UNSIGNED_SHORT_5_5_5_1 */
  38718. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  38719. /** UNSIGNED_SHORT_5_6_5 */
  38720. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  38721. /** UNSIGNED_INT_2_10_10_10_REV */
  38722. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  38723. /** UNSIGNED_INT_24_8 */
  38724. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  38725. /** UNSIGNED_INT_10F_11F_11F_REV */
  38726. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  38727. /** UNSIGNED_INT_5_9_9_9_REV */
  38728. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  38729. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  38730. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  38731. /** nearest is mag = nearest and min = nearest and mip = linear */
  38732. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  38733. /** Bilinear is mag = linear and min = linear and mip = nearest */
  38734. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  38735. /** Trilinear is mag = linear and min = linear and mip = linear */
  38736. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  38737. /** nearest is mag = nearest and min = nearest and mip = linear */
  38738. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  38739. /** Bilinear is mag = linear and min = linear and mip = nearest */
  38740. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  38741. /** Trilinear is mag = linear and min = linear and mip = linear */
  38742. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  38743. /** mag = nearest and min = nearest and mip = nearest */
  38744. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  38745. /** mag = nearest and min = linear and mip = nearest */
  38746. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  38747. /** mag = nearest and min = linear and mip = linear */
  38748. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  38749. /** mag = nearest and min = linear and mip = none */
  38750. static readonly TEXTURE_NEAREST_LINEAR: number;
  38751. /** mag = nearest and min = nearest and mip = none */
  38752. static readonly TEXTURE_NEAREST_NEAREST: number;
  38753. /** mag = linear and min = nearest and mip = nearest */
  38754. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  38755. /** mag = linear and min = nearest and mip = linear */
  38756. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  38757. /** mag = linear and min = linear and mip = none */
  38758. static readonly TEXTURE_LINEAR_LINEAR: number;
  38759. /** mag = linear and min = nearest and mip = none */
  38760. static readonly TEXTURE_LINEAR_NEAREST: number;
  38761. /** Explicit coordinates mode */
  38762. static readonly TEXTURE_EXPLICIT_MODE: number;
  38763. /** Spherical coordinates mode */
  38764. static readonly TEXTURE_SPHERICAL_MODE: number;
  38765. /** Planar coordinates mode */
  38766. static readonly TEXTURE_PLANAR_MODE: number;
  38767. /** Cubic coordinates mode */
  38768. static readonly TEXTURE_CUBIC_MODE: number;
  38769. /** Projection coordinates mode */
  38770. static readonly TEXTURE_PROJECTION_MODE: number;
  38771. /** Skybox coordinates mode */
  38772. static readonly TEXTURE_SKYBOX_MODE: number;
  38773. /** Inverse Cubic coordinates mode */
  38774. static readonly TEXTURE_INVCUBIC_MODE: number;
  38775. /** Equirectangular coordinates mode */
  38776. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  38777. /** Equirectangular Fixed coordinates mode */
  38778. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  38779. /** Equirectangular Fixed Mirrored coordinates mode */
  38780. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  38781. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  38782. static readonly SCALEMODE_FLOOR: number;
  38783. /** Defines that texture rescaling will look for the nearest power of 2 size */
  38784. static readonly SCALEMODE_NEAREST: number;
  38785. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  38786. static readonly SCALEMODE_CEILING: number;
  38787. /**
  38788. * Returns the current npm package of the sdk
  38789. */
  38790. static get NpmPackage(): string;
  38791. /**
  38792. * Returns the current version of the framework
  38793. */
  38794. static get Version(): string;
  38795. /** Gets the list of created engines */
  38796. static get Instances(): Engine[];
  38797. /**
  38798. * Gets the latest created engine
  38799. */
  38800. static get LastCreatedEngine(): Nullable<Engine>;
  38801. /**
  38802. * Gets the latest created scene
  38803. */
  38804. static get LastCreatedScene(): Nullable<Scene>;
  38805. /**
  38806. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  38807. * @param flag defines which part of the materials must be marked as dirty
  38808. * @param predicate defines a predicate used to filter which materials should be affected
  38809. */
  38810. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  38811. /**
  38812. * Method called to create the default loading screen.
  38813. * This can be overriden in your own app.
  38814. * @param canvas The rendering canvas element
  38815. * @returns The loading screen
  38816. */
  38817. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  38818. /**
  38819. * Method called to create the default rescale post process on each engine.
  38820. */
  38821. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  38822. /**
  38823. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  38824. **/
  38825. enableOfflineSupport: boolean;
  38826. /**
  38827. * 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)
  38828. **/
  38829. disableManifestCheck: boolean;
  38830. /**
  38831. * Gets the list of created scenes
  38832. */
  38833. scenes: Scene[];
  38834. /**
  38835. * Event raised when a new scene is created
  38836. */
  38837. onNewSceneAddedObservable: Observable<Scene>;
  38838. /**
  38839. * Gets the list of created postprocesses
  38840. */
  38841. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  38842. /**
  38843. * Gets a boolean indicating if the pointer is currently locked
  38844. */
  38845. isPointerLock: boolean;
  38846. /**
  38847. * Observable event triggered each time the rendering canvas is resized
  38848. */
  38849. onResizeObservable: Observable<Engine>;
  38850. /**
  38851. * Observable event triggered each time the canvas loses focus
  38852. */
  38853. onCanvasBlurObservable: Observable<Engine>;
  38854. /**
  38855. * Observable event triggered each time the canvas gains focus
  38856. */
  38857. onCanvasFocusObservable: Observable<Engine>;
  38858. /**
  38859. * Observable event triggered each time the canvas receives pointerout event
  38860. */
  38861. onCanvasPointerOutObservable: Observable<PointerEvent>;
  38862. /**
  38863. * Observable raised when the engine begins a new frame
  38864. */
  38865. onBeginFrameObservable: Observable<Engine>;
  38866. /**
  38867. * If set, will be used to request the next animation frame for the render loop
  38868. */
  38869. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  38870. /**
  38871. * Observable raised when the engine ends the current frame
  38872. */
  38873. onEndFrameObservable: Observable<Engine>;
  38874. /**
  38875. * Observable raised when the engine is about to compile a shader
  38876. */
  38877. onBeforeShaderCompilationObservable: Observable<Engine>;
  38878. /**
  38879. * Observable raised when the engine has jsut compiled a shader
  38880. */
  38881. onAfterShaderCompilationObservable: Observable<Engine>;
  38882. /**
  38883. * Gets the audio engine
  38884. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38885. * @ignorenaming
  38886. */
  38887. static audioEngine: IAudioEngine;
  38888. /**
  38889. * Default AudioEngine factory responsible of creating the Audio Engine.
  38890. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  38891. */
  38892. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  38893. /**
  38894. * Default offline support factory responsible of creating a tool used to store data locally.
  38895. * By default, this will create a Database object if the workload has been embedded.
  38896. */
  38897. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  38898. private _loadingScreen;
  38899. private _pointerLockRequested;
  38900. private _rescalePostProcess;
  38901. private _deterministicLockstep;
  38902. private _lockstepMaxSteps;
  38903. private _timeStep;
  38904. protected get _supportsHardwareTextureRescaling(): boolean;
  38905. private _fps;
  38906. private _deltaTime;
  38907. /** @hidden */
  38908. _drawCalls: PerfCounter;
  38909. /** 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 */
  38910. canvasTabIndex: number;
  38911. /**
  38912. * Turn this value on if you want to pause FPS computation when in background
  38913. */
  38914. disablePerformanceMonitorInBackground: boolean;
  38915. private _performanceMonitor;
  38916. /**
  38917. * Gets the performance monitor attached to this engine
  38918. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  38919. */
  38920. get performanceMonitor(): PerformanceMonitor;
  38921. private _onFocus;
  38922. private _onBlur;
  38923. private _onCanvasPointerOut;
  38924. private _onCanvasBlur;
  38925. private _onCanvasFocus;
  38926. private _onFullscreenChange;
  38927. private _onPointerLockChange;
  38928. /**
  38929. * Gets the HTML element used to attach event listeners
  38930. * @returns a HTML element
  38931. */
  38932. getInputElement(): Nullable<HTMLElement>;
  38933. /**
  38934. * Creates a new engine
  38935. * @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
  38936. * @param antialias defines enable antialiasing (default: false)
  38937. * @param options defines further options to be sent to the getContext() function
  38938. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  38939. */
  38940. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  38941. /**
  38942. * Gets current aspect ratio
  38943. * @param viewportOwner defines the camera to use to get the aspect ratio
  38944. * @param useScreen defines if screen size must be used (or the current render target if any)
  38945. * @returns a number defining the aspect ratio
  38946. */
  38947. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  38948. /**
  38949. * Gets current screen aspect ratio
  38950. * @returns a number defining the aspect ratio
  38951. */
  38952. getScreenAspectRatio(): number;
  38953. /**
  38954. * Gets the client rect of the HTML canvas attached with the current webGL context
  38955. * @returns a client rectanglee
  38956. */
  38957. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  38958. /**
  38959. * Gets the client rect of the HTML element used for events
  38960. * @returns a client rectanglee
  38961. */
  38962. getInputElementClientRect(): Nullable<ClientRect>;
  38963. /**
  38964. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  38965. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  38966. * @returns true if engine is in deterministic lock step mode
  38967. */
  38968. isDeterministicLockStep(): boolean;
  38969. /**
  38970. * Gets the max steps when engine is running in deterministic lock step
  38971. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  38972. * @returns the max steps
  38973. */
  38974. getLockstepMaxSteps(): number;
  38975. /**
  38976. * Returns the time in ms between steps when using deterministic lock step.
  38977. * @returns time step in (ms)
  38978. */
  38979. getTimeStep(): number;
  38980. /**
  38981. * Force the mipmap generation for the given render target texture
  38982. * @param texture defines the render target texture to use
  38983. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  38984. */
  38985. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  38986. /** States */
  38987. /**
  38988. * Set various states to the webGL context
  38989. * @param culling defines backface culling state
  38990. * @param zOffset defines the value to apply to zOffset (0 by default)
  38991. * @param force defines if states must be applied even if cache is up to date
  38992. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  38993. */
  38994. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  38995. /**
  38996. * Set the z offset to apply to current rendering
  38997. * @param value defines the offset to apply
  38998. */
  38999. setZOffset(value: number): void;
  39000. /**
  39001. * Gets the current value of the zOffset
  39002. * @returns the current zOffset state
  39003. */
  39004. getZOffset(): number;
  39005. /**
  39006. * Enable or disable depth buffering
  39007. * @param enable defines the state to set
  39008. */
  39009. setDepthBuffer(enable: boolean): void;
  39010. /**
  39011. * Gets a boolean indicating if depth writing is enabled
  39012. * @returns the current depth writing state
  39013. */
  39014. getDepthWrite(): boolean;
  39015. /**
  39016. * Enable or disable depth writing
  39017. * @param enable defines the state to set
  39018. */
  39019. setDepthWrite(enable: boolean): void;
  39020. /**
  39021. * Gets a boolean indicating if stencil buffer is enabled
  39022. * @returns the current stencil buffer state
  39023. */
  39024. getStencilBuffer(): boolean;
  39025. /**
  39026. * Enable or disable the stencil buffer
  39027. * @param enable defines if the stencil buffer must be enabled or disabled
  39028. */
  39029. setStencilBuffer(enable: boolean): void;
  39030. /**
  39031. * Gets the current stencil mask
  39032. * @returns a number defining the new stencil mask to use
  39033. */
  39034. getStencilMask(): number;
  39035. /**
  39036. * Sets the current stencil mask
  39037. * @param mask defines the new stencil mask to use
  39038. */
  39039. setStencilMask(mask: number): void;
  39040. /**
  39041. * Gets the current stencil function
  39042. * @returns a number defining the stencil function to use
  39043. */
  39044. getStencilFunction(): number;
  39045. /**
  39046. * Gets the current stencil reference value
  39047. * @returns a number defining the stencil reference value to use
  39048. */
  39049. getStencilFunctionReference(): number;
  39050. /**
  39051. * Gets the current stencil mask
  39052. * @returns a number defining the stencil mask to use
  39053. */
  39054. getStencilFunctionMask(): number;
  39055. /**
  39056. * Sets the current stencil function
  39057. * @param stencilFunc defines the new stencil function to use
  39058. */
  39059. setStencilFunction(stencilFunc: number): void;
  39060. /**
  39061. * Sets the current stencil reference
  39062. * @param reference defines the new stencil reference to use
  39063. */
  39064. setStencilFunctionReference(reference: number): void;
  39065. /**
  39066. * Sets the current stencil mask
  39067. * @param mask defines the new stencil mask to use
  39068. */
  39069. setStencilFunctionMask(mask: number): void;
  39070. /**
  39071. * Gets the current stencil operation when stencil fails
  39072. * @returns a number defining stencil operation to use when stencil fails
  39073. */
  39074. getStencilOperationFail(): number;
  39075. /**
  39076. * Gets the current stencil operation when depth fails
  39077. * @returns a number defining stencil operation to use when depth fails
  39078. */
  39079. getStencilOperationDepthFail(): number;
  39080. /**
  39081. * Gets the current stencil operation when stencil passes
  39082. * @returns a number defining stencil operation to use when stencil passes
  39083. */
  39084. getStencilOperationPass(): number;
  39085. /**
  39086. * Sets the stencil operation to use when stencil fails
  39087. * @param operation defines the stencil operation to use when stencil fails
  39088. */
  39089. setStencilOperationFail(operation: number): void;
  39090. /**
  39091. * Sets the stencil operation to use when depth fails
  39092. * @param operation defines the stencil operation to use when depth fails
  39093. */
  39094. setStencilOperationDepthFail(operation: number): void;
  39095. /**
  39096. * Sets the stencil operation to use when stencil passes
  39097. * @param operation defines the stencil operation to use when stencil passes
  39098. */
  39099. setStencilOperationPass(operation: number): void;
  39100. /**
  39101. * Sets a boolean indicating if the dithering state is enabled or disabled
  39102. * @param value defines the dithering state
  39103. */
  39104. setDitheringState(value: boolean): void;
  39105. /**
  39106. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  39107. * @param value defines the rasterizer state
  39108. */
  39109. setRasterizerState(value: boolean): void;
  39110. /**
  39111. * Gets the current depth function
  39112. * @returns a number defining the depth function
  39113. */
  39114. getDepthFunction(): Nullable<number>;
  39115. /**
  39116. * Sets the current depth function
  39117. * @param depthFunc defines the function to use
  39118. */
  39119. setDepthFunction(depthFunc: number): void;
  39120. /**
  39121. * Sets the current depth function to GREATER
  39122. */
  39123. setDepthFunctionToGreater(): void;
  39124. /**
  39125. * Sets the current depth function to GEQUAL
  39126. */
  39127. setDepthFunctionToGreaterOrEqual(): void;
  39128. /**
  39129. * Sets the current depth function to LESS
  39130. */
  39131. setDepthFunctionToLess(): void;
  39132. /**
  39133. * Sets the current depth function to LEQUAL
  39134. */
  39135. setDepthFunctionToLessOrEqual(): void;
  39136. private _cachedStencilBuffer;
  39137. private _cachedStencilFunction;
  39138. private _cachedStencilMask;
  39139. private _cachedStencilOperationPass;
  39140. private _cachedStencilOperationFail;
  39141. private _cachedStencilOperationDepthFail;
  39142. private _cachedStencilReference;
  39143. /**
  39144. * Caches the the state of the stencil buffer
  39145. */
  39146. cacheStencilState(): void;
  39147. /**
  39148. * Restores the state of the stencil buffer
  39149. */
  39150. restoreStencilState(): void;
  39151. /**
  39152. * Directly set the WebGL Viewport
  39153. * @param x defines the x coordinate of the viewport (in screen space)
  39154. * @param y defines the y coordinate of the viewport (in screen space)
  39155. * @param width defines the width of the viewport (in screen space)
  39156. * @param height defines the height of the viewport (in screen space)
  39157. * @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
  39158. */
  39159. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  39160. /**
  39161. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  39162. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  39163. * @param y defines the y-coordinate of the corner of the clear rectangle
  39164. * @param width defines the width of the clear rectangle
  39165. * @param height defines the height of the clear rectangle
  39166. * @param clearColor defines the clear color
  39167. */
  39168. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  39169. /**
  39170. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  39171. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  39172. * @param y defines the y-coordinate of the corner of the clear rectangle
  39173. * @param width defines the width of the clear rectangle
  39174. * @param height defines the height of the clear rectangle
  39175. */
  39176. enableScissor(x: number, y: number, width: number, height: number): void;
  39177. /**
  39178. * Disable previously set scissor test rectangle
  39179. */
  39180. disableScissor(): void;
  39181. protected _reportDrawCall(): void;
  39182. /**
  39183. * Initializes a webVR display and starts listening to display change events
  39184. * The onVRDisplayChangedObservable will be notified upon these changes
  39185. * @returns The onVRDisplayChangedObservable
  39186. */
  39187. initWebVR(): Observable<IDisplayChangedEventArgs>;
  39188. /** @hidden */
  39189. _prepareVRComponent(): void;
  39190. /** @hidden */
  39191. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  39192. /** @hidden */
  39193. _submitVRFrame(): void;
  39194. /**
  39195. * Call this function to leave webVR mode
  39196. * Will do nothing if webVR is not supported or if there is no webVR device
  39197. * @see https://doc.babylonjs.com/how_to/webvr_camera
  39198. */
  39199. disableVR(): void;
  39200. /**
  39201. * Gets a boolean indicating that the system is in VR mode and is presenting
  39202. * @returns true if VR mode is engaged
  39203. */
  39204. isVRPresenting(): boolean;
  39205. /** @hidden */
  39206. _requestVRFrame(): void;
  39207. /** @hidden */
  39208. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  39209. /**
  39210. * Gets the source code of the vertex shader associated with a specific webGL program
  39211. * @param program defines the program to use
  39212. * @returns a string containing the source code of the vertex shader associated with the program
  39213. */
  39214. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  39215. /**
  39216. * Gets the source code of the fragment shader associated with a specific webGL program
  39217. * @param program defines the program to use
  39218. * @returns a string containing the source code of the fragment shader associated with the program
  39219. */
  39220. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  39221. /**
  39222. * Sets a depth stencil texture from a render target to the according uniform.
  39223. * @param channel The texture channel
  39224. * @param uniform The uniform to set
  39225. * @param texture The render target texture containing the depth stencil texture to apply
  39226. */
  39227. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  39228. /**
  39229. * Sets a texture to the webGL context from a postprocess
  39230. * @param channel defines the channel to use
  39231. * @param postProcess defines the source postprocess
  39232. */
  39233. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  39234. /**
  39235. * Binds the output of the passed in post process to the texture channel specified
  39236. * @param channel The channel the texture should be bound to
  39237. * @param postProcess The post process which's output should be bound
  39238. */
  39239. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  39240. protected _rebuildBuffers(): void;
  39241. /** @hidden */
  39242. _renderFrame(): void;
  39243. _renderLoop(): void;
  39244. /** @hidden */
  39245. _renderViews(): boolean;
  39246. /**
  39247. * Toggle full screen mode
  39248. * @param requestPointerLock defines if a pointer lock should be requested from the user
  39249. */
  39250. switchFullscreen(requestPointerLock: boolean): void;
  39251. /**
  39252. * Enters full screen mode
  39253. * @param requestPointerLock defines if a pointer lock should be requested from the user
  39254. */
  39255. enterFullscreen(requestPointerLock: boolean): void;
  39256. /**
  39257. * Exits full screen mode
  39258. */
  39259. exitFullscreen(): void;
  39260. /**
  39261. * Enters Pointerlock mode
  39262. */
  39263. enterPointerlock(): void;
  39264. /**
  39265. * Exits Pointerlock mode
  39266. */
  39267. exitPointerlock(): void;
  39268. /**
  39269. * Begin a new frame
  39270. */
  39271. beginFrame(): void;
  39272. /**
  39273. * Enf the current frame
  39274. */
  39275. endFrame(): void;
  39276. resize(): void;
  39277. /**
  39278. * Force a specific size of the canvas
  39279. * @param width defines the new canvas' width
  39280. * @param height defines the new canvas' height
  39281. * @returns true if the size was changed
  39282. */
  39283. setSize(width: number, height: number): boolean;
  39284. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  39285. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39286. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39287. _releaseTexture(texture: InternalTexture): void;
  39288. /**
  39289. * @hidden
  39290. * Rescales a texture
  39291. * @param source input texutre
  39292. * @param destination destination texture
  39293. * @param scene scene to use to render the resize
  39294. * @param internalFormat format to use when resizing
  39295. * @param onComplete callback to be called when resize has completed
  39296. */
  39297. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  39298. /**
  39299. * Gets the current framerate
  39300. * @returns a number representing the framerate
  39301. */
  39302. getFps(): number;
  39303. /**
  39304. * Gets the time spent between current and previous frame
  39305. * @returns a number representing the delta time in ms
  39306. */
  39307. getDeltaTime(): number;
  39308. private _measureFps;
  39309. /** @hidden */
  39310. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  39311. /**
  39312. * Updates the sample count of a render target texture
  39313. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  39314. * @param texture defines the texture to update
  39315. * @param samples defines the sample count to set
  39316. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  39317. */
  39318. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  39319. /**
  39320. * Updates a depth texture Comparison Mode and Function.
  39321. * If the comparison Function is equal to 0, the mode will be set to none.
  39322. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  39323. * @param texture The texture to set the comparison function for
  39324. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  39325. */
  39326. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  39327. /**
  39328. * Creates a webGL buffer to use with instanciation
  39329. * @param capacity defines the size of the buffer
  39330. * @returns the webGL buffer
  39331. */
  39332. createInstancesBuffer(capacity: number): DataBuffer;
  39333. /**
  39334. * Delete a webGL buffer used with instanciation
  39335. * @param buffer defines the webGL buffer to delete
  39336. */
  39337. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  39338. private _clientWaitAsync;
  39339. /** @hidden */
  39340. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  39341. dispose(): void;
  39342. private _disableTouchAction;
  39343. /**
  39344. * Display the loading screen
  39345. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39346. */
  39347. displayLoadingUI(): void;
  39348. /**
  39349. * Hide the loading screen
  39350. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39351. */
  39352. hideLoadingUI(): void;
  39353. /**
  39354. * Gets the current loading screen object
  39355. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39356. */
  39357. get loadingScreen(): ILoadingScreen;
  39358. /**
  39359. * Sets the current loading screen object
  39360. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39361. */
  39362. set loadingScreen(loadingScreen: ILoadingScreen);
  39363. /**
  39364. * Sets the current loading screen text
  39365. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39366. */
  39367. set loadingUIText(text: string);
  39368. /**
  39369. * Sets the current loading screen background color
  39370. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39371. */
  39372. set loadingUIBackgroundColor(color: string);
  39373. /** Pointerlock and fullscreen */
  39374. /**
  39375. * Ask the browser to promote the current element to pointerlock mode
  39376. * @param element defines the DOM element to promote
  39377. */
  39378. static _RequestPointerlock(element: HTMLElement): void;
  39379. /**
  39380. * Asks the browser to exit pointerlock mode
  39381. */
  39382. static _ExitPointerlock(): void;
  39383. /**
  39384. * Ask the browser to promote the current element to fullscreen rendering mode
  39385. * @param element defines the DOM element to promote
  39386. */
  39387. static _RequestFullscreen(element: HTMLElement): void;
  39388. /**
  39389. * Asks the browser to exit fullscreen mode
  39390. */
  39391. static _ExitFullscreen(): void;
  39392. }
  39393. }
  39394. declare module "babylonjs/Engines/engineStore" {
  39395. import { Nullable } from "babylonjs/types";
  39396. import { Engine } from "babylonjs/Engines/engine";
  39397. import { Scene } from "babylonjs/scene";
  39398. /**
  39399. * The engine store class is responsible to hold all the instances of Engine and Scene created
  39400. * during the life time of the application.
  39401. */
  39402. export class EngineStore {
  39403. /** Gets the list of created engines */
  39404. static Instances: import("babylonjs/Engines/engine").Engine[];
  39405. /** @hidden */
  39406. static _LastCreatedScene: Nullable<Scene>;
  39407. /**
  39408. * Gets the latest created engine
  39409. */
  39410. static get LastCreatedEngine(): Nullable<Engine>;
  39411. /**
  39412. * Gets the latest created scene
  39413. */
  39414. static get LastCreatedScene(): Nullable<Scene>;
  39415. /**
  39416. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  39417. * @ignorenaming
  39418. */
  39419. static UseFallbackTexture: boolean;
  39420. /**
  39421. * Texture content used if a texture cannot loaded
  39422. * @ignorenaming
  39423. */
  39424. static FallbackTexture: string;
  39425. }
  39426. }
  39427. declare module "babylonjs/Misc/promise" {
  39428. /**
  39429. * Helper class that provides a small promise polyfill
  39430. */
  39431. export class PromisePolyfill {
  39432. /**
  39433. * Static function used to check if the polyfill is required
  39434. * If this is the case then the function will inject the polyfill to window.Promise
  39435. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  39436. */
  39437. static Apply(force?: boolean): void;
  39438. }
  39439. }
  39440. declare module "babylonjs/Misc/interfaces/screenshotSize" {
  39441. /**
  39442. * Interface for screenshot methods with describe argument called `size` as object with options
  39443. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  39444. */
  39445. export interface IScreenshotSize {
  39446. /**
  39447. * number in pixels for canvas height
  39448. */
  39449. height?: number;
  39450. /**
  39451. * multiplier allowing render at a higher or lower resolution
  39452. * If value is defined then height and width will be ignored and taken from camera
  39453. */
  39454. precision?: number;
  39455. /**
  39456. * number in pixels for canvas width
  39457. */
  39458. width?: number;
  39459. }
  39460. }
  39461. declare module "babylonjs/Misc/tools" {
  39462. import { Nullable, float } from "babylonjs/types";
  39463. import { DomManagement } from "babylonjs/Misc/domManagement";
  39464. import { WebRequest } from "babylonjs/Misc/webRequest";
  39465. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  39466. import { ReadFileError } from "babylonjs/Misc/fileTools";
  39467. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  39468. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  39469. import { Camera } from "babylonjs/Cameras/camera";
  39470. import { Engine } from "babylonjs/Engines/engine";
  39471. interface IColor4Like {
  39472. r: float;
  39473. g: float;
  39474. b: float;
  39475. a: float;
  39476. }
  39477. /**
  39478. * Class containing a set of static utilities functions
  39479. */
  39480. export class Tools {
  39481. /**
  39482. * Gets or sets the base URL to use to load assets
  39483. */
  39484. static get BaseUrl(): string;
  39485. static set BaseUrl(value: string);
  39486. /**
  39487. * Enable/Disable Custom HTTP Request Headers globally.
  39488. * default = false
  39489. * @see CustomRequestHeaders
  39490. */
  39491. static UseCustomRequestHeaders: boolean;
  39492. /**
  39493. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  39494. * i.e. when loading files, where the server/service expects an Authorization header
  39495. */
  39496. static CustomRequestHeaders: {
  39497. [key: string]: string;
  39498. };
  39499. /**
  39500. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  39501. */
  39502. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  39503. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  39504. /**
  39505. * Default behaviour for cors in the application.
  39506. * It can be a string if the expected behavior is identical in the entire app.
  39507. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  39508. */
  39509. static get CorsBehavior(): string | ((url: string | string[]) => string);
  39510. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  39511. /**
  39512. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  39513. * @ignorenaming
  39514. */
  39515. static get UseFallbackTexture(): boolean;
  39516. static set UseFallbackTexture(value: boolean);
  39517. /**
  39518. * Use this object to register external classes like custom textures or material
  39519. * to allow the laoders to instantiate them
  39520. */
  39521. static get RegisteredExternalClasses(): {
  39522. [key: string]: Object;
  39523. };
  39524. static set RegisteredExternalClasses(classes: {
  39525. [key: string]: Object;
  39526. });
  39527. /**
  39528. * Texture content used if a texture cannot loaded
  39529. * @ignorenaming
  39530. */
  39531. static get fallbackTexture(): string;
  39532. static set fallbackTexture(value: string);
  39533. /**
  39534. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  39535. * @param u defines the coordinate on X axis
  39536. * @param v defines the coordinate on Y axis
  39537. * @param width defines the width of the source data
  39538. * @param height defines the height of the source data
  39539. * @param pixels defines the source byte array
  39540. * @param color defines the output color
  39541. */
  39542. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  39543. /**
  39544. * Interpolates between a and b via alpha
  39545. * @param a The lower value (returned when alpha = 0)
  39546. * @param b The upper value (returned when alpha = 1)
  39547. * @param alpha The interpolation-factor
  39548. * @return The mixed value
  39549. */
  39550. static Mix(a: number, b: number, alpha: number): number;
  39551. /**
  39552. * Tries to instantiate a new object from a given class name
  39553. * @param className defines the class name to instantiate
  39554. * @returns the new object or null if the system was not able to do the instantiation
  39555. */
  39556. static Instantiate(className: string): any;
  39557. /**
  39558. * Provides a slice function that will work even on IE
  39559. * @param data defines the array to slice
  39560. * @param start defines the start of the data (optional)
  39561. * @param end defines the end of the data (optional)
  39562. * @returns the new sliced array
  39563. */
  39564. static Slice<T>(data: T, start?: number, end?: number): T;
  39565. /**
  39566. * Polyfill for setImmediate
  39567. * @param action defines the action to execute after the current execution block
  39568. */
  39569. static SetImmediate(action: () => void): void;
  39570. /**
  39571. * Function indicating if a number is an exponent of 2
  39572. * @param value defines the value to test
  39573. * @returns true if the value is an exponent of 2
  39574. */
  39575. static IsExponentOfTwo(value: number): boolean;
  39576. private static _tmpFloatArray;
  39577. /**
  39578. * Returns the nearest 32-bit single precision float representation of a Number
  39579. * @param value A Number. If the parameter is of a different type, it will get converted
  39580. * to a number or to NaN if it cannot be converted
  39581. * @returns number
  39582. */
  39583. static FloatRound(value: number): number;
  39584. /**
  39585. * Extracts the filename from a path
  39586. * @param path defines the path to use
  39587. * @returns the filename
  39588. */
  39589. static GetFilename(path: string): string;
  39590. /**
  39591. * Extracts the "folder" part of a path (everything before the filename).
  39592. * @param uri The URI to extract the info from
  39593. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  39594. * @returns The "folder" part of the path
  39595. */
  39596. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  39597. /**
  39598. * Extracts text content from a DOM element hierarchy
  39599. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  39600. */
  39601. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  39602. /**
  39603. * Convert an angle in radians to degrees
  39604. * @param angle defines the angle to convert
  39605. * @returns the angle in degrees
  39606. */
  39607. static ToDegrees(angle: number): number;
  39608. /**
  39609. * Convert an angle in degrees to radians
  39610. * @param angle defines the angle to convert
  39611. * @returns the angle in radians
  39612. */
  39613. static ToRadians(angle: number): number;
  39614. /**
  39615. * Returns an array if obj is not an array
  39616. * @param obj defines the object to evaluate as an array
  39617. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  39618. * @returns either obj directly if obj is an array or a new array containing obj
  39619. */
  39620. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  39621. /**
  39622. * Gets the pointer prefix to use
  39623. * @param engine defines the engine we are finding the prefix for
  39624. * @returns "pointer" if touch is enabled. Else returns "mouse"
  39625. */
  39626. static GetPointerPrefix(engine: Engine): string;
  39627. /**
  39628. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  39629. * @param url define the url we are trying
  39630. * @param element define the dom element where to configure the cors policy
  39631. */
  39632. static SetCorsBehavior(url: string | string[], element: {
  39633. crossOrigin: string | null;
  39634. }): void;
  39635. /**
  39636. * Removes unwanted characters from an url
  39637. * @param url defines the url to clean
  39638. * @returns the cleaned url
  39639. */
  39640. static CleanUrl(url: string): string;
  39641. /**
  39642. * Gets or sets a function used to pre-process url before using them to load assets
  39643. */
  39644. static get PreprocessUrl(): (url: string) => string;
  39645. static set PreprocessUrl(processor: (url: string) => string);
  39646. /**
  39647. * Loads an image as an HTMLImageElement.
  39648. * @param input url string, ArrayBuffer, or Blob to load
  39649. * @param onLoad callback called when the image successfully loads
  39650. * @param onError callback called when the image fails to load
  39651. * @param offlineProvider offline provider for caching
  39652. * @param mimeType optional mime type
  39653. * @returns the HTMLImageElement of the loaded image
  39654. */
  39655. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  39656. /**
  39657. * Loads a file from a url
  39658. * @param url url string, ArrayBuffer, or Blob to load
  39659. * @param onSuccess callback called when the file successfully loads
  39660. * @param onProgress callback called while file is loading (if the server supports this mode)
  39661. * @param offlineProvider defines the offline provider for caching
  39662. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  39663. * @param onError callback called when the file fails to load
  39664. * @returns a file request object
  39665. */
  39666. 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;
  39667. /**
  39668. * Loads a file from a url
  39669. * @param url the file url to load
  39670. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  39671. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  39672. */
  39673. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  39674. /**
  39675. * Load a script (identified by an url). When the url returns, the
  39676. * content of this file is added into a new script element, attached to the DOM (body element)
  39677. * @param scriptUrl defines the url of the script to laod
  39678. * @param onSuccess defines the callback called when the script is loaded
  39679. * @param onError defines the callback to call if an error occurs
  39680. * @param scriptId defines the id of the script element
  39681. */
  39682. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  39683. /**
  39684. * Load an asynchronous script (identified by an url). When the url returns, the
  39685. * content of this file is added into a new script element, attached to the DOM (body element)
  39686. * @param scriptUrl defines the url of the script to laod
  39687. * @param scriptId defines the id of the script element
  39688. * @returns a promise request object
  39689. */
  39690. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  39691. /**
  39692. * Loads a file from a blob
  39693. * @param fileToLoad defines the blob to use
  39694. * @param callback defines the callback to call when data is loaded
  39695. * @param progressCallback defines the callback to call during loading process
  39696. * @returns a file request object
  39697. */
  39698. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  39699. /**
  39700. * Reads a file from a File object
  39701. * @param file defines the file to load
  39702. * @param onSuccess defines the callback to call when data is loaded
  39703. * @param onProgress defines the callback to call during loading process
  39704. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  39705. * @param onError defines the callback to call when an error occurs
  39706. * @returns a file request object
  39707. */
  39708. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  39709. /**
  39710. * Creates a data url from a given string content
  39711. * @param content defines the content to convert
  39712. * @returns the new data url link
  39713. */
  39714. static FileAsURL(content: string): string;
  39715. /**
  39716. * Format the given number to a specific decimal format
  39717. * @param value defines the number to format
  39718. * @param decimals defines the number of decimals to use
  39719. * @returns the formatted string
  39720. */
  39721. static Format(value: number, decimals?: number): string;
  39722. /**
  39723. * Tries to copy an object by duplicating every property
  39724. * @param source defines the source object
  39725. * @param destination defines the target object
  39726. * @param doNotCopyList defines a list of properties to avoid
  39727. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  39728. */
  39729. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  39730. /**
  39731. * Gets a boolean indicating if the given object has no own property
  39732. * @param obj defines the object to test
  39733. * @returns true if object has no own property
  39734. */
  39735. static IsEmpty(obj: any): boolean;
  39736. /**
  39737. * Function used to register events at window level
  39738. * @param windowElement defines the Window object to use
  39739. * @param events defines the events to register
  39740. */
  39741. static RegisterTopRootEvents(windowElement: Window, events: {
  39742. name: string;
  39743. handler: Nullable<(e: FocusEvent) => any>;
  39744. }[]): void;
  39745. /**
  39746. * Function used to unregister events from window level
  39747. * @param windowElement defines the Window object to use
  39748. * @param events defines the events to unregister
  39749. */
  39750. static UnregisterTopRootEvents(windowElement: Window, events: {
  39751. name: string;
  39752. handler: Nullable<(e: FocusEvent) => any>;
  39753. }[]): void;
  39754. /**
  39755. * @ignore
  39756. */
  39757. static _ScreenshotCanvas: HTMLCanvasElement;
  39758. /**
  39759. * Dumps the current bound framebuffer
  39760. * @param width defines the rendering width
  39761. * @param height defines the rendering height
  39762. * @param engine defines the hosting engine
  39763. * @param successCallback defines the callback triggered once the data are available
  39764. * @param mimeType defines the mime type of the result
  39765. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  39766. */
  39767. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  39768. /**
  39769. * Converts the canvas data to blob.
  39770. * This acts as a polyfill for browsers not supporting the to blob function.
  39771. * @param canvas Defines the canvas to extract the data from
  39772. * @param successCallback Defines the callback triggered once the data are available
  39773. * @param mimeType Defines the mime type of the result
  39774. */
  39775. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  39776. /**
  39777. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  39778. * @param successCallback defines the callback triggered once the data are available
  39779. * @param mimeType defines the mime type of the result
  39780. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  39781. */
  39782. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  39783. /**
  39784. * Downloads a blob in the browser
  39785. * @param blob defines the blob to download
  39786. * @param fileName defines the name of the downloaded file
  39787. */
  39788. static Download(blob: Blob, fileName: string): void;
  39789. /**
  39790. * Captures a screenshot of the current rendering
  39791. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39792. * @param engine defines the rendering engine
  39793. * @param camera defines the source camera
  39794. * @param size This parameter can be set to a single number or to an object with the
  39795. * following (optional) properties: precision, width, height. If a single number is passed,
  39796. * it will be used for both width and height. If an object is passed, the screenshot size
  39797. * will be derived from the parameters. The precision property is a multiplier allowing
  39798. * rendering at a higher or lower resolution
  39799. * @param successCallback defines the callback receives a single parameter which contains the
  39800. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  39801. * src parameter of an <img> to display it
  39802. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  39803. * Check your browser for supported MIME types
  39804. */
  39805. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  39806. /**
  39807. * Captures a screenshot of the current rendering
  39808. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39809. * @param engine defines the rendering engine
  39810. * @param camera defines the source camera
  39811. * @param size This parameter can be set to a single number or to an object with the
  39812. * following (optional) properties: precision, width, height. If a single number is passed,
  39813. * it will be used for both width and height. If an object is passed, the screenshot size
  39814. * will be derived from the parameters. The precision property is a multiplier allowing
  39815. * rendering at a higher or lower resolution
  39816. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  39817. * Check your browser for supported MIME types
  39818. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  39819. * to the src parameter of an <img> to display it
  39820. */
  39821. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  39822. /**
  39823. * Generates an image screenshot from the specified camera.
  39824. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39825. * @param engine The engine to use for rendering
  39826. * @param camera The camera to use for rendering
  39827. * @param size This parameter can be set to a single number or to an object with the
  39828. * following (optional) properties: precision, width, height. If a single number is passed,
  39829. * it will be used for both width and height. If an object is passed, the screenshot size
  39830. * will be derived from the parameters. The precision property is a multiplier allowing
  39831. * rendering at a higher or lower resolution
  39832. * @param successCallback The callback receives a single parameter which contains the
  39833. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  39834. * src parameter of an <img> to display it
  39835. * @param mimeType The MIME type of the screenshot image (default: image/png).
  39836. * Check your browser for supported MIME types
  39837. * @param samples Texture samples (default: 1)
  39838. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  39839. * @param fileName A name for for the downloaded file.
  39840. */
  39841. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  39842. /**
  39843. * Generates an image screenshot from the specified camera.
  39844. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39845. * @param engine The engine to use for rendering
  39846. * @param camera The camera to use for rendering
  39847. * @param size This parameter can be set to a single number or to an object with the
  39848. * following (optional) properties: precision, width, height. If a single number is passed,
  39849. * it will be used for both width and height. If an object is passed, the screenshot size
  39850. * will be derived from the parameters. The precision property is a multiplier allowing
  39851. * rendering at a higher or lower resolution
  39852. * @param mimeType The MIME type of the screenshot image (default: image/png).
  39853. * Check your browser for supported MIME types
  39854. * @param samples Texture samples (default: 1)
  39855. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  39856. * @param fileName A name for for the downloaded file.
  39857. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  39858. * to the src parameter of an <img> to display it
  39859. */
  39860. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  39861. /**
  39862. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  39863. * Be aware Math.random() could cause collisions, but:
  39864. * "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"
  39865. * @returns a pseudo random id
  39866. */
  39867. static RandomId(): string;
  39868. /**
  39869. * Test if the given uri is a base64 string
  39870. * @param uri The uri to test
  39871. * @return True if the uri is a base64 string or false otherwise
  39872. */
  39873. static IsBase64(uri: string): boolean;
  39874. /**
  39875. * Decode the given base64 uri.
  39876. * @param uri The uri to decode
  39877. * @return The decoded base64 data.
  39878. */
  39879. static DecodeBase64(uri: string): ArrayBuffer;
  39880. /**
  39881. * Gets the absolute url.
  39882. * @param url the input url
  39883. * @return the absolute url
  39884. */
  39885. static GetAbsoluteUrl(url: string): string;
  39886. /**
  39887. * No log
  39888. */
  39889. static readonly NoneLogLevel: number;
  39890. /**
  39891. * Only message logs
  39892. */
  39893. static readonly MessageLogLevel: number;
  39894. /**
  39895. * Only warning logs
  39896. */
  39897. static readonly WarningLogLevel: number;
  39898. /**
  39899. * Only error logs
  39900. */
  39901. static readonly ErrorLogLevel: number;
  39902. /**
  39903. * All logs
  39904. */
  39905. static readonly AllLogLevel: number;
  39906. /**
  39907. * Gets a value indicating the number of loading errors
  39908. * @ignorenaming
  39909. */
  39910. static get errorsCount(): number;
  39911. /**
  39912. * Callback called when a new log is added
  39913. */
  39914. static OnNewCacheEntry: (entry: string) => void;
  39915. /**
  39916. * Log a message to the console
  39917. * @param message defines the message to log
  39918. */
  39919. static Log(message: string): void;
  39920. /**
  39921. * Write a warning message to the console
  39922. * @param message defines the message to log
  39923. */
  39924. static Warn(message: string): void;
  39925. /**
  39926. * Write an error message to the console
  39927. * @param message defines the message to log
  39928. */
  39929. static Error(message: string): void;
  39930. /**
  39931. * Gets current log cache (list of logs)
  39932. */
  39933. static get LogCache(): string;
  39934. /**
  39935. * Clears the log cache
  39936. */
  39937. static ClearLogCache(): void;
  39938. /**
  39939. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  39940. */
  39941. static set LogLevels(level: number);
  39942. /**
  39943. * Checks if the window object exists
  39944. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  39945. */
  39946. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  39947. /**
  39948. * No performance log
  39949. */
  39950. static readonly PerformanceNoneLogLevel: number;
  39951. /**
  39952. * Use user marks to log performance
  39953. */
  39954. static readonly PerformanceUserMarkLogLevel: number;
  39955. /**
  39956. * Log performance to the console
  39957. */
  39958. static readonly PerformanceConsoleLogLevel: number;
  39959. private static _performance;
  39960. /**
  39961. * Sets the current performance log level
  39962. */
  39963. static set PerformanceLogLevel(level: number);
  39964. private static _StartPerformanceCounterDisabled;
  39965. private static _EndPerformanceCounterDisabled;
  39966. private static _StartUserMark;
  39967. private static _EndUserMark;
  39968. private static _StartPerformanceConsole;
  39969. private static _EndPerformanceConsole;
  39970. /**
  39971. * Starts a performance counter
  39972. */
  39973. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  39974. /**
  39975. * Ends a specific performance coutner
  39976. */
  39977. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  39978. /**
  39979. * Gets either window.performance.now() if supported or Date.now() else
  39980. */
  39981. static get Now(): number;
  39982. /**
  39983. * This method will return the name of the class used to create the instance of the given object.
  39984. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  39985. * @param object the object to get the class name from
  39986. * @param isType defines if the object is actually a type
  39987. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  39988. */
  39989. static GetClassName(object: any, isType?: boolean): string;
  39990. /**
  39991. * Gets the first element of an array satisfying a given predicate
  39992. * @param array defines the array to browse
  39993. * @param predicate defines the predicate to use
  39994. * @returns null if not found or the element
  39995. */
  39996. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  39997. /**
  39998. * This method will return the name of the full name of the class, including its owning module (if any).
  39999. * 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).
  40000. * @param object the object to get the class name from
  40001. * @param isType defines if the object is actually a type
  40002. * @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.
  40003. * @ignorenaming
  40004. */
  40005. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  40006. /**
  40007. * Returns a promise that resolves after the given amount of time.
  40008. * @param delay Number of milliseconds to delay
  40009. * @returns Promise that resolves after the given amount of time
  40010. */
  40011. static DelayAsync(delay: number): Promise<void>;
  40012. /**
  40013. * Utility function to detect if the current user agent is Safari
  40014. * @returns whether or not the current user agent is safari
  40015. */
  40016. static IsSafari(): boolean;
  40017. }
  40018. /**
  40019. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  40020. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  40021. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  40022. * @param name The name of the class, case should be preserved
  40023. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  40024. */
  40025. export function className(name: string, module?: string): (target: Object) => void;
  40026. /**
  40027. * An implementation of a loop for asynchronous functions.
  40028. */
  40029. export class AsyncLoop {
  40030. /**
  40031. * Defines the number of iterations for the loop
  40032. */
  40033. iterations: number;
  40034. /**
  40035. * Defines the current index of the loop.
  40036. */
  40037. index: number;
  40038. private _done;
  40039. private _fn;
  40040. private _successCallback;
  40041. /**
  40042. * Constructor.
  40043. * @param iterations the number of iterations.
  40044. * @param func the function to run each iteration
  40045. * @param successCallback the callback that will be called upon succesful execution
  40046. * @param offset starting offset.
  40047. */
  40048. constructor(
  40049. /**
  40050. * Defines the number of iterations for the loop
  40051. */
  40052. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  40053. /**
  40054. * Execute the next iteration. Must be called after the last iteration was finished.
  40055. */
  40056. executeNext(): void;
  40057. /**
  40058. * Break the loop and run the success callback.
  40059. */
  40060. breakLoop(): void;
  40061. /**
  40062. * Create and run an async loop.
  40063. * @param iterations the number of iterations.
  40064. * @param fn the function to run each iteration
  40065. * @param successCallback the callback that will be called upon succesful execution
  40066. * @param offset starting offset.
  40067. * @returns the created async loop object
  40068. */
  40069. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  40070. /**
  40071. * A for-loop that will run a given number of iterations synchronous and the rest async.
  40072. * @param iterations total number of iterations
  40073. * @param syncedIterations number of synchronous iterations in each async iteration.
  40074. * @param fn the function to call each iteration.
  40075. * @param callback a success call back that will be called when iterating stops.
  40076. * @param breakFunction a break condition (optional)
  40077. * @param timeout timeout settings for the setTimeout function. default - 0.
  40078. * @returns the created async loop object
  40079. */
  40080. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  40081. }
  40082. }
  40083. declare module "babylonjs/Misc/stringDictionary" {
  40084. import { Nullable } from "babylonjs/types";
  40085. /**
  40086. * This class implement a typical dictionary using a string as key and the generic type T as value.
  40087. * The underlying implementation relies on an associative array to ensure the best performances.
  40088. * The value can be anything including 'null' but except 'undefined'
  40089. */
  40090. export class StringDictionary<T> {
  40091. /**
  40092. * This will clear this dictionary and copy the content from the 'source' one.
  40093. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  40094. * @param source the dictionary to take the content from and copy to this dictionary
  40095. */
  40096. copyFrom(source: StringDictionary<T>): void;
  40097. /**
  40098. * Get a value based from its key
  40099. * @param key the given key to get the matching value from
  40100. * @return the value if found, otherwise undefined is returned
  40101. */
  40102. get(key: string): T | undefined;
  40103. /**
  40104. * Get a value from its key or add it if it doesn't exist.
  40105. * This method will ensure you that a given key/data will be present in the dictionary.
  40106. * @param key the given key to get the matching value from
  40107. * @param factory the factory that will create the value if the key is not present in the dictionary.
  40108. * The factory will only be invoked if there's no data for the given key.
  40109. * @return the value corresponding to the key.
  40110. */
  40111. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  40112. /**
  40113. * Get a value from its key if present in the dictionary otherwise add it
  40114. * @param key the key to get the value from
  40115. * @param val if there's no such key/value pair in the dictionary add it with this value
  40116. * @return the value corresponding to the key
  40117. */
  40118. getOrAdd(key: string, val: T): T;
  40119. /**
  40120. * Check if there's a given key in the dictionary
  40121. * @param key the key to check for
  40122. * @return true if the key is present, false otherwise
  40123. */
  40124. contains(key: string): boolean;
  40125. /**
  40126. * Add a new key and its corresponding value
  40127. * @param key the key to add
  40128. * @param value the value corresponding to the key
  40129. * @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
  40130. */
  40131. add(key: string, value: T): boolean;
  40132. /**
  40133. * Update a specific value associated to a key
  40134. * @param key defines the key to use
  40135. * @param value defines the value to store
  40136. * @returns true if the value was updated (or false if the key was not found)
  40137. */
  40138. set(key: string, value: T): boolean;
  40139. /**
  40140. * Get the element of the given key and remove it from the dictionary
  40141. * @param key defines the key to search
  40142. * @returns the value associated with the key or null if not found
  40143. */
  40144. getAndRemove(key: string): Nullable<T>;
  40145. /**
  40146. * Remove a key/value from the dictionary.
  40147. * @param key the key to remove
  40148. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  40149. */
  40150. remove(key: string): boolean;
  40151. /**
  40152. * Clear the whole content of the dictionary
  40153. */
  40154. clear(): void;
  40155. /**
  40156. * Gets the current count
  40157. */
  40158. get count(): number;
  40159. /**
  40160. * Execute a callback on each key/val of the dictionary.
  40161. * Note that you can remove any element in this dictionary in the callback implementation
  40162. * @param callback the callback to execute on a given key/value pair
  40163. */
  40164. forEach(callback: (key: string, val: T) => void): void;
  40165. /**
  40166. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  40167. * If the callback returns null or undefined the method will iterate to the next key/value pair
  40168. * Note that you can remove any element in this dictionary in the callback implementation
  40169. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  40170. * @returns the first item
  40171. */
  40172. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  40173. private _count;
  40174. private _data;
  40175. }
  40176. }
  40177. declare module "babylonjs/Collisions/collisionCoordinator" {
  40178. import { Nullable } from "babylonjs/types";
  40179. import { Scene } from "babylonjs/scene";
  40180. import { Vector3 } from "babylonjs/Maths/math.vector";
  40181. import { Collider } from "babylonjs/Collisions/collider";
  40182. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40183. /** @hidden */
  40184. export interface ICollisionCoordinator {
  40185. createCollider(): Collider;
  40186. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  40187. init(scene: Scene): void;
  40188. }
  40189. /** @hidden */
  40190. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  40191. private _scene;
  40192. private _scaledPosition;
  40193. private _scaledVelocity;
  40194. private _finalPosition;
  40195. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  40196. createCollider(): Collider;
  40197. init(scene: Scene): void;
  40198. private _collideWithWorld;
  40199. }
  40200. }
  40201. declare module "babylonjs/Inputs/scene.inputManager" {
  40202. import { Nullable } from "babylonjs/types";
  40203. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  40204. import { Vector2 } from "babylonjs/Maths/math.vector";
  40205. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40206. import { Scene } from "babylonjs/scene";
  40207. /**
  40208. * Class used to manage all inputs for the scene.
  40209. */
  40210. export class InputManager {
  40211. /** The distance in pixel that you have to move to prevent some events */
  40212. static DragMovementThreshold: number;
  40213. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  40214. static LongPressDelay: number;
  40215. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  40216. static DoubleClickDelay: number;
  40217. /** If you need to check double click without raising a single click at first click, enable this flag */
  40218. static ExclusiveDoubleClickMode: boolean;
  40219. /** 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. */
  40220. private _alreadyAttached;
  40221. private _wheelEventName;
  40222. private _onPointerMove;
  40223. private _onPointerDown;
  40224. private _onPointerUp;
  40225. private _initClickEvent;
  40226. private _initActionManager;
  40227. private _delayedSimpleClick;
  40228. private _delayedSimpleClickTimeout;
  40229. private _previousDelayedSimpleClickTimeout;
  40230. private _meshPickProceed;
  40231. private _previousButtonPressed;
  40232. private _currentPickResult;
  40233. private _previousPickResult;
  40234. private _totalPointersPressed;
  40235. private _doubleClickOccured;
  40236. private _pointerOverMesh;
  40237. private _pickedDownMesh;
  40238. private _pickedUpMesh;
  40239. private _pointerX;
  40240. private _pointerY;
  40241. private _unTranslatedPointerX;
  40242. private _unTranslatedPointerY;
  40243. private _startingPointerPosition;
  40244. private _previousStartingPointerPosition;
  40245. private _startingPointerTime;
  40246. private _previousStartingPointerTime;
  40247. private _pointerCaptures;
  40248. private _onKeyDown;
  40249. private _onKeyUp;
  40250. private _onCanvasFocusObserver;
  40251. private _onCanvasBlurObserver;
  40252. private _scene;
  40253. /**
  40254. * Creates a new InputManager
  40255. * @param scene defines the hosting scene
  40256. */
  40257. constructor(scene: Scene);
  40258. /**
  40259. * Gets the mesh that is currently under the pointer
  40260. */
  40261. get meshUnderPointer(): Nullable<AbstractMesh>;
  40262. /**
  40263. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  40264. */
  40265. get unTranslatedPointer(): Vector2;
  40266. /**
  40267. * Gets or sets the current on-screen X position of the pointer
  40268. */
  40269. get pointerX(): number;
  40270. set pointerX(value: number);
  40271. /**
  40272. * Gets or sets the current on-screen Y position of the pointer
  40273. */
  40274. get pointerY(): number;
  40275. set pointerY(value: number);
  40276. private _updatePointerPosition;
  40277. private _processPointerMove;
  40278. private _setRayOnPointerInfo;
  40279. private _checkPrePointerObservable;
  40280. /**
  40281. * Use this method to simulate a pointer move on a mesh
  40282. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40283. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40284. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40285. */
  40286. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  40287. /**
  40288. * Use this method to simulate a pointer down on a mesh
  40289. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40290. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40291. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40292. */
  40293. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  40294. private _processPointerDown;
  40295. /** @hidden */
  40296. _isPointerSwiping(): boolean;
  40297. /**
  40298. * Use this method to simulate a pointer up on a mesh
  40299. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40300. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40301. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40302. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  40303. */
  40304. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  40305. private _processPointerUp;
  40306. /**
  40307. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  40308. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  40309. * @returns true if the pointer was captured
  40310. */
  40311. isPointerCaptured(pointerId?: number): boolean;
  40312. /**
  40313. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  40314. * @param attachUp defines if you want to attach events to pointerup
  40315. * @param attachDown defines if you want to attach events to pointerdown
  40316. * @param attachMove defines if you want to attach events to pointermove
  40317. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  40318. */
  40319. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  40320. /**
  40321. * Detaches all event handlers
  40322. */
  40323. detachControl(): void;
  40324. /**
  40325. * Force the value of meshUnderPointer
  40326. * @param mesh defines the mesh to use
  40327. */
  40328. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  40329. /**
  40330. * Gets the mesh under the pointer
  40331. * @returns a Mesh or null if no mesh is under the pointer
  40332. */
  40333. getPointerOverMesh(): Nullable<AbstractMesh>;
  40334. }
  40335. }
  40336. declare module "babylonjs/Animations/animationGroup" {
  40337. import { Animatable } from "babylonjs/Animations/animatable";
  40338. import { Animation } from "babylonjs/Animations/animation";
  40339. import { Scene, IDisposable } from "babylonjs/scene";
  40340. import { Observable } from "babylonjs/Misc/observable";
  40341. import { Nullable } from "babylonjs/types";
  40342. import "babylonjs/Animations/animatable";
  40343. /**
  40344. * This class defines the direct association between an animation and a target
  40345. */
  40346. export class TargetedAnimation {
  40347. /**
  40348. * Animation to perform
  40349. */
  40350. animation: Animation;
  40351. /**
  40352. * Target to animate
  40353. */
  40354. target: any;
  40355. /**
  40356. * Returns the string "TargetedAnimation"
  40357. * @returns "TargetedAnimation"
  40358. */
  40359. getClassName(): string;
  40360. /**
  40361. * Serialize the object
  40362. * @returns the JSON object representing the current entity
  40363. */
  40364. serialize(): any;
  40365. }
  40366. /**
  40367. * Use this class to create coordinated animations on multiple targets
  40368. */
  40369. export class AnimationGroup implements IDisposable {
  40370. /** The name of the animation group */
  40371. name: string;
  40372. private _scene;
  40373. private _targetedAnimations;
  40374. private _animatables;
  40375. private _from;
  40376. private _to;
  40377. private _isStarted;
  40378. private _isPaused;
  40379. private _speedRatio;
  40380. private _loopAnimation;
  40381. private _isAdditive;
  40382. /**
  40383. * Gets or sets the unique id of the node
  40384. */
  40385. uniqueId: number;
  40386. /**
  40387. * This observable will notify when one animation have ended
  40388. */
  40389. onAnimationEndObservable: Observable<TargetedAnimation>;
  40390. /**
  40391. * Observer raised when one animation loops
  40392. */
  40393. onAnimationLoopObservable: Observable<TargetedAnimation>;
  40394. /**
  40395. * Observer raised when all animations have looped
  40396. */
  40397. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  40398. /**
  40399. * This observable will notify when all animations have ended.
  40400. */
  40401. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  40402. /**
  40403. * This observable will notify when all animations have paused.
  40404. */
  40405. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  40406. /**
  40407. * This observable will notify when all animations are playing.
  40408. */
  40409. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  40410. /**
  40411. * Gets the first frame
  40412. */
  40413. get from(): number;
  40414. /**
  40415. * Gets the last frame
  40416. */
  40417. get to(): number;
  40418. /**
  40419. * Define if the animations are started
  40420. */
  40421. get isStarted(): boolean;
  40422. /**
  40423. * Gets a value indicating that the current group is playing
  40424. */
  40425. get isPlaying(): boolean;
  40426. /**
  40427. * Gets or sets the speed ratio to use for all animations
  40428. */
  40429. get speedRatio(): number;
  40430. /**
  40431. * Gets or sets the speed ratio to use for all animations
  40432. */
  40433. set speedRatio(value: number);
  40434. /**
  40435. * Gets or sets if all animations should loop or not
  40436. */
  40437. get loopAnimation(): boolean;
  40438. set loopAnimation(value: boolean);
  40439. /**
  40440. * Gets or sets if all animations should be evaluated additively
  40441. */
  40442. get isAdditive(): boolean;
  40443. set isAdditive(value: boolean);
  40444. /**
  40445. * Gets the targeted animations for this animation group
  40446. */
  40447. get targetedAnimations(): Array<TargetedAnimation>;
  40448. /**
  40449. * returning the list of animatables controlled by this animation group.
  40450. */
  40451. get animatables(): Array<Animatable>;
  40452. /**
  40453. * Gets the list of target animations
  40454. */
  40455. get children(): TargetedAnimation[];
  40456. /**
  40457. * Instantiates a new Animation Group.
  40458. * This helps managing several animations at once.
  40459. * @see https://doc.babylonjs.com/how_to/group
  40460. * @param name Defines the name of the group
  40461. * @param scene Defines the scene the group belongs to
  40462. */
  40463. constructor(
  40464. /** The name of the animation group */
  40465. name: string, scene?: Nullable<Scene>);
  40466. /**
  40467. * Add an animation (with its target) in the group
  40468. * @param animation defines the animation we want to add
  40469. * @param target defines the target of the animation
  40470. * @returns the TargetedAnimation object
  40471. */
  40472. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  40473. /**
  40474. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  40475. * It can add constant keys at begin or end
  40476. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  40477. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  40478. * @returns the animation group
  40479. */
  40480. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  40481. private _animationLoopCount;
  40482. private _animationLoopFlags;
  40483. private _processLoop;
  40484. /**
  40485. * Start all animations on given targets
  40486. * @param loop defines if animations must loop
  40487. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  40488. * @param from defines the from key (optional)
  40489. * @param to defines the to key (optional)
  40490. * @param isAdditive defines the additive state for the resulting animatables (optional)
  40491. * @returns the current animation group
  40492. */
  40493. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  40494. /**
  40495. * Pause all animations
  40496. * @returns the animation group
  40497. */
  40498. pause(): AnimationGroup;
  40499. /**
  40500. * Play all animations to initial state
  40501. * This function will start() the animations if they were not started or will restart() them if they were paused
  40502. * @param loop defines if animations must loop
  40503. * @returns the animation group
  40504. */
  40505. play(loop?: boolean): AnimationGroup;
  40506. /**
  40507. * Reset all animations to initial state
  40508. * @returns the animation group
  40509. */
  40510. reset(): AnimationGroup;
  40511. /**
  40512. * Restart animations from key 0
  40513. * @returns the animation group
  40514. */
  40515. restart(): AnimationGroup;
  40516. /**
  40517. * Stop all animations
  40518. * @returns the animation group
  40519. */
  40520. stop(): AnimationGroup;
  40521. /**
  40522. * Set animation weight for all animatables
  40523. * @param weight defines the weight to use
  40524. * @return the animationGroup
  40525. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  40526. */
  40527. setWeightForAllAnimatables(weight: number): AnimationGroup;
  40528. /**
  40529. * Synchronize and normalize all animatables with a source animatable
  40530. * @param root defines the root animatable to synchronize with
  40531. * @return the animationGroup
  40532. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  40533. */
  40534. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  40535. /**
  40536. * Goes to a specific frame in this animation group
  40537. * @param frame the frame number to go to
  40538. * @return the animationGroup
  40539. */
  40540. goToFrame(frame: number): AnimationGroup;
  40541. /**
  40542. * Dispose all associated resources
  40543. */
  40544. dispose(): void;
  40545. private _checkAnimationGroupEnded;
  40546. /**
  40547. * Clone the current animation group and returns a copy
  40548. * @param newName defines the name of the new group
  40549. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  40550. * @returns the new aniamtion group
  40551. */
  40552. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  40553. /**
  40554. * Serializes the animationGroup to an object
  40555. * @returns Serialized object
  40556. */
  40557. serialize(): any;
  40558. /**
  40559. * Returns a new AnimationGroup object parsed from the source provided.
  40560. * @param parsedAnimationGroup defines the source
  40561. * @param scene defines the scene that will receive the animationGroup
  40562. * @returns a new AnimationGroup
  40563. */
  40564. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  40565. /**
  40566. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  40567. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  40568. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  40569. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  40570. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  40571. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  40572. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  40573. */
  40574. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  40575. /**
  40576. * Returns the string "AnimationGroup"
  40577. * @returns "AnimationGroup"
  40578. */
  40579. getClassName(): string;
  40580. /**
  40581. * Creates a detailled string about the object
  40582. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  40583. * @returns a string representing the object
  40584. */
  40585. toString(fullDetails?: boolean): string;
  40586. }
  40587. }
  40588. declare module "babylonjs/scene" {
  40589. import { Nullable } from "babylonjs/types";
  40590. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  40591. import { Observable } from "babylonjs/Misc/observable";
  40592. import { SmartArrayNoDuplicate, SmartArray, ISmartArrayLike } from "babylonjs/Misc/smartArray";
  40593. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  40594. import { Geometry } from "babylonjs/Meshes/geometry";
  40595. import { TransformNode } from "babylonjs/Meshes/transformNode";
  40596. import { SubMesh } from "babylonjs/Meshes/subMesh";
  40597. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40598. import { Mesh } from "babylonjs/Meshes/mesh";
  40599. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  40600. import { Bone } from "babylonjs/Bones/bone";
  40601. import { Skeleton } from "babylonjs/Bones/skeleton";
  40602. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  40603. import { Camera } from "babylonjs/Cameras/camera";
  40604. import { AbstractScene } from "babylonjs/abstractScene";
  40605. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  40606. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  40607. import { Material } from "babylonjs/Materials/material";
  40608. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  40609. import { Effect } from "babylonjs/Materials/effect";
  40610. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  40611. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  40612. import { Light } from "babylonjs/Lights/light";
  40613. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  40614. import { ICollisionCoordinator } from "babylonjs/Collisions/collisionCoordinator";
  40615. import { PointerEventTypes, PointerInfoPre, PointerInfo } from "babylonjs/Events/pointerEvents";
  40616. import { KeyboardInfoPre, KeyboardInfo } from "babylonjs/Events/keyboardEvents";
  40617. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  40618. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  40619. import { RenderingGroupInfo, IRenderingManagerAutoClearSetup } from "babylonjs/Rendering/renderingManager";
  40620. import { ISceneComponent, ISceneSerializableComponent, Stage, SimpleStageAction, RenderTargetsStageAction, RenderTargetStageAction, MeshStageAction, EvaluateSubMeshStageAction, ActiveMeshStageAction, CameraStageAction, RenderingGroupStageAction, RenderingMeshStageAction, PointerMoveStageAction, PointerUpDownStageAction, CameraStageFrameBufferAction } from "babylonjs/sceneComponent";
  40621. import { Engine } from "babylonjs/Engines/engine";
  40622. import { Node } from "babylonjs/node";
  40623. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  40624. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  40625. import { WebRequest } from "babylonjs/Misc/webRequest";
  40626. import { InputManager } from "babylonjs/Inputs/scene.inputManager";
  40627. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  40628. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  40629. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  40630. import { Plane } from "babylonjs/Maths/math.plane";
  40631. import { LoadFileError, RequestFileError, ReadFileError } from "babylonjs/Misc/fileTools";
  40632. import { IClipPlanesHolder } from "babylonjs/Misc/interfaces/iClipPlanesHolder";
  40633. import { Ray } from "babylonjs/Culling/ray";
  40634. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  40635. import { Animation } from "babylonjs/Animations/animation";
  40636. import { Animatable } from "babylonjs/Animations/animatable";
  40637. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  40638. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  40639. import { Collider } from "babylonjs/Collisions/collider";
  40640. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  40641. /**
  40642. * Define an interface for all classes that will hold resources
  40643. */
  40644. export interface IDisposable {
  40645. /**
  40646. * Releases all held resources
  40647. */
  40648. dispose(): void;
  40649. }
  40650. /** Interface defining initialization parameters for Scene class */
  40651. export interface SceneOptions {
  40652. /**
  40653. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  40654. * It will improve performance when the number of geometries becomes important.
  40655. */
  40656. useGeometryUniqueIdsMap?: boolean;
  40657. /**
  40658. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  40659. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  40660. */
  40661. useMaterialMeshMap?: boolean;
  40662. /**
  40663. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  40664. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  40665. */
  40666. useClonedMeshMap?: boolean;
  40667. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  40668. virtual?: boolean;
  40669. }
  40670. /**
  40671. * Represents a scene to be rendered by the engine.
  40672. * @see https://doc.babylonjs.com/features/scene
  40673. */
  40674. export class Scene extends AbstractScene implements IAnimatable, IClipPlanesHolder {
  40675. /** The fog is deactivated */
  40676. static readonly FOGMODE_NONE: number;
  40677. /** The fog density is following an exponential function */
  40678. static readonly FOGMODE_EXP: number;
  40679. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  40680. static readonly FOGMODE_EXP2: number;
  40681. /** The fog density is following a linear function. */
  40682. static readonly FOGMODE_LINEAR: number;
  40683. /**
  40684. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  40685. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40686. */
  40687. static MinDeltaTime: number;
  40688. /**
  40689. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  40690. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40691. */
  40692. static MaxDeltaTime: number;
  40693. /**
  40694. * Factory used to create the default material.
  40695. * @param name The name of the material to create
  40696. * @param scene The scene to create the material for
  40697. * @returns The default material
  40698. */
  40699. static DefaultMaterialFactory(scene: Scene): Material;
  40700. /**
  40701. * Factory used to create the a collision coordinator.
  40702. * @returns The collision coordinator
  40703. */
  40704. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  40705. /** @hidden */
  40706. _inputManager: InputManager;
  40707. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  40708. cameraToUseForPointers: Nullable<Camera>;
  40709. /** @hidden */
  40710. readonly _isScene: boolean;
  40711. /** @hidden */
  40712. _blockEntityCollection: boolean;
  40713. /**
  40714. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  40715. */
  40716. autoClear: boolean;
  40717. /**
  40718. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  40719. */
  40720. autoClearDepthAndStencil: boolean;
  40721. /**
  40722. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  40723. */
  40724. clearColor: Color4;
  40725. /**
  40726. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  40727. */
  40728. ambientColor: Color3;
  40729. /**
  40730. * This is use to store the default BRDF lookup for PBR materials in your scene.
  40731. * It should only be one of the following (if not the default embedded one):
  40732. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  40733. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  40734. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  40735. * The material properties need to be setup according to the type of texture in use.
  40736. */
  40737. environmentBRDFTexture: BaseTexture;
  40738. /**
  40739. * Texture used in all pbr material as the reflection texture.
  40740. * As in the majority of the scene they are the same (exception for multi room and so on),
  40741. * this is easier to reference from here than from all the materials.
  40742. */
  40743. get environmentTexture(): Nullable<BaseTexture>;
  40744. /**
  40745. * Texture used in all pbr material as the reflection texture.
  40746. * As in the majority of the scene they are the same (exception for multi room and so on),
  40747. * this is easier to set here than in all the materials.
  40748. */
  40749. set environmentTexture(value: Nullable<BaseTexture>);
  40750. /** @hidden */
  40751. protected _environmentIntensity: number;
  40752. /**
  40753. * Intensity of the environment in all pbr material.
  40754. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  40755. * As in the majority of the scene they are the same (exception for multi room and so on),
  40756. * this is easier to reference from here than from all the materials.
  40757. */
  40758. get environmentIntensity(): number;
  40759. /**
  40760. * Intensity of the environment in all pbr material.
  40761. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  40762. * As in the majority of the scene they are the same (exception for multi room and so on),
  40763. * this is easier to set here than in all the materials.
  40764. */
  40765. set environmentIntensity(value: number);
  40766. /** @hidden */
  40767. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  40768. /**
  40769. * Default image processing configuration used either in the rendering
  40770. * Forward main pass or through the imageProcessingPostProcess if present.
  40771. * As in the majority of the scene they are the same (exception for multi camera),
  40772. * this is easier to reference from here than from all the materials and post process.
  40773. *
  40774. * No setter as we it is a shared configuration, you can set the values instead.
  40775. */
  40776. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  40777. private _forceWireframe;
  40778. /**
  40779. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  40780. */
  40781. set forceWireframe(value: boolean);
  40782. get forceWireframe(): boolean;
  40783. private _skipFrustumClipping;
  40784. /**
  40785. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  40786. */
  40787. set skipFrustumClipping(value: boolean);
  40788. get skipFrustumClipping(): boolean;
  40789. private _forcePointsCloud;
  40790. /**
  40791. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  40792. */
  40793. set forcePointsCloud(value: boolean);
  40794. get forcePointsCloud(): boolean;
  40795. /**
  40796. * Gets or sets the active clipplane 1
  40797. */
  40798. clipPlane: Nullable<Plane>;
  40799. /**
  40800. * Gets or sets the active clipplane 2
  40801. */
  40802. clipPlane2: Nullable<Plane>;
  40803. /**
  40804. * Gets or sets the active clipplane 3
  40805. */
  40806. clipPlane3: Nullable<Plane>;
  40807. /**
  40808. * Gets or sets the active clipplane 4
  40809. */
  40810. clipPlane4: Nullable<Plane>;
  40811. /**
  40812. * Gets or sets the active clipplane 5
  40813. */
  40814. clipPlane5: Nullable<Plane>;
  40815. /**
  40816. * Gets or sets the active clipplane 6
  40817. */
  40818. clipPlane6: Nullable<Plane>;
  40819. /**
  40820. * Gets or sets a boolean indicating if animations are enabled
  40821. */
  40822. animationsEnabled: boolean;
  40823. private _animationPropertiesOverride;
  40824. /**
  40825. * Gets or sets the animation properties override
  40826. */
  40827. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  40828. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  40829. /**
  40830. * Gets or sets a boolean indicating if a constant deltatime has to be used
  40831. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  40832. */
  40833. useConstantAnimationDeltaTime: boolean;
  40834. /**
  40835. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  40836. * Please note that it requires to run a ray cast through the scene on every frame
  40837. */
  40838. constantlyUpdateMeshUnderPointer: boolean;
  40839. /**
  40840. * Defines the HTML cursor to use when hovering over interactive elements
  40841. */
  40842. hoverCursor: string;
  40843. /**
  40844. * Defines the HTML default cursor to use (empty by default)
  40845. */
  40846. defaultCursor: string;
  40847. /**
  40848. * Defines whether cursors are handled by the scene.
  40849. */
  40850. doNotHandleCursors: boolean;
  40851. /**
  40852. * This is used to call preventDefault() on pointer down
  40853. * in order to block unwanted artifacts like system double clicks
  40854. */
  40855. preventDefaultOnPointerDown: boolean;
  40856. /**
  40857. * This is used to call preventDefault() on pointer up
  40858. * in order to block unwanted artifacts like system double clicks
  40859. */
  40860. preventDefaultOnPointerUp: boolean;
  40861. /**
  40862. * Gets or sets user defined metadata
  40863. */
  40864. metadata: any;
  40865. /**
  40866. * For internal use only. Please do not use.
  40867. */
  40868. reservedDataStore: any;
  40869. /**
  40870. * Gets the name of the plugin used to load this scene (null by default)
  40871. */
  40872. loadingPluginName: string;
  40873. /**
  40874. * Use this array to add regular expressions used to disable offline support for specific urls
  40875. */
  40876. disableOfflineSupportExceptionRules: RegExp[];
  40877. /**
  40878. * An event triggered when the scene is disposed.
  40879. */
  40880. onDisposeObservable: Observable<Scene>;
  40881. private _onDisposeObserver;
  40882. /** Sets a function to be executed when this scene is disposed. */
  40883. set onDispose(callback: () => void);
  40884. /**
  40885. * An event triggered before rendering the scene (right after animations and physics)
  40886. */
  40887. onBeforeRenderObservable: Observable<Scene>;
  40888. private _onBeforeRenderObserver;
  40889. /** Sets a function to be executed before rendering this scene */
  40890. set beforeRender(callback: Nullable<() => void>);
  40891. /**
  40892. * An event triggered after rendering the scene
  40893. */
  40894. onAfterRenderObservable: Observable<Scene>;
  40895. /**
  40896. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  40897. */
  40898. onAfterRenderCameraObservable: Observable<Camera>;
  40899. private _onAfterRenderObserver;
  40900. /** Sets a function to be executed after rendering this scene */
  40901. set afterRender(callback: Nullable<() => void>);
  40902. /**
  40903. * An event triggered before animating the scene
  40904. */
  40905. onBeforeAnimationsObservable: Observable<Scene>;
  40906. /**
  40907. * An event triggered after animations processing
  40908. */
  40909. onAfterAnimationsObservable: Observable<Scene>;
  40910. /**
  40911. * An event triggered before draw calls are ready to be sent
  40912. */
  40913. onBeforeDrawPhaseObservable: Observable<Scene>;
  40914. /**
  40915. * An event triggered after draw calls have been sent
  40916. */
  40917. onAfterDrawPhaseObservable: Observable<Scene>;
  40918. /**
  40919. * An event triggered when the scene is ready
  40920. */
  40921. onReadyObservable: Observable<Scene>;
  40922. /**
  40923. * An event triggered before rendering a camera
  40924. */
  40925. onBeforeCameraRenderObservable: Observable<Camera>;
  40926. private _onBeforeCameraRenderObserver;
  40927. /** Sets a function to be executed before rendering a camera*/
  40928. set beforeCameraRender(callback: () => void);
  40929. /**
  40930. * An event triggered after rendering a camera
  40931. */
  40932. onAfterCameraRenderObservable: Observable<Camera>;
  40933. private _onAfterCameraRenderObserver;
  40934. /** Sets a function to be executed after rendering a camera*/
  40935. set afterCameraRender(callback: () => void);
  40936. /**
  40937. * An event triggered when active meshes evaluation is about to start
  40938. */
  40939. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  40940. /**
  40941. * An event triggered when active meshes evaluation is done
  40942. */
  40943. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  40944. /**
  40945. * An event triggered when particles rendering is about to start
  40946. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  40947. */
  40948. onBeforeParticlesRenderingObservable: Observable<Scene>;
  40949. /**
  40950. * An event triggered when particles rendering is done
  40951. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  40952. */
  40953. onAfterParticlesRenderingObservable: Observable<Scene>;
  40954. /**
  40955. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  40956. */
  40957. onDataLoadedObservable: Observable<Scene>;
  40958. /**
  40959. * An event triggered when a camera is created
  40960. */
  40961. onNewCameraAddedObservable: Observable<Camera>;
  40962. /**
  40963. * An event triggered when a camera is removed
  40964. */
  40965. onCameraRemovedObservable: Observable<Camera>;
  40966. /**
  40967. * An event triggered when a light is created
  40968. */
  40969. onNewLightAddedObservable: Observable<Light>;
  40970. /**
  40971. * An event triggered when a light is removed
  40972. */
  40973. onLightRemovedObservable: Observable<Light>;
  40974. /**
  40975. * An event triggered when a geometry is created
  40976. */
  40977. onNewGeometryAddedObservable: Observable<Geometry>;
  40978. /**
  40979. * An event triggered when a geometry is removed
  40980. */
  40981. onGeometryRemovedObservable: Observable<Geometry>;
  40982. /**
  40983. * An event triggered when a transform node is created
  40984. */
  40985. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  40986. /**
  40987. * An event triggered when a transform node is removed
  40988. */
  40989. onTransformNodeRemovedObservable: Observable<TransformNode>;
  40990. /**
  40991. * An event triggered when a mesh is created
  40992. */
  40993. onNewMeshAddedObservable: Observable<AbstractMesh>;
  40994. /**
  40995. * An event triggered when a mesh is removed
  40996. */
  40997. onMeshRemovedObservable: Observable<AbstractMesh>;
  40998. /**
  40999. * An event triggered when a skeleton is created
  41000. */
  41001. onNewSkeletonAddedObservable: Observable<Skeleton>;
  41002. /**
  41003. * An event triggered when a skeleton is removed
  41004. */
  41005. onSkeletonRemovedObservable: Observable<Skeleton>;
  41006. /**
  41007. * An event triggered when a material is created
  41008. */
  41009. onNewMaterialAddedObservable: Observable<Material>;
  41010. /**
  41011. * An event triggered when a material is removed
  41012. */
  41013. onMaterialRemovedObservable: Observable<Material>;
  41014. /**
  41015. * An event triggered when a texture is created
  41016. */
  41017. onNewTextureAddedObservable: Observable<BaseTexture>;
  41018. /**
  41019. * An event triggered when a texture is removed
  41020. */
  41021. onTextureRemovedObservable: Observable<BaseTexture>;
  41022. /**
  41023. * An event triggered when render targets are about to be rendered
  41024. * Can happen multiple times per frame.
  41025. */
  41026. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  41027. /**
  41028. * An event triggered when render targets were rendered.
  41029. * Can happen multiple times per frame.
  41030. */
  41031. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  41032. /**
  41033. * An event triggered before calculating deterministic simulation step
  41034. */
  41035. onBeforeStepObservable: Observable<Scene>;
  41036. /**
  41037. * An event triggered after calculating deterministic simulation step
  41038. */
  41039. onAfterStepObservable: Observable<Scene>;
  41040. /**
  41041. * An event triggered when the activeCamera property is updated
  41042. */
  41043. onActiveCameraChanged: Observable<Scene>;
  41044. /**
  41045. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  41046. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  41047. * 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)
  41048. */
  41049. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  41050. /**
  41051. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  41052. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  41053. * 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)
  41054. */
  41055. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  41056. /**
  41057. * This Observable will when a mesh has been imported into the scene.
  41058. */
  41059. onMeshImportedObservable: Observable<AbstractMesh>;
  41060. /**
  41061. * This Observable will when an animation file has been imported into the scene.
  41062. */
  41063. onAnimationFileImportedObservable: Observable<Scene>;
  41064. /**
  41065. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  41066. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  41067. */
  41068. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  41069. /** @hidden */
  41070. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  41071. /**
  41072. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  41073. */
  41074. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  41075. /**
  41076. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  41077. */
  41078. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  41079. /**
  41080. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  41081. */
  41082. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  41083. /** Callback called when a pointer move is detected */
  41084. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  41085. /** Callback called when a pointer down is detected */
  41086. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  41087. /** Callback called when a pointer up is detected */
  41088. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  41089. /** Callback called when a pointer pick is detected */
  41090. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  41091. /**
  41092. * 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).
  41093. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  41094. */
  41095. onPrePointerObservable: Observable<PointerInfoPre>;
  41096. /**
  41097. * Observable event triggered each time an input event is received from the rendering canvas
  41098. */
  41099. onPointerObservable: Observable<PointerInfo>;
  41100. /**
  41101. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  41102. */
  41103. get unTranslatedPointer(): Vector2;
  41104. /**
  41105. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  41106. */
  41107. static get DragMovementThreshold(): number;
  41108. static set DragMovementThreshold(value: number);
  41109. /**
  41110. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  41111. */
  41112. static get LongPressDelay(): number;
  41113. static set LongPressDelay(value: number);
  41114. /**
  41115. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  41116. */
  41117. static get DoubleClickDelay(): number;
  41118. static set DoubleClickDelay(value: number);
  41119. /** If you need to check double click without raising a single click at first click, enable this flag */
  41120. static get ExclusiveDoubleClickMode(): boolean;
  41121. static set ExclusiveDoubleClickMode(value: boolean);
  41122. /** @hidden */
  41123. _mirroredCameraPosition: Nullable<Vector3>;
  41124. /**
  41125. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  41126. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  41127. */
  41128. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  41129. /**
  41130. * Observable event triggered each time an keyboard event is received from the hosting window
  41131. */
  41132. onKeyboardObservable: Observable<KeyboardInfo>;
  41133. private _useRightHandedSystem;
  41134. /**
  41135. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  41136. */
  41137. set useRightHandedSystem(value: boolean);
  41138. get useRightHandedSystem(): boolean;
  41139. private _timeAccumulator;
  41140. private _currentStepId;
  41141. private _currentInternalStep;
  41142. /**
  41143. * Sets the step Id used by deterministic lock step
  41144. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41145. * @param newStepId defines the step Id
  41146. */
  41147. setStepId(newStepId: number): void;
  41148. /**
  41149. * Gets the step Id used by deterministic lock step
  41150. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41151. * @returns the step Id
  41152. */
  41153. getStepId(): number;
  41154. /**
  41155. * Gets the internal step used by deterministic lock step
  41156. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41157. * @returns the internal step
  41158. */
  41159. getInternalStep(): number;
  41160. private _fogEnabled;
  41161. /**
  41162. * Gets or sets a boolean indicating if fog is enabled on this scene
  41163. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41164. * (Default is true)
  41165. */
  41166. set fogEnabled(value: boolean);
  41167. get fogEnabled(): boolean;
  41168. private _fogMode;
  41169. /**
  41170. * Gets or sets the fog mode to use
  41171. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41172. * | mode | value |
  41173. * | --- | --- |
  41174. * | FOGMODE_NONE | 0 |
  41175. * | FOGMODE_EXP | 1 |
  41176. * | FOGMODE_EXP2 | 2 |
  41177. * | FOGMODE_LINEAR | 3 |
  41178. */
  41179. set fogMode(value: number);
  41180. get fogMode(): number;
  41181. /**
  41182. * Gets or sets the fog color to use
  41183. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41184. * (Default is Color3(0.2, 0.2, 0.3))
  41185. */
  41186. fogColor: Color3;
  41187. /**
  41188. * Gets or sets the fog density to use
  41189. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41190. * (Default is 0.1)
  41191. */
  41192. fogDensity: number;
  41193. /**
  41194. * Gets or sets the fog start distance to use
  41195. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41196. * (Default is 0)
  41197. */
  41198. fogStart: number;
  41199. /**
  41200. * Gets or sets the fog end distance to use
  41201. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41202. * (Default is 1000)
  41203. */
  41204. fogEnd: number;
  41205. /**
  41206. * Flag indicating that the frame buffer binding is handled by another component
  41207. */
  41208. prePass: boolean;
  41209. private _shadowsEnabled;
  41210. /**
  41211. * Gets or sets a boolean indicating if shadows are enabled on this scene
  41212. */
  41213. set shadowsEnabled(value: boolean);
  41214. get shadowsEnabled(): boolean;
  41215. private _lightsEnabled;
  41216. /**
  41217. * Gets or sets a boolean indicating if lights are enabled on this scene
  41218. */
  41219. set lightsEnabled(value: boolean);
  41220. get lightsEnabled(): boolean;
  41221. /** All of the active cameras added to this scene. */
  41222. activeCameras: Camera[];
  41223. /** @hidden */
  41224. _activeCamera: Nullable<Camera>;
  41225. /** Gets or sets the current active camera */
  41226. get activeCamera(): Nullable<Camera>;
  41227. set activeCamera(value: Nullable<Camera>);
  41228. private _defaultMaterial;
  41229. /** The default material used on meshes when no material is affected */
  41230. get defaultMaterial(): Material;
  41231. /** The default material used on meshes when no material is affected */
  41232. set defaultMaterial(value: Material);
  41233. private _texturesEnabled;
  41234. /**
  41235. * Gets or sets a boolean indicating if textures are enabled on this scene
  41236. */
  41237. set texturesEnabled(value: boolean);
  41238. get texturesEnabled(): boolean;
  41239. /**
  41240. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  41241. */
  41242. physicsEnabled: boolean;
  41243. /**
  41244. * Gets or sets a boolean indicating if particles are enabled on this scene
  41245. */
  41246. particlesEnabled: boolean;
  41247. /**
  41248. * Gets or sets a boolean indicating if sprites are enabled on this scene
  41249. */
  41250. spritesEnabled: boolean;
  41251. private _skeletonsEnabled;
  41252. /**
  41253. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  41254. */
  41255. set skeletonsEnabled(value: boolean);
  41256. get skeletonsEnabled(): boolean;
  41257. /**
  41258. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  41259. */
  41260. lensFlaresEnabled: boolean;
  41261. /**
  41262. * Gets or sets a boolean indicating if collisions are enabled on this scene
  41263. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  41264. */
  41265. collisionsEnabled: boolean;
  41266. private _collisionCoordinator;
  41267. /** @hidden */
  41268. get collisionCoordinator(): ICollisionCoordinator;
  41269. /**
  41270. * Defines the gravity applied to this scene (used only for collisions)
  41271. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  41272. */
  41273. gravity: Vector3;
  41274. /**
  41275. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  41276. */
  41277. postProcessesEnabled: boolean;
  41278. /**
  41279. * Gets the current postprocess manager
  41280. */
  41281. postProcessManager: PostProcessManager;
  41282. /**
  41283. * Gets or sets a boolean indicating if render targets are enabled on this scene
  41284. */
  41285. renderTargetsEnabled: boolean;
  41286. /**
  41287. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  41288. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  41289. */
  41290. dumpNextRenderTargets: boolean;
  41291. /**
  41292. * The list of user defined render targets added to the scene
  41293. */
  41294. customRenderTargets: RenderTargetTexture[];
  41295. /**
  41296. * Defines if texture loading must be delayed
  41297. * If true, textures will only be loaded when they need to be rendered
  41298. */
  41299. useDelayedTextureLoading: boolean;
  41300. /**
  41301. * Gets the list of meshes imported to the scene through SceneLoader
  41302. */
  41303. importedMeshesFiles: String[];
  41304. /**
  41305. * Gets or sets a boolean indicating if probes are enabled on this scene
  41306. */
  41307. probesEnabled: boolean;
  41308. /**
  41309. * Gets or sets the current offline provider to use to store scene data
  41310. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  41311. */
  41312. offlineProvider: IOfflineProvider;
  41313. /**
  41314. * Gets or sets the action manager associated with the scene
  41315. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  41316. */
  41317. actionManager: AbstractActionManager;
  41318. private _meshesForIntersections;
  41319. /**
  41320. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  41321. */
  41322. proceduralTexturesEnabled: boolean;
  41323. private _engine;
  41324. private _totalVertices;
  41325. /** @hidden */
  41326. _activeIndices: PerfCounter;
  41327. /** @hidden */
  41328. _activeParticles: PerfCounter;
  41329. /** @hidden */
  41330. _activeBones: PerfCounter;
  41331. private _animationRatio;
  41332. /** @hidden */
  41333. _animationTimeLast: number;
  41334. /** @hidden */
  41335. _animationTime: number;
  41336. /**
  41337. * Gets or sets a general scale for animation speed
  41338. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  41339. */
  41340. animationTimeScale: number;
  41341. /** @hidden */
  41342. _cachedMaterial: Nullable<Material>;
  41343. /** @hidden */
  41344. _cachedEffect: Nullable<Effect>;
  41345. /** @hidden */
  41346. _cachedVisibility: Nullable<number>;
  41347. private _renderId;
  41348. private _frameId;
  41349. private _executeWhenReadyTimeoutId;
  41350. private _intermediateRendering;
  41351. private _viewUpdateFlag;
  41352. private _projectionUpdateFlag;
  41353. /** @hidden */
  41354. _toBeDisposed: Nullable<IDisposable>[];
  41355. private _activeRequests;
  41356. /** @hidden */
  41357. _pendingData: any[];
  41358. private _isDisposed;
  41359. /**
  41360. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  41361. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  41362. */
  41363. dispatchAllSubMeshesOfActiveMeshes: boolean;
  41364. private _activeMeshes;
  41365. private _processedMaterials;
  41366. private _renderTargets;
  41367. /** @hidden */
  41368. _activeParticleSystems: SmartArray<IParticleSystem>;
  41369. private _activeSkeletons;
  41370. private _softwareSkinnedMeshes;
  41371. private _renderingManager;
  41372. /** @hidden */
  41373. _activeAnimatables: import("babylonjs/Animations/animatable").Animatable[];
  41374. private _transformMatrix;
  41375. private _sceneUbo;
  41376. /** @hidden */
  41377. _viewMatrix: Matrix;
  41378. private _projectionMatrix;
  41379. /** @hidden */
  41380. _forcedViewPosition: Nullable<Vector3>;
  41381. /** @hidden */
  41382. _frustumPlanes: Plane[];
  41383. /**
  41384. * Gets the list of frustum planes (built from the active camera)
  41385. */
  41386. get frustumPlanes(): Plane[];
  41387. /**
  41388. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  41389. * This is useful if there are more lights that the maximum simulteanous authorized
  41390. */
  41391. requireLightSorting: boolean;
  41392. /** @hidden */
  41393. readonly useMaterialMeshMap: boolean;
  41394. /** @hidden */
  41395. readonly useClonedMeshMap: boolean;
  41396. private _externalData;
  41397. private _uid;
  41398. /**
  41399. * @hidden
  41400. * Backing store of defined scene components.
  41401. */
  41402. _components: ISceneComponent[];
  41403. /**
  41404. * @hidden
  41405. * Backing store of defined scene components.
  41406. */
  41407. _serializableComponents: ISceneSerializableComponent[];
  41408. /**
  41409. * List of components to register on the next registration step.
  41410. */
  41411. private _transientComponents;
  41412. /**
  41413. * Registers the transient components if needed.
  41414. */
  41415. private _registerTransientComponents;
  41416. /**
  41417. * @hidden
  41418. * Add a component to the scene.
  41419. * Note that the ccomponent could be registered on th next frame if this is called after
  41420. * the register component stage.
  41421. * @param component Defines the component to add to the scene
  41422. */
  41423. _addComponent(component: ISceneComponent): void;
  41424. /**
  41425. * @hidden
  41426. * Gets a component from the scene.
  41427. * @param name defines the name of the component to retrieve
  41428. * @returns the component or null if not present
  41429. */
  41430. _getComponent(name: string): Nullable<ISceneComponent>;
  41431. /**
  41432. * @hidden
  41433. * Defines the actions happening before camera updates.
  41434. */
  41435. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  41436. /**
  41437. * @hidden
  41438. * Defines the actions happening before clear the canvas.
  41439. */
  41440. _beforeClearStage: Stage<SimpleStageAction>;
  41441. /**
  41442. * @hidden
  41443. * Defines the actions when collecting render targets for the frame.
  41444. */
  41445. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  41446. /**
  41447. * @hidden
  41448. * Defines the actions happening for one camera in the frame.
  41449. */
  41450. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  41451. /**
  41452. * @hidden
  41453. * Defines the actions happening during the per mesh ready checks.
  41454. */
  41455. _isReadyForMeshStage: Stage<MeshStageAction>;
  41456. /**
  41457. * @hidden
  41458. * Defines the actions happening before evaluate active mesh checks.
  41459. */
  41460. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  41461. /**
  41462. * @hidden
  41463. * Defines the actions happening during the evaluate sub mesh checks.
  41464. */
  41465. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  41466. /**
  41467. * @hidden
  41468. * Defines the actions happening during the active mesh stage.
  41469. */
  41470. _activeMeshStage: Stage<ActiveMeshStageAction>;
  41471. /**
  41472. * @hidden
  41473. * Defines the actions happening during the per camera render target step.
  41474. */
  41475. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  41476. /**
  41477. * @hidden
  41478. * Defines the actions happening just before the active camera is drawing.
  41479. */
  41480. _beforeCameraDrawStage: Stage<CameraStageAction>;
  41481. /**
  41482. * @hidden
  41483. * Defines the actions happening just before a render target is drawing.
  41484. */
  41485. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  41486. /**
  41487. * @hidden
  41488. * Defines the actions happening just before a rendering group is drawing.
  41489. */
  41490. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  41491. /**
  41492. * @hidden
  41493. * Defines the actions happening just before a mesh is drawing.
  41494. */
  41495. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  41496. /**
  41497. * @hidden
  41498. * Defines the actions happening just after a mesh has been drawn.
  41499. */
  41500. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  41501. /**
  41502. * @hidden
  41503. * Defines the actions happening just after a rendering group has been drawn.
  41504. */
  41505. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  41506. /**
  41507. * @hidden
  41508. * Defines the actions happening just after the active camera has been drawn.
  41509. */
  41510. _afterCameraDrawStage: Stage<CameraStageAction>;
  41511. /**
  41512. * @hidden
  41513. * Defines the actions happening just after a render target has been drawn.
  41514. */
  41515. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  41516. /**
  41517. * @hidden
  41518. * Defines the actions happening just after rendering all cameras and computing intersections.
  41519. */
  41520. _afterRenderStage: Stage<SimpleStageAction>;
  41521. /**
  41522. * @hidden
  41523. * Defines the actions happening when a pointer move event happens.
  41524. */
  41525. _pointerMoveStage: Stage<PointerMoveStageAction>;
  41526. /**
  41527. * @hidden
  41528. * Defines the actions happening when a pointer down event happens.
  41529. */
  41530. _pointerDownStage: Stage<PointerUpDownStageAction>;
  41531. /**
  41532. * @hidden
  41533. * Defines the actions happening when a pointer up event happens.
  41534. */
  41535. _pointerUpStage: Stage<PointerUpDownStageAction>;
  41536. /**
  41537. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  41538. */
  41539. private geometriesByUniqueId;
  41540. /**
  41541. * Creates a new Scene
  41542. * @param engine defines the engine to use to render this scene
  41543. * @param options defines the scene options
  41544. */
  41545. constructor(engine: Engine, options?: SceneOptions);
  41546. /**
  41547. * Gets a string identifying the name of the class
  41548. * @returns "Scene" string
  41549. */
  41550. getClassName(): string;
  41551. private _defaultMeshCandidates;
  41552. /**
  41553. * @hidden
  41554. */
  41555. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  41556. private _defaultSubMeshCandidates;
  41557. /**
  41558. * @hidden
  41559. */
  41560. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  41561. /**
  41562. * Sets the default candidate providers for the scene.
  41563. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  41564. * and getCollidingSubMeshCandidates to their default function
  41565. */
  41566. setDefaultCandidateProviders(): void;
  41567. /**
  41568. * Gets the mesh that is currently under the pointer
  41569. */
  41570. get meshUnderPointer(): Nullable<AbstractMesh>;
  41571. /**
  41572. * Gets or sets the current on-screen X position of the pointer
  41573. */
  41574. get pointerX(): number;
  41575. set pointerX(value: number);
  41576. /**
  41577. * Gets or sets the current on-screen Y position of the pointer
  41578. */
  41579. get pointerY(): number;
  41580. set pointerY(value: number);
  41581. /**
  41582. * Gets the cached material (ie. the latest rendered one)
  41583. * @returns the cached material
  41584. */
  41585. getCachedMaterial(): Nullable<Material>;
  41586. /**
  41587. * Gets the cached effect (ie. the latest rendered one)
  41588. * @returns the cached effect
  41589. */
  41590. getCachedEffect(): Nullable<Effect>;
  41591. /**
  41592. * Gets the cached visibility state (ie. the latest rendered one)
  41593. * @returns the cached visibility state
  41594. */
  41595. getCachedVisibility(): Nullable<number>;
  41596. /**
  41597. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  41598. * @param material defines the current material
  41599. * @param effect defines the current effect
  41600. * @param visibility defines the current visibility state
  41601. * @returns true if one parameter is not cached
  41602. */
  41603. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  41604. /**
  41605. * Gets the engine associated with the scene
  41606. * @returns an Engine
  41607. */
  41608. getEngine(): Engine;
  41609. /**
  41610. * Gets the total number of vertices rendered per frame
  41611. * @returns the total number of vertices rendered per frame
  41612. */
  41613. getTotalVertices(): number;
  41614. /**
  41615. * Gets the performance counter for total vertices
  41616. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41617. */
  41618. get totalVerticesPerfCounter(): PerfCounter;
  41619. /**
  41620. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  41621. * @returns the total number of active indices rendered per frame
  41622. */
  41623. getActiveIndices(): number;
  41624. /**
  41625. * Gets the performance counter for active indices
  41626. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41627. */
  41628. get totalActiveIndicesPerfCounter(): PerfCounter;
  41629. /**
  41630. * Gets the total number of active particles rendered per frame
  41631. * @returns the total number of active particles rendered per frame
  41632. */
  41633. getActiveParticles(): number;
  41634. /**
  41635. * Gets the performance counter for active particles
  41636. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41637. */
  41638. get activeParticlesPerfCounter(): PerfCounter;
  41639. /**
  41640. * Gets the total number of active bones rendered per frame
  41641. * @returns the total number of active bones rendered per frame
  41642. */
  41643. getActiveBones(): number;
  41644. /**
  41645. * Gets the performance counter for active bones
  41646. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41647. */
  41648. get activeBonesPerfCounter(): PerfCounter;
  41649. /**
  41650. * Gets the array of active meshes
  41651. * @returns an array of AbstractMesh
  41652. */
  41653. getActiveMeshes(): SmartArray<AbstractMesh>;
  41654. /**
  41655. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  41656. * @returns a number
  41657. */
  41658. getAnimationRatio(): number;
  41659. /**
  41660. * Gets an unique Id for the current render phase
  41661. * @returns a number
  41662. */
  41663. getRenderId(): number;
  41664. /**
  41665. * Gets an unique Id for the current frame
  41666. * @returns a number
  41667. */
  41668. getFrameId(): number;
  41669. /** Call this function if you want to manually increment the render Id*/
  41670. incrementRenderId(): void;
  41671. private _createUbo;
  41672. /**
  41673. * Use this method to simulate a pointer move on a mesh
  41674. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41675. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41676. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41677. * @returns the current scene
  41678. */
  41679. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  41680. /**
  41681. * Use this method to simulate a pointer down on a mesh
  41682. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41683. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41684. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41685. * @returns the current scene
  41686. */
  41687. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  41688. /**
  41689. * Use this method to simulate a pointer up on a mesh
  41690. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41691. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41692. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41693. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  41694. * @returns the current scene
  41695. */
  41696. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  41697. /**
  41698. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  41699. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  41700. * @returns true if the pointer was captured
  41701. */
  41702. isPointerCaptured(pointerId?: number): boolean;
  41703. /**
  41704. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  41705. * @param attachUp defines if you want to attach events to pointerup
  41706. * @param attachDown defines if you want to attach events to pointerdown
  41707. * @param attachMove defines if you want to attach events to pointermove
  41708. */
  41709. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  41710. /** Detaches all event handlers*/
  41711. detachControl(): void;
  41712. /**
  41713. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  41714. * Delay loaded resources are not taking in account
  41715. * @return true if all required resources are ready
  41716. */
  41717. isReady(): boolean;
  41718. /** Resets all cached information relative to material (including effect and visibility) */
  41719. resetCachedMaterial(): void;
  41720. /**
  41721. * Registers a function to be called before every frame render
  41722. * @param func defines the function to register
  41723. */
  41724. registerBeforeRender(func: () => void): void;
  41725. /**
  41726. * Unregisters a function called before every frame render
  41727. * @param func defines the function to unregister
  41728. */
  41729. unregisterBeforeRender(func: () => void): void;
  41730. /**
  41731. * Registers a function to be called after every frame render
  41732. * @param func defines the function to register
  41733. */
  41734. registerAfterRender(func: () => void): void;
  41735. /**
  41736. * Unregisters a function called after every frame render
  41737. * @param func defines the function to unregister
  41738. */
  41739. unregisterAfterRender(func: () => void): void;
  41740. private _executeOnceBeforeRender;
  41741. /**
  41742. * The provided function will run before render once and will be disposed afterwards.
  41743. * A timeout delay can be provided so that the function will be executed in N ms.
  41744. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  41745. * @param func The function to be executed.
  41746. * @param timeout optional delay in ms
  41747. */
  41748. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  41749. /** @hidden */
  41750. _addPendingData(data: any): void;
  41751. /** @hidden */
  41752. _removePendingData(data: any): void;
  41753. /**
  41754. * Returns the number of items waiting to be loaded
  41755. * @returns the number of items waiting to be loaded
  41756. */
  41757. getWaitingItemsCount(): number;
  41758. /**
  41759. * Returns a boolean indicating if the scene is still loading data
  41760. */
  41761. get isLoading(): boolean;
  41762. /**
  41763. * Registers a function to be executed when the scene is ready
  41764. * @param {Function} func - the function to be executed
  41765. */
  41766. executeWhenReady(func: () => void): void;
  41767. /**
  41768. * Returns a promise that resolves when the scene is ready
  41769. * @returns A promise that resolves when the scene is ready
  41770. */
  41771. whenReadyAsync(): Promise<void>;
  41772. /** @hidden */
  41773. _checkIsReady(): void;
  41774. /**
  41775. * Gets all animatable attached to the scene
  41776. */
  41777. get animatables(): Animatable[];
  41778. /**
  41779. * Resets the last animation time frame.
  41780. * Useful to override when animations start running when loading a scene for the first time.
  41781. */
  41782. resetLastAnimationTimeFrame(): void;
  41783. /**
  41784. * Gets the current view matrix
  41785. * @returns a Matrix
  41786. */
  41787. getViewMatrix(): Matrix;
  41788. /**
  41789. * Gets the current projection matrix
  41790. * @returns a Matrix
  41791. */
  41792. getProjectionMatrix(): Matrix;
  41793. /**
  41794. * Gets the current transform matrix
  41795. * @returns a Matrix made of View * Projection
  41796. */
  41797. getTransformMatrix(): Matrix;
  41798. /**
  41799. * Sets the current transform matrix
  41800. * @param viewL defines the View matrix to use
  41801. * @param projectionL defines the Projection matrix to use
  41802. * @param viewR defines the right View matrix to use (if provided)
  41803. * @param projectionR defines the right Projection matrix to use (if provided)
  41804. */
  41805. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  41806. /**
  41807. * Gets the uniform buffer used to store scene data
  41808. * @returns a UniformBuffer
  41809. */
  41810. getSceneUniformBuffer(): UniformBuffer;
  41811. /**
  41812. * Gets an unique (relatively to the current scene) Id
  41813. * @returns an unique number for the scene
  41814. */
  41815. getUniqueId(): number;
  41816. /**
  41817. * Add a mesh to the list of scene's meshes
  41818. * @param newMesh defines the mesh to add
  41819. * @param recursive if all child meshes should also be added to the scene
  41820. */
  41821. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  41822. /**
  41823. * Remove a mesh for the list of scene's meshes
  41824. * @param toRemove defines the mesh to remove
  41825. * @param recursive if all child meshes should also be removed from the scene
  41826. * @returns the index where the mesh was in the mesh list
  41827. */
  41828. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  41829. /**
  41830. * Add a transform node to the list of scene's transform nodes
  41831. * @param newTransformNode defines the transform node to add
  41832. */
  41833. addTransformNode(newTransformNode: TransformNode): void;
  41834. /**
  41835. * Remove a transform node for the list of scene's transform nodes
  41836. * @param toRemove defines the transform node to remove
  41837. * @returns the index where the transform node was in the transform node list
  41838. */
  41839. removeTransformNode(toRemove: TransformNode): number;
  41840. /**
  41841. * Remove a skeleton for the list of scene's skeletons
  41842. * @param toRemove defines the skeleton to remove
  41843. * @returns the index where the skeleton was in the skeleton list
  41844. */
  41845. removeSkeleton(toRemove: Skeleton): number;
  41846. /**
  41847. * Remove a morph target for the list of scene's morph targets
  41848. * @param toRemove defines the morph target to remove
  41849. * @returns the index where the morph target was in the morph target list
  41850. */
  41851. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  41852. /**
  41853. * Remove a light for the list of scene's lights
  41854. * @param toRemove defines the light to remove
  41855. * @returns the index where the light was in the light list
  41856. */
  41857. removeLight(toRemove: Light): number;
  41858. /**
  41859. * Remove a camera for the list of scene's cameras
  41860. * @param toRemove defines the camera to remove
  41861. * @returns the index where the camera was in the camera list
  41862. */
  41863. removeCamera(toRemove: Camera): number;
  41864. /**
  41865. * Remove a particle system for the list of scene's particle systems
  41866. * @param toRemove defines the particle system to remove
  41867. * @returns the index where the particle system was in the particle system list
  41868. */
  41869. removeParticleSystem(toRemove: IParticleSystem): number;
  41870. /**
  41871. * Remove a animation for the list of scene's animations
  41872. * @param toRemove defines the animation to remove
  41873. * @returns the index where the animation was in the animation list
  41874. */
  41875. removeAnimation(toRemove: Animation): number;
  41876. /**
  41877. * Will stop the animation of the given target
  41878. * @param target - the target
  41879. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  41880. * @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)
  41881. */
  41882. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  41883. /**
  41884. * Removes the given animation group from this scene.
  41885. * @param toRemove The animation group to remove
  41886. * @returns The index of the removed animation group
  41887. */
  41888. removeAnimationGroup(toRemove: AnimationGroup): number;
  41889. /**
  41890. * Removes the given multi-material from this scene.
  41891. * @param toRemove The multi-material to remove
  41892. * @returns The index of the removed multi-material
  41893. */
  41894. removeMultiMaterial(toRemove: MultiMaterial): number;
  41895. /**
  41896. * Removes the given material from this scene.
  41897. * @param toRemove The material to remove
  41898. * @returns The index of the removed material
  41899. */
  41900. removeMaterial(toRemove: Material): number;
  41901. /**
  41902. * Removes the given action manager from this scene.
  41903. * @param toRemove The action manager to remove
  41904. * @returns The index of the removed action manager
  41905. */
  41906. removeActionManager(toRemove: AbstractActionManager): number;
  41907. /**
  41908. * Removes the given texture from this scene.
  41909. * @param toRemove The texture to remove
  41910. * @returns The index of the removed texture
  41911. */
  41912. removeTexture(toRemove: BaseTexture): number;
  41913. /**
  41914. * Adds the given light to this scene
  41915. * @param newLight The light to add
  41916. */
  41917. addLight(newLight: Light): void;
  41918. /**
  41919. * Sorts the list list based on light priorities
  41920. */
  41921. sortLightsByPriority(): void;
  41922. /**
  41923. * Adds the given camera to this scene
  41924. * @param newCamera The camera to add
  41925. */
  41926. addCamera(newCamera: Camera): void;
  41927. /**
  41928. * Adds the given skeleton to this scene
  41929. * @param newSkeleton The skeleton to add
  41930. */
  41931. addSkeleton(newSkeleton: Skeleton): void;
  41932. /**
  41933. * Adds the given particle system to this scene
  41934. * @param newParticleSystem The particle system to add
  41935. */
  41936. addParticleSystem(newParticleSystem: IParticleSystem): void;
  41937. /**
  41938. * Adds the given animation to this scene
  41939. * @param newAnimation The animation to add
  41940. */
  41941. addAnimation(newAnimation: Animation): void;
  41942. /**
  41943. * Adds the given animation group to this scene.
  41944. * @param newAnimationGroup The animation group to add
  41945. */
  41946. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  41947. /**
  41948. * Adds the given multi-material to this scene
  41949. * @param newMultiMaterial The multi-material to add
  41950. */
  41951. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  41952. /**
  41953. * Adds the given material to this scene
  41954. * @param newMaterial The material to add
  41955. */
  41956. addMaterial(newMaterial: Material): void;
  41957. /**
  41958. * Adds the given morph target to this scene
  41959. * @param newMorphTargetManager The morph target to add
  41960. */
  41961. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  41962. /**
  41963. * Adds the given geometry to this scene
  41964. * @param newGeometry The geometry to add
  41965. */
  41966. addGeometry(newGeometry: Geometry): void;
  41967. /**
  41968. * Adds the given action manager to this scene
  41969. * @param newActionManager The action manager to add
  41970. */
  41971. addActionManager(newActionManager: AbstractActionManager): void;
  41972. /**
  41973. * Adds the given texture to this scene.
  41974. * @param newTexture The texture to add
  41975. */
  41976. addTexture(newTexture: BaseTexture): void;
  41977. /**
  41978. * Switch active camera
  41979. * @param newCamera defines the new active camera
  41980. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  41981. */
  41982. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  41983. /**
  41984. * sets the active camera of the scene using its ID
  41985. * @param id defines the camera's ID
  41986. * @return the new active camera or null if none found.
  41987. */
  41988. setActiveCameraByID(id: string): Nullable<Camera>;
  41989. /**
  41990. * sets the active camera of the scene using its name
  41991. * @param name defines the camera's name
  41992. * @returns the new active camera or null if none found.
  41993. */
  41994. setActiveCameraByName(name: string): Nullable<Camera>;
  41995. /**
  41996. * get an animation group using its name
  41997. * @param name defines the material's name
  41998. * @return the animation group or null if none found.
  41999. */
  42000. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  42001. /**
  42002. * Get a material using its unique id
  42003. * @param uniqueId defines the material's unique id
  42004. * @return the material or null if none found.
  42005. */
  42006. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  42007. /**
  42008. * get a material using its id
  42009. * @param id defines the material's ID
  42010. * @return the material or null if none found.
  42011. */
  42012. getMaterialByID(id: string): Nullable<Material>;
  42013. /**
  42014. * Gets a the last added material using a given id
  42015. * @param id defines the material's ID
  42016. * @return the last material with the given id or null if none found.
  42017. */
  42018. getLastMaterialByID(id: string): Nullable<Material>;
  42019. /**
  42020. * Gets a material using its name
  42021. * @param name defines the material's name
  42022. * @return the material or null if none found.
  42023. */
  42024. getMaterialByName(name: string): Nullable<Material>;
  42025. /**
  42026. * Get a texture using its unique id
  42027. * @param uniqueId defines the texture's unique id
  42028. * @return the texture or null if none found.
  42029. */
  42030. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  42031. /**
  42032. * Gets a camera using its id
  42033. * @param id defines the id to look for
  42034. * @returns the camera or null if not found
  42035. */
  42036. getCameraByID(id: string): Nullable<Camera>;
  42037. /**
  42038. * Gets a camera using its unique id
  42039. * @param uniqueId defines the unique id to look for
  42040. * @returns the camera or null if not found
  42041. */
  42042. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  42043. /**
  42044. * Gets a camera using its name
  42045. * @param name defines the camera's name
  42046. * @return the camera or null if none found.
  42047. */
  42048. getCameraByName(name: string): Nullable<Camera>;
  42049. /**
  42050. * Gets a bone using its id
  42051. * @param id defines the bone's id
  42052. * @return the bone or null if not found
  42053. */
  42054. getBoneByID(id: string): Nullable<Bone>;
  42055. /**
  42056. * Gets a bone using its id
  42057. * @param name defines the bone's name
  42058. * @return the bone or null if not found
  42059. */
  42060. getBoneByName(name: string): Nullable<Bone>;
  42061. /**
  42062. * Gets a light node using its name
  42063. * @param name defines the the light's name
  42064. * @return the light or null if none found.
  42065. */
  42066. getLightByName(name: string): Nullable<Light>;
  42067. /**
  42068. * Gets a light node using its id
  42069. * @param id defines the light's id
  42070. * @return the light or null if none found.
  42071. */
  42072. getLightByID(id: string): Nullable<Light>;
  42073. /**
  42074. * Gets a light node using its scene-generated unique ID
  42075. * @param uniqueId defines the light's unique id
  42076. * @return the light or null if none found.
  42077. */
  42078. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  42079. /**
  42080. * Gets a particle system by id
  42081. * @param id defines the particle system id
  42082. * @return the corresponding system or null if none found
  42083. */
  42084. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  42085. /**
  42086. * Gets a geometry using its ID
  42087. * @param id defines the geometry's id
  42088. * @return the geometry or null if none found.
  42089. */
  42090. getGeometryByID(id: string): Nullable<Geometry>;
  42091. private _getGeometryByUniqueID;
  42092. /**
  42093. * Add a new geometry to this scene
  42094. * @param geometry defines the geometry to be added to the scene.
  42095. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  42096. * @return a boolean defining if the geometry was added or not
  42097. */
  42098. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  42099. /**
  42100. * Removes an existing geometry
  42101. * @param geometry defines the geometry to be removed from the scene
  42102. * @return a boolean defining if the geometry was removed or not
  42103. */
  42104. removeGeometry(geometry: Geometry): boolean;
  42105. /**
  42106. * Gets the list of geometries attached to the scene
  42107. * @returns an array of Geometry
  42108. */
  42109. getGeometries(): Geometry[];
  42110. /**
  42111. * Gets the first added mesh found of a given ID
  42112. * @param id defines the id to search for
  42113. * @return the mesh found or null if not found at all
  42114. */
  42115. getMeshByID(id: string): Nullable<AbstractMesh>;
  42116. /**
  42117. * Gets a list of meshes using their id
  42118. * @param id defines the id to search for
  42119. * @returns a list of meshes
  42120. */
  42121. getMeshesByID(id: string): Array<AbstractMesh>;
  42122. /**
  42123. * Gets the first added transform node found of a given ID
  42124. * @param id defines the id to search for
  42125. * @return the found transform node or null if not found at all.
  42126. */
  42127. getTransformNodeByID(id: string): Nullable<TransformNode>;
  42128. /**
  42129. * Gets a transform node with its auto-generated unique id
  42130. * @param uniqueId efines the unique id to search for
  42131. * @return the found transform node or null if not found at all.
  42132. */
  42133. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  42134. /**
  42135. * Gets a list of transform nodes using their id
  42136. * @param id defines the id to search for
  42137. * @returns a list of transform nodes
  42138. */
  42139. getTransformNodesByID(id: string): Array<TransformNode>;
  42140. /**
  42141. * Gets a mesh with its auto-generated unique id
  42142. * @param uniqueId defines the unique id to search for
  42143. * @return the found mesh or null if not found at all.
  42144. */
  42145. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  42146. /**
  42147. * Gets a the last added mesh using a given id
  42148. * @param id defines the id to search for
  42149. * @return the found mesh or null if not found at all.
  42150. */
  42151. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  42152. /**
  42153. * Gets a the last added node (Mesh, Camera, Light) using a given id
  42154. * @param id defines the id to search for
  42155. * @return the found node or null if not found at all
  42156. */
  42157. getLastEntryByID(id: string): Nullable<Node>;
  42158. /**
  42159. * Gets a node (Mesh, Camera, Light) using a given id
  42160. * @param id defines the id to search for
  42161. * @return the found node or null if not found at all
  42162. */
  42163. getNodeByID(id: string): Nullable<Node>;
  42164. /**
  42165. * Gets a node (Mesh, Camera, Light) using a given name
  42166. * @param name defines the name to search for
  42167. * @return the found node or null if not found at all.
  42168. */
  42169. getNodeByName(name: string): Nullable<Node>;
  42170. /**
  42171. * Gets a mesh using a given name
  42172. * @param name defines the name to search for
  42173. * @return the found mesh or null if not found at all.
  42174. */
  42175. getMeshByName(name: string): Nullable<AbstractMesh>;
  42176. /**
  42177. * Gets a transform node using a given name
  42178. * @param name defines the name to search for
  42179. * @return the found transform node or null if not found at all.
  42180. */
  42181. getTransformNodeByName(name: string): Nullable<TransformNode>;
  42182. /**
  42183. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  42184. * @param id defines the id to search for
  42185. * @return the found skeleton or null if not found at all.
  42186. */
  42187. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  42188. /**
  42189. * Gets a skeleton using a given auto generated unique id
  42190. * @param uniqueId defines the unique id to search for
  42191. * @return the found skeleton or null if not found at all.
  42192. */
  42193. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  42194. /**
  42195. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  42196. * @param id defines the id to search for
  42197. * @return the found skeleton or null if not found at all.
  42198. */
  42199. getSkeletonById(id: string): Nullable<Skeleton>;
  42200. /**
  42201. * Gets a skeleton using a given name
  42202. * @param name defines the name to search for
  42203. * @return the found skeleton or null if not found at all.
  42204. */
  42205. getSkeletonByName(name: string): Nullable<Skeleton>;
  42206. /**
  42207. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  42208. * @param id defines the id to search for
  42209. * @return the found morph target manager or null if not found at all.
  42210. */
  42211. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  42212. /**
  42213. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  42214. * @param id defines the id to search for
  42215. * @return the found morph target or null if not found at all.
  42216. */
  42217. getMorphTargetById(id: string): Nullable<MorphTarget>;
  42218. /**
  42219. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  42220. * @param name defines the name to search for
  42221. * @return the found morph target or null if not found at all.
  42222. */
  42223. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  42224. /**
  42225. * Gets a post process using a given name (if many are found, this function will pick the first one)
  42226. * @param name defines the name to search for
  42227. * @return the found post process or null if not found at all.
  42228. */
  42229. getPostProcessByName(name: string): Nullable<PostProcess>;
  42230. /**
  42231. * Gets a boolean indicating if the given mesh is active
  42232. * @param mesh defines the mesh to look for
  42233. * @returns true if the mesh is in the active list
  42234. */
  42235. isActiveMesh(mesh: AbstractMesh): boolean;
  42236. /**
  42237. * Return a unique id as a string which can serve as an identifier for the scene
  42238. */
  42239. get uid(): string;
  42240. /**
  42241. * Add an externaly attached data from its key.
  42242. * This method call will fail and return false, if such key already exists.
  42243. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  42244. * @param key the unique key that identifies the data
  42245. * @param data the data object to associate to the key for this Engine instance
  42246. * @return true if no such key were already present and the data was added successfully, false otherwise
  42247. */
  42248. addExternalData<T>(key: string, data: T): boolean;
  42249. /**
  42250. * Get an externaly attached data from its key
  42251. * @param key the unique key that identifies the data
  42252. * @return the associated data, if present (can be null), or undefined if not present
  42253. */
  42254. getExternalData<T>(key: string): Nullable<T>;
  42255. /**
  42256. * Get an externaly attached data from its key, create it using a factory if it's not already present
  42257. * @param key the unique key that identifies the data
  42258. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  42259. * @return the associated data, can be null if the factory returned null.
  42260. */
  42261. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  42262. /**
  42263. * Remove an externaly attached data from the Engine instance
  42264. * @param key the unique key that identifies the data
  42265. * @return true if the data was successfully removed, false if it doesn't exist
  42266. */
  42267. removeExternalData(key: string): boolean;
  42268. private _evaluateSubMesh;
  42269. /**
  42270. * Clear the processed materials smart array preventing retention point in material dispose.
  42271. */
  42272. freeProcessedMaterials(): void;
  42273. private _preventFreeActiveMeshesAndRenderingGroups;
  42274. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  42275. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  42276. * when disposing several meshes in a row or a hierarchy of meshes.
  42277. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  42278. */
  42279. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  42280. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  42281. /**
  42282. * Clear the active meshes smart array preventing retention point in mesh dispose.
  42283. */
  42284. freeActiveMeshes(): void;
  42285. /**
  42286. * Clear the info related to rendering groups preventing retention points during dispose.
  42287. */
  42288. freeRenderingGroups(): void;
  42289. /** @hidden */
  42290. _isInIntermediateRendering(): boolean;
  42291. /**
  42292. * Lambda returning the list of potentially active meshes.
  42293. */
  42294. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  42295. /**
  42296. * Lambda returning the list of potentially active sub meshes.
  42297. */
  42298. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  42299. /**
  42300. * Lambda returning the list of potentially intersecting sub meshes.
  42301. */
  42302. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  42303. /**
  42304. * Lambda returning the list of potentially colliding sub meshes.
  42305. */
  42306. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  42307. private _activeMeshesFrozen;
  42308. private _skipEvaluateActiveMeshesCompletely;
  42309. /**
  42310. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  42311. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  42312. * @returns the current scene
  42313. */
  42314. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  42315. /**
  42316. * Use this function to restart evaluating active meshes on every frame
  42317. * @returns the current scene
  42318. */
  42319. unfreezeActiveMeshes(): Scene;
  42320. private _evaluateActiveMeshes;
  42321. private _activeMesh;
  42322. /**
  42323. * Update the transform matrix to update from the current active camera
  42324. * @param force defines a boolean used to force the update even if cache is up to date
  42325. */
  42326. updateTransformMatrix(force?: boolean): void;
  42327. private _bindFrameBuffer;
  42328. /** @hidden */
  42329. _allowPostProcessClearColor: boolean;
  42330. /** @hidden */
  42331. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  42332. private _processSubCameras;
  42333. private _checkIntersections;
  42334. /** @hidden */
  42335. _advancePhysicsEngineStep(step: number): void;
  42336. /**
  42337. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  42338. */
  42339. getDeterministicFrameTime: () => number;
  42340. /** @hidden */
  42341. _animate(): void;
  42342. /** Execute all animations (for a frame) */
  42343. animate(): void;
  42344. /**
  42345. * Render the scene
  42346. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  42347. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  42348. */
  42349. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  42350. /**
  42351. * Freeze all materials
  42352. * A frozen material will not be updatable but should be faster to render
  42353. */
  42354. freezeMaterials(): void;
  42355. /**
  42356. * Unfreeze all materials
  42357. * A frozen material will not be updatable but should be faster to render
  42358. */
  42359. unfreezeMaterials(): void;
  42360. /**
  42361. * Releases all held ressources
  42362. */
  42363. dispose(): void;
  42364. /**
  42365. * Gets if the scene is already disposed
  42366. */
  42367. get isDisposed(): boolean;
  42368. /**
  42369. * Call this function to reduce memory footprint of the scene.
  42370. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  42371. */
  42372. clearCachedVertexData(): void;
  42373. /**
  42374. * This function will remove the local cached buffer data from texture.
  42375. * It will save memory but will prevent the texture from being rebuilt
  42376. */
  42377. cleanCachedTextureBuffer(): void;
  42378. /**
  42379. * Get the world extend vectors with an optional filter
  42380. *
  42381. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  42382. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  42383. */
  42384. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  42385. min: Vector3;
  42386. max: Vector3;
  42387. };
  42388. /**
  42389. * Creates a ray that can be used to pick in the scene
  42390. * @param x defines the x coordinate of the origin (on-screen)
  42391. * @param y defines the y coordinate of the origin (on-screen)
  42392. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  42393. * @param camera defines the camera to use for the picking
  42394. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  42395. * @returns a Ray
  42396. */
  42397. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  42398. /**
  42399. * Creates a ray that can be used to pick in the scene
  42400. * @param x defines the x coordinate of the origin (on-screen)
  42401. * @param y defines the y coordinate of the origin (on-screen)
  42402. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  42403. * @param result defines the ray where to store the picking ray
  42404. * @param camera defines the camera to use for the picking
  42405. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  42406. * @returns the current scene
  42407. */
  42408. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  42409. /**
  42410. * Creates a ray that can be used to pick in the scene
  42411. * @param x defines the x coordinate of the origin (on-screen)
  42412. * @param y defines the y coordinate of the origin (on-screen)
  42413. * @param camera defines the camera to use for the picking
  42414. * @returns a Ray
  42415. */
  42416. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): 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 result defines the ray where to store the picking ray
  42422. * @param camera defines the camera to use for the picking
  42423. * @returns the current scene
  42424. */
  42425. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  42426. /** Launch a ray to try to pick a mesh in the scene
  42427. * @param x position on screen
  42428. * @param y position on screen
  42429. * @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
  42430. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42431. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42432. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42433. * @returns a PickingInfo
  42434. */
  42435. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  42436. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  42437. * @param x position on screen
  42438. * @param y position on screen
  42439. * @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
  42440. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42441. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42442. * @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)
  42443. */
  42444. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  42445. /** Use the given ray to pick a mesh in the scene
  42446. * @param ray The ray to use to pick meshes
  42447. * @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
  42448. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42449. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42450. * @returns a PickingInfo
  42451. */
  42452. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  42453. /**
  42454. * Launch a ray to try to pick a mesh in the scene
  42455. * @param x X position on screen
  42456. * @param y Y position on screen
  42457. * @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
  42458. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42459. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42460. * @returns an array of PickingInfo
  42461. */
  42462. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  42463. /**
  42464. * Launch a ray to try to pick a mesh in the scene
  42465. * @param ray Ray to use
  42466. * @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
  42467. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42468. * @returns an array of PickingInfo
  42469. */
  42470. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  42471. /**
  42472. * Force the value of meshUnderPointer
  42473. * @param mesh defines the mesh to use
  42474. */
  42475. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  42476. /**
  42477. * Gets the mesh under the pointer
  42478. * @returns a Mesh or null if no mesh is under the pointer
  42479. */
  42480. getPointerOverMesh(): Nullable<AbstractMesh>;
  42481. /** @hidden */
  42482. _rebuildGeometries(): void;
  42483. /** @hidden */
  42484. _rebuildTextures(): void;
  42485. private _getByTags;
  42486. /**
  42487. * Get a list of meshes by tags
  42488. * @param tagsQuery defines the tags query to use
  42489. * @param forEach defines a predicate used to filter results
  42490. * @returns an array of Mesh
  42491. */
  42492. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  42493. /**
  42494. * Get a list of cameras by tags
  42495. * @param tagsQuery defines the tags query to use
  42496. * @param forEach defines a predicate used to filter results
  42497. * @returns an array of Camera
  42498. */
  42499. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  42500. /**
  42501. * Get a list of lights by tags
  42502. * @param tagsQuery defines the tags query to use
  42503. * @param forEach defines a predicate used to filter results
  42504. * @returns an array of Light
  42505. */
  42506. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  42507. /**
  42508. * Get a list of materials by tags
  42509. * @param tagsQuery defines the tags query to use
  42510. * @param forEach defines a predicate used to filter results
  42511. * @returns an array of Material
  42512. */
  42513. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  42514. /**
  42515. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  42516. * This allowed control for front to back rendering or reversly depending of the special needs.
  42517. *
  42518. * @param renderingGroupId The rendering group id corresponding to its index
  42519. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  42520. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  42521. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  42522. */
  42523. 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;
  42524. /**
  42525. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  42526. *
  42527. * @param renderingGroupId The rendering group id corresponding to its index
  42528. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  42529. * @param depth Automatically clears depth between groups if true and autoClear is true.
  42530. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  42531. */
  42532. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  42533. /**
  42534. * Gets the current auto clear configuration for one rendering group of the rendering
  42535. * manager.
  42536. * @param index the rendering group index to get the information for
  42537. * @returns The auto clear setup for the requested rendering group
  42538. */
  42539. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  42540. private _blockMaterialDirtyMechanism;
  42541. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  42542. get blockMaterialDirtyMechanism(): boolean;
  42543. set blockMaterialDirtyMechanism(value: boolean);
  42544. /**
  42545. * Will flag all materials as dirty to trigger new shader compilation
  42546. * @param flag defines the flag used to specify which material part must be marked as dirty
  42547. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  42548. */
  42549. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  42550. /** @hidden */
  42551. _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;
  42552. /** @hidden */
  42553. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  42554. /** @hidden */
  42555. _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;
  42556. /** @hidden */
  42557. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  42558. /** @hidden */
  42559. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  42560. /** @hidden */
  42561. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  42562. }
  42563. }
  42564. declare module "babylonjs/assetContainer" {
  42565. import { AbstractScene } from "babylonjs/abstractScene";
  42566. import { Scene } from "babylonjs/scene";
  42567. import { Mesh } from "babylonjs/Meshes/mesh";
  42568. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42569. import { Skeleton } from "babylonjs/Bones/skeleton";
  42570. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  42571. import { Animatable } from "babylonjs/Animations/animatable";
  42572. import { Nullable } from "babylonjs/types";
  42573. import { Node } from "babylonjs/node";
  42574. /**
  42575. * Set of assets to keep when moving a scene into an asset container.
  42576. */
  42577. export class KeepAssets extends AbstractScene {
  42578. }
  42579. /**
  42580. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  42581. */
  42582. export class InstantiatedEntries {
  42583. /**
  42584. * List of new root nodes (eg. nodes with no parent)
  42585. */
  42586. rootNodes: TransformNode[];
  42587. /**
  42588. * List of new skeletons
  42589. */
  42590. skeletons: Skeleton[];
  42591. /**
  42592. * List of new animation groups
  42593. */
  42594. animationGroups: AnimationGroup[];
  42595. }
  42596. /**
  42597. * Container with a set of assets that can be added or removed from a scene.
  42598. */
  42599. export class AssetContainer extends AbstractScene {
  42600. private _wasAddedToScene;
  42601. /**
  42602. * The scene the AssetContainer belongs to.
  42603. */
  42604. scene: Scene;
  42605. /**
  42606. * Instantiates an AssetContainer.
  42607. * @param scene The scene the AssetContainer belongs to.
  42608. */
  42609. constructor(scene: Scene);
  42610. /**
  42611. * Instantiate or clone all meshes and add the new ones to the scene.
  42612. * Skeletons and animation groups will all be cloned
  42613. * @param nameFunction defines an optional function used to get new names for clones
  42614. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  42615. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  42616. */
  42617. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  42618. /**
  42619. * Adds all the assets from the container to the scene.
  42620. */
  42621. addAllToScene(): void;
  42622. /**
  42623. * Removes all the assets in the container from the scene
  42624. */
  42625. removeAllFromScene(): void;
  42626. /**
  42627. * Disposes all the assets in the container
  42628. */
  42629. dispose(): void;
  42630. private _moveAssets;
  42631. /**
  42632. * Removes all the assets contained in the scene and adds them to the container.
  42633. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  42634. */
  42635. moveAllFromScene(keepAssets?: KeepAssets): void;
  42636. /**
  42637. * 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.
  42638. * @returns the root mesh
  42639. */
  42640. createRootMesh(): Mesh;
  42641. /**
  42642. * Merge animations (direct and animation groups) from this asset container into a scene
  42643. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  42644. * @param animatables set of animatables to retarget to a node from the scene
  42645. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  42646. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  42647. */
  42648. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  42649. }
  42650. }
  42651. declare module "babylonjs/abstractScene" {
  42652. import { Scene } from "babylonjs/scene";
  42653. import { Nullable } from "babylonjs/types";
  42654. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42655. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42656. import { Geometry } from "babylonjs/Meshes/geometry";
  42657. import { Skeleton } from "babylonjs/Bones/skeleton";
  42658. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  42659. import { AssetContainer } from "babylonjs/assetContainer";
  42660. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  42661. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  42662. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  42663. import { Material } from "babylonjs/Materials/material";
  42664. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  42665. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  42666. import { Camera } from "babylonjs/Cameras/camera";
  42667. import { Light } from "babylonjs/Lights/light";
  42668. import { Node } from "babylonjs/node";
  42669. import { Animation } from "babylonjs/Animations/animation";
  42670. /**
  42671. * Defines how the parser contract is defined.
  42672. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  42673. */
  42674. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  42675. /**
  42676. * Defines how the individual parser contract is defined.
  42677. * These parser can parse an individual asset
  42678. */
  42679. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  42680. /**
  42681. * Base class of the scene acting as a container for the different elements composing a scene.
  42682. * This class is dynamically extended by the different components of the scene increasing
  42683. * flexibility and reducing coupling
  42684. */
  42685. export abstract class AbstractScene {
  42686. /**
  42687. * Stores the list of available parsers in the application.
  42688. */
  42689. private static _BabylonFileParsers;
  42690. /**
  42691. * Stores the list of available individual parsers in the application.
  42692. */
  42693. private static _IndividualBabylonFileParsers;
  42694. /**
  42695. * Adds a parser in the list of available ones
  42696. * @param name Defines the name of the parser
  42697. * @param parser Defines the parser to add
  42698. */
  42699. static AddParser(name: string, parser: BabylonFileParser): void;
  42700. /**
  42701. * Gets a general parser from the list of avaialble ones
  42702. * @param name Defines the name of the parser
  42703. * @returns the requested parser or null
  42704. */
  42705. static GetParser(name: string): Nullable<BabylonFileParser>;
  42706. /**
  42707. * Adds n individual parser in the list of available ones
  42708. * @param name Defines the name of the parser
  42709. * @param parser Defines the parser to add
  42710. */
  42711. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  42712. /**
  42713. * Gets an individual parser from the list of avaialble ones
  42714. * @param name Defines the name of the parser
  42715. * @returns the requested parser or null
  42716. */
  42717. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  42718. /**
  42719. * Parser json data and populate both a scene and its associated container object
  42720. * @param jsonData Defines the data to parse
  42721. * @param scene Defines the scene to parse the data for
  42722. * @param container Defines the container attached to the parsing sequence
  42723. * @param rootUrl Defines the root url of the data
  42724. */
  42725. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  42726. /**
  42727. * Gets the list of root nodes (ie. nodes with no parent)
  42728. */
  42729. rootNodes: Node[];
  42730. /** All of the cameras added to this scene
  42731. * @see https://doc.babylonjs.com/babylon101/cameras
  42732. */
  42733. cameras: Camera[];
  42734. /**
  42735. * All of the lights added to this scene
  42736. * @see https://doc.babylonjs.com/babylon101/lights
  42737. */
  42738. lights: Light[];
  42739. /**
  42740. * All of the (abstract) meshes added to this scene
  42741. */
  42742. meshes: AbstractMesh[];
  42743. /**
  42744. * The list of skeletons added to the scene
  42745. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  42746. */
  42747. skeletons: Skeleton[];
  42748. /**
  42749. * All of the particle systems added to this scene
  42750. * @see https://doc.babylonjs.com/babylon101/particles
  42751. */
  42752. particleSystems: IParticleSystem[];
  42753. /**
  42754. * Gets a list of Animations associated with the scene
  42755. */
  42756. animations: Animation[];
  42757. /**
  42758. * All of the animation groups added to this scene
  42759. * @see https://doc.babylonjs.com/how_to/group
  42760. */
  42761. animationGroups: AnimationGroup[];
  42762. /**
  42763. * All of the multi-materials added to this scene
  42764. * @see https://doc.babylonjs.com/how_to/multi_materials
  42765. */
  42766. multiMaterials: MultiMaterial[];
  42767. /**
  42768. * All of the materials added to this scene
  42769. * In the context of a Scene, it is not supposed to be modified manually.
  42770. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  42771. * Note also that the order of the Material within the array is not significant and might change.
  42772. * @see https://doc.babylonjs.com/babylon101/materials
  42773. */
  42774. materials: Material[];
  42775. /**
  42776. * The list of morph target managers added to the scene
  42777. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  42778. */
  42779. morphTargetManagers: MorphTargetManager[];
  42780. /**
  42781. * The list of geometries used in the scene.
  42782. */
  42783. geometries: Geometry[];
  42784. /**
  42785. * All of the tranform nodes added to this scene
  42786. * In the context of a Scene, it is not supposed to be modified manually.
  42787. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  42788. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  42789. * @see https://doc.babylonjs.com/how_to/transformnode
  42790. */
  42791. transformNodes: TransformNode[];
  42792. /**
  42793. * ActionManagers available on the scene.
  42794. */
  42795. actionManagers: AbstractActionManager[];
  42796. /**
  42797. * Textures to keep.
  42798. */
  42799. textures: BaseTexture[];
  42800. /** @hidden */
  42801. protected _environmentTexture: Nullable<BaseTexture>;
  42802. /**
  42803. * Texture used in all pbr material as the reflection texture.
  42804. * As in the majority of the scene they are the same (exception for multi room and so on),
  42805. * this is easier to reference from here than from all the materials.
  42806. */
  42807. get environmentTexture(): Nullable<BaseTexture>;
  42808. set environmentTexture(value: Nullable<BaseTexture>);
  42809. /**
  42810. * The list of postprocesses added to the scene
  42811. */
  42812. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  42813. /**
  42814. * @returns all meshes, lights, cameras, transformNodes and bones
  42815. */
  42816. getNodes(): Array<Node>;
  42817. }
  42818. }
  42819. declare module "babylonjs/Audio/sound" {
  42820. import { Observable } from "babylonjs/Misc/observable";
  42821. import { Vector3 } from "babylonjs/Maths/math.vector";
  42822. import { Nullable } from "babylonjs/types";
  42823. import { Scene } from "babylonjs/scene";
  42824. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42825. /**
  42826. * Interface used to define options for Sound class
  42827. */
  42828. export interface ISoundOptions {
  42829. /**
  42830. * Does the sound autoplay once loaded.
  42831. */
  42832. autoplay?: boolean;
  42833. /**
  42834. * Does the sound loop after it finishes playing once.
  42835. */
  42836. loop?: boolean;
  42837. /**
  42838. * Sound's volume
  42839. */
  42840. volume?: number;
  42841. /**
  42842. * Is it a spatial sound?
  42843. */
  42844. spatialSound?: boolean;
  42845. /**
  42846. * Maximum distance to hear that sound
  42847. */
  42848. maxDistance?: number;
  42849. /**
  42850. * Uses user defined attenuation function
  42851. */
  42852. useCustomAttenuation?: boolean;
  42853. /**
  42854. * Define the roll off factor of spatial sounds.
  42855. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42856. */
  42857. rolloffFactor?: number;
  42858. /**
  42859. * Define the reference distance the sound should be heard perfectly.
  42860. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42861. */
  42862. refDistance?: number;
  42863. /**
  42864. * Define the distance attenuation model the sound will follow.
  42865. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42866. */
  42867. distanceModel?: string;
  42868. /**
  42869. * Defines the playback speed (1 by default)
  42870. */
  42871. playbackRate?: number;
  42872. /**
  42873. * Defines if the sound is from a streaming source
  42874. */
  42875. streaming?: boolean;
  42876. /**
  42877. * Defines an optional length (in seconds) inside the sound file
  42878. */
  42879. length?: number;
  42880. /**
  42881. * Defines an optional offset (in seconds) inside the sound file
  42882. */
  42883. offset?: number;
  42884. /**
  42885. * If true, URLs will not be required to state the audio file codec to use.
  42886. */
  42887. skipCodecCheck?: boolean;
  42888. }
  42889. /**
  42890. * Defines a sound that can be played in the application.
  42891. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  42892. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  42893. */
  42894. export class Sound {
  42895. /**
  42896. * The name of the sound in the scene.
  42897. */
  42898. name: string;
  42899. /**
  42900. * Does the sound autoplay once loaded.
  42901. */
  42902. autoplay: boolean;
  42903. /**
  42904. * Does the sound loop after it finishes playing once.
  42905. */
  42906. loop: boolean;
  42907. /**
  42908. * Does the sound use a custom attenuation curve to simulate the falloff
  42909. * happening when the source gets further away from the camera.
  42910. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  42911. */
  42912. useCustomAttenuation: boolean;
  42913. /**
  42914. * The sound track id this sound belongs to.
  42915. */
  42916. soundTrackId: number;
  42917. /**
  42918. * Is this sound currently played.
  42919. */
  42920. isPlaying: boolean;
  42921. /**
  42922. * Is this sound currently paused.
  42923. */
  42924. isPaused: boolean;
  42925. /**
  42926. * Does this sound enables spatial sound.
  42927. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42928. */
  42929. spatialSound: boolean;
  42930. /**
  42931. * Define the reference distance the sound should be heard perfectly.
  42932. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42933. */
  42934. refDistance: number;
  42935. /**
  42936. * Define the roll off factor of spatial sounds.
  42937. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42938. */
  42939. rolloffFactor: number;
  42940. /**
  42941. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  42942. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42943. */
  42944. maxDistance: number;
  42945. /**
  42946. * Define the distance attenuation model the sound will follow.
  42947. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42948. */
  42949. distanceModel: string;
  42950. /**
  42951. * @hidden
  42952. * Back Compat
  42953. **/
  42954. onended: () => any;
  42955. /**
  42956. * Gets or sets an object used to store user defined information for the sound.
  42957. */
  42958. metadata: any;
  42959. /**
  42960. * Observable event when the current playing sound finishes.
  42961. */
  42962. onEndedObservable: Observable<Sound>;
  42963. private _panningModel;
  42964. private _playbackRate;
  42965. private _streaming;
  42966. private _startTime;
  42967. private _startOffset;
  42968. private _position;
  42969. /** @hidden */
  42970. _positionInEmitterSpace: boolean;
  42971. private _localDirection;
  42972. private _volume;
  42973. private _isReadyToPlay;
  42974. private _isDirectional;
  42975. private _readyToPlayCallback;
  42976. private _audioBuffer;
  42977. private _soundSource;
  42978. private _streamingSource;
  42979. private _soundPanner;
  42980. private _soundGain;
  42981. private _inputAudioNode;
  42982. private _outputAudioNode;
  42983. private _coneInnerAngle;
  42984. private _coneOuterAngle;
  42985. private _coneOuterGain;
  42986. private _scene;
  42987. private _connectedTransformNode;
  42988. private _customAttenuationFunction;
  42989. private _registerFunc;
  42990. private _isOutputConnected;
  42991. private _htmlAudioElement;
  42992. private _urlType;
  42993. private _length?;
  42994. private _offset?;
  42995. /** @hidden */
  42996. static _SceneComponentInitialization: (scene: Scene) => void;
  42997. /**
  42998. * Create a sound and attach it to a scene
  42999. * @param name Name of your sound
  43000. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  43001. * @param scene defines the scene the sound belongs to
  43002. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  43003. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  43004. */
  43005. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  43006. /**
  43007. * Release the sound and its associated resources
  43008. */
  43009. dispose(): void;
  43010. /**
  43011. * Gets if the sounds is ready to be played or not.
  43012. * @returns true if ready, otherwise false
  43013. */
  43014. isReady(): boolean;
  43015. private _soundLoaded;
  43016. /**
  43017. * Sets the data of the sound from an audiobuffer
  43018. * @param audioBuffer The audioBuffer containing the data
  43019. */
  43020. setAudioBuffer(audioBuffer: AudioBuffer): void;
  43021. /**
  43022. * Updates the current sounds options such as maxdistance, loop...
  43023. * @param options A JSON object containing values named as the object properties
  43024. */
  43025. updateOptions(options: ISoundOptions): void;
  43026. private _createSpatialParameters;
  43027. private _updateSpatialParameters;
  43028. /**
  43029. * Switch the panning model to HRTF:
  43030. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  43031. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43032. */
  43033. switchPanningModelToHRTF(): void;
  43034. /**
  43035. * Switch the panning model to Equal Power:
  43036. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  43037. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43038. */
  43039. switchPanningModelToEqualPower(): void;
  43040. private _switchPanningModel;
  43041. /**
  43042. * Connect this sound to a sound track audio node like gain...
  43043. * @param soundTrackAudioNode the sound track audio node to connect to
  43044. */
  43045. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  43046. /**
  43047. * Transform this sound into a directional source
  43048. * @param coneInnerAngle Size of the inner cone in degree
  43049. * @param coneOuterAngle Size of the outer cone in degree
  43050. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  43051. */
  43052. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  43053. /**
  43054. * Gets or sets the inner angle for the directional cone.
  43055. */
  43056. get directionalConeInnerAngle(): number;
  43057. /**
  43058. * Gets or sets the inner angle for the directional cone.
  43059. */
  43060. set directionalConeInnerAngle(value: number);
  43061. /**
  43062. * Gets or sets the outer angle for the directional cone.
  43063. */
  43064. get directionalConeOuterAngle(): number;
  43065. /**
  43066. * Gets or sets the outer angle for the directional cone.
  43067. */
  43068. set directionalConeOuterAngle(value: number);
  43069. /**
  43070. * Sets the position of the emitter if spatial sound is enabled
  43071. * @param newPosition Defines the new posisiton
  43072. */
  43073. setPosition(newPosition: Vector3): void;
  43074. /**
  43075. * Sets the local direction of the emitter if spatial sound is enabled
  43076. * @param newLocalDirection Defines the new local direction
  43077. */
  43078. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  43079. private _updateDirection;
  43080. /** @hidden */
  43081. updateDistanceFromListener(): void;
  43082. /**
  43083. * Sets a new custom attenuation function for the sound.
  43084. * @param callback Defines the function used for the attenuation
  43085. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  43086. */
  43087. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  43088. /**
  43089. * Play the sound
  43090. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  43091. * @param offset (optional) Start the sound at a specific time in seconds
  43092. * @param length (optional) Sound duration (in seconds)
  43093. */
  43094. play(time?: number, offset?: number, length?: number): void;
  43095. private _onended;
  43096. /**
  43097. * Stop the sound
  43098. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  43099. */
  43100. stop(time?: number): void;
  43101. /**
  43102. * Put the sound in pause
  43103. */
  43104. pause(): void;
  43105. /**
  43106. * Sets a dedicated volume for this sounds
  43107. * @param newVolume Define the new volume of the sound
  43108. * @param time Define time for gradual change to new volume
  43109. */
  43110. setVolume(newVolume: number, time?: number): void;
  43111. /**
  43112. * Set the sound play back rate
  43113. * @param newPlaybackRate Define the playback rate the sound should be played at
  43114. */
  43115. setPlaybackRate(newPlaybackRate: number): void;
  43116. /**
  43117. * Gets the volume of the sound.
  43118. * @returns the volume of the sound
  43119. */
  43120. getVolume(): number;
  43121. /**
  43122. * Attach the sound to a dedicated mesh
  43123. * @param transformNode The transform node to connect the sound with
  43124. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  43125. */
  43126. attachToMesh(transformNode: TransformNode): void;
  43127. /**
  43128. * Detach the sound from the previously attached mesh
  43129. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  43130. */
  43131. detachFromMesh(): void;
  43132. private _onRegisterAfterWorldMatrixUpdate;
  43133. /**
  43134. * Clone the current sound in the scene.
  43135. * @returns the new sound clone
  43136. */
  43137. clone(): Nullable<Sound>;
  43138. /**
  43139. * Gets the current underlying audio buffer containing the data
  43140. * @returns the audio buffer
  43141. */
  43142. getAudioBuffer(): Nullable<AudioBuffer>;
  43143. /**
  43144. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  43145. * @returns the source node
  43146. */
  43147. getSoundSource(): Nullable<AudioBufferSourceNode>;
  43148. /**
  43149. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  43150. * @returns the gain node
  43151. */
  43152. getSoundGain(): Nullable<GainNode>;
  43153. /**
  43154. * Serializes the Sound in a JSON representation
  43155. * @returns the JSON representation of the sound
  43156. */
  43157. serialize(): any;
  43158. /**
  43159. * Parse a JSON representation of a sound to innstantiate in a given scene
  43160. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  43161. * @param scene Define the scene the new parsed sound should be created in
  43162. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  43163. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  43164. * @returns the newly parsed sound
  43165. */
  43166. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  43167. }
  43168. }
  43169. declare module "babylonjs/Actions/directAudioActions" {
  43170. import { Action } from "babylonjs/Actions/action";
  43171. import { Condition } from "babylonjs/Actions/condition";
  43172. import { Sound } from "babylonjs/Audio/sound";
  43173. /**
  43174. * This defines an action helpful to play a defined sound on a triggered action.
  43175. */
  43176. export class PlaySoundAction extends Action {
  43177. private _sound;
  43178. /**
  43179. * Instantiate the action
  43180. * @param triggerOptions defines the trigger options
  43181. * @param sound defines the sound to play
  43182. * @param condition defines the trigger related conditions
  43183. */
  43184. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  43185. /** @hidden */
  43186. _prepare(): void;
  43187. /**
  43188. * Execute the action and play the sound.
  43189. */
  43190. execute(): void;
  43191. /**
  43192. * Serializes the actions and its related information.
  43193. * @param parent defines the object to serialize in
  43194. * @returns the serialized object
  43195. */
  43196. serialize(parent: any): any;
  43197. }
  43198. /**
  43199. * This defines an action helpful to stop a defined sound on a triggered action.
  43200. */
  43201. export class StopSoundAction extends Action {
  43202. private _sound;
  43203. /**
  43204. * Instantiate the action
  43205. * @param triggerOptions defines the trigger options
  43206. * @param sound defines the sound to stop
  43207. * @param condition defines the trigger related conditions
  43208. */
  43209. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  43210. /** @hidden */
  43211. _prepare(): void;
  43212. /**
  43213. * Execute the action and stop the sound.
  43214. */
  43215. execute(): void;
  43216. /**
  43217. * Serializes the actions and its related information.
  43218. * @param parent defines the object to serialize in
  43219. * @returns the serialized object
  43220. */
  43221. serialize(parent: any): any;
  43222. }
  43223. }
  43224. declare module "babylonjs/Actions/interpolateValueAction" {
  43225. import { Action } from "babylonjs/Actions/action";
  43226. import { Condition } from "babylonjs/Actions/condition";
  43227. import { Observable } from "babylonjs/Misc/observable";
  43228. /**
  43229. * This defines an action responsible to change the value of a property
  43230. * by interpolating between its current value and the newly set one once triggered.
  43231. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  43232. */
  43233. export class InterpolateValueAction extends Action {
  43234. /**
  43235. * Defines the path of the property where the value should be interpolated
  43236. */
  43237. propertyPath: string;
  43238. /**
  43239. * Defines the target value at the end of the interpolation.
  43240. */
  43241. value: any;
  43242. /**
  43243. * Defines the time it will take for the property to interpolate to the value.
  43244. */
  43245. duration: number;
  43246. /**
  43247. * Defines if the other scene animations should be stopped when the action has been triggered
  43248. */
  43249. stopOtherAnimations?: boolean;
  43250. /**
  43251. * Defines a callback raised once the interpolation animation has been done.
  43252. */
  43253. onInterpolationDone?: () => void;
  43254. /**
  43255. * Observable triggered once the interpolation animation has been done.
  43256. */
  43257. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  43258. private _target;
  43259. private _effectiveTarget;
  43260. private _property;
  43261. /**
  43262. * Instantiate the action
  43263. * @param triggerOptions defines the trigger options
  43264. * @param target defines the object containing the value to interpolate
  43265. * @param propertyPath defines the path to the property in the target object
  43266. * @param value defines the target value at the end of the interpolation
  43267. * @param duration deines the time it will take for the property to interpolate to the value.
  43268. * @param condition defines the trigger related conditions
  43269. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  43270. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  43271. */
  43272. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  43273. /** @hidden */
  43274. _prepare(): void;
  43275. /**
  43276. * Execute the action starts the value interpolation.
  43277. */
  43278. execute(): void;
  43279. /**
  43280. * Serializes the actions and its related information.
  43281. * @param parent defines the object to serialize in
  43282. * @returns the serialized object
  43283. */
  43284. serialize(parent: any): any;
  43285. }
  43286. }
  43287. declare module "babylonjs/Actions/index" {
  43288. export * from "babylonjs/Actions/abstractActionManager";
  43289. export * from "babylonjs/Actions/action";
  43290. export * from "babylonjs/Actions/actionEvent";
  43291. export * from "babylonjs/Actions/actionManager";
  43292. export * from "babylonjs/Actions/condition";
  43293. export * from "babylonjs/Actions/directActions";
  43294. export * from "babylonjs/Actions/directAudioActions";
  43295. export * from "babylonjs/Actions/interpolateValueAction";
  43296. }
  43297. declare module "babylonjs/Animations/index" {
  43298. export * from "babylonjs/Animations/animatable";
  43299. export * from "babylonjs/Animations/animation";
  43300. export * from "babylonjs/Animations/animationGroup";
  43301. export * from "babylonjs/Animations/animationPropertiesOverride";
  43302. export * from "babylonjs/Animations/easing";
  43303. export * from "babylonjs/Animations/runtimeAnimation";
  43304. export * from "babylonjs/Animations/animationEvent";
  43305. export * from "babylonjs/Animations/animationGroup";
  43306. export * from "babylonjs/Animations/animationKey";
  43307. export * from "babylonjs/Animations/animationRange";
  43308. export * from "babylonjs/Animations/animatable.interface";
  43309. }
  43310. declare module "babylonjs/Audio/soundTrack" {
  43311. import { Sound } from "babylonjs/Audio/sound";
  43312. import { Analyser } from "babylonjs/Audio/analyser";
  43313. import { Scene } from "babylonjs/scene";
  43314. /**
  43315. * Options allowed during the creation of a sound track.
  43316. */
  43317. export interface ISoundTrackOptions {
  43318. /**
  43319. * The volume the sound track should take during creation
  43320. */
  43321. volume?: number;
  43322. /**
  43323. * Define if the sound track is the main sound track of the scene
  43324. */
  43325. mainTrack?: boolean;
  43326. }
  43327. /**
  43328. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  43329. * It will be also used in a future release to apply effects on a specific track.
  43330. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  43331. */
  43332. export class SoundTrack {
  43333. /**
  43334. * The unique identifier of the sound track in the scene.
  43335. */
  43336. id: number;
  43337. /**
  43338. * The list of sounds included in the sound track.
  43339. */
  43340. soundCollection: Array<Sound>;
  43341. private _outputAudioNode;
  43342. private _scene;
  43343. private _connectedAnalyser;
  43344. private _options;
  43345. private _isInitialized;
  43346. /**
  43347. * Creates a new sound track.
  43348. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  43349. * @param scene Define the scene the sound track belongs to
  43350. * @param options
  43351. */
  43352. constructor(scene: Scene, options?: ISoundTrackOptions);
  43353. private _initializeSoundTrackAudioGraph;
  43354. /**
  43355. * Release the sound track and its associated resources
  43356. */
  43357. dispose(): void;
  43358. /**
  43359. * Adds a sound to this sound track
  43360. * @param sound define the cound to add
  43361. * @ignoreNaming
  43362. */
  43363. AddSound(sound: Sound): void;
  43364. /**
  43365. * Removes a sound to this sound track
  43366. * @param sound define the cound to remove
  43367. * @ignoreNaming
  43368. */
  43369. RemoveSound(sound: Sound): void;
  43370. /**
  43371. * Set a global volume for the full sound track.
  43372. * @param newVolume Define the new volume of the sound track
  43373. */
  43374. setVolume(newVolume: number): void;
  43375. /**
  43376. * Switch the panning model to HRTF:
  43377. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  43378. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43379. */
  43380. switchPanningModelToHRTF(): void;
  43381. /**
  43382. * Switch the panning model to Equal Power:
  43383. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  43384. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43385. */
  43386. switchPanningModelToEqualPower(): void;
  43387. /**
  43388. * Connect the sound track to an audio analyser allowing some amazing
  43389. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  43390. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  43391. * @param analyser The analyser to connect to the engine
  43392. */
  43393. connectToAnalyser(analyser: Analyser): void;
  43394. }
  43395. }
  43396. declare module "babylonjs/Audio/audioSceneComponent" {
  43397. import { Sound } from "babylonjs/Audio/sound";
  43398. import { SoundTrack } from "babylonjs/Audio/soundTrack";
  43399. import { Nullable } from "babylonjs/types";
  43400. import { Vector3 } from "babylonjs/Maths/math.vector";
  43401. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  43402. import { Scene } from "babylonjs/scene";
  43403. import { AbstractScene } from "babylonjs/abstractScene";
  43404. import "babylonjs/Audio/audioEngine";
  43405. module "babylonjs/abstractScene" {
  43406. interface AbstractScene {
  43407. /**
  43408. * The list of sounds used in the scene.
  43409. */
  43410. sounds: Nullable<Array<Sound>>;
  43411. }
  43412. }
  43413. module "babylonjs/scene" {
  43414. interface Scene {
  43415. /**
  43416. * @hidden
  43417. * Backing field
  43418. */
  43419. _mainSoundTrack: SoundTrack;
  43420. /**
  43421. * The main sound track played by the scene.
  43422. * It cotains your primary collection of sounds.
  43423. */
  43424. mainSoundTrack: SoundTrack;
  43425. /**
  43426. * The list of sound tracks added to the scene
  43427. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43428. */
  43429. soundTracks: Nullable<Array<SoundTrack>>;
  43430. /**
  43431. * Gets a sound using a given name
  43432. * @param name defines the name to search for
  43433. * @return the found sound or null if not found at all.
  43434. */
  43435. getSoundByName(name: string): Nullable<Sound>;
  43436. /**
  43437. * Gets or sets if audio support is enabled
  43438. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43439. */
  43440. audioEnabled: boolean;
  43441. /**
  43442. * Gets or sets if audio will be output to headphones
  43443. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43444. */
  43445. headphone: boolean;
  43446. /**
  43447. * Gets or sets custom audio listener position provider
  43448. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43449. */
  43450. audioListenerPositionProvider: Nullable<() => Vector3>;
  43451. /**
  43452. * Gets or sets a refresh rate when using 3D audio positioning
  43453. */
  43454. audioPositioningRefreshRate: number;
  43455. }
  43456. }
  43457. /**
  43458. * Defines the sound scene component responsible to manage any sounds
  43459. * in a given scene.
  43460. */
  43461. export class AudioSceneComponent implements ISceneSerializableComponent {
  43462. /**
  43463. * The component name helpfull to identify the component in the list of scene components.
  43464. */
  43465. readonly name: string;
  43466. /**
  43467. * The scene the component belongs to.
  43468. */
  43469. scene: Scene;
  43470. private _audioEnabled;
  43471. /**
  43472. * Gets whether audio is enabled or not.
  43473. * Please use related enable/disable method to switch state.
  43474. */
  43475. get audioEnabled(): boolean;
  43476. private _headphone;
  43477. /**
  43478. * Gets whether audio is outputing to headphone or not.
  43479. * Please use the according Switch methods to change output.
  43480. */
  43481. get headphone(): boolean;
  43482. /**
  43483. * Gets or sets a refresh rate when using 3D audio positioning
  43484. */
  43485. audioPositioningRefreshRate: number;
  43486. private _audioListenerPositionProvider;
  43487. /**
  43488. * Gets the current audio listener position provider
  43489. */
  43490. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  43491. /**
  43492. * Sets a custom listener position for all sounds in the scene
  43493. * By default, this is the position of the first active camera
  43494. */
  43495. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  43496. /**
  43497. * Creates a new instance of the component for the given scene
  43498. * @param scene Defines the scene to register the component in
  43499. */
  43500. constructor(scene: Scene);
  43501. /**
  43502. * Registers the component in a given scene
  43503. */
  43504. register(): void;
  43505. /**
  43506. * Rebuilds the elements related to this component in case of
  43507. * context lost for instance.
  43508. */
  43509. rebuild(): void;
  43510. /**
  43511. * Serializes the component data to the specified json object
  43512. * @param serializationObject The object to serialize to
  43513. */
  43514. serialize(serializationObject: any): void;
  43515. /**
  43516. * Adds all the elements from the container to the scene
  43517. * @param container the container holding the elements
  43518. */
  43519. addFromContainer(container: AbstractScene): void;
  43520. /**
  43521. * Removes all the elements in the container from the scene
  43522. * @param container contains the elements to remove
  43523. * @param dispose if the removed element should be disposed (default: false)
  43524. */
  43525. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  43526. /**
  43527. * Disposes the component and the associated ressources.
  43528. */
  43529. dispose(): void;
  43530. /**
  43531. * Disables audio in the associated scene.
  43532. */
  43533. disableAudio(): void;
  43534. /**
  43535. * Enables audio in the associated scene.
  43536. */
  43537. enableAudio(): void;
  43538. /**
  43539. * Switch audio to headphone output.
  43540. */
  43541. switchAudioModeForHeadphones(): void;
  43542. /**
  43543. * Switch audio to normal speakers.
  43544. */
  43545. switchAudioModeForNormalSpeakers(): void;
  43546. private _cachedCameraDirection;
  43547. private _cachedCameraPosition;
  43548. private _lastCheck;
  43549. private _afterRender;
  43550. }
  43551. }
  43552. declare module "babylonjs/Audio/weightedsound" {
  43553. import { Sound } from "babylonjs/Audio/sound";
  43554. /**
  43555. * Wraps one or more Sound objects and selects one with random weight for playback.
  43556. */
  43557. export class WeightedSound {
  43558. /** When true a Sound will be selected and played when the current playing Sound completes. */
  43559. loop: boolean;
  43560. private _coneInnerAngle;
  43561. private _coneOuterAngle;
  43562. private _volume;
  43563. /** A Sound is currently playing. */
  43564. isPlaying: boolean;
  43565. /** A Sound is currently paused. */
  43566. isPaused: boolean;
  43567. private _sounds;
  43568. private _weights;
  43569. private _currentIndex?;
  43570. /**
  43571. * Creates a new WeightedSound from the list of sounds given.
  43572. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  43573. * @param sounds Array of Sounds that will be selected from.
  43574. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  43575. */
  43576. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  43577. /**
  43578. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  43579. */
  43580. get directionalConeInnerAngle(): number;
  43581. /**
  43582. * The size of cone in degress for a directional sound in which there will be no attenuation.
  43583. */
  43584. set directionalConeInnerAngle(value: number);
  43585. /**
  43586. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  43587. * Listener angles between innerAngle and outerAngle will falloff linearly.
  43588. */
  43589. get directionalConeOuterAngle(): number;
  43590. /**
  43591. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  43592. * Listener angles between innerAngle and outerAngle will falloff linearly.
  43593. */
  43594. set directionalConeOuterAngle(value: number);
  43595. /**
  43596. * Playback volume.
  43597. */
  43598. get volume(): number;
  43599. /**
  43600. * Playback volume.
  43601. */
  43602. set volume(value: number);
  43603. private _onended;
  43604. /**
  43605. * Suspend playback
  43606. */
  43607. pause(): void;
  43608. /**
  43609. * Stop playback
  43610. */
  43611. stop(): void;
  43612. /**
  43613. * Start playback.
  43614. * @param startOffset Position the clip head at a specific time in seconds.
  43615. */
  43616. play(startOffset?: number): void;
  43617. }
  43618. }
  43619. declare module "babylonjs/Audio/index" {
  43620. export * from "babylonjs/Audio/analyser";
  43621. export * from "babylonjs/Audio/audioEngine";
  43622. export * from "babylonjs/Audio/audioSceneComponent";
  43623. export * from "babylonjs/Audio/sound";
  43624. export * from "babylonjs/Audio/soundTrack";
  43625. export * from "babylonjs/Audio/weightedsound";
  43626. }
  43627. declare module "babylonjs/Behaviors/Cameras/bouncingBehavior" {
  43628. import { Behavior } from "babylonjs/Behaviors/behavior";
  43629. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43630. import { BackEase } from "babylonjs/Animations/easing";
  43631. /**
  43632. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  43633. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  43634. */
  43635. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  43636. /**
  43637. * Gets the name of the behavior.
  43638. */
  43639. get name(): string;
  43640. /**
  43641. * The easing function used by animations
  43642. */
  43643. static EasingFunction: BackEase;
  43644. /**
  43645. * The easing mode used by animations
  43646. */
  43647. static EasingMode: number;
  43648. /**
  43649. * The duration of the animation, in milliseconds
  43650. */
  43651. transitionDuration: number;
  43652. /**
  43653. * Length of the distance animated by the transition when lower radius is reached
  43654. */
  43655. lowerRadiusTransitionRange: number;
  43656. /**
  43657. * Length of the distance animated by the transition when upper radius is reached
  43658. */
  43659. upperRadiusTransitionRange: number;
  43660. private _autoTransitionRange;
  43661. /**
  43662. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  43663. */
  43664. get autoTransitionRange(): boolean;
  43665. /**
  43666. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  43667. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  43668. */
  43669. set autoTransitionRange(value: boolean);
  43670. private _attachedCamera;
  43671. private _onAfterCheckInputsObserver;
  43672. private _onMeshTargetChangedObserver;
  43673. /**
  43674. * Initializes the behavior.
  43675. */
  43676. init(): void;
  43677. /**
  43678. * Attaches the behavior to its arc rotate camera.
  43679. * @param camera Defines the camera to attach the behavior to
  43680. */
  43681. attach(camera: ArcRotateCamera): void;
  43682. /**
  43683. * Detaches the behavior from its current arc rotate camera.
  43684. */
  43685. detach(): void;
  43686. private _radiusIsAnimating;
  43687. private _radiusBounceTransition;
  43688. private _animatables;
  43689. private _cachedWheelPrecision;
  43690. /**
  43691. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  43692. * @param radiusLimit The limit to check against.
  43693. * @return Bool to indicate if at limit.
  43694. */
  43695. private _isRadiusAtLimit;
  43696. /**
  43697. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  43698. * @param radiusDelta The delta by which to animate to. Can be negative.
  43699. */
  43700. private _applyBoundRadiusAnimation;
  43701. /**
  43702. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  43703. */
  43704. protected _clearAnimationLocks(): void;
  43705. /**
  43706. * Stops and removes all animations that have been applied to the camera
  43707. */
  43708. stopAllAnimations(): void;
  43709. }
  43710. }
  43711. declare module "babylonjs/Behaviors/Cameras/framingBehavior" {
  43712. import { Behavior } from "babylonjs/Behaviors/behavior";
  43713. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43714. import { ExponentialEase } from "babylonjs/Animations/easing";
  43715. import { Nullable } from "babylonjs/types";
  43716. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43717. import { Vector3 } from "babylonjs/Maths/math.vector";
  43718. /**
  43719. * 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.
  43720. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  43721. */
  43722. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  43723. /**
  43724. * Gets the name of the behavior.
  43725. */
  43726. get name(): string;
  43727. private _mode;
  43728. private _radiusScale;
  43729. private _positionScale;
  43730. private _defaultElevation;
  43731. private _elevationReturnTime;
  43732. private _elevationReturnWaitTime;
  43733. private _zoomStopsAnimation;
  43734. private _framingTime;
  43735. /**
  43736. * The easing function used by animations
  43737. */
  43738. static EasingFunction: ExponentialEase;
  43739. /**
  43740. * The easing mode used by animations
  43741. */
  43742. static EasingMode: number;
  43743. /**
  43744. * Sets the current mode used by the behavior
  43745. */
  43746. set mode(mode: number);
  43747. /**
  43748. * Gets current mode used by the behavior.
  43749. */
  43750. get mode(): number;
  43751. /**
  43752. * Sets the scale applied to the radius (1 by default)
  43753. */
  43754. set radiusScale(radius: number);
  43755. /**
  43756. * Gets the scale applied to the radius
  43757. */
  43758. get radiusScale(): number;
  43759. /**
  43760. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  43761. */
  43762. set positionScale(scale: number);
  43763. /**
  43764. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  43765. */
  43766. get positionScale(): number;
  43767. /**
  43768. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  43769. * behaviour is triggered, in radians.
  43770. */
  43771. set defaultElevation(elevation: number);
  43772. /**
  43773. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  43774. * behaviour is triggered, in radians.
  43775. */
  43776. get defaultElevation(): number;
  43777. /**
  43778. * Sets the time (in milliseconds) taken to return to the default beta position.
  43779. * Negative value indicates camera should not return to default.
  43780. */
  43781. set elevationReturnTime(speed: number);
  43782. /**
  43783. * Gets the time (in milliseconds) taken to return to the default beta position.
  43784. * Negative value indicates camera should not return to default.
  43785. */
  43786. get elevationReturnTime(): number;
  43787. /**
  43788. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  43789. */
  43790. set elevationReturnWaitTime(time: number);
  43791. /**
  43792. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  43793. */
  43794. get elevationReturnWaitTime(): number;
  43795. /**
  43796. * Sets the flag that indicates if user zooming should stop animation.
  43797. */
  43798. set zoomStopsAnimation(flag: boolean);
  43799. /**
  43800. * Gets the flag that indicates if user zooming should stop animation.
  43801. */
  43802. get zoomStopsAnimation(): boolean;
  43803. /**
  43804. * Sets the transition time when framing the mesh, in milliseconds
  43805. */
  43806. set framingTime(time: number);
  43807. /**
  43808. * Gets the transition time when framing the mesh, in milliseconds
  43809. */
  43810. get framingTime(): number;
  43811. /**
  43812. * Define if the behavior should automatically change the configured
  43813. * camera limits and sensibilities.
  43814. */
  43815. autoCorrectCameraLimitsAndSensibility: boolean;
  43816. private _onPrePointerObservableObserver;
  43817. private _onAfterCheckInputsObserver;
  43818. private _onMeshTargetChangedObserver;
  43819. private _attachedCamera;
  43820. private _isPointerDown;
  43821. private _lastInteractionTime;
  43822. /**
  43823. * Initializes the behavior.
  43824. */
  43825. init(): void;
  43826. /**
  43827. * Attaches the behavior to its arc rotate camera.
  43828. * @param camera Defines the camera to attach the behavior to
  43829. */
  43830. attach(camera: ArcRotateCamera): void;
  43831. /**
  43832. * Detaches the behavior from its current arc rotate camera.
  43833. */
  43834. detach(): void;
  43835. private _animatables;
  43836. private _betaIsAnimating;
  43837. private _betaTransition;
  43838. private _radiusTransition;
  43839. private _vectorTransition;
  43840. /**
  43841. * Targets the given mesh and updates zoom level accordingly.
  43842. * @param mesh The mesh to target.
  43843. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43844. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43845. */
  43846. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43847. /**
  43848. * Targets the given mesh with its children and updates zoom level accordingly.
  43849. * @param mesh The mesh to target.
  43850. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43851. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43852. */
  43853. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43854. /**
  43855. * Targets the given meshes with their children and updates zoom level accordingly.
  43856. * @param meshes The mesh to target.
  43857. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43858. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43859. */
  43860. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43861. /**
  43862. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  43863. * @param minimumWorld Determines the smaller position of the bounding box extend
  43864. * @param maximumWorld Determines the bigger position of the bounding box extend
  43865. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43866. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43867. */
  43868. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43869. /**
  43870. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  43871. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  43872. * frustum width.
  43873. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  43874. * to fully enclose the mesh in the viewing frustum.
  43875. */
  43876. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  43877. /**
  43878. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  43879. * is automatically returned to its default position (expected to be above ground plane).
  43880. */
  43881. private _maintainCameraAboveGround;
  43882. /**
  43883. * Returns the frustum slope based on the canvas ratio and camera FOV
  43884. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  43885. */
  43886. private _getFrustumSlope;
  43887. /**
  43888. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  43889. */
  43890. private _clearAnimationLocks;
  43891. /**
  43892. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  43893. */
  43894. private _applyUserInteraction;
  43895. /**
  43896. * Stops and removes all animations that have been applied to the camera
  43897. */
  43898. stopAllAnimations(): void;
  43899. /**
  43900. * Gets a value indicating if the user is moving the camera
  43901. */
  43902. get isUserIsMoving(): boolean;
  43903. /**
  43904. * The camera can move all the way towards the mesh.
  43905. */
  43906. static IgnoreBoundsSizeMode: number;
  43907. /**
  43908. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  43909. */
  43910. static FitFrustumSidesMode: number;
  43911. }
  43912. }
  43913. declare module "babylonjs/Cameras/Inputs/BaseCameraPointersInput" {
  43914. import { Nullable } from "babylonjs/types";
  43915. import { Camera } from "babylonjs/Cameras/camera";
  43916. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  43917. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  43918. /**
  43919. * Base class for Camera Pointer Inputs.
  43920. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  43921. * for example usage.
  43922. */
  43923. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  43924. /**
  43925. * Defines the camera the input is attached to.
  43926. */
  43927. abstract camera: Camera;
  43928. /**
  43929. * Whether keyboard modifier keys are pressed at time of last mouse event.
  43930. */
  43931. protected _altKey: boolean;
  43932. protected _ctrlKey: boolean;
  43933. protected _metaKey: boolean;
  43934. protected _shiftKey: boolean;
  43935. /**
  43936. * Which mouse buttons were pressed at time of last mouse event.
  43937. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  43938. */
  43939. protected _buttonsPressed: number;
  43940. /**
  43941. * Defines the buttons associated with the input to handle camera move.
  43942. */
  43943. buttons: number[];
  43944. /**
  43945. * Attach the input controls to a specific dom element to get the input from.
  43946. * @param element Defines the element the controls should be listened from
  43947. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  43948. */
  43949. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  43950. /**
  43951. * Detach the current controls from the specified dom element.
  43952. * @param element Defines the element to stop listening the inputs from
  43953. */
  43954. detachControl(element: Nullable<HTMLElement>): void;
  43955. /**
  43956. * Gets the class name of the current input.
  43957. * @returns the class name
  43958. */
  43959. getClassName(): string;
  43960. /**
  43961. * Get the friendly name associated with the input class.
  43962. * @returns the input friendly name
  43963. */
  43964. getSimpleName(): string;
  43965. /**
  43966. * Called on pointer POINTERDOUBLETAP event.
  43967. * Override this method to provide functionality on POINTERDOUBLETAP event.
  43968. */
  43969. protected onDoubleTap(type: string): void;
  43970. /**
  43971. * Called on pointer POINTERMOVE event if only a single touch is active.
  43972. * Override this method to provide functionality.
  43973. */
  43974. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  43975. /**
  43976. * Called on pointer POINTERMOVE event if multiple touches are active.
  43977. * Override this method to provide functionality.
  43978. */
  43979. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  43980. /**
  43981. * Called on JS contextmenu event.
  43982. * Override this method to provide functionality.
  43983. */
  43984. protected onContextMenu(evt: PointerEvent): void;
  43985. /**
  43986. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  43987. * press.
  43988. * Override this method to provide functionality.
  43989. */
  43990. protected onButtonDown(evt: PointerEvent): void;
  43991. /**
  43992. * Called each time a new POINTERUP event occurs. Ie, for each button
  43993. * release.
  43994. * Override this method to provide functionality.
  43995. */
  43996. protected onButtonUp(evt: PointerEvent): void;
  43997. /**
  43998. * Called when window becomes inactive.
  43999. * Override this method to provide functionality.
  44000. */
  44001. protected onLostFocus(): void;
  44002. private _pointerInput;
  44003. private _observer;
  44004. private _onLostFocus;
  44005. private pointA;
  44006. private pointB;
  44007. }
  44008. }
  44009. declare module "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput" {
  44010. import { Nullable } from "babylonjs/types";
  44011. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44012. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  44013. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  44014. /**
  44015. * Manage the pointers inputs to control an arc rotate camera.
  44016. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44017. */
  44018. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  44019. /**
  44020. * Defines the camera the input is attached to.
  44021. */
  44022. camera: ArcRotateCamera;
  44023. /**
  44024. * Gets the class name of the current input.
  44025. * @returns the class name
  44026. */
  44027. getClassName(): string;
  44028. /**
  44029. * Defines the buttons associated with the input to handle camera move.
  44030. */
  44031. buttons: number[];
  44032. /**
  44033. * Defines the pointer angular sensibility along the X axis or how fast is
  44034. * the camera rotating.
  44035. */
  44036. angularSensibilityX: number;
  44037. /**
  44038. * Defines the pointer angular sensibility along the Y axis or how fast is
  44039. * the camera rotating.
  44040. */
  44041. angularSensibilityY: number;
  44042. /**
  44043. * Defines the pointer pinch precision or how fast is the camera zooming.
  44044. */
  44045. pinchPrecision: number;
  44046. /**
  44047. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  44048. * from 0.
  44049. * It defines the percentage of current camera.radius to use as delta when
  44050. * pinch zoom is used.
  44051. */
  44052. pinchDeltaPercentage: number;
  44053. /**
  44054. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  44055. * that any object in the plane at the camera's target point will scale
  44056. * perfectly with finger motion.
  44057. * Overrides pinchDeltaPercentage and pinchPrecision.
  44058. */
  44059. useNaturalPinchZoom: boolean;
  44060. /**
  44061. * Defines the pointer panning sensibility or how fast is the camera moving.
  44062. */
  44063. panningSensibility: number;
  44064. /**
  44065. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  44066. */
  44067. multiTouchPanning: boolean;
  44068. /**
  44069. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  44070. * zoom (pinch) through multitouch.
  44071. */
  44072. multiTouchPanAndZoom: boolean;
  44073. /**
  44074. * Revers pinch action direction.
  44075. */
  44076. pinchInwards: boolean;
  44077. private _isPanClick;
  44078. private _twoFingerActivityCount;
  44079. private _isPinching;
  44080. /**
  44081. * Called on pointer POINTERMOVE event if only a single touch is active.
  44082. */
  44083. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  44084. /**
  44085. * Called on pointer POINTERDOUBLETAP event.
  44086. */
  44087. protected onDoubleTap(type: string): void;
  44088. /**
  44089. * Called on pointer POINTERMOVE event if multiple touches are active.
  44090. */
  44091. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  44092. /**
  44093. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  44094. * press.
  44095. */
  44096. protected onButtonDown(evt: PointerEvent): void;
  44097. /**
  44098. * Called each time a new POINTERUP event occurs. Ie, for each button
  44099. * release.
  44100. */
  44101. protected onButtonUp(evt: PointerEvent): void;
  44102. /**
  44103. * Called when window becomes inactive.
  44104. */
  44105. protected onLostFocus(): void;
  44106. }
  44107. }
  44108. declare module "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput" {
  44109. import { Nullable } from "babylonjs/types";
  44110. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44111. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44112. /**
  44113. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  44114. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44115. */
  44116. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  44117. /**
  44118. * Defines the camera the input is attached to.
  44119. */
  44120. camera: ArcRotateCamera;
  44121. /**
  44122. * Defines the list of key codes associated with the up action (increase alpha)
  44123. */
  44124. keysUp: number[];
  44125. /**
  44126. * Defines the list of key codes associated with the down action (decrease alpha)
  44127. */
  44128. keysDown: number[];
  44129. /**
  44130. * Defines the list of key codes associated with the left action (increase beta)
  44131. */
  44132. keysLeft: number[];
  44133. /**
  44134. * Defines the list of key codes associated with the right action (decrease beta)
  44135. */
  44136. keysRight: number[];
  44137. /**
  44138. * Defines the list of key codes associated with the reset action.
  44139. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  44140. */
  44141. keysReset: number[];
  44142. /**
  44143. * Defines the panning sensibility of the inputs.
  44144. * (How fast is the camera panning)
  44145. */
  44146. panningSensibility: number;
  44147. /**
  44148. * Defines the zooming sensibility of the inputs.
  44149. * (How fast is the camera zooming)
  44150. */
  44151. zoomingSensibility: number;
  44152. /**
  44153. * Defines whether maintaining the alt key down switch the movement mode from
  44154. * orientation to zoom.
  44155. */
  44156. useAltToZoom: boolean;
  44157. /**
  44158. * Rotation speed of the camera
  44159. */
  44160. angularSpeed: number;
  44161. private _keys;
  44162. private _ctrlPressed;
  44163. private _altPressed;
  44164. private _onCanvasBlurObserver;
  44165. private _onKeyboardObserver;
  44166. private _engine;
  44167. private _scene;
  44168. /**
  44169. * Attach the input controls to a specific dom element to get the input from.
  44170. * @param element Defines the element the controls should be listened from
  44171. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44172. */
  44173. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44174. /**
  44175. * Detach the current controls from the specified dom element.
  44176. * @param element Defines the element to stop listening the inputs from
  44177. */
  44178. detachControl(element: Nullable<HTMLElement>): void;
  44179. /**
  44180. * Update the current camera state depending on the inputs that have been used this frame.
  44181. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  44182. */
  44183. checkInputs(): void;
  44184. /**
  44185. * Gets the class name of the current intput.
  44186. * @returns the class name
  44187. */
  44188. getClassName(): string;
  44189. /**
  44190. * Get the friendly name associated with the input class.
  44191. * @returns the input friendly name
  44192. */
  44193. getSimpleName(): string;
  44194. }
  44195. }
  44196. declare module "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput" {
  44197. import { Nullable } from "babylonjs/types";
  44198. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44199. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44200. /**
  44201. * Manage the mouse wheel inputs to control an arc rotate camera.
  44202. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44203. */
  44204. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  44205. /**
  44206. * Defines the camera the input is attached to.
  44207. */
  44208. camera: ArcRotateCamera;
  44209. /**
  44210. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  44211. */
  44212. wheelPrecision: number;
  44213. /**
  44214. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  44215. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  44216. */
  44217. wheelDeltaPercentage: number;
  44218. private _wheel;
  44219. private _observer;
  44220. private computeDeltaFromMouseWheelLegacyEvent;
  44221. /**
  44222. * Attach the input controls to a specific dom element to get the input from.
  44223. * @param element Defines the element the controls should be listened from
  44224. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44225. */
  44226. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44227. /**
  44228. * Detach the current controls from the specified dom element.
  44229. * @param element Defines the element to stop listening the inputs from
  44230. */
  44231. detachControl(element: Nullable<HTMLElement>): void;
  44232. /**
  44233. * Gets the class name of the current intput.
  44234. * @returns the class name
  44235. */
  44236. getClassName(): string;
  44237. /**
  44238. * Get the friendly name associated with the input class.
  44239. * @returns the input friendly name
  44240. */
  44241. getSimpleName(): string;
  44242. }
  44243. }
  44244. declare module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  44245. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44246. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  44247. /**
  44248. * Default Inputs manager for the ArcRotateCamera.
  44249. * It groups all the default supported inputs for ease of use.
  44250. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44251. */
  44252. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  44253. /**
  44254. * Instantiates a new ArcRotateCameraInputsManager.
  44255. * @param camera Defines the camera the inputs belong to
  44256. */
  44257. constructor(camera: ArcRotateCamera);
  44258. /**
  44259. * Add mouse wheel input support to the input manager.
  44260. * @returns the current input manager
  44261. */
  44262. addMouseWheel(): ArcRotateCameraInputsManager;
  44263. /**
  44264. * Add pointers input support to the input manager.
  44265. * @returns the current input manager
  44266. */
  44267. addPointers(): ArcRotateCameraInputsManager;
  44268. /**
  44269. * Add keyboard input support to the input manager.
  44270. * @returns the current input manager
  44271. */
  44272. addKeyboard(): ArcRotateCameraInputsManager;
  44273. }
  44274. }
  44275. declare module "babylonjs/Cameras/arcRotateCamera" {
  44276. import { Observable } from "babylonjs/Misc/observable";
  44277. import { Nullable } from "babylonjs/types";
  44278. import { Scene } from "babylonjs/scene";
  44279. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  44280. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44281. import { AutoRotationBehavior } from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  44282. import { BouncingBehavior } from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  44283. import { FramingBehavior } from "babylonjs/Behaviors/Cameras/framingBehavior";
  44284. import { Camera } from "babylonjs/Cameras/camera";
  44285. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  44286. import { ArcRotateCameraInputsManager } from "babylonjs/Cameras/arcRotateCameraInputsManager";
  44287. import { Collider } from "babylonjs/Collisions/collider";
  44288. /**
  44289. * This represents an orbital type of camera.
  44290. *
  44291. * 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.
  44292. * 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.
  44293. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  44294. */
  44295. export class ArcRotateCamera extends TargetCamera {
  44296. /**
  44297. * Defines the rotation angle of the camera along the longitudinal axis.
  44298. */
  44299. alpha: number;
  44300. /**
  44301. * Defines the rotation angle of the camera along the latitudinal axis.
  44302. */
  44303. beta: number;
  44304. /**
  44305. * Defines the radius of the camera from it s target point.
  44306. */
  44307. radius: number;
  44308. protected _target: Vector3;
  44309. protected _targetHost: Nullable<AbstractMesh>;
  44310. /**
  44311. * Defines the target point of the camera.
  44312. * The camera looks towards it form the radius distance.
  44313. * Please note that you can set the target to a mesh and thus the target will be copied from mesh.position
  44314. */
  44315. get target(): Vector3;
  44316. set target(value: Vector3);
  44317. /**
  44318. * Define the current local position of the camera in the scene
  44319. */
  44320. get position(): Vector3;
  44321. set position(newPosition: Vector3);
  44322. protected _upToYMatrix: Matrix;
  44323. protected _YToUpMatrix: Matrix;
  44324. /**
  44325. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  44326. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  44327. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  44328. */
  44329. set upVector(vec: Vector3);
  44330. get upVector(): Vector3;
  44331. /**
  44332. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  44333. */
  44334. setMatUp(): void;
  44335. /**
  44336. * Current inertia value on the longitudinal axis.
  44337. * The bigger this number the longer it will take for the camera to stop.
  44338. */
  44339. inertialAlphaOffset: number;
  44340. /**
  44341. * Current inertia value on the latitudinal axis.
  44342. * The bigger this number the longer it will take for the camera to stop.
  44343. */
  44344. inertialBetaOffset: number;
  44345. /**
  44346. * Current inertia value on the radius axis.
  44347. * The bigger this number the longer it will take for the camera to stop.
  44348. */
  44349. inertialRadiusOffset: number;
  44350. /**
  44351. * Minimum allowed angle on the longitudinal axis.
  44352. * This can help limiting how the Camera is able to move in the scene.
  44353. */
  44354. lowerAlphaLimit: Nullable<number>;
  44355. /**
  44356. * Maximum allowed angle on the longitudinal axis.
  44357. * This can help limiting how the Camera is able to move in the scene.
  44358. */
  44359. upperAlphaLimit: Nullable<number>;
  44360. /**
  44361. * Minimum allowed angle on the latitudinal axis.
  44362. * This can help limiting how the Camera is able to move in the scene.
  44363. */
  44364. lowerBetaLimit: number;
  44365. /**
  44366. * Maximum allowed angle on the latitudinal axis.
  44367. * This can help limiting how the Camera is able to move in the scene.
  44368. */
  44369. upperBetaLimit: number;
  44370. /**
  44371. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  44372. * This can help limiting how the Camera is able to move in the scene.
  44373. */
  44374. lowerRadiusLimit: Nullable<number>;
  44375. /**
  44376. * Maximum allowed distance of the camera to the target (The camera can not get further).
  44377. * This can help limiting how the Camera is able to move in the scene.
  44378. */
  44379. upperRadiusLimit: Nullable<number>;
  44380. /**
  44381. * Defines the current inertia value used during panning of the camera along the X axis.
  44382. */
  44383. inertialPanningX: number;
  44384. /**
  44385. * Defines the current inertia value used during panning of the camera along the Y axis.
  44386. */
  44387. inertialPanningY: number;
  44388. /**
  44389. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  44390. * Basically if your fingers moves away from more than this distance you will be considered
  44391. * in pinch mode.
  44392. */
  44393. pinchToPanMaxDistance: number;
  44394. /**
  44395. * Defines the maximum distance the camera can pan.
  44396. * This could help keeping the cammera always in your scene.
  44397. */
  44398. panningDistanceLimit: Nullable<number>;
  44399. /**
  44400. * Defines the target of the camera before paning.
  44401. */
  44402. panningOriginTarget: Vector3;
  44403. /**
  44404. * Defines the value of the inertia used during panning.
  44405. * 0 would mean stop inertia and one would mean no decelleration at all.
  44406. */
  44407. panningInertia: number;
  44408. /**
  44409. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  44410. */
  44411. get angularSensibilityX(): number;
  44412. set angularSensibilityX(value: number);
  44413. /**
  44414. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  44415. */
  44416. get angularSensibilityY(): number;
  44417. set angularSensibilityY(value: number);
  44418. /**
  44419. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  44420. */
  44421. get pinchPrecision(): number;
  44422. set pinchPrecision(value: number);
  44423. /**
  44424. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  44425. * It will be used instead of pinchDeltaPrecision if different from 0.
  44426. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  44427. */
  44428. get pinchDeltaPercentage(): number;
  44429. set pinchDeltaPercentage(value: number);
  44430. /**
  44431. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  44432. * and pinch delta percentage.
  44433. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  44434. * that any object in the plane at the camera's target point will scale
  44435. * perfectly with finger motion.
  44436. */
  44437. get useNaturalPinchZoom(): boolean;
  44438. set useNaturalPinchZoom(value: boolean);
  44439. /**
  44440. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  44441. */
  44442. get panningSensibility(): number;
  44443. set panningSensibility(value: number);
  44444. /**
  44445. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  44446. */
  44447. get keysUp(): number[];
  44448. set keysUp(value: number[]);
  44449. /**
  44450. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  44451. */
  44452. get keysDown(): number[];
  44453. set keysDown(value: number[]);
  44454. /**
  44455. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  44456. */
  44457. get keysLeft(): number[];
  44458. set keysLeft(value: number[]);
  44459. /**
  44460. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  44461. */
  44462. get keysRight(): number[];
  44463. set keysRight(value: number[]);
  44464. /**
  44465. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  44466. */
  44467. get wheelPrecision(): number;
  44468. set wheelPrecision(value: number);
  44469. /**
  44470. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  44471. * It will be used instead of pinchDeltaPrecision if different from 0.
  44472. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  44473. */
  44474. get wheelDeltaPercentage(): number;
  44475. set wheelDeltaPercentage(value: number);
  44476. /**
  44477. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  44478. */
  44479. zoomOnFactor: number;
  44480. /**
  44481. * Defines a screen offset for the camera position.
  44482. */
  44483. targetScreenOffset: Vector2;
  44484. /**
  44485. * Allows the camera to be completely reversed.
  44486. * If false the camera can not arrive upside down.
  44487. */
  44488. allowUpsideDown: boolean;
  44489. /**
  44490. * Define if double tap/click is used to restore the previously saved state of the camera.
  44491. */
  44492. useInputToRestoreState: boolean;
  44493. /** @hidden */
  44494. _viewMatrix: Matrix;
  44495. /** @hidden */
  44496. _useCtrlForPanning: boolean;
  44497. /** @hidden */
  44498. _panningMouseButton: number;
  44499. /**
  44500. * Defines the input associated to the camera.
  44501. */
  44502. inputs: ArcRotateCameraInputsManager;
  44503. /** @hidden */
  44504. _reset: () => void;
  44505. /**
  44506. * Defines the allowed panning axis.
  44507. */
  44508. panningAxis: Vector3;
  44509. protected _localDirection: Vector3;
  44510. protected _transformedDirection: Vector3;
  44511. private _bouncingBehavior;
  44512. /**
  44513. * Gets the bouncing behavior of the camera if it has been enabled.
  44514. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  44515. */
  44516. get bouncingBehavior(): Nullable<BouncingBehavior>;
  44517. /**
  44518. * Defines if the bouncing behavior of the camera is enabled on the camera.
  44519. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  44520. */
  44521. get useBouncingBehavior(): boolean;
  44522. set useBouncingBehavior(value: boolean);
  44523. private _framingBehavior;
  44524. /**
  44525. * Gets the framing behavior of the camera if it has been enabled.
  44526. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  44527. */
  44528. get framingBehavior(): Nullable<FramingBehavior>;
  44529. /**
  44530. * Defines if the framing behavior of the camera is enabled on the camera.
  44531. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  44532. */
  44533. get useFramingBehavior(): boolean;
  44534. set useFramingBehavior(value: boolean);
  44535. private _autoRotationBehavior;
  44536. /**
  44537. * Gets the auto rotation behavior of the camera if it has been enabled.
  44538. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44539. */
  44540. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  44541. /**
  44542. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  44543. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44544. */
  44545. get useAutoRotationBehavior(): boolean;
  44546. set useAutoRotationBehavior(value: boolean);
  44547. /**
  44548. * Observable triggered when the mesh target has been changed on the camera.
  44549. */
  44550. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  44551. /**
  44552. * Event raised when the camera is colliding with a mesh.
  44553. */
  44554. onCollide: (collidedMesh: AbstractMesh) => void;
  44555. /**
  44556. * Defines whether the camera should check collision with the objects oh the scene.
  44557. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  44558. */
  44559. checkCollisions: boolean;
  44560. /**
  44561. * Defines the collision radius of the camera.
  44562. * This simulates a sphere around the camera.
  44563. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  44564. */
  44565. collisionRadius: Vector3;
  44566. protected _collider: Collider;
  44567. protected _previousPosition: Vector3;
  44568. protected _collisionVelocity: Vector3;
  44569. protected _newPosition: Vector3;
  44570. protected _previousAlpha: number;
  44571. protected _previousBeta: number;
  44572. protected _previousRadius: number;
  44573. protected _collisionTriggered: boolean;
  44574. protected _targetBoundingCenter: Nullable<Vector3>;
  44575. private _computationVector;
  44576. /**
  44577. * Instantiates a new ArcRotateCamera in a given scene
  44578. * @param name Defines the name of the camera
  44579. * @param alpha Defines the camera rotation along the logitudinal axis
  44580. * @param beta Defines the camera rotation along the latitudinal axis
  44581. * @param radius Defines the camera distance from its target
  44582. * @param target Defines the camera target
  44583. * @param scene Defines the scene the camera belongs to
  44584. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  44585. */
  44586. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  44587. /** @hidden */
  44588. _initCache(): void;
  44589. /** @hidden */
  44590. _updateCache(ignoreParentClass?: boolean): void;
  44591. protected _getTargetPosition(): Vector3;
  44592. private _storedAlpha;
  44593. private _storedBeta;
  44594. private _storedRadius;
  44595. private _storedTarget;
  44596. private _storedTargetScreenOffset;
  44597. /**
  44598. * Stores the current state of the camera (alpha, beta, radius and target)
  44599. * @returns the camera itself
  44600. */
  44601. storeState(): Camera;
  44602. /**
  44603. * @hidden
  44604. * Restored camera state. You must call storeState() first
  44605. */
  44606. _restoreStateValues(): boolean;
  44607. /** @hidden */
  44608. _isSynchronizedViewMatrix(): boolean;
  44609. /**
  44610. * Attached controls to the current camera.
  44611. * @param element Defines the element the controls should be listened from
  44612. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44613. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  44614. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  44615. */
  44616. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  44617. /**
  44618. * Detach the current controls from the camera.
  44619. * The camera will stop reacting to inputs.
  44620. * @param element Defines the element to stop listening the inputs from
  44621. */
  44622. detachControl(element: HTMLElement): void;
  44623. /** @hidden */
  44624. _checkInputs(): void;
  44625. protected _checkLimits(): void;
  44626. /**
  44627. * Rebuilds angles (alpha, beta) and radius from the give position and target
  44628. */
  44629. rebuildAnglesAndRadius(): void;
  44630. /**
  44631. * Use a position to define the current camera related information like alpha, beta and radius
  44632. * @param position Defines the position to set the camera at
  44633. */
  44634. setPosition(position: Vector3): void;
  44635. /**
  44636. * Defines the target the camera should look at.
  44637. * This will automatically adapt alpha beta and radius to fit within the new target.
  44638. * @param target Defines the new target as a Vector or a mesh
  44639. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  44640. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  44641. */
  44642. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  44643. /** @hidden */
  44644. _getViewMatrix(): Matrix;
  44645. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  44646. /**
  44647. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  44648. * @param meshes Defines the mesh to zoom on
  44649. * @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)
  44650. */
  44651. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  44652. /**
  44653. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  44654. * The target will be changed but the radius
  44655. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  44656. * @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)
  44657. */
  44658. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  44659. min: Vector3;
  44660. max: Vector3;
  44661. distance: number;
  44662. }, doNotUpdateMaxZ?: boolean): void;
  44663. /**
  44664. * @override
  44665. * Override Camera.createRigCamera
  44666. */
  44667. createRigCamera(name: string, cameraIndex: number): Camera;
  44668. /**
  44669. * @hidden
  44670. * @override
  44671. * Override Camera._updateRigCameras
  44672. */
  44673. _updateRigCameras(): void;
  44674. /**
  44675. * Destroy the camera and release the current resources hold by it.
  44676. */
  44677. dispose(): void;
  44678. /**
  44679. * Gets the current object class name.
  44680. * @return the class name
  44681. */
  44682. getClassName(): string;
  44683. }
  44684. }
  44685. declare module "babylonjs/Behaviors/Cameras/autoRotationBehavior" {
  44686. import { Behavior } from "babylonjs/Behaviors/behavior";
  44687. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44688. /**
  44689. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  44690. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44691. */
  44692. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  44693. /**
  44694. * Gets the name of the behavior.
  44695. */
  44696. get name(): string;
  44697. private _zoomStopsAnimation;
  44698. private _idleRotationSpeed;
  44699. private _idleRotationWaitTime;
  44700. private _idleRotationSpinupTime;
  44701. /**
  44702. * Sets the flag that indicates if user zooming should stop animation.
  44703. */
  44704. set zoomStopsAnimation(flag: boolean);
  44705. /**
  44706. * Gets the flag that indicates if user zooming should stop animation.
  44707. */
  44708. get zoomStopsAnimation(): boolean;
  44709. /**
  44710. * Sets the default speed at which the camera rotates around the model.
  44711. */
  44712. set idleRotationSpeed(speed: number);
  44713. /**
  44714. * Gets the default speed at which the camera rotates around the model.
  44715. */
  44716. get idleRotationSpeed(): number;
  44717. /**
  44718. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  44719. */
  44720. set idleRotationWaitTime(time: number);
  44721. /**
  44722. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  44723. */
  44724. get idleRotationWaitTime(): number;
  44725. /**
  44726. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  44727. */
  44728. set idleRotationSpinupTime(time: number);
  44729. /**
  44730. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  44731. */
  44732. get idleRotationSpinupTime(): number;
  44733. /**
  44734. * Gets a value indicating if the camera is currently rotating because of this behavior
  44735. */
  44736. get rotationInProgress(): boolean;
  44737. private _onPrePointerObservableObserver;
  44738. private _onAfterCheckInputsObserver;
  44739. private _attachedCamera;
  44740. private _isPointerDown;
  44741. private _lastFrameTime;
  44742. private _lastInteractionTime;
  44743. private _cameraRotationSpeed;
  44744. /**
  44745. * Initializes the behavior.
  44746. */
  44747. init(): void;
  44748. /**
  44749. * Attaches the behavior to its arc rotate camera.
  44750. * @param camera Defines the camera to attach the behavior to
  44751. */
  44752. attach(camera: ArcRotateCamera): void;
  44753. /**
  44754. * Detaches the behavior from its current arc rotate camera.
  44755. */
  44756. detach(): void;
  44757. /**
  44758. * Returns true if user is scrolling.
  44759. * @return true if user is scrolling.
  44760. */
  44761. private _userIsZooming;
  44762. private _lastFrameRadius;
  44763. private _shouldAnimationStopForInteraction;
  44764. /**
  44765. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  44766. */
  44767. private _applyUserInteraction;
  44768. private _userIsMoving;
  44769. }
  44770. }
  44771. declare module "babylonjs/Behaviors/Cameras/index" {
  44772. export * from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  44773. export * from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  44774. export * from "babylonjs/Behaviors/Cameras/framingBehavior";
  44775. }
  44776. declare module "babylonjs/Behaviors/Meshes/attachToBoxBehavior" {
  44777. import { Mesh } from "babylonjs/Meshes/mesh";
  44778. import { TransformNode } from "babylonjs/Meshes/transformNode";
  44779. import { Behavior } from "babylonjs/Behaviors/behavior";
  44780. /**
  44781. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  44782. */
  44783. export class AttachToBoxBehavior implements Behavior<Mesh> {
  44784. private ui;
  44785. /**
  44786. * The name of the behavior
  44787. */
  44788. name: string;
  44789. /**
  44790. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  44791. */
  44792. distanceAwayFromFace: number;
  44793. /**
  44794. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  44795. */
  44796. distanceAwayFromBottomOfFace: number;
  44797. private _faceVectors;
  44798. private _target;
  44799. private _scene;
  44800. private _onRenderObserver;
  44801. private _tmpMatrix;
  44802. private _tmpVector;
  44803. /**
  44804. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  44805. * @param ui The transform node that should be attched to the mesh
  44806. */
  44807. constructor(ui: TransformNode);
  44808. /**
  44809. * Initializes the behavior
  44810. */
  44811. init(): void;
  44812. private _closestFace;
  44813. private _zeroVector;
  44814. private _lookAtTmpMatrix;
  44815. private _lookAtToRef;
  44816. /**
  44817. * Attaches the AttachToBoxBehavior to the passed in mesh
  44818. * @param target The mesh that the specified node will be attached to
  44819. */
  44820. attach(target: Mesh): void;
  44821. /**
  44822. * Detaches the behavior from the mesh
  44823. */
  44824. detach(): void;
  44825. }
  44826. }
  44827. declare module "babylonjs/Behaviors/Meshes/fadeInOutBehavior" {
  44828. import { Behavior } from "babylonjs/Behaviors/behavior";
  44829. import { Mesh } from "babylonjs/Meshes/mesh";
  44830. /**
  44831. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  44832. */
  44833. export class FadeInOutBehavior implements Behavior<Mesh> {
  44834. /**
  44835. * Time in milliseconds to delay before fading in (Default: 0)
  44836. */
  44837. delay: number;
  44838. /**
  44839. * Time in milliseconds for the mesh to fade in (Default: 300)
  44840. */
  44841. fadeInTime: number;
  44842. private _millisecondsPerFrame;
  44843. private _hovered;
  44844. private _hoverValue;
  44845. private _ownerNode;
  44846. /**
  44847. * Instatiates the FadeInOutBehavior
  44848. */
  44849. constructor();
  44850. /**
  44851. * The name of the behavior
  44852. */
  44853. get name(): string;
  44854. /**
  44855. * Initializes the behavior
  44856. */
  44857. init(): void;
  44858. /**
  44859. * Attaches the fade behavior on the passed in mesh
  44860. * @param ownerNode The mesh that will be faded in/out once attached
  44861. */
  44862. attach(ownerNode: Mesh): void;
  44863. /**
  44864. * Detaches the behavior from the mesh
  44865. */
  44866. detach(): void;
  44867. /**
  44868. * Triggers the mesh to begin fading in or out
  44869. * @param value if the object should fade in or out (true to fade in)
  44870. */
  44871. fadeIn(value: boolean): void;
  44872. private _update;
  44873. private _setAllVisibility;
  44874. }
  44875. }
  44876. declare module "babylonjs/Misc/pivotTools" {
  44877. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44878. /**
  44879. * Class containing a set of static utilities functions for managing Pivots
  44880. * @hidden
  44881. */
  44882. export class PivotTools {
  44883. private static _PivotCached;
  44884. private static _OldPivotPoint;
  44885. private static _PivotTranslation;
  44886. private static _PivotTmpVector;
  44887. /** @hidden */
  44888. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  44889. /** @hidden */
  44890. static _RestorePivotPoint(mesh: AbstractMesh): void;
  44891. }
  44892. }
  44893. declare module "babylonjs/Meshes/Builders/planeBuilder" {
  44894. import { Scene } from "babylonjs/scene";
  44895. import { Vector4 } from "babylonjs/Maths/math.vector";
  44896. import { Mesh } from "babylonjs/Meshes/mesh";
  44897. import { Nullable } from "babylonjs/types";
  44898. import { Plane } from "babylonjs/Maths/math.plane";
  44899. /**
  44900. * Class containing static functions to help procedurally build meshes
  44901. */
  44902. export class PlaneBuilder {
  44903. /**
  44904. * Creates a plane mesh
  44905. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  44906. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  44907. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  44908. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  44909. * * 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
  44910. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  44911. * @param name defines the name of the mesh
  44912. * @param options defines the options used to create the mesh
  44913. * @param scene defines the hosting scene
  44914. * @returns the plane mesh
  44915. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  44916. */
  44917. static CreatePlane(name: string, options: {
  44918. size?: number;
  44919. width?: number;
  44920. height?: number;
  44921. sideOrientation?: number;
  44922. frontUVs?: Vector4;
  44923. backUVs?: Vector4;
  44924. updatable?: boolean;
  44925. sourcePlane?: Plane;
  44926. }, scene?: Nullable<Scene>): Mesh;
  44927. }
  44928. }
  44929. declare module "babylonjs/Behaviors/Meshes/pointerDragBehavior" {
  44930. import { Behavior } from "babylonjs/Behaviors/behavior";
  44931. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44932. import { Observable } from "babylonjs/Misc/observable";
  44933. import { Vector3 } from "babylonjs/Maths/math.vector";
  44934. import { Ray } from "babylonjs/Culling/ray";
  44935. import "babylonjs/Meshes/Builders/planeBuilder";
  44936. /**
  44937. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  44938. */
  44939. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  44940. private static _AnyMouseID;
  44941. /**
  44942. * Abstract mesh the behavior is set on
  44943. */
  44944. attachedNode: AbstractMesh;
  44945. private _dragPlane;
  44946. private _scene;
  44947. private _pointerObserver;
  44948. private _beforeRenderObserver;
  44949. private static _planeScene;
  44950. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  44951. /**
  44952. * 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)
  44953. */
  44954. maxDragAngle: number;
  44955. /**
  44956. * @hidden
  44957. */
  44958. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  44959. /**
  44960. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  44961. */
  44962. currentDraggingPointerID: number;
  44963. /**
  44964. * The last position where the pointer hit the drag plane in world space
  44965. */
  44966. lastDragPosition: Vector3;
  44967. /**
  44968. * If the behavior is currently in a dragging state
  44969. */
  44970. dragging: boolean;
  44971. /**
  44972. * 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)
  44973. */
  44974. dragDeltaRatio: number;
  44975. /**
  44976. * If the drag plane orientation should be updated during the dragging (Default: true)
  44977. */
  44978. updateDragPlane: boolean;
  44979. private _debugMode;
  44980. private _moving;
  44981. /**
  44982. * Fires each time the attached mesh is dragged with the pointer
  44983. * * delta between last drag position and current drag position in world space
  44984. * * dragDistance along the drag axis
  44985. * * dragPlaneNormal normal of the current drag plane used during the drag
  44986. * * dragPlanePoint in world space where the drag intersects the drag plane
  44987. */
  44988. onDragObservable: Observable<{
  44989. delta: Vector3;
  44990. dragPlanePoint: Vector3;
  44991. dragPlaneNormal: Vector3;
  44992. dragDistance: number;
  44993. pointerId: number;
  44994. }>;
  44995. /**
  44996. * Fires each time a drag begins (eg. mouse down on mesh)
  44997. */
  44998. onDragStartObservable: Observable<{
  44999. dragPlanePoint: Vector3;
  45000. pointerId: number;
  45001. }>;
  45002. /**
  45003. * Fires each time a drag ends (eg. mouse release after drag)
  45004. */
  45005. onDragEndObservable: Observable<{
  45006. dragPlanePoint: Vector3;
  45007. pointerId: number;
  45008. }>;
  45009. /**
  45010. * If the attached mesh should be moved when dragged
  45011. */
  45012. moveAttached: boolean;
  45013. /**
  45014. * If the drag behavior will react to drag events (Default: true)
  45015. */
  45016. enabled: boolean;
  45017. /**
  45018. * If pointer events should start and release the drag (Default: true)
  45019. */
  45020. startAndReleaseDragOnPointerEvents: boolean;
  45021. /**
  45022. * If camera controls should be detached during the drag
  45023. */
  45024. detachCameraControls: boolean;
  45025. /**
  45026. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  45027. */
  45028. useObjectOrientationForDragging: boolean;
  45029. private _options;
  45030. /**
  45031. * Gets the options used by the behavior
  45032. */
  45033. get options(): {
  45034. dragAxis?: Vector3;
  45035. dragPlaneNormal?: Vector3;
  45036. };
  45037. /**
  45038. * Sets the options used by the behavior
  45039. */
  45040. set options(options: {
  45041. dragAxis?: Vector3;
  45042. dragPlaneNormal?: Vector3;
  45043. });
  45044. /**
  45045. * Creates a pointer drag behavior that can be attached to a mesh
  45046. * @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)
  45047. */
  45048. constructor(options?: {
  45049. dragAxis?: Vector3;
  45050. dragPlaneNormal?: Vector3;
  45051. });
  45052. /**
  45053. * Predicate to determine if it is valid to move the object to a new position when it is moved
  45054. */
  45055. validateDrag: (targetPosition: Vector3) => boolean;
  45056. /**
  45057. * The name of the behavior
  45058. */
  45059. get name(): string;
  45060. /**
  45061. * Initializes the behavior
  45062. */
  45063. init(): void;
  45064. private _tmpVector;
  45065. private _alternatePickedPoint;
  45066. private _worldDragAxis;
  45067. private _targetPosition;
  45068. private _attachedElement;
  45069. /**
  45070. * Attaches the drag behavior the passed in mesh
  45071. * @param ownerNode The mesh that will be dragged around once attached
  45072. * @param predicate Predicate to use for pick filtering
  45073. */
  45074. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  45075. /**
  45076. * Force relase the drag action by code.
  45077. */
  45078. releaseDrag(): void;
  45079. private _startDragRay;
  45080. private _lastPointerRay;
  45081. /**
  45082. * Simulates the start of a pointer drag event on the behavior
  45083. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  45084. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  45085. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  45086. */
  45087. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  45088. private _startDrag;
  45089. private _dragDelta;
  45090. private _moveDrag;
  45091. private _pickWithRayOnDragPlane;
  45092. private _pointA;
  45093. private _pointC;
  45094. private _localAxis;
  45095. private _lookAt;
  45096. private _updateDragPlanePosition;
  45097. /**
  45098. * Detaches the behavior from the mesh
  45099. */
  45100. detach(): void;
  45101. }
  45102. }
  45103. declare module "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior" {
  45104. import { Mesh } from "babylonjs/Meshes/mesh";
  45105. import { Behavior } from "babylonjs/Behaviors/behavior";
  45106. /**
  45107. * A behavior that when attached to a mesh will allow the mesh to be scaled
  45108. */
  45109. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  45110. private _dragBehaviorA;
  45111. private _dragBehaviorB;
  45112. private _startDistance;
  45113. private _initialScale;
  45114. private _targetScale;
  45115. private _ownerNode;
  45116. private _sceneRenderObserver;
  45117. /**
  45118. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  45119. */
  45120. constructor();
  45121. /**
  45122. * The name of the behavior
  45123. */
  45124. get name(): string;
  45125. /**
  45126. * Initializes the behavior
  45127. */
  45128. init(): void;
  45129. private _getCurrentDistance;
  45130. /**
  45131. * Attaches the scale behavior the passed in mesh
  45132. * @param ownerNode The mesh that will be scaled around once attached
  45133. */
  45134. attach(ownerNode: Mesh): void;
  45135. /**
  45136. * Detaches the behavior from the mesh
  45137. */
  45138. detach(): void;
  45139. }
  45140. }
  45141. declare module "babylonjs/Behaviors/Meshes/sixDofDragBehavior" {
  45142. import { Behavior } from "babylonjs/Behaviors/behavior";
  45143. import { Mesh } from "babylonjs/Meshes/mesh";
  45144. import { Observable } from "babylonjs/Misc/observable";
  45145. /**
  45146. * 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
  45147. */
  45148. export class SixDofDragBehavior implements Behavior<Mesh> {
  45149. private static _virtualScene;
  45150. private _ownerNode;
  45151. private _sceneRenderObserver;
  45152. private _scene;
  45153. private _targetPosition;
  45154. private _virtualOriginMesh;
  45155. private _virtualDragMesh;
  45156. private _pointerObserver;
  45157. private _moving;
  45158. private _startingOrientation;
  45159. private _attachedElement;
  45160. /**
  45161. * 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)
  45162. */
  45163. private zDragFactor;
  45164. /**
  45165. * If the object should rotate to face the drag origin
  45166. */
  45167. rotateDraggedObject: boolean;
  45168. /**
  45169. * If the behavior is currently in a dragging state
  45170. */
  45171. dragging: boolean;
  45172. /**
  45173. * 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)
  45174. */
  45175. dragDeltaRatio: number;
  45176. /**
  45177. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  45178. */
  45179. currentDraggingPointerID: number;
  45180. /**
  45181. * If camera controls should be detached during the drag
  45182. */
  45183. detachCameraControls: boolean;
  45184. /**
  45185. * Fires each time a drag starts
  45186. */
  45187. onDragStartObservable: Observable<{}>;
  45188. /**
  45189. * Fires each time a drag ends (eg. mouse release after drag)
  45190. */
  45191. onDragEndObservable: Observable<{}>;
  45192. /**
  45193. * 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
  45194. */
  45195. constructor();
  45196. /**
  45197. * The name of the behavior
  45198. */
  45199. get name(): string;
  45200. /**
  45201. * Initializes the behavior
  45202. */
  45203. init(): void;
  45204. /**
  45205. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  45206. */
  45207. private get _pointerCamera();
  45208. /**
  45209. * Attaches the scale behavior the passed in mesh
  45210. * @param ownerNode The mesh that will be scaled around once attached
  45211. */
  45212. attach(ownerNode: Mesh): void;
  45213. /**
  45214. * Detaches the behavior from the mesh
  45215. */
  45216. detach(): void;
  45217. }
  45218. }
  45219. declare module "babylonjs/Behaviors/Meshes/index" {
  45220. export * from "babylonjs/Behaviors/Meshes/attachToBoxBehavior";
  45221. export * from "babylonjs/Behaviors/Meshes/fadeInOutBehavior";
  45222. export * from "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior";
  45223. export * from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  45224. export * from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  45225. }
  45226. declare module "babylonjs/Behaviors/index" {
  45227. export * from "babylonjs/Behaviors/behavior";
  45228. export * from "babylonjs/Behaviors/Cameras/index";
  45229. export * from "babylonjs/Behaviors/Meshes/index";
  45230. }
  45231. declare module "babylonjs/Bones/boneIKController" {
  45232. import { Bone } from "babylonjs/Bones/bone";
  45233. import { Vector3 } from "babylonjs/Maths/math.vector";
  45234. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45235. import { Nullable } from "babylonjs/types";
  45236. /**
  45237. * Class used to apply inverse kinematics to bones
  45238. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  45239. */
  45240. export class BoneIKController {
  45241. private static _tmpVecs;
  45242. private static _tmpQuat;
  45243. private static _tmpMats;
  45244. /**
  45245. * Gets or sets the target mesh
  45246. */
  45247. targetMesh: AbstractMesh;
  45248. /** Gets or sets the mesh used as pole */
  45249. poleTargetMesh: AbstractMesh;
  45250. /**
  45251. * Gets or sets the bone used as pole
  45252. */
  45253. poleTargetBone: Nullable<Bone>;
  45254. /**
  45255. * Gets or sets the target position
  45256. */
  45257. targetPosition: Vector3;
  45258. /**
  45259. * Gets or sets the pole target position
  45260. */
  45261. poleTargetPosition: Vector3;
  45262. /**
  45263. * Gets or sets the pole target local offset
  45264. */
  45265. poleTargetLocalOffset: Vector3;
  45266. /**
  45267. * Gets or sets the pole angle
  45268. */
  45269. poleAngle: number;
  45270. /**
  45271. * Gets or sets the mesh associated with the controller
  45272. */
  45273. mesh: AbstractMesh;
  45274. /**
  45275. * 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)
  45276. */
  45277. slerpAmount: number;
  45278. private _bone1Quat;
  45279. private _bone1Mat;
  45280. private _bone2Ang;
  45281. private _bone1;
  45282. private _bone2;
  45283. private _bone1Length;
  45284. private _bone2Length;
  45285. private _maxAngle;
  45286. private _maxReach;
  45287. private _rightHandedSystem;
  45288. private _bendAxis;
  45289. private _slerping;
  45290. private _adjustRoll;
  45291. /**
  45292. * Gets or sets maximum allowed angle
  45293. */
  45294. get maxAngle(): number;
  45295. set maxAngle(value: number);
  45296. /**
  45297. * Creates a new BoneIKController
  45298. * @param mesh defines the mesh to control
  45299. * @param bone defines the bone to control
  45300. * @param options defines options to set up the controller
  45301. */
  45302. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  45303. targetMesh?: AbstractMesh;
  45304. poleTargetMesh?: AbstractMesh;
  45305. poleTargetBone?: Bone;
  45306. poleTargetLocalOffset?: Vector3;
  45307. poleAngle?: number;
  45308. bendAxis?: Vector3;
  45309. maxAngle?: number;
  45310. slerpAmount?: number;
  45311. });
  45312. private _setMaxAngle;
  45313. /**
  45314. * Force the controller to update the bones
  45315. */
  45316. update(): void;
  45317. }
  45318. }
  45319. declare module "babylonjs/Bones/boneLookController" {
  45320. import { Vector3 } from "babylonjs/Maths/math.vector";
  45321. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45322. import { Bone } from "babylonjs/Bones/bone";
  45323. import { Space } from "babylonjs/Maths/math.axis";
  45324. /**
  45325. * Class used to make a bone look toward a point in space
  45326. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  45327. */
  45328. export class BoneLookController {
  45329. private static _tmpVecs;
  45330. private static _tmpQuat;
  45331. private static _tmpMats;
  45332. /**
  45333. * The target Vector3 that the bone will look at
  45334. */
  45335. target: Vector3;
  45336. /**
  45337. * The mesh that the bone is attached to
  45338. */
  45339. mesh: AbstractMesh;
  45340. /**
  45341. * The bone that will be looking to the target
  45342. */
  45343. bone: Bone;
  45344. /**
  45345. * The up axis of the coordinate system that is used when the bone is rotated
  45346. */
  45347. upAxis: Vector3;
  45348. /**
  45349. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  45350. */
  45351. upAxisSpace: Space;
  45352. /**
  45353. * Used to make an adjustment to the yaw of the bone
  45354. */
  45355. adjustYaw: number;
  45356. /**
  45357. * Used to make an adjustment to the pitch of the bone
  45358. */
  45359. adjustPitch: number;
  45360. /**
  45361. * Used to make an adjustment to the roll of the bone
  45362. */
  45363. adjustRoll: number;
  45364. /**
  45365. * 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)
  45366. */
  45367. slerpAmount: number;
  45368. private _minYaw;
  45369. private _maxYaw;
  45370. private _minPitch;
  45371. private _maxPitch;
  45372. private _minYawSin;
  45373. private _minYawCos;
  45374. private _maxYawSin;
  45375. private _maxYawCos;
  45376. private _midYawConstraint;
  45377. private _minPitchTan;
  45378. private _maxPitchTan;
  45379. private _boneQuat;
  45380. private _slerping;
  45381. private _transformYawPitch;
  45382. private _transformYawPitchInv;
  45383. private _firstFrameSkipped;
  45384. private _yawRange;
  45385. private _fowardAxis;
  45386. /**
  45387. * Gets or sets the minimum yaw angle that the bone can look to
  45388. */
  45389. get minYaw(): number;
  45390. set minYaw(value: number);
  45391. /**
  45392. * Gets or sets the maximum yaw angle that the bone can look to
  45393. */
  45394. get maxYaw(): number;
  45395. set maxYaw(value: number);
  45396. /**
  45397. * Gets or sets the minimum pitch angle that the bone can look to
  45398. */
  45399. get minPitch(): number;
  45400. set minPitch(value: number);
  45401. /**
  45402. * Gets or sets the maximum pitch angle that the bone can look to
  45403. */
  45404. get maxPitch(): number;
  45405. set maxPitch(value: number);
  45406. /**
  45407. * Create a BoneLookController
  45408. * @param mesh the mesh that the bone belongs to
  45409. * @param bone the bone that will be looking to the target
  45410. * @param target the target Vector3 to look at
  45411. * @param options optional settings:
  45412. * * maxYaw: the maximum angle the bone will yaw to
  45413. * * minYaw: the minimum angle the bone will yaw to
  45414. * * maxPitch: the maximum angle the bone will pitch to
  45415. * * minPitch: the minimum angle the bone will yaw to
  45416. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  45417. * * upAxis: the up axis of the coordinate system
  45418. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  45419. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  45420. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  45421. * * adjustYaw: used to make an adjustment to the yaw of the bone
  45422. * * adjustPitch: used to make an adjustment to the pitch of the bone
  45423. * * adjustRoll: used to make an adjustment to the roll of the bone
  45424. **/
  45425. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  45426. maxYaw?: number;
  45427. minYaw?: number;
  45428. maxPitch?: number;
  45429. minPitch?: number;
  45430. slerpAmount?: number;
  45431. upAxis?: Vector3;
  45432. upAxisSpace?: Space;
  45433. yawAxis?: Vector3;
  45434. pitchAxis?: Vector3;
  45435. adjustYaw?: number;
  45436. adjustPitch?: number;
  45437. adjustRoll?: number;
  45438. });
  45439. /**
  45440. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  45441. */
  45442. update(): void;
  45443. private _getAngleDiff;
  45444. private _getAngleBetween;
  45445. private _isAngleBetween;
  45446. }
  45447. }
  45448. declare module "babylonjs/Bones/index" {
  45449. export * from "babylonjs/Bones/bone";
  45450. export * from "babylonjs/Bones/boneIKController";
  45451. export * from "babylonjs/Bones/boneLookController";
  45452. export * from "babylonjs/Bones/skeleton";
  45453. }
  45454. declare module "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput" {
  45455. import { Nullable } from "babylonjs/types";
  45456. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  45457. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45458. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  45459. /**
  45460. * Manage the gamepad inputs to control an arc rotate camera.
  45461. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45462. */
  45463. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  45464. /**
  45465. * Defines the camera the input is attached to.
  45466. */
  45467. camera: ArcRotateCamera;
  45468. /**
  45469. * Defines the gamepad the input is gathering event from.
  45470. */
  45471. gamepad: Nullable<Gamepad>;
  45472. /**
  45473. * Defines the gamepad rotation sensiblity.
  45474. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  45475. */
  45476. gamepadRotationSensibility: number;
  45477. /**
  45478. * Defines the gamepad move sensiblity.
  45479. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  45480. */
  45481. gamepadMoveSensibility: number;
  45482. private _yAxisScale;
  45483. /**
  45484. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  45485. */
  45486. get invertYAxis(): boolean;
  45487. set invertYAxis(value: boolean);
  45488. private _onGamepadConnectedObserver;
  45489. private _onGamepadDisconnectedObserver;
  45490. /**
  45491. * Attach the input controls to a specific dom element to get the input from.
  45492. * @param element Defines the element the controls should be listened from
  45493. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45494. */
  45495. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45496. /**
  45497. * Detach the current controls from the specified dom element.
  45498. * @param element Defines the element to stop listening the inputs from
  45499. */
  45500. detachControl(element: Nullable<HTMLElement>): void;
  45501. /**
  45502. * Update the current camera state depending on the inputs that have been used this frame.
  45503. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45504. */
  45505. checkInputs(): void;
  45506. /**
  45507. * Gets the class name of the current intput.
  45508. * @returns the class name
  45509. */
  45510. getClassName(): string;
  45511. /**
  45512. * Get the friendly name associated with the input class.
  45513. * @returns the input friendly name
  45514. */
  45515. getSimpleName(): string;
  45516. }
  45517. }
  45518. declare module "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput" {
  45519. import { Nullable } from "babylonjs/types";
  45520. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  45521. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45522. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  45523. interface ArcRotateCameraInputsManager {
  45524. /**
  45525. * Add orientation input support to the input manager.
  45526. * @returns the current input manager
  45527. */
  45528. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  45529. }
  45530. }
  45531. /**
  45532. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  45533. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45534. */
  45535. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  45536. /**
  45537. * Defines the camera the input is attached to.
  45538. */
  45539. camera: ArcRotateCamera;
  45540. /**
  45541. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  45542. */
  45543. alphaCorrection: number;
  45544. /**
  45545. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  45546. */
  45547. gammaCorrection: number;
  45548. private _alpha;
  45549. private _gamma;
  45550. private _dirty;
  45551. private _deviceOrientationHandler;
  45552. /**
  45553. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  45554. */
  45555. constructor();
  45556. /**
  45557. * Attach the input controls to a specific dom element to get the input from.
  45558. * @param element Defines the element the controls should be listened from
  45559. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45560. */
  45561. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45562. /** @hidden */
  45563. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  45564. /**
  45565. * Update the current camera state depending on the inputs that have been used this frame.
  45566. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45567. */
  45568. checkInputs(): void;
  45569. /**
  45570. * Detach the current controls from the specified dom element.
  45571. * @param element Defines the element to stop listening the inputs from
  45572. */
  45573. detachControl(element: Nullable<HTMLElement>): void;
  45574. /**
  45575. * Gets the class name of the current intput.
  45576. * @returns the class name
  45577. */
  45578. getClassName(): string;
  45579. /**
  45580. * Get the friendly name associated with the input class.
  45581. * @returns the input friendly name
  45582. */
  45583. getSimpleName(): string;
  45584. }
  45585. }
  45586. declare module "babylonjs/Cameras/Inputs/flyCameraMouseInput" {
  45587. import { Nullable } from "babylonjs/types";
  45588. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45589. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45590. /**
  45591. * Listen to mouse events to control the camera.
  45592. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45593. */
  45594. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  45595. /**
  45596. * Defines the camera the input is attached to.
  45597. */
  45598. camera: FlyCamera;
  45599. /**
  45600. * Defines if touch is enabled. (Default is true.)
  45601. */
  45602. touchEnabled: boolean;
  45603. /**
  45604. * Defines the buttons associated with the input to handle camera rotation.
  45605. */
  45606. buttons: number[];
  45607. /**
  45608. * Assign buttons for Yaw control.
  45609. */
  45610. buttonsYaw: number[];
  45611. /**
  45612. * Assign buttons for Pitch control.
  45613. */
  45614. buttonsPitch: number[];
  45615. /**
  45616. * Assign buttons for Roll control.
  45617. */
  45618. buttonsRoll: number[];
  45619. /**
  45620. * Detect if any button is being pressed while mouse is moved.
  45621. * -1 = Mouse locked.
  45622. * 0 = Left button.
  45623. * 1 = Middle Button.
  45624. * 2 = Right Button.
  45625. */
  45626. activeButton: number;
  45627. /**
  45628. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  45629. * Higher values reduce its sensitivity.
  45630. */
  45631. angularSensibility: number;
  45632. private _mousemoveCallback;
  45633. private _observer;
  45634. private _rollObserver;
  45635. private previousPosition;
  45636. private noPreventDefault;
  45637. private element;
  45638. /**
  45639. * Listen to mouse events to control the camera.
  45640. * @param touchEnabled Define if touch is enabled. (Default is true.)
  45641. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45642. */
  45643. constructor(touchEnabled?: boolean);
  45644. /**
  45645. * Attach the mouse control to the HTML DOM element.
  45646. * @param element Defines the element that listens to the input events.
  45647. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  45648. */
  45649. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45650. /**
  45651. * Detach the current controls from the specified dom element.
  45652. * @param element Defines the element to stop listening the inputs from
  45653. */
  45654. detachControl(element: Nullable<HTMLElement>): void;
  45655. /**
  45656. * Gets the class name of the current input.
  45657. * @returns the class name.
  45658. */
  45659. getClassName(): string;
  45660. /**
  45661. * Get the friendly name associated with the input class.
  45662. * @returns the input's friendly name.
  45663. */
  45664. getSimpleName(): string;
  45665. private _pointerInput;
  45666. private _onMouseMove;
  45667. /**
  45668. * Rotate camera by mouse offset.
  45669. */
  45670. private rotateCamera;
  45671. }
  45672. }
  45673. declare module "babylonjs/Cameras/flyCameraInputsManager" {
  45674. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45675. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  45676. /**
  45677. * Default Inputs manager for the FlyCamera.
  45678. * It groups all the default supported inputs for ease of use.
  45679. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45680. */
  45681. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  45682. /**
  45683. * Instantiates a new FlyCameraInputsManager.
  45684. * @param camera Defines the camera the inputs belong to.
  45685. */
  45686. constructor(camera: FlyCamera);
  45687. /**
  45688. * Add keyboard input support to the input manager.
  45689. * @returns the new FlyCameraKeyboardMoveInput().
  45690. */
  45691. addKeyboard(): FlyCameraInputsManager;
  45692. /**
  45693. * Add mouse input support to the input manager.
  45694. * @param touchEnabled Enable touch screen support.
  45695. * @returns the new FlyCameraMouseInput().
  45696. */
  45697. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  45698. }
  45699. }
  45700. declare module "babylonjs/Cameras/flyCamera" {
  45701. import { Scene } from "babylonjs/scene";
  45702. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  45703. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45704. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  45705. import { FlyCameraInputsManager } from "babylonjs/Cameras/flyCameraInputsManager";
  45706. /**
  45707. * This is a flying camera, designed for 3D movement and rotation in all directions,
  45708. * such as in a 3D Space Shooter or a Flight Simulator.
  45709. */
  45710. export class FlyCamera extends TargetCamera {
  45711. /**
  45712. * Define the collision ellipsoid of the camera.
  45713. * This is helpful for simulating a camera body, like a player's body.
  45714. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  45715. */
  45716. ellipsoid: Vector3;
  45717. /**
  45718. * Define an offset for the position of the ellipsoid around the camera.
  45719. * This can be helpful if the camera is attached away from the player's body center,
  45720. * such as at its head.
  45721. */
  45722. ellipsoidOffset: Vector3;
  45723. /**
  45724. * Enable or disable collisions of the camera with the rest of the scene objects.
  45725. */
  45726. checkCollisions: boolean;
  45727. /**
  45728. * Enable or disable gravity on the camera.
  45729. */
  45730. applyGravity: boolean;
  45731. /**
  45732. * Define the current direction the camera is moving to.
  45733. */
  45734. cameraDirection: Vector3;
  45735. /**
  45736. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  45737. * This overrides and empties cameraRotation.
  45738. */
  45739. rotationQuaternion: Quaternion;
  45740. /**
  45741. * Track Roll to maintain the wanted Rolling when looking around.
  45742. */
  45743. _trackRoll: number;
  45744. /**
  45745. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  45746. */
  45747. rollCorrect: number;
  45748. /**
  45749. * Mimic a banked turn, Rolling the camera when Yawing.
  45750. * It's recommended to use rollCorrect = 10 for faster banking correction.
  45751. */
  45752. bankedTurn: boolean;
  45753. /**
  45754. * Limit in radians for how much Roll banking will add. (Default: 90°)
  45755. */
  45756. bankedTurnLimit: number;
  45757. /**
  45758. * Value of 0 disables the banked Roll.
  45759. * Value of 1 is equal to the Yaw angle in radians.
  45760. */
  45761. bankedTurnMultiplier: number;
  45762. /**
  45763. * The inputs manager loads all the input sources, such as keyboard and mouse.
  45764. */
  45765. inputs: FlyCameraInputsManager;
  45766. /**
  45767. * Gets the input sensibility for mouse input.
  45768. * Higher values reduce sensitivity.
  45769. */
  45770. get angularSensibility(): number;
  45771. /**
  45772. * Sets the input sensibility for a mouse input.
  45773. * Higher values reduce sensitivity.
  45774. */
  45775. set angularSensibility(value: number);
  45776. /**
  45777. * Get the keys for camera movement forward.
  45778. */
  45779. get keysForward(): number[];
  45780. /**
  45781. * Set the keys for camera movement forward.
  45782. */
  45783. set keysForward(value: number[]);
  45784. /**
  45785. * Get the keys for camera movement backward.
  45786. */
  45787. get keysBackward(): number[];
  45788. set keysBackward(value: number[]);
  45789. /**
  45790. * Get the keys for camera movement up.
  45791. */
  45792. get keysUp(): number[];
  45793. /**
  45794. * Set the keys for camera movement up.
  45795. */
  45796. set keysUp(value: number[]);
  45797. /**
  45798. * Get the keys for camera movement down.
  45799. */
  45800. get keysDown(): number[];
  45801. /**
  45802. * Set the keys for camera movement down.
  45803. */
  45804. set keysDown(value: number[]);
  45805. /**
  45806. * Get the keys for camera movement left.
  45807. */
  45808. get keysLeft(): number[];
  45809. /**
  45810. * Set the keys for camera movement left.
  45811. */
  45812. set keysLeft(value: number[]);
  45813. /**
  45814. * Set the keys for camera movement right.
  45815. */
  45816. get keysRight(): number[];
  45817. /**
  45818. * Set the keys for camera movement right.
  45819. */
  45820. set keysRight(value: number[]);
  45821. /**
  45822. * Event raised when the camera collides with a mesh in the scene.
  45823. */
  45824. onCollide: (collidedMesh: AbstractMesh) => void;
  45825. private _collider;
  45826. private _needMoveForGravity;
  45827. private _oldPosition;
  45828. private _diffPosition;
  45829. private _newPosition;
  45830. /** @hidden */
  45831. _localDirection: Vector3;
  45832. /** @hidden */
  45833. _transformedDirection: Vector3;
  45834. /**
  45835. * Instantiates a FlyCamera.
  45836. * This is a flying camera, designed for 3D movement and rotation in all directions,
  45837. * such as in a 3D Space Shooter or a Flight Simulator.
  45838. * @param name Define the name of the camera in the scene.
  45839. * @param position Define the starting position of the camera in the scene.
  45840. * @param scene Define the scene the camera belongs to.
  45841. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  45842. */
  45843. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  45844. /**
  45845. * Attach a control to the HTML DOM element.
  45846. * @param element Defines the element that listens to the input events.
  45847. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  45848. */
  45849. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45850. /**
  45851. * Detach a control from the HTML DOM element.
  45852. * The camera will stop reacting to that input.
  45853. * @param element Defines the element that listens to the input events.
  45854. */
  45855. detachControl(element: HTMLElement): void;
  45856. private _collisionMask;
  45857. /**
  45858. * Get the mask that the camera ignores in collision events.
  45859. */
  45860. get collisionMask(): number;
  45861. /**
  45862. * Set the mask that the camera ignores in collision events.
  45863. */
  45864. set collisionMask(mask: number);
  45865. /** @hidden */
  45866. _collideWithWorld(displacement: Vector3): void;
  45867. /** @hidden */
  45868. private _onCollisionPositionChange;
  45869. /** @hidden */
  45870. _checkInputs(): void;
  45871. /** @hidden */
  45872. _decideIfNeedsToMove(): boolean;
  45873. /** @hidden */
  45874. _updatePosition(): void;
  45875. /**
  45876. * Restore the Roll to its target value at the rate specified.
  45877. * @param rate - Higher means slower restoring.
  45878. * @hidden
  45879. */
  45880. restoreRoll(rate: number): void;
  45881. /**
  45882. * Destroy the camera and release the current resources held by it.
  45883. */
  45884. dispose(): void;
  45885. /**
  45886. * Get the current object class name.
  45887. * @returns the class name.
  45888. */
  45889. getClassName(): string;
  45890. }
  45891. }
  45892. declare module "babylonjs/Cameras/Inputs/flyCameraKeyboardInput" {
  45893. import { Nullable } from "babylonjs/types";
  45894. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45895. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45896. /**
  45897. * Listen to keyboard events to control the camera.
  45898. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45899. */
  45900. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  45901. /**
  45902. * Defines the camera the input is attached to.
  45903. */
  45904. camera: FlyCamera;
  45905. /**
  45906. * The list of keyboard keys used to control the forward move of the camera.
  45907. */
  45908. keysForward: number[];
  45909. /**
  45910. * The list of keyboard keys used to control the backward move of the camera.
  45911. */
  45912. keysBackward: number[];
  45913. /**
  45914. * The list of keyboard keys used to control the forward move of the camera.
  45915. */
  45916. keysUp: number[];
  45917. /**
  45918. * The list of keyboard keys used to control the backward move of the camera.
  45919. */
  45920. keysDown: number[];
  45921. /**
  45922. * The list of keyboard keys used to control the right strafe move of the camera.
  45923. */
  45924. keysRight: number[];
  45925. /**
  45926. * The list of keyboard keys used to control the left strafe move of the camera.
  45927. */
  45928. keysLeft: number[];
  45929. private _keys;
  45930. private _onCanvasBlurObserver;
  45931. private _onKeyboardObserver;
  45932. private _engine;
  45933. private _scene;
  45934. /**
  45935. * Attach the input controls to a specific dom element to get the input from.
  45936. * @param element Defines the element the controls should be listened from
  45937. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45938. */
  45939. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45940. /**
  45941. * Detach the current controls from the specified dom element.
  45942. * @param element Defines the element to stop listening the inputs from
  45943. */
  45944. detachControl(element: Nullable<HTMLElement>): void;
  45945. /**
  45946. * Gets the class name of the current intput.
  45947. * @returns the class name
  45948. */
  45949. getClassName(): string;
  45950. /** @hidden */
  45951. _onLostFocus(e: FocusEvent): void;
  45952. /**
  45953. * Get the friendly name associated with the input class.
  45954. * @returns the input friendly name
  45955. */
  45956. getSimpleName(): string;
  45957. /**
  45958. * Update the current camera state depending on the inputs that have been used this frame.
  45959. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45960. */
  45961. checkInputs(): void;
  45962. }
  45963. }
  45964. declare module "babylonjs/Cameras/Inputs/followCameraMouseWheelInput" {
  45965. import { Nullable } from "babylonjs/types";
  45966. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  45967. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45968. /**
  45969. * Manage the mouse wheel inputs to control a follow camera.
  45970. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45971. */
  45972. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  45973. /**
  45974. * Defines the camera the input is attached to.
  45975. */
  45976. camera: FollowCamera;
  45977. /**
  45978. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  45979. */
  45980. axisControlRadius: boolean;
  45981. /**
  45982. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  45983. */
  45984. axisControlHeight: boolean;
  45985. /**
  45986. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  45987. */
  45988. axisControlRotation: boolean;
  45989. /**
  45990. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  45991. * relation to mouseWheel events.
  45992. */
  45993. wheelPrecision: number;
  45994. /**
  45995. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  45996. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  45997. */
  45998. wheelDeltaPercentage: number;
  45999. private _wheel;
  46000. private _observer;
  46001. /**
  46002. * Attach the input controls to a specific dom element to get the input from.
  46003. * @param element Defines the element the controls should be listened from
  46004. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46005. */
  46006. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46007. /**
  46008. * Detach the current controls from the specified dom element.
  46009. * @param element Defines the element to stop listening the inputs from
  46010. */
  46011. detachControl(element: Nullable<HTMLElement>): void;
  46012. /**
  46013. * Gets the class name of the current intput.
  46014. * @returns the class name
  46015. */
  46016. getClassName(): string;
  46017. /**
  46018. * Get the friendly name associated with the input class.
  46019. * @returns the input friendly name
  46020. */
  46021. getSimpleName(): string;
  46022. }
  46023. }
  46024. declare module "babylonjs/Cameras/Inputs/followCameraPointersInput" {
  46025. import { Nullable } from "babylonjs/types";
  46026. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46027. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  46028. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  46029. /**
  46030. * Manage the pointers inputs to control an follow camera.
  46031. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46032. */
  46033. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  46034. /**
  46035. * Defines the camera the input is attached to.
  46036. */
  46037. camera: FollowCamera;
  46038. /**
  46039. * Gets the class name of the current input.
  46040. * @returns the class name
  46041. */
  46042. getClassName(): string;
  46043. /**
  46044. * Defines the pointer angular sensibility along the X axis or how fast is
  46045. * the camera rotating.
  46046. * A negative number will reverse the axis direction.
  46047. */
  46048. angularSensibilityX: number;
  46049. /**
  46050. * Defines the pointer angular sensibility along the Y axis or how fast is
  46051. * the camera rotating.
  46052. * A negative number will reverse the axis direction.
  46053. */
  46054. angularSensibilityY: number;
  46055. /**
  46056. * Defines the pointer pinch precision or how fast is the camera zooming.
  46057. * A negative number will reverse the axis direction.
  46058. */
  46059. pinchPrecision: number;
  46060. /**
  46061. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  46062. * from 0.
  46063. * It defines the percentage of current camera.radius to use as delta when
  46064. * pinch zoom is used.
  46065. */
  46066. pinchDeltaPercentage: number;
  46067. /**
  46068. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  46069. */
  46070. axisXControlRadius: boolean;
  46071. /**
  46072. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  46073. */
  46074. axisXControlHeight: boolean;
  46075. /**
  46076. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  46077. */
  46078. axisXControlRotation: boolean;
  46079. /**
  46080. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  46081. */
  46082. axisYControlRadius: boolean;
  46083. /**
  46084. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  46085. */
  46086. axisYControlHeight: boolean;
  46087. /**
  46088. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  46089. */
  46090. axisYControlRotation: boolean;
  46091. /**
  46092. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  46093. */
  46094. axisPinchControlRadius: boolean;
  46095. /**
  46096. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  46097. */
  46098. axisPinchControlHeight: boolean;
  46099. /**
  46100. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  46101. */
  46102. axisPinchControlRotation: boolean;
  46103. /**
  46104. * Log error messages if basic misconfiguration has occurred.
  46105. */
  46106. warningEnable: boolean;
  46107. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  46108. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  46109. private _warningCounter;
  46110. private _warning;
  46111. }
  46112. }
  46113. declare module "babylonjs/Cameras/followCameraInputsManager" {
  46114. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  46115. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46116. /**
  46117. * Default Inputs manager for the FollowCamera.
  46118. * It groups all the default supported inputs for ease of use.
  46119. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46120. */
  46121. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  46122. /**
  46123. * Instantiates a new FollowCameraInputsManager.
  46124. * @param camera Defines the camera the inputs belong to
  46125. */
  46126. constructor(camera: FollowCamera);
  46127. /**
  46128. * Add keyboard input support to the input manager.
  46129. * @returns the current input manager
  46130. */
  46131. addKeyboard(): FollowCameraInputsManager;
  46132. /**
  46133. * Add mouse wheel input support to the input manager.
  46134. * @returns the current input manager
  46135. */
  46136. addMouseWheel(): FollowCameraInputsManager;
  46137. /**
  46138. * Add pointers input support to the input manager.
  46139. * @returns the current input manager
  46140. */
  46141. addPointers(): FollowCameraInputsManager;
  46142. /**
  46143. * Add orientation input support to the input manager.
  46144. * @returns the current input manager
  46145. */
  46146. addVRDeviceOrientation(): FollowCameraInputsManager;
  46147. }
  46148. }
  46149. declare module "babylonjs/Cameras/followCamera" {
  46150. import { Nullable } from "babylonjs/types";
  46151. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  46152. import { Scene } from "babylonjs/scene";
  46153. import { Vector3 } from "babylonjs/Maths/math.vector";
  46154. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  46155. import { FollowCameraInputsManager } from "babylonjs/Cameras/followCameraInputsManager";
  46156. /**
  46157. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  46158. * an arc rotate version arcFollowCamera are available.
  46159. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46160. */
  46161. export class FollowCamera extends TargetCamera {
  46162. /**
  46163. * Distance the follow camera should follow an object at
  46164. */
  46165. radius: number;
  46166. /**
  46167. * Minimum allowed distance of the camera to the axis of rotation
  46168. * (The camera can not get closer).
  46169. * This can help limiting how the Camera is able to move in the scene.
  46170. */
  46171. lowerRadiusLimit: Nullable<number>;
  46172. /**
  46173. * Maximum allowed distance of the camera to the axis of rotation
  46174. * (The camera can not get further).
  46175. * This can help limiting how the Camera is able to move in the scene.
  46176. */
  46177. upperRadiusLimit: Nullable<number>;
  46178. /**
  46179. * Define a rotation offset between the camera and the object it follows
  46180. */
  46181. rotationOffset: number;
  46182. /**
  46183. * Minimum allowed angle to camera position relative to target object.
  46184. * This can help limiting how the Camera is able to move in the scene.
  46185. */
  46186. lowerRotationOffsetLimit: Nullable<number>;
  46187. /**
  46188. * Maximum allowed angle to camera position relative to target object.
  46189. * This can help limiting how the Camera is able to move in the scene.
  46190. */
  46191. upperRotationOffsetLimit: Nullable<number>;
  46192. /**
  46193. * Define a height offset between the camera and the object it follows.
  46194. * It can help following an object from the top (like a car chaing a plane)
  46195. */
  46196. heightOffset: number;
  46197. /**
  46198. * Minimum allowed height of camera position relative to target object.
  46199. * This can help limiting how the Camera is able to move in the scene.
  46200. */
  46201. lowerHeightOffsetLimit: Nullable<number>;
  46202. /**
  46203. * Maximum allowed height of camera position relative to target object.
  46204. * This can help limiting how the Camera is able to move in the scene.
  46205. */
  46206. upperHeightOffsetLimit: Nullable<number>;
  46207. /**
  46208. * Define how fast the camera can accelerate to follow it s target.
  46209. */
  46210. cameraAcceleration: number;
  46211. /**
  46212. * Define the speed limit of the camera following an object.
  46213. */
  46214. maxCameraSpeed: number;
  46215. /**
  46216. * Define the target of the camera.
  46217. */
  46218. lockedTarget: Nullable<AbstractMesh>;
  46219. /**
  46220. * Defines the input associated with the camera.
  46221. */
  46222. inputs: FollowCameraInputsManager;
  46223. /**
  46224. * Instantiates the follow camera.
  46225. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46226. * @param name Define the name of the camera in the scene
  46227. * @param position Define the position of the camera
  46228. * @param scene Define the scene the camera belong to
  46229. * @param lockedTarget Define the target of the camera
  46230. */
  46231. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  46232. private _follow;
  46233. /**
  46234. * Attached controls to the current camera.
  46235. * @param element Defines the element the controls should be listened from
  46236. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46237. */
  46238. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46239. /**
  46240. * Detach the current controls from the camera.
  46241. * The camera will stop reacting to inputs.
  46242. * @param element Defines the element to stop listening the inputs from
  46243. */
  46244. detachControl(element: HTMLElement): void;
  46245. /** @hidden */
  46246. _checkInputs(): void;
  46247. private _checkLimits;
  46248. /**
  46249. * Gets the camera class name.
  46250. * @returns the class name
  46251. */
  46252. getClassName(): string;
  46253. }
  46254. /**
  46255. * Arc Rotate version of the follow camera.
  46256. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  46257. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46258. */
  46259. export class ArcFollowCamera extends TargetCamera {
  46260. /** The longitudinal angle of the camera */
  46261. alpha: number;
  46262. /** The latitudinal angle of the camera */
  46263. beta: number;
  46264. /** The radius of the camera from its target */
  46265. radius: number;
  46266. private _cartesianCoordinates;
  46267. /** Define the camera target (the mesh it should follow) */
  46268. private _meshTarget;
  46269. /**
  46270. * Instantiates a new ArcFollowCamera
  46271. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46272. * @param name Define the name of the camera
  46273. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  46274. * @param beta Define the rotation angle of the camera around the elevation axis
  46275. * @param radius Define the radius of the camera from its target point
  46276. * @param target Define the target of the camera
  46277. * @param scene Define the scene the camera belongs to
  46278. */
  46279. constructor(name: string,
  46280. /** The longitudinal angle of the camera */
  46281. alpha: number,
  46282. /** The latitudinal angle of the camera */
  46283. beta: number,
  46284. /** The radius of the camera from its target */
  46285. radius: number,
  46286. /** Define the camera target (the mesh it should follow) */
  46287. target: Nullable<AbstractMesh>, scene: Scene);
  46288. private _follow;
  46289. /** @hidden */
  46290. _checkInputs(): void;
  46291. /**
  46292. * Returns the class name of the object.
  46293. * It is mostly used internally for serialization purposes.
  46294. */
  46295. getClassName(): string;
  46296. }
  46297. }
  46298. declare module "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput" {
  46299. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46300. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46301. import { Nullable } from "babylonjs/types";
  46302. /**
  46303. * Manage the keyboard inputs to control the movement of a follow camera.
  46304. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46305. */
  46306. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  46307. /**
  46308. * Defines the camera the input is attached to.
  46309. */
  46310. camera: FollowCamera;
  46311. /**
  46312. * Defines the list of key codes associated with the up action (increase heightOffset)
  46313. */
  46314. keysHeightOffsetIncr: number[];
  46315. /**
  46316. * Defines the list of key codes associated with the down action (decrease heightOffset)
  46317. */
  46318. keysHeightOffsetDecr: number[];
  46319. /**
  46320. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  46321. */
  46322. keysHeightOffsetModifierAlt: boolean;
  46323. /**
  46324. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  46325. */
  46326. keysHeightOffsetModifierCtrl: boolean;
  46327. /**
  46328. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  46329. */
  46330. keysHeightOffsetModifierShift: boolean;
  46331. /**
  46332. * Defines the list of key codes associated with the left action (increase rotationOffset)
  46333. */
  46334. keysRotationOffsetIncr: number[];
  46335. /**
  46336. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  46337. */
  46338. keysRotationOffsetDecr: number[];
  46339. /**
  46340. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  46341. */
  46342. keysRotationOffsetModifierAlt: boolean;
  46343. /**
  46344. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  46345. */
  46346. keysRotationOffsetModifierCtrl: boolean;
  46347. /**
  46348. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  46349. */
  46350. keysRotationOffsetModifierShift: boolean;
  46351. /**
  46352. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  46353. */
  46354. keysRadiusIncr: number[];
  46355. /**
  46356. * Defines the list of key codes associated with the zoom-out action (increase radius)
  46357. */
  46358. keysRadiusDecr: number[];
  46359. /**
  46360. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  46361. */
  46362. keysRadiusModifierAlt: boolean;
  46363. /**
  46364. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  46365. */
  46366. keysRadiusModifierCtrl: boolean;
  46367. /**
  46368. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  46369. */
  46370. keysRadiusModifierShift: boolean;
  46371. /**
  46372. * Defines the rate of change of heightOffset.
  46373. */
  46374. heightSensibility: number;
  46375. /**
  46376. * Defines the rate of change of rotationOffset.
  46377. */
  46378. rotationSensibility: number;
  46379. /**
  46380. * Defines the rate of change of radius.
  46381. */
  46382. radiusSensibility: number;
  46383. private _keys;
  46384. private _ctrlPressed;
  46385. private _altPressed;
  46386. private _shiftPressed;
  46387. private _onCanvasBlurObserver;
  46388. private _onKeyboardObserver;
  46389. private _engine;
  46390. private _scene;
  46391. /**
  46392. * Attach the input controls to a specific dom element to get the input from.
  46393. * @param element Defines the element the controls should be listened from
  46394. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46395. */
  46396. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46397. /**
  46398. * Detach the current controls from the specified dom element.
  46399. * @param element Defines the element to stop listening the inputs from
  46400. */
  46401. detachControl(element: Nullable<HTMLElement>): void;
  46402. /**
  46403. * Update the current camera state depending on the inputs that have been used this frame.
  46404. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46405. */
  46406. checkInputs(): void;
  46407. /**
  46408. * Gets the class name of the current input.
  46409. * @returns the class name
  46410. */
  46411. getClassName(): string;
  46412. /**
  46413. * Get the friendly name associated with the input class.
  46414. * @returns the input friendly name
  46415. */
  46416. getSimpleName(): string;
  46417. /**
  46418. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46419. * allow modification of the heightOffset value.
  46420. */
  46421. private _modifierHeightOffset;
  46422. /**
  46423. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46424. * allow modification of the rotationOffset value.
  46425. */
  46426. private _modifierRotationOffset;
  46427. /**
  46428. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46429. * allow modification of the radius value.
  46430. */
  46431. private _modifierRadius;
  46432. }
  46433. }
  46434. declare module "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput" {
  46435. import { Nullable } from "babylonjs/types";
  46436. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46437. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46438. import { Observable } from "babylonjs/Misc/observable";
  46439. module "babylonjs/Cameras/freeCameraInputsManager" {
  46440. interface FreeCameraInputsManager {
  46441. /**
  46442. * @hidden
  46443. */
  46444. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  46445. /**
  46446. * Add orientation input support to the input manager.
  46447. * @returns the current input manager
  46448. */
  46449. addDeviceOrientation(): FreeCameraInputsManager;
  46450. }
  46451. }
  46452. /**
  46453. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  46454. * Screen rotation is taken into account.
  46455. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46456. */
  46457. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  46458. private _camera;
  46459. private _screenOrientationAngle;
  46460. private _constantTranform;
  46461. private _screenQuaternion;
  46462. private _alpha;
  46463. private _beta;
  46464. private _gamma;
  46465. /**
  46466. * Can be used to detect if a device orientation sensor is available on a device
  46467. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  46468. * @returns a promise that will resolve on orientation change
  46469. */
  46470. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  46471. /**
  46472. * @hidden
  46473. */
  46474. _onDeviceOrientationChangedObservable: Observable<void>;
  46475. /**
  46476. * Instantiates a new input
  46477. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46478. */
  46479. constructor();
  46480. /**
  46481. * Define the camera controlled by the input.
  46482. */
  46483. get camera(): FreeCamera;
  46484. set camera(camera: FreeCamera);
  46485. /**
  46486. * Attach the input controls to a specific dom element to get the input from.
  46487. * @param element Defines the element the controls should be listened from
  46488. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46489. */
  46490. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46491. private _orientationChanged;
  46492. private _deviceOrientation;
  46493. /**
  46494. * Detach the current controls from the specified dom element.
  46495. * @param element Defines the element to stop listening the inputs from
  46496. */
  46497. detachControl(element: Nullable<HTMLElement>): void;
  46498. /**
  46499. * Update the current camera state depending on the inputs that have been used this frame.
  46500. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46501. */
  46502. checkInputs(): void;
  46503. /**
  46504. * Gets the class name of the current intput.
  46505. * @returns the class name
  46506. */
  46507. getClassName(): string;
  46508. /**
  46509. * Get the friendly name associated with the input class.
  46510. * @returns the input friendly name
  46511. */
  46512. getSimpleName(): string;
  46513. }
  46514. }
  46515. declare module "babylonjs/Cameras/Inputs/freeCameraGamepadInput" {
  46516. import { Nullable } from "babylonjs/types";
  46517. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46518. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46519. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  46520. /**
  46521. * Manage the gamepad inputs to control a free camera.
  46522. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46523. */
  46524. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  46525. /**
  46526. * Define the camera the input is attached to.
  46527. */
  46528. camera: FreeCamera;
  46529. /**
  46530. * Define the Gamepad controlling the input
  46531. */
  46532. gamepad: Nullable<Gamepad>;
  46533. /**
  46534. * Defines the gamepad rotation sensiblity.
  46535. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  46536. */
  46537. gamepadAngularSensibility: number;
  46538. /**
  46539. * Defines the gamepad move sensiblity.
  46540. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  46541. */
  46542. gamepadMoveSensibility: number;
  46543. private _yAxisScale;
  46544. /**
  46545. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  46546. */
  46547. get invertYAxis(): boolean;
  46548. set invertYAxis(value: boolean);
  46549. private _onGamepadConnectedObserver;
  46550. private _onGamepadDisconnectedObserver;
  46551. private _cameraTransform;
  46552. private _deltaTransform;
  46553. private _vector3;
  46554. private _vector2;
  46555. /**
  46556. * Attach the input controls to a specific dom element to get the input from.
  46557. * @param element Defines the element the controls should be listened from
  46558. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46559. */
  46560. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46561. /**
  46562. * Detach the current controls from the specified dom element.
  46563. * @param element Defines the element to stop listening the inputs from
  46564. */
  46565. detachControl(element: Nullable<HTMLElement>): void;
  46566. /**
  46567. * Update the current camera state depending on the inputs that have been used this frame.
  46568. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46569. */
  46570. checkInputs(): void;
  46571. /**
  46572. * Gets the class name of the current intput.
  46573. * @returns the class name
  46574. */
  46575. getClassName(): string;
  46576. /**
  46577. * Get the friendly name associated with the input class.
  46578. * @returns the input friendly name
  46579. */
  46580. getSimpleName(): string;
  46581. }
  46582. }
  46583. declare module "babylonjs/Misc/virtualJoystick" {
  46584. import { Nullable } from "babylonjs/types";
  46585. import { Vector3 } from "babylonjs/Maths/math.vector";
  46586. /**
  46587. * Defines the potential axis of a Joystick
  46588. */
  46589. export enum JoystickAxis {
  46590. /** X axis */
  46591. X = 0,
  46592. /** Y axis */
  46593. Y = 1,
  46594. /** Z axis */
  46595. Z = 2
  46596. }
  46597. /**
  46598. * Represents the different customization options available
  46599. * for VirtualJoystick
  46600. */
  46601. interface VirtualJoystickCustomizations {
  46602. /**
  46603. * Size of the joystick's puck
  46604. */
  46605. puckSize: number;
  46606. /**
  46607. * Size of the joystick's container
  46608. */
  46609. containerSize: number;
  46610. /**
  46611. * Color of the joystick && puck
  46612. */
  46613. color: string;
  46614. /**
  46615. * Image URL for the joystick's puck
  46616. */
  46617. puckImage?: string;
  46618. /**
  46619. * Image URL for the joystick's container
  46620. */
  46621. containerImage?: string;
  46622. /**
  46623. * Defines the unmoving position of the joystick container
  46624. */
  46625. position?: {
  46626. x: number;
  46627. y: number;
  46628. };
  46629. /**
  46630. * Defines whether or not the joystick container is always visible
  46631. */
  46632. alwaysVisible: boolean;
  46633. /**
  46634. * Defines whether or not to limit the movement of the puck to the joystick's container
  46635. */
  46636. limitToContainer: boolean;
  46637. }
  46638. /**
  46639. * Class used to define virtual joystick (used in touch mode)
  46640. */
  46641. export class VirtualJoystick {
  46642. /**
  46643. * Gets or sets a boolean indicating that left and right values must be inverted
  46644. */
  46645. reverseLeftRight: boolean;
  46646. /**
  46647. * Gets or sets a boolean indicating that up and down values must be inverted
  46648. */
  46649. reverseUpDown: boolean;
  46650. /**
  46651. * Gets the offset value for the position (ie. the change of the position value)
  46652. */
  46653. deltaPosition: Vector3;
  46654. /**
  46655. * Gets a boolean indicating if the virtual joystick was pressed
  46656. */
  46657. pressed: boolean;
  46658. /**
  46659. * Canvas the virtual joystick will render onto, default z-index of this is 5
  46660. */
  46661. static Canvas: Nullable<HTMLCanvasElement>;
  46662. /**
  46663. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  46664. */
  46665. limitToContainer: boolean;
  46666. private static _globalJoystickIndex;
  46667. private static _alwaysVisibleSticks;
  46668. private static vjCanvasContext;
  46669. private static vjCanvasWidth;
  46670. private static vjCanvasHeight;
  46671. private static halfWidth;
  46672. private static _GetDefaultOptions;
  46673. private _action;
  46674. private _axisTargetedByLeftAndRight;
  46675. private _axisTargetedByUpAndDown;
  46676. private _joystickSensibility;
  46677. private _inversedSensibility;
  46678. private _joystickPointerID;
  46679. private _joystickColor;
  46680. private _joystickPointerPos;
  46681. private _joystickPreviousPointerPos;
  46682. private _joystickPointerStartPos;
  46683. private _deltaJoystickVector;
  46684. private _leftJoystick;
  46685. private _touches;
  46686. private _joystickPosition;
  46687. private _alwaysVisible;
  46688. private _puckImage;
  46689. private _containerImage;
  46690. private _joystickPuckSize;
  46691. private _joystickContainerSize;
  46692. private _clearPuckSize;
  46693. private _clearContainerSize;
  46694. private _clearPuckSizeOffset;
  46695. private _clearContainerSizeOffset;
  46696. private _onPointerDownHandlerRef;
  46697. private _onPointerMoveHandlerRef;
  46698. private _onPointerUpHandlerRef;
  46699. private _onResize;
  46700. /**
  46701. * Creates a new virtual joystick
  46702. * @param leftJoystick defines that the joystick is for left hand (false by default)
  46703. * @param customizations Defines the options we want to customize the VirtualJoystick
  46704. */
  46705. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  46706. /**
  46707. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  46708. * @param newJoystickSensibility defines the new sensibility
  46709. */
  46710. setJoystickSensibility(newJoystickSensibility: number): void;
  46711. private _onPointerDown;
  46712. private _onPointerMove;
  46713. private _onPointerUp;
  46714. /**
  46715. * Change the color of the virtual joystick
  46716. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  46717. */
  46718. setJoystickColor(newColor: string): void;
  46719. /**
  46720. * Size of the joystick's container
  46721. */
  46722. set containerSize(newSize: number);
  46723. get containerSize(): number;
  46724. /**
  46725. * Size of the joystick's puck
  46726. */
  46727. set puckSize(newSize: number);
  46728. get puckSize(): number;
  46729. /**
  46730. * Clears the set position of the joystick
  46731. */
  46732. clearPosition(): void;
  46733. /**
  46734. * Defines whether or not the joystick container is always visible
  46735. */
  46736. set alwaysVisible(value: boolean);
  46737. get alwaysVisible(): boolean;
  46738. /**
  46739. * Sets the constant position of the Joystick container
  46740. * @param x X axis coordinate
  46741. * @param y Y axis coordinate
  46742. */
  46743. setPosition(x: number, y: number): void;
  46744. /**
  46745. * Defines a callback to call when the joystick is touched
  46746. * @param action defines the callback
  46747. */
  46748. setActionOnTouch(action: () => any): void;
  46749. /**
  46750. * Defines which axis you'd like to control for left & right
  46751. * @param axis defines the axis to use
  46752. */
  46753. setAxisForLeftRight(axis: JoystickAxis): void;
  46754. /**
  46755. * Defines which axis you'd like to control for up & down
  46756. * @param axis defines the axis to use
  46757. */
  46758. setAxisForUpDown(axis: JoystickAxis): void;
  46759. /**
  46760. * Clears the canvas from the previous puck / container draw
  46761. */
  46762. private _clearPreviousDraw;
  46763. /**
  46764. * Loads `urlPath` to be used for the container's image
  46765. * @param urlPath defines the urlPath of an image to use
  46766. */
  46767. setContainerImage(urlPath: string): void;
  46768. /**
  46769. * Loads `urlPath` to be used for the puck's image
  46770. * @param urlPath defines the urlPath of an image to use
  46771. */
  46772. setPuckImage(urlPath: string): void;
  46773. /**
  46774. * Draws the Virtual Joystick's container
  46775. */
  46776. private _drawContainer;
  46777. /**
  46778. * Draws the Virtual Joystick's puck
  46779. */
  46780. private _drawPuck;
  46781. private _drawVirtualJoystick;
  46782. /**
  46783. * Release internal HTML canvas
  46784. */
  46785. releaseCanvas(): void;
  46786. }
  46787. }
  46788. declare module "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput" {
  46789. import { VirtualJoystick } from "babylonjs/Misc/virtualJoystick";
  46790. import { Nullable } from "babylonjs/types";
  46791. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46792. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46793. module "babylonjs/Cameras/freeCameraInputsManager" {
  46794. interface FreeCameraInputsManager {
  46795. /**
  46796. * Add virtual joystick input support to the input manager.
  46797. * @returns the current input manager
  46798. */
  46799. addVirtualJoystick(): FreeCameraInputsManager;
  46800. }
  46801. }
  46802. /**
  46803. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  46804. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46805. */
  46806. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  46807. /**
  46808. * Defines the camera the input is attached to.
  46809. */
  46810. camera: FreeCamera;
  46811. private _leftjoystick;
  46812. private _rightjoystick;
  46813. /**
  46814. * Gets the left stick of the virtual joystick.
  46815. * @returns The virtual Joystick
  46816. */
  46817. getLeftJoystick(): VirtualJoystick;
  46818. /**
  46819. * Gets the right stick of the virtual joystick.
  46820. * @returns The virtual Joystick
  46821. */
  46822. getRightJoystick(): VirtualJoystick;
  46823. /**
  46824. * Update the current camera state depending on the inputs that have been used this frame.
  46825. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46826. */
  46827. checkInputs(): void;
  46828. /**
  46829. * Attach the input controls to a specific dom element to get the input from.
  46830. * @param element Defines the element the controls should be listened from
  46831. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46832. */
  46833. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46834. /**
  46835. * Detach the current controls from the specified dom element.
  46836. * @param element Defines the element to stop listening the inputs from
  46837. */
  46838. detachControl(element: Nullable<HTMLElement>): void;
  46839. /**
  46840. * Gets the class name of the current intput.
  46841. * @returns the class name
  46842. */
  46843. getClassName(): string;
  46844. /**
  46845. * Get the friendly name associated with the input class.
  46846. * @returns the input friendly name
  46847. */
  46848. getSimpleName(): string;
  46849. }
  46850. }
  46851. declare module "babylonjs/Cameras/Inputs/index" {
  46852. export * from "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput";
  46853. export * from "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput";
  46854. export * from "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput";
  46855. export * from "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput";
  46856. export * from "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  46857. export * from "babylonjs/Cameras/Inputs/flyCameraKeyboardInput";
  46858. export * from "babylonjs/Cameras/Inputs/flyCameraMouseInput";
  46859. export * from "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput";
  46860. export * from "babylonjs/Cameras/Inputs/followCameraMouseWheelInput";
  46861. export * from "babylonjs/Cameras/Inputs/followCameraPointersInput";
  46862. export * from "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  46863. export * from "babylonjs/Cameras/Inputs/freeCameraGamepadInput";
  46864. export * from "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput";
  46865. export * from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  46866. export * from "babylonjs/Cameras/Inputs/freeCameraTouchInput";
  46867. export * from "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  46868. }
  46869. declare module "babylonjs/Cameras/touchCamera" {
  46870. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46871. import { Scene } from "babylonjs/scene";
  46872. import { Vector3 } from "babylonjs/Maths/math.vector";
  46873. /**
  46874. * This represents a FPS type of camera controlled by touch.
  46875. * This is like a universal camera minus the Gamepad controls.
  46876. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  46877. */
  46878. export class TouchCamera extends FreeCamera {
  46879. /**
  46880. * Defines the touch sensibility for rotation.
  46881. * The higher the faster.
  46882. */
  46883. get touchAngularSensibility(): number;
  46884. set touchAngularSensibility(value: number);
  46885. /**
  46886. * Defines the touch sensibility for move.
  46887. * The higher the faster.
  46888. */
  46889. get touchMoveSensibility(): number;
  46890. set touchMoveSensibility(value: number);
  46891. /**
  46892. * Instantiates a new touch camera.
  46893. * This represents a FPS type of camera controlled by touch.
  46894. * This is like a universal camera minus the Gamepad controls.
  46895. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  46896. * @param name Define the name of the camera in the scene
  46897. * @param position Define the start position of the camera in the scene
  46898. * @param scene Define the scene the camera belongs to
  46899. */
  46900. constructor(name: string, position: Vector3, scene: Scene);
  46901. /**
  46902. * Gets the current object class name.
  46903. * @return the class name
  46904. */
  46905. getClassName(): string;
  46906. /** @hidden */
  46907. _setupInputs(): void;
  46908. }
  46909. }
  46910. declare module "babylonjs/Cameras/deviceOrientationCamera" {
  46911. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46912. import { Scene } from "babylonjs/scene";
  46913. import { Vector3 } from "babylonjs/Maths/math.vector";
  46914. import "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  46915. import { Axis } from "babylonjs/Maths/math.axis";
  46916. /**
  46917. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  46918. * being tilted forward or back and left or right.
  46919. */
  46920. export class DeviceOrientationCamera extends FreeCamera {
  46921. private _initialQuaternion;
  46922. private _quaternionCache;
  46923. private _tmpDragQuaternion;
  46924. private _disablePointerInputWhenUsingDeviceOrientation;
  46925. /**
  46926. * Creates a new device orientation camera
  46927. * @param name The name of the camera
  46928. * @param position The start position camera
  46929. * @param scene The scene the camera belongs to
  46930. */
  46931. constructor(name: string, position: Vector3, scene: Scene);
  46932. /**
  46933. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  46934. */
  46935. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  46936. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  46937. private _dragFactor;
  46938. /**
  46939. * Enabled turning on the y axis when the orientation sensor is active
  46940. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  46941. */
  46942. enableHorizontalDragging(dragFactor?: number): void;
  46943. /**
  46944. * Gets the current instance class name ("DeviceOrientationCamera").
  46945. * This helps avoiding instanceof at run time.
  46946. * @returns the class name
  46947. */
  46948. getClassName(): string;
  46949. /**
  46950. * @hidden
  46951. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  46952. */
  46953. _checkInputs(): void;
  46954. /**
  46955. * Reset the camera to its default orientation on the specified axis only.
  46956. * @param axis The axis to reset
  46957. */
  46958. resetToCurrentRotation(axis?: Axis): void;
  46959. }
  46960. }
  46961. declare module "babylonjs/Gamepads/xboxGamepad" {
  46962. import { Observable } from "babylonjs/Misc/observable";
  46963. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  46964. /**
  46965. * Defines supported buttons for XBox360 compatible gamepads
  46966. */
  46967. export enum Xbox360Button {
  46968. /** A */
  46969. A = 0,
  46970. /** B */
  46971. B = 1,
  46972. /** X */
  46973. X = 2,
  46974. /** Y */
  46975. Y = 3,
  46976. /** Left button */
  46977. LB = 4,
  46978. /** Right button */
  46979. RB = 5,
  46980. /** Back */
  46981. Back = 8,
  46982. /** Start */
  46983. Start = 9,
  46984. /** Left stick */
  46985. LeftStick = 10,
  46986. /** Right stick */
  46987. RightStick = 11
  46988. }
  46989. /** Defines values for XBox360 DPad */
  46990. export enum Xbox360Dpad {
  46991. /** Up */
  46992. Up = 12,
  46993. /** Down */
  46994. Down = 13,
  46995. /** Left */
  46996. Left = 14,
  46997. /** Right */
  46998. Right = 15
  46999. }
  47000. /**
  47001. * Defines a XBox360 gamepad
  47002. */
  47003. export class Xbox360Pad extends Gamepad {
  47004. private _leftTrigger;
  47005. private _rightTrigger;
  47006. private _onlefttriggerchanged;
  47007. private _onrighttriggerchanged;
  47008. private _onbuttondown;
  47009. private _onbuttonup;
  47010. private _ondpaddown;
  47011. private _ondpadup;
  47012. /** Observable raised when a button is pressed */
  47013. onButtonDownObservable: Observable<Xbox360Button>;
  47014. /** Observable raised when a button is released */
  47015. onButtonUpObservable: Observable<Xbox360Button>;
  47016. /** Observable raised when a pad is pressed */
  47017. onPadDownObservable: Observable<Xbox360Dpad>;
  47018. /** Observable raised when a pad is released */
  47019. onPadUpObservable: Observable<Xbox360Dpad>;
  47020. private _buttonA;
  47021. private _buttonB;
  47022. private _buttonX;
  47023. private _buttonY;
  47024. private _buttonBack;
  47025. private _buttonStart;
  47026. private _buttonLB;
  47027. private _buttonRB;
  47028. private _buttonLeftStick;
  47029. private _buttonRightStick;
  47030. private _dPadUp;
  47031. private _dPadDown;
  47032. private _dPadLeft;
  47033. private _dPadRight;
  47034. private _isXboxOnePad;
  47035. /**
  47036. * Creates a new XBox360 gamepad object
  47037. * @param id defines the id of this gamepad
  47038. * @param index defines its index
  47039. * @param gamepad defines the internal HTML gamepad object
  47040. * @param xboxOne defines if it is a XBox One gamepad
  47041. */
  47042. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  47043. /**
  47044. * Defines the callback to call when left trigger is pressed
  47045. * @param callback defines the callback to use
  47046. */
  47047. onlefttriggerchanged(callback: (value: number) => void): void;
  47048. /**
  47049. * Defines the callback to call when right trigger is pressed
  47050. * @param callback defines the callback to use
  47051. */
  47052. onrighttriggerchanged(callback: (value: number) => void): void;
  47053. /**
  47054. * Gets the left trigger value
  47055. */
  47056. get leftTrigger(): number;
  47057. /**
  47058. * Sets the left trigger value
  47059. */
  47060. set leftTrigger(newValue: number);
  47061. /**
  47062. * Gets the right trigger value
  47063. */
  47064. get rightTrigger(): number;
  47065. /**
  47066. * Sets the right trigger value
  47067. */
  47068. set rightTrigger(newValue: number);
  47069. /**
  47070. * Defines the callback to call when a button is pressed
  47071. * @param callback defines the callback to use
  47072. */
  47073. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  47074. /**
  47075. * Defines the callback to call when a button is released
  47076. * @param callback defines the callback to use
  47077. */
  47078. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  47079. /**
  47080. * Defines the callback to call when a pad is pressed
  47081. * @param callback defines the callback to use
  47082. */
  47083. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  47084. /**
  47085. * Defines the callback to call when a pad is released
  47086. * @param callback defines the callback to use
  47087. */
  47088. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  47089. private _setButtonValue;
  47090. private _setDPadValue;
  47091. /**
  47092. * Gets the value of the `A` button
  47093. */
  47094. get buttonA(): number;
  47095. /**
  47096. * Sets the value of the `A` button
  47097. */
  47098. set buttonA(value: number);
  47099. /**
  47100. * Gets the value of the `B` button
  47101. */
  47102. get buttonB(): number;
  47103. /**
  47104. * Sets the value of the `B` button
  47105. */
  47106. set buttonB(value: number);
  47107. /**
  47108. * Gets the value of the `X` button
  47109. */
  47110. get buttonX(): number;
  47111. /**
  47112. * Sets the value of the `X` button
  47113. */
  47114. set buttonX(value: number);
  47115. /**
  47116. * Gets the value of the `Y` button
  47117. */
  47118. get buttonY(): number;
  47119. /**
  47120. * Sets the value of the `Y` button
  47121. */
  47122. set buttonY(value: number);
  47123. /**
  47124. * Gets the value of the `Start` button
  47125. */
  47126. get buttonStart(): number;
  47127. /**
  47128. * Sets the value of the `Start` button
  47129. */
  47130. set buttonStart(value: number);
  47131. /**
  47132. * Gets the value of the `Back` button
  47133. */
  47134. get buttonBack(): number;
  47135. /**
  47136. * Sets the value of the `Back` button
  47137. */
  47138. set buttonBack(value: number);
  47139. /**
  47140. * Gets the value of the `Left` button
  47141. */
  47142. get buttonLB(): number;
  47143. /**
  47144. * Sets the value of the `Left` button
  47145. */
  47146. set buttonLB(value: number);
  47147. /**
  47148. * Gets the value of the `Right` button
  47149. */
  47150. get buttonRB(): number;
  47151. /**
  47152. * Sets the value of the `Right` button
  47153. */
  47154. set buttonRB(value: number);
  47155. /**
  47156. * Gets the value of the Left joystick
  47157. */
  47158. get buttonLeftStick(): number;
  47159. /**
  47160. * Sets the value of the Left joystick
  47161. */
  47162. set buttonLeftStick(value: number);
  47163. /**
  47164. * Gets the value of the Right joystick
  47165. */
  47166. get buttonRightStick(): number;
  47167. /**
  47168. * Sets the value of the Right joystick
  47169. */
  47170. set buttonRightStick(value: number);
  47171. /**
  47172. * Gets the value of D-pad up
  47173. */
  47174. get dPadUp(): number;
  47175. /**
  47176. * Sets the value of D-pad up
  47177. */
  47178. set dPadUp(value: number);
  47179. /**
  47180. * Gets the value of D-pad down
  47181. */
  47182. get dPadDown(): number;
  47183. /**
  47184. * Sets the value of D-pad down
  47185. */
  47186. set dPadDown(value: number);
  47187. /**
  47188. * Gets the value of D-pad left
  47189. */
  47190. get dPadLeft(): number;
  47191. /**
  47192. * Sets the value of D-pad left
  47193. */
  47194. set dPadLeft(value: number);
  47195. /**
  47196. * Gets the value of D-pad right
  47197. */
  47198. get dPadRight(): number;
  47199. /**
  47200. * Sets the value of D-pad right
  47201. */
  47202. set dPadRight(value: number);
  47203. /**
  47204. * Force the gamepad to synchronize with device values
  47205. */
  47206. update(): void;
  47207. /**
  47208. * Disposes the gamepad
  47209. */
  47210. dispose(): void;
  47211. }
  47212. }
  47213. declare module "babylonjs/Gamepads/dualShockGamepad" {
  47214. import { Observable } from "babylonjs/Misc/observable";
  47215. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47216. /**
  47217. * Defines supported buttons for DualShock compatible gamepads
  47218. */
  47219. export enum DualShockButton {
  47220. /** Cross */
  47221. Cross = 0,
  47222. /** Circle */
  47223. Circle = 1,
  47224. /** Square */
  47225. Square = 2,
  47226. /** Triangle */
  47227. Triangle = 3,
  47228. /** L1 */
  47229. L1 = 4,
  47230. /** R1 */
  47231. R1 = 5,
  47232. /** Share */
  47233. Share = 8,
  47234. /** Options */
  47235. Options = 9,
  47236. /** Left stick */
  47237. LeftStick = 10,
  47238. /** Right stick */
  47239. RightStick = 11
  47240. }
  47241. /** Defines values for DualShock DPad */
  47242. export enum DualShockDpad {
  47243. /** Up */
  47244. Up = 12,
  47245. /** Down */
  47246. Down = 13,
  47247. /** Left */
  47248. Left = 14,
  47249. /** Right */
  47250. Right = 15
  47251. }
  47252. /**
  47253. * Defines a DualShock gamepad
  47254. */
  47255. export class DualShockPad extends Gamepad {
  47256. private _leftTrigger;
  47257. private _rightTrigger;
  47258. private _onlefttriggerchanged;
  47259. private _onrighttriggerchanged;
  47260. private _onbuttondown;
  47261. private _onbuttonup;
  47262. private _ondpaddown;
  47263. private _ondpadup;
  47264. /** Observable raised when a button is pressed */
  47265. onButtonDownObservable: Observable<DualShockButton>;
  47266. /** Observable raised when a button is released */
  47267. onButtonUpObservable: Observable<DualShockButton>;
  47268. /** Observable raised when a pad is pressed */
  47269. onPadDownObservable: Observable<DualShockDpad>;
  47270. /** Observable raised when a pad is released */
  47271. onPadUpObservable: Observable<DualShockDpad>;
  47272. private _buttonCross;
  47273. private _buttonCircle;
  47274. private _buttonSquare;
  47275. private _buttonTriangle;
  47276. private _buttonShare;
  47277. private _buttonOptions;
  47278. private _buttonL1;
  47279. private _buttonR1;
  47280. private _buttonLeftStick;
  47281. private _buttonRightStick;
  47282. private _dPadUp;
  47283. private _dPadDown;
  47284. private _dPadLeft;
  47285. private _dPadRight;
  47286. /**
  47287. * Creates a new DualShock gamepad object
  47288. * @param id defines the id of this gamepad
  47289. * @param index defines its index
  47290. * @param gamepad defines the internal HTML gamepad object
  47291. */
  47292. constructor(id: string, index: number, gamepad: any);
  47293. /**
  47294. * Defines the callback to call when left trigger is pressed
  47295. * @param callback defines the callback to use
  47296. */
  47297. onlefttriggerchanged(callback: (value: number) => void): void;
  47298. /**
  47299. * Defines the callback to call when right trigger is pressed
  47300. * @param callback defines the callback to use
  47301. */
  47302. onrighttriggerchanged(callback: (value: number) => void): void;
  47303. /**
  47304. * Gets the left trigger value
  47305. */
  47306. get leftTrigger(): number;
  47307. /**
  47308. * Sets the left trigger value
  47309. */
  47310. set leftTrigger(newValue: number);
  47311. /**
  47312. * Gets the right trigger value
  47313. */
  47314. get rightTrigger(): number;
  47315. /**
  47316. * Sets the right trigger value
  47317. */
  47318. set rightTrigger(newValue: number);
  47319. /**
  47320. * Defines the callback to call when a button is pressed
  47321. * @param callback defines the callback to use
  47322. */
  47323. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  47324. /**
  47325. * Defines the callback to call when a button is released
  47326. * @param callback defines the callback to use
  47327. */
  47328. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  47329. /**
  47330. * Defines the callback to call when a pad is pressed
  47331. * @param callback defines the callback to use
  47332. */
  47333. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  47334. /**
  47335. * Defines the callback to call when a pad is released
  47336. * @param callback defines the callback to use
  47337. */
  47338. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  47339. private _setButtonValue;
  47340. private _setDPadValue;
  47341. /**
  47342. * Gets the value of the `Cross` button
  47343. */
  47344. get buttonCross(): number;
  47345. /**
  47346. * Sets the value of the `Cross` button
  47347. */
  47348. set buttonCross(value: number);
  47349. /**
  47350. * Gets the value of the `Circle` button
  47351. */
  47352. get buttonCircle(): number;
  47353. /**
  47354. * Sets the value of the `Circle` button
  47355. */
  47356. set buttonCircle(value: number);
  47357. /**
  47358. * Gets the value of the `Square` button
  47359. */
  47360. get buttonSquare(): number;
  47361. /**
  47362. * Sets the value of the `Square` button
  47363. */
  47364. set buttonSquare(value: number);
  47365. /**
  47366. * Gets the value of the `Triangle` button
  47367. */
  47368. get buttonTriangle(): number;
  47369. /**
  47370. * Sets the value of the `Triangle` button
  47371. */
  47372. set buttonTriangle(value: number);
  47373. /**
  47374. * Gets the value of the `Options` button
  47375. */
  47376. get buttonOptions(): number;
  47377. /**
  47378. * Sets the value of the `Options` button
  47379. */
  47380. set buttonOptions(value: number);
  47381. /**
  47382. * Gets the value of the `Share` button
  47383. */
  47384. get buttonShare(): number;
  47385. /**
  47386. * Sets the value of the `Share` button
  47387. */
  47388. set buttonShare(value: number);
  47389. /**
  47390. * Gets the value of the `L1` button
  47391. */
  47392. get buttonL1(): number;
  47393. /**
  47394. * Sets the value of the `L1` button
  47395. */
  47396. set buttonL1(value: number);
  47397. /**
  47398. * Gets the value of the `R1` button
  47399. */
  47400. get buttonR1(): number;
  47401. /**
  47402. * Sets the value of the `R1` button
  47403. */
  47404. set buttonR1(value: number);
  47405. /**
  47406. * Gets the value of the Left joystick
  47407. */
  47408. get buttonLeftStick(): number;
  47409. /**
  47410. * Sets the value of the Left joystick
  47411. */
  47412. set buttonLeftStick(value: number);
  47413. /**
  47414. * Gets the value of the Right joystick
  47415. */
  47416. get buttonRightStick(): number;
  47417. /**
  47418. * Sets the value of the Right joystick
  47419. */
  47420. set buttonRightStick(value: number);
  47421. /**
  47422. * Gets the value of D-pad up
  47423. */
  47424. get dPadUp(): number;
  47425. /**
  47426. * Sets the value of D-pad up
  47427. */
  47428. set dPadUp(value: number);
  47429. /**
  47430. * Gets the value of D-pad down
  47431. */
  47432. get dPadDown(): number;
  47433. /**
  47434. * Sets the value of D-pad down
  47435. */
  47436. set dPadDown(value: number);
  47437. /**
  47438. * Gets the value of D-pad left
  47439. */
  47440. get dPadLeft(): number;
  47441. /**
  47442. * Sets the value of D-pad left
  47443. */
  47444. set dPadLeft(value: number);
  47445. /**
  47446. * Gets the value of D-pad right
  47447. */
  47448. get dPadRight(): number;
  47449. /**
  47450. * Sets the value of D-pad right
  47451. */
  47452. set dPadRight(value: number);
  47453. /**
  47454. * Force the gamepad to synchronize with device values
  47455. */
  47456. update(): void;
  47457. /**
  47458. * Disposes the gamepad
  47459. */
  47460. dispose(): void;
  47461. }
  47462. }
  47463. declare module "babylonjs/Gamepads/gamepadManager" {
  47464. import { Observable } from "babylonjs/Misc/observable";
  47465. import { Nullable } from "babylonjs/types";
  47466. import { Scene } from "babylonjs/scene";
  47467. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47468. /**
  47469. * Manager for handling gamepads
  47470. */
  47471. export class GamepadManager {
  47472. private _scene?;
  47473. private _babylonGamepads;
  47474. private _oneGamepadConnected;
  47475. /** @hidden */
  47476. _isMonitoring: boolean;
  47477. private _gamepadEventSupported;
  47478. private _gamepadSupport?;
  47479. /**
  47480. * observable to be triggered when the gamepad controller has been connected
  47481. */
  47482. onGamepadConnectedObservable: Observable<Gamepad>;
  47483. /**
  47484. * observable to be triggered when the gamepad controller has been disconnected
  47485. */
  47486. onGamepadDisconnectedObservable: Observable<Gamepad>;
  47487. private _onGamepadConnectedEvent;
  47488. private _onGamepadDisconnectedEvent;
  47489. /**
  47490. * Initializes the gamepad manager
  47491. * @param _scene BabylonJS scene
  47492. */
  47493. constructor(_scene?: Scene | undefined);
  47494. /**
  47495. * The gamepads in the game pad manager
  47496. */
  47497. get gamepads(): Gamepad[];
  47498. /**
  47499. * Get the gamepad controllers based on type
  47500. * @param type The type of gamepad controller
  47501. * @returns Nullable gamepad
  47502. */
  47503. getGamepadByType(type?: number): Nullable<Gamepad>;
  47504. /**
  47505. * Disposes the gamepad manager
  47506. */
  47507. dispose(): void;
  47508. private _addNewGamepad;
  47509. private _startMonitoringGamepads;
  47510. private _stopMonitoringGamepads;
  47511. /** @hidden */
  47512. _checkGamepadsStatus(): void;
  47513. private _updateGamepadObjects;
  47514. }
  47515. }
  47516. declare module "babylonjs/Gamepads/gamepadSceneComponent" {
  47517. import { Nullable } from "babylonjs/types";
  47518. import { Scene } from "babylonjs/scene";
  47519. import { ISceneComponent } from "babylonjs/sceneComponent";
  47520. import { GamepadManager } from "babylonjs/Gamepads/gamepadManager";
  47521. module "babylonjs/scene" {
  47522. interface Scene {
  47523. /** @hidden */
  47524. _gamepadManager: Nullable<GamepadManager>;
  47525. /**
  47526. * Gets the gamepad manager associated with the scene
  47527. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  47528. */
  47529. gamepadManager: GamepadManager;
  47530. }
  47531. }
  47532. module "babylonjs/Cameras/freeCameraInputsManager" {
  47533. /**
  47534. * Interface representing a free camera inputs manager
  47535. */
  47536. interface FreeCameraInputsManager {
  47537. /**
  47538. * Adds gamepad input support to the FreeCameraInputsManager.
  47539. * @returns the FreeCameraInputsManager
  47540. */
  47541. addGamepad(): FreeCameraInputsManager;
  47542. }
  47543. }
  47544. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  47545. /**
  47546. * Interface representing an arc rotate camera inputs manager
  47547. */
  47548. interface ArcRotateCameraInputsManager {
  47549. /**
  47550. * Adds gamepad input support to the ArcRotateCamera InputManager.
  47551. * @returns the camera inputs manager
  47552. */
  47553. addGamepad(): ArcRotateCameraInputsManager;
  47554. }
  47555. }
  47556. /**
  47557. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  47558. */
  47559. export class GamepadSystemSceneComponent implements ISceneComponent {
  47560. /**
  47561. * The component name helpfull to identify the component in the list of scene components.
  47562. */
  47563. readonly name: string;
  47564. /**
  47565. * The scene the component belongs to.
  47566. */
  47567. scene: Scene;
  47568. /**
  47569. * Creates a new instance of the component for the given scene
  47570. * @param scene Defines the scene to register the component in
  47571. */
  47572. constructor(scene: Scene);
  47573. /**
  47574. * Registers the component in a given scene
  47575. */
  47576. register(): void;
  47577. /**
  47578. * Rebuilds the elements related to this component in case of
  47579. * context lost for instance.
  47580. */
  47581. rebuild(): void;
  47582. /**
  47583. * Disposes the component and the associated ressources
  47584. */
  47585. dispose(): void;
  47586. private _beforeCameraUpdate;
  47587. }
  47588. }
  47589. declare module "babylonjs/Cameras/universalCamera" {
  47590. import { TouchCamera } from "babylonjs/Cameras/touchCamera";
  47591. import { Scene } from "babylonjs/scene";
  47592. import { Vector3 } from "babylonjs/Maths/math.vector";
  47593. import "babylonjs/Gamepads/gamepadSceneComponent";
  47594. /**
  47595. * 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,
  47596. * which still works and will still be found in many Playgrounds.
  47597. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47598. */
  47599. export class UniversalCamera extends TouchCamera {
  47600. /**
  47601. * Defines the gamepad rotation sensiblity.
  47602. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  47603. */
  47604. get gamepadAngularSensibility(): number;
  47605. set gamepadAngularSensibility(value: number);
  47606. /**
  47607. * Defines the gamepad move sensiblity.
  47608. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  47609. */
  47610. get gamepadMoveSensibility(): number;
  47611. set gamepadMoveSensibility(value: number);
  47612. /**
  47613. * 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,
  47614. * which still works and will still be found in many Playgrounds.
  47615. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47616. * @param name Define the name of the camera in the scene
  47617. * @param position Define the start position of the camera in the scene
  47618. * @param scene Define the scene the camera belongs to
  47619. */
  47620. constructor(name: string, position: Vector3, scene: Scene);
  47621. /**
  47622. * Gets the current object class name.
  47623. * @return the class name
  47624. */
  47625. getClassName(): string;
  47626. }
  47627. }
  47628. declare module "babylonjs/Cameras/gamepadCamera" {
  47629. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47630. import { Scene } from "babylonjs/scene";
  47631. import { Vector3 } from "babylonjs/Maths/math.vector";
  47632. /**
  47633. * This represents a FPS type of camera. This is only here for back compat purpose.
  47634. * Please use the UniversalCamera instead as both are identical.
  47635. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47636. */
  47637. export class GamepadCamera extends UniversalCamera {
  47638. /**
  47639. * Instantiates a new Gamepad Camera
  47640. * This represents a FPS type of camera. This is only here for back compat purpose.
  47641. * Please use the UniversalCamera instead as both are identical.
  47642. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47643. * @param name Define the name of the camera in the scene
  47644. * @param position Define the start position of the camera in the scene
  47645. * @param scene Define the scene the camera belongs to
  47646. */
  47647. constructor(name: string, position: Vector3, scene: Scene);
  47648. /**
  47649. * Gets the current object class name.
  47650. * @return the class name
  47651. */
  47652. getClassName(): string;
  47653. }
  47654. }
  47655. declare module "babylonjs/Shaders/pass.fragment" {
  47656. /** @hidden */
  47657. export var passPixelShader: {
  47658. name: string;
  47659. shader: string;
  47660. };
  47661. }
  47662. declare module "babylonjs/Shaders/passCube.fragment" {
  47663. /** @hidden */
  47664. export var passCubePixelShader: {
  47665. name: string;
  47666. shader: string;
  47667. };
  47668. }
  47669. declare module "babylonjs/PostProcesses/passPostProcess" {
  47670. import { Nullable } from "babylonjs/types";
  47671. import { Camera } from "babylonjs/Cameras/camera";
  47672. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  47673. import { Engine } from "babylonjs/Engines/engine";
  47674. import "babylonjs/Shaders/pass.fragment";
  47675. import "babylonjs/Shaders/passCube.fragment";
  47676. import { Scene } from "babylonjs/scene";
  47677. /**
  47678. * PassPostProcess which produces an output the same as it's input
  47679. */
  47680. export class PassPostProcess extends PostProcess {
  47681. /**
  47682. * Gets a string identifying the name of the class
  47683. * @returns "PassPostProcess" string
  47684. */
  47685. getClassName(): string;
  47686. /**
  47687. * Creates the PassPostProcess
  47688. * @param name The name of the effect.
  47689. * @param options The required width/height ratio to downsize to before computing the render pass.
  47690. * @param camera The camera to apply the render pass to.
  47691. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  47692. * @param engine The engine which the post process will be applied. (default: current engine)
  47693. * @param reusable If the post process can be reused on the same frame. (default: false)
  47694. * @param textureType The type of texture to be used when performing the post processing.
  47695. * @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)
  47696. */
  47697. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  47698. /** @hidden */
  47699. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassPostProcess;
  47700. }
  47701. /**
  47702. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  47703. */
  47704. export class PassCubePostProcess extends PostProcess {
  47705. private _face;
  47706. /**
  47707. * Gets or sets the cube face to display.
  47708. * * 0 is +X
  47709. * * 1 is -X
  47710. * * 2 is +Y
  47711. * * 3 is -Y
  47712. * * 4 is +Z
  47713. * * 5 is -Z
  47714. */
  47715. get face(): number;
  47716. set face(value: number);
  47717. /**
  47718. * Gets a string identifying the name of the class
  47719. * @returns "PassCubePostProcess" string
  47720. */
  47721. getClassName(): string;
  47722. /**
  47723. * Creates the PassCubePostProcess
  47724. * @param name The name of the effect.
  47725. * @param options The required width/height ratio to downsize to before computing the render pass.
  47726. * @param camera The camera to apply the render pass to.
  47727. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  47728. * @param engine The engine which the post process will be applied. (default: current engine)
  47729. * @param reusable If the post process can be reused on the same frame. (default: false)
  47730. * @param textureType The type of texture to be used when performing the post processing.
  47731. * @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)
  47732. */
  47733. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  47734. /** @hidden */
  47735. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassCubePostProcess;
  47736. }
  47737. }
  47738. declare module "babylonjs/Shaders/anaglyph.fragment" {
  47739. /** @hidden */
  47740. export var anaglyphPixelShader: {
  47741. name: string;
  47742. shader: string;
  47743. };
  47744. }
  47745. declare module "babylonjs/PostProcesses/anaglyphPostProcess" {
  47746. import { Engine } from "babylonjs/Engines/engine";
  47747. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  47748. import { Camera } from "babylonjs/Cameras/camera";
  47749. import "babylonjs/Shaders/anaglyph.fragment";
  47750. /**
  47751. * Postprocess used to generate anaglyphic rendering
  47752. */
  47753. export class AnaglyphPostProcess extends PostProcess {
  47754. private _passedProcess;
  47755. /**
  47756. * Gets a string identifying the name of the class
  47757. * @returns "AnaglyphPostProcess" string
  47758. */
  47759. getClassName(): string;
  47760. /**
  47761. * Creates a new AnaglyphPostProcess
  47762. * @param name defines postprocess name
  47763. * @param options defines creation options or target ratio scale
  47764. * @param rigCameras defines cameras using this postprocess
  47765. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  47766. * @param engine defines hosting engine
  47767. * @param reusable defines if the postprocess will be reused multiple times per frame
  47768. */
  47769. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  47770. }
  47771. }
  47772. declare module "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode" { }
  47773. declare module "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera" {
  47774. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47775. import { Scene } from "babylonjs/scene";
  47776. import { Vector3 } from "babylonjs/Maths/math.vector";
  47777. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47778. /**
  47779. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  47780. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47781. */
  47782. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  47783. /**
  47784. * Creates a new AnaglyphArcRotateCamera
  47785. * @param name defines camera name
  47786. * @param alpha defines alpha angle (in radians)
  47787. * @param beta defines beta angle (in radians)
  47788. * @param radius defines radius
  47789. * @param target defines camera target
  47790. * @param interaxialDistance defines distance between each color axis
  47791. * @param scene defines the hosting scene
  47792. */
  47793. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  47794. /**
  47795. * Gets camera class name
  47796. * @returns AnaglyphArcRotateCamera
  47797. */
  47798. getClassName(): string;
  47799. }
  47800. }
  47801. declare module "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera" {
  47802. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47803. import { Scene } from "babylonjs/scene";
  47804. import { Vector3 } from "babylonjs/Maths/math.vector";
  47805. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47806. /**
  47807. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  47808. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47809. */
  47810. export class AnaglyphFreeCamera extends FreeCamera {
  47811. /**
  47812. * Creates a new AnaglyphFreeCamera
  47813. * @param name defines camera name
  47814. * @param position defines initial position
  47815. * @param interaxialDistance defines distance between each color axis
  47816. * @param scene defines the hosting scene
  47817. */
  47818. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47819. /**
  47820. * Gets camera class name
  47821. * @returns AnaglyphFreeCamera
  47822. */
  47823. getClassName(): string;
  47824. }
  47825. }
  47826. declare module "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera" {
  47827. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  47828. import { Scene } from "babylonjs/scene";
  47829. import { Vector3 } from "babylonjs/Maths/math.vector";
  47830. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47831. /**
  47832. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  47833. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47834. */
  47835. export class AnaglyphGamepadCamera extends GamepadCamera {
  47836. /**
  47837. * Creates a new AnaglyphGamepadCamera
  47838. * @param name defines camera name
  47839. * @param position defines initial position
  47840. * @param interaxialDistance defines distance between each color axis
  47841. * @param scene defines the hosting scene
  47842. */
  47843. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47844. /**
  47845. * Gets camera class name
  47846. * @returns AnaglyphGamepadCamera
  47847. */
  47848. getClassName(): string;
  47849. }
  47850. }
  47851. declare module "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera" {
  47852. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47853. import { Scene } from "babylonjs/scene";
  47854. import { Vector3 } from "babylonjs/Maths/math.vector";
  47855. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47856. /**
  47857. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  47858. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47859. */
  47860. export class AnaglyphUniversalCamera extends UniversalCamera {
  47861. /**
  47862. * Creates a new AnaglyphUniversalCamera
  47863. * @param name defines camera name
  47864. * @param position defines initial position
  47865. * @param interaxialDistance defines distance between each color axis
  47866. * @param scene defines the hosting scene
  47867. */
  47868. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47869. /**
  47870. * Gets camera class name
  47871. * @returns AnaglyphUniversalCamera
  47872. */
  47873. getClassName(): string;
  47874. }
  47875. }
  47876. declare module "babylonjs/Cameras/RigModes/stereoscopicRigMode" { }
  47877. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera" {
  47878. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47879. import { Scene } from "babylonjs/scene";
  47880. import { Vector3 } from "babylonjs/Maths/math.vector";
  47881. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47882. /**
  47883. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  47884. * @see https://doc.babylonjs.com/features/cameras
  47885. */
  47886. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  47887. /**
  47888. * Creates a new StereoscopicArcRotateCamera
  47889. * @param name defines camera name
  47890. * @param alpha defines alpha angle (in radians)
  47891. * @param beta defines beta angle (in radians)
  47892. * @param radius defines radius
  47893. * @param target defines camera target
  47894. * @param interaxialDistance defines distance between each color axis
  47895. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47896. * @param scene defines the hosting scene
  47897. */
  47898. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47899. /**
  47900. * Gets camera class name
  47901. * @returns StereoscopicArcRotateCamera
  47902. */
  47903. getClassName(): string;
  47904. }
  47905. }
  47906. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera" {
  47907. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47908. import { Scene } from "babylonjs/scene";
  47909. import { Vector3 } from "babylonjs/Maths/math.vector";
  47910. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47911. /**
  47912. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  47913. * @see https://doc.babylonjs.com/features/cameras
  47914. */
  47915. export class StereoscopicFreeCamera extends FreeCamera {
  47916. /**
  47917. * Creates a new StereoscopicFreeCamera
  47918. * @param name defines camera name
  47919. * @param position defines initial position
  47920. * @param interaxialDistance defines distance between each color axis
  47921. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47922. * @param scene defines the hosting scene
  47923. */
  47924. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47925. /**
  47926. * Gets camera class name
  47927. * @returns StereoscopicFreeCamera
  47928. */
  47929. getClassName(): string;
  47930. }
  47931. }
  47932. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera" {
  47933. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  47934. import { Scene } from "babylonjs/scene";
  47935. import { Vector3 } from "babylonjs/Maths/math.vector";
  47936. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47937. /**
  47938. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  47939. * @see https://doc.babylonjs.com/features/cameras
  47940. */
  47941. export class StereoscopicGamepadCamera extends GamepadCamera {
  47942. /**
  47943. * Creates a new StereoscopicGamepadCamera
  47944. * @param name defines camera name
  47945. * @param position defines initial position
  47946. * @param interaxialDistance defines distance between each color axis
  47947. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47948. * @param scene defines the hosting scene
  47949. */
  47950. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47951. /**
  47952. * Gets camera class name
  47953. * @returns StereoscopicGamepadCamera
  47954. */
  47955. getClassName(): string;
  47956. }
  47957. }
  47958. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera" {
  47959. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47960. import { Scene } from "babylonjs/scene";
  47961. import { Vector3 } from "babylonjs/Maths/math.vector";
  47962. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47963. /**
  47964. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  47965. * @see https://doc.babylonjs.com/features/cameras
  47966. */
  47967. export class StereoscopicUniversalCamera extends UniversalCamera {
  47968. /**
  47969. * Creates a new StereoscopicUniversalCamera
  47970. * @param name defines camera name
  47971. * @param position defines initial position
  47972. * @param interaxialDistance defines distance between each color axis
  47973. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47974. * @param scene defines the hosting scene
  47975. */
  47976. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47977. /**
  47978. * Gets camera class name
  47979. * @returns StereoscopicUniversalCamera
  47980. */
  47981. getClassName(): string;
  47982. }
  47983. }
  47984. declare module "babylonjs/Cameras/Stereoscopic/index" {
  47985. export * from "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera";
  47986. export * from "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera";
  47987. export * from "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera";
  47988. export * from "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera";
  47989. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera";
  47990. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera";
  47991. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera";
  47992. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera";
  47993. }
  47994. declare module "babylonjs/Cameras/virtualJoysticksCamera" {
  47995. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47996. import { Scene } from "babylonjs/scene";
  47997. import { Vector3 } from "babylonjs/Maths/math.vector";
  47998. import "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  47999. /**
  48000. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  48001. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  48002. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  48003. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  48004. */
  48005. export class VirtualJoysticksCamera extends FreeCamera {
  48006. /**
  48007. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  48008. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  48009. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  48010. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  48011. * @param name Define the name of the camera in the scene
  48012. * @param position Define the start position of the camera in the scene
  48013. * @param scene Define the scene the camera belongs to
  48014. */
  48015. constructor(name: string, position: Vector3, scene: Scene);
  48016. /**
  48017. * Gets the current object class name.
  48018. * @return the class name
  48019. */
  48020. getClassName(): string;
  48021. }
  48022. }
  48023. declare module "babylonjs/Cameras/VR/vrCameraMetrics" {
  48024. import { Matrix } from "babylonjs/Maths/math.vector";
  48025. /**
  48026. * This represents all the required metrics to create a VR camera.
  48027. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  48028. */
  48029. export class VRCameraMetrics {
  48030. /**
  48031. * Define the horizontal resolution off the screen.
  48032. */
  48033. hResolution: number;
  48034. /**
  48035. * Define the vertical resolution off the screen.
  48036. */
  48037. vResolution: number;
  48038. /**
  48039. * Define the horizontal screen size.
  48040. */
  48041. hScreenSize: number;
  48042. /**
  48043. * Define the vertical screen size.
  48044. */
  48045. vScreenSize: number;
  48046. /**
  48047. * Define the vertical screen center position.
  48048. */
  48049. vScreenCenter: number;
  48050. /**
  48051. * Define the distance of the eyes to the screen.
  48052. */
  48053. eyeToScreenDistance: number;
  48054. /**
  48055. * Define the distance between both lenses
  48056. */
  48057. lensSeparationDistance: number;
  48058. /**
  48059. * Define the distance between both viewer's eyes.
  48060. */
  48061. interpupillaryDistance: number;
  48062. /**
  48063. * Define the distortion factor of the VR postprocess.
  48064. * Please, touch with care.
  48065. */
  48066. distortionK: number[];
  48067. /**
  48068. * Define the chromatic aberration correction factors for the VR post process.
  48069. */
  48070. chromaAbCorrection: number[];
  48071. /**
  48072. * Define the scale factor of the post process.
  48073. * The smaller the better but the slower.
  48074. */
  48075. postProcessScaleFactor: number;
  48076. /**
  48077. * Define an offset for the lens center.
  48078. */
  48079. lensCenterOffset: number;
  48080. /**
  48081. * Define if the current vr camera should compensate the distortion of the lense or not.
  48082. */
  48083. compensateDistortion: boolean;
  48084. /**
  48085. * Defines if multiview should be enabled when rendering (Default: false)
  48086. */
  48087. multiviewEnabled: boolean;
  48088. /**
  48089. * Gets the rendering aspect ratio based on the provided resolutions.
  48090. */
  48091. get aspectRatio(): number;
  48092. /**
  48093. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  48094. */
  48095. get aspectRatioFov(): number;
  48096. /**
  48097. * @hidden
  48098. */
  48099. get leftHMatrix(): Matrix;
  48100. /**
  48101. * @hidden
  48102. */
  48103. get rightHMatrix(): Matrix;
  48104. /**
  48105. * @hidden
  48106. */
  48107. get leftPreViewMatrix(): Matrix;
  48108. /**
  48109. * @hidden
  48110. */
  48111. get rightPreViewMatrix(): Matrix;
  48112. /**
  48113. * Get the default VRMetrics based on the most generic setup.
  48114. * @returns the default vr metrics
  48115. */
  48116. static GetDefault(): VRCameraMetrics;
  48117. }
  48118. }
  48119. declare module "babylonjs/Shaders/vrDistortionCorrection.fragment" {
  48120. /** @hidden */
  48121. export var vrDistortionCorrectionPixelShader: {
  48122. name: string;
  48123. shader: string;
  48124. };
  48125. }
  48126. declare module "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess" {
  48127. import { Camera } from "babylonjs/Cameras/camera";
  48128. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48129. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  48130. import "babylonjs/Shaders/vrDistortionCorrection.fragment";
  48131. /**
  48132. * VRDistortionCorrectionPostProcess used for mobile VR
  48133. */
  48134. export class VRDistortionCorrectionPostProcess extends PostProcess {
  48135. private _isRightEye;
  48136. private _distortionFactors;
  48137. private _postProcessScaleFactor;
  48138. private _lensCenterOffset;
  48139. private _scaleIn;
  48140. private _scaleFactor;
  48141. private _lensCenter;
  48142. /**
  48143. * Gets a string identifying the name of the class
  48144. * @returns "VRDistortionCorrectionPostProcess" string
  48145. */
  48146. getClassName(): string;
  48147. /**
  48148. * Initializes the VRDistortionCorrectionPostProcess
  48149. * @param name The name of the effect.
  48150. * @param camera The camera to apply the render pass to.
  48151. * @param isRightEye If this is for the right eye distortion
  48152. * @param vrMetrics All the required metrics for the VR camera
  48153. */
  48154. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  48155. }
  48156. }
  48157. declare module "babylonjs/Cameras/RigModes/vrRigMode" { }
  48158. declare module "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera" {
  48159. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  48160. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48161. import { Scene } from "babylonjs/scene";
  48162. import { Vector3 } from "babylonjs/Maths/math.vector";
  48163. import "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  48164. import "babylonjs/Cameras/RigModes/vrRigMode";
  48165. /**
  48166. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  48167. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48168. */
  48169. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  48170. /**
  48171. * Creates a new VRDeviceOrientationArcRotateCamera
  48172. * @param name defines camera name
  48173. * @param alpha defines the camera rotation along the logitudinal axis
  48174. * @param beta defines the camera rotation along the latitudinal axis
  48175. * @param radius defines the camera distance from its target
  48176. * @param target defines the camera target
  48177. * @param scene defines the scene the camera belongs to
  48178. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48179. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48180. */
  48181. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48182. /**
  48183. * Gets camera class name
  48184. * @returns VRDeviceOrientationArcRotateCamera
  48185. */
  48186. getClassName(): string;
  48187. }
  48188. }
  48189. declare module "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera" {
  48190. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  48191. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48192. import { Scene } from "babylonjs/scene";
  48193. import { Vector3 } from "babylonjs/Maths/math.vector";
  48194. import "babylonjs/Cameras/RigModes/vrRigMode";
  48195. /**
  48196. * Camera used to simulate VR rendering (based on FreeCamera)
  48197. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48198. */
  48199. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  48200. /**
  48201. * Creates a new VRDeviceOrientationFreeCamera
  48202. * @param name defines camera name
  48203. * @param position defines the start position of the camera
  48204. * @param scene defines the scene the camera belongs to
  48205. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48206. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48207. */
  48208. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48209. /**
  48210. * Gets camera class name
  48211. * @returns VRDeviceOrientationFreeCamera
  48212. */
  48213. getClassName(): string;
  48214. }
  48215. }
  48216. declare module "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera" {
  48217. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  48218. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48219. import { Scene } from "babylonjs/scene";
  48220. import { Vector3 } from "babylonjs/Maths/math.vector";
  48221. import "babylonjs/Gamepads/gamepadSceneComponent";
  48222. /**
  48223. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  48224. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48225. */
  48226. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  48227. /**
  48228. * Creates a new VRDeviceOrientationGamepadCamera
  48229. * @param name defines camera name
  48230. * @param position defines the start position of the camera
  48231. * @param scene defines the scene the camera belongs to
  48232. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48233. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48234. */
  48235. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48236. /**
  48237. * Gets camera class name
  48238. * @returns VRDeviceOrientationGamepadCamera
  48239. */
  48240. getClassName(): string;
  48241. }
  48242. }
  48243. declare module "babylonjs/Materials/Textures/dynamicTexture" {
  48244. import { Scene } from "babylonjs/scene";
  48245. import { Texture } from "babylonjs/Materials/Textures/texture";
  48246. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  48247. /**
  48248. * A class extending Texture allowing drawing on a texture
  48249. * @see https://doc.babylonjs.com/how_to/dynamictexture
  48250. */
  48251. export class DynamicTexture extends Texture {
  48252. private _generateMipMaps;
  48253. private _canvas;
  48254. private _context;
  48255. /**
  48256. * Creates a DynamicTexture
  48257. * @param name defines the name of the texture
  48258. * @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
  48259. * @param scene defines the scene where you want the texture
  48260. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  48261. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  48262. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  48263. */
  48264. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  48265. /**
  48266. * Get the current class name of the texture useful for serialization or dynamic coding.
  48267. * @returns "DynamicTexture"
  48268. */
  48269. getClassName(): string;
  48270. /**
  48271. * Gets the current state of canRescale
  48272. */
  48273. get canRescale(): boolean;
  48274. private _recreate;
  48275. /**
  48276. * Scales the texture
  48277. * @param ratio the scale factor to apply to both width and height
  48278. */
  48279. scale(ratio: number): void;
  48280. /**
  48281. * Resizes the texture
  48282. * @param width the new width
  48283. * @param height the new height
  48284. */
  48285. scaleTo(width: number, height: number): void;
  48286. /**
  48287. * Gets the context of the canvas used by the texture
  48288. * @returns the canvas context of the dynamic texture
  48289. */
  48290. getContext(): CanvasRenderingContext2D;
  48291. /**
  48292. * Clears the texture
  48293. */
  48294. clear(): void;
  48295. /**
  48296. * Updates the texture
  48297. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  48298. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  48299. */
  48300. update(invertY?: boolean, premulAlpha?: boolean): void;
  48301. /**
  48302. * Draws text onto the texture
  48303. * @param text defines the text to be drawn
  48304. * @param x defines the placement of the text from the left
  48305. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  48306. * @param font defines the font to be used with font-style, font-size, font-name
  48307. * @param color defines the color used for the text
  48308. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  48309. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  48310. * @param update defines whether texture is immediately update (default is true)
  48311. */
  48312. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  48313. /**
  48314. * Clones the texture
  48315. * @returns the clone of the texture.
  48316. */
  48317. clone(): DynamicTexture;
  48318. /**
  48319. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  48320. * @returns a serialized dynamic texture object
  48321. */
  48322. serialize(): any;
  48323. private _IsCanvasElement;
  48324. /** @hidden */
  48325. _rebuild(): void;
  48326. }
  48327. }
  48328. declare module "babylonjs/Meshes/Builders/groundBuilder" {
  48329. import { Scene } from "babylonjs/scene";
  48330. import { Color3 } from "babylonjs/Maths/math.color";
  48331. import { Mesh } from "babylonjs/Meshes/mesh";
  48332. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  48333. import { Nullable } from "babylonjs/types";
  48334. /**
  48335. * Class containing static functions to help procedurally build meshes
  48336. */
  48337. export class GroundBuilder {
  48338. /**
  48339. * Creates a ground mesh
  48340. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  48341. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  48342. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  48343. * @param name defines the name of the mesh
  48344. * @param options defines the options used to create the mesh
  48345. * @param scene defines the hosting scene
  48346. * @returns the ground mesh
  48347. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  48348. */
  48349. static CreateGround(name: string, options: {
  48350. width?: number;
  48351. height?: number;
  48352. subdivisions?: number;
  48353. subdivisionsX?: number;
  48354. subdivisionsY?: number;
  48355. updatable?: boolean;
  48356. }, scene: any): Mesh;
  48357. /**
  48358. * Creates a tiled ground mesh
  48359. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  48360. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  48361. * * 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
  48362. * * 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
  48363. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48364. * @param name defines the name of the mesh
  48365. * @param options defines the options used to create the mesh
  48366. * @param scene defines the hosting scene
  48367. * @returns the tiled ground mesh
  48368. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  48369. */
  48370. static CreateTiledGround(name: string, options: {
  48371. xmin: number;
  48372. zmin: number;
  48373. xmax: number;
  48374. zmax: number;
  48375. subdivisions?: {
  48376. w: number;
  48377. h: number;
  48378. };
  48379. precision?: {
  48380. w: number;
  48381. h: number;
  48382. };
  48383. updatable?: boolean;
  48384. }, scene?: Nullable<Scene>): Mesh;
  48385. /**
  48386. * Creates a ground mesh from a height map
  48387. * * The parameter `url` sets the URL of the height map image resource.
  48388. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  48389. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  48390. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  48391. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  48392. * * 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.
  48393. * * 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).
  48394. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  48395. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48396. * @param name defines the name of the mesh
  48397. * @param url defines the url to the height map
  48398. * @param options defines the options used to create the mesh
  48399. * @param scene defines the hosting scene
  48400. * @returns the ground mesh
  48401. * @see https://doc.babylonjs.com/babylon101/height_map
  48402. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  48403. */
  48404. static CreateGroundFromHeightMap(name: string, url: string, options: {
  48405. width?: number;
  48406. height?: number;
  48407. subdivisions?: number;
  48408. minHeight?: number;
  48409. maxHeight?: number;
  48410. colorFilter?: Color3;
  48411. alphaFilter?: number;
  48412. updatable?: boolean;
  48413. onReady?: (mesh: GroundMesh) => void;
  48414. }, scene?: Nullable<Scene>): GroundMesh;
  48415. }
  48416. }
  48417. declare module "babylonjs/Meshes/Builders/torusBuilder" {
  48418. import { Vector4 } from "babylonjs/Maths/math.vector";
  48419. import { Mesh } from "babylonjs/Meshes/mesh";
  48420. /**
  48421. * Class containing static functions to help procedurally build meshes
  48422. */
  48423. export class TorusBuilder {
  48424. /**
  48425. * Creates a torus mesh
  48426. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  48427. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  48428. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  48429. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  48430. * * 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
  48431. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48432. * @param name defines the name of the mesh
  48433. * @param options defines the options used to create the mesh
  48434. * @param scene defines the hosting scene
  48435. * @returns the torus mesh
  48436. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  48437. */
  48438. static CreateTorus(name: string, options: {
  48439. diameter?: number;
  48440. thickness?: number;
  48441. tessellation?: number;
  48442. updatable?: boolean;
  48443. sideOrientation?: number;
  48444. frontUVs?: Vector4;
  48445. backUVs?: Vector4;
  48446. }, scene: any): Mesh;
  48447. }
  48448. }
  48449. declare module "babylonjs/Meshes/Builders/cylinderBuilder" {
  48450. import { Vector4 } from "babylonjs/Maths/math.vector";
  48451. import { Color4 } from "babylonjs/Maths/math.color";
  48452. import { Mesh } from "babylonjs/Meshes/mesh";
  48453. /**
  48454. * Class containing static functions to help procedurally build meshes
  48455. */
  48456. export class CylinderBuilder {
  48457. /**
  48458. * Creates a cylinder or a cone mesh
  48459. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  48460. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  48461. * * 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.
  48462. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  48463. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  48464. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  48465. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  48466. * * 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).
  48467. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  48468. * * 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).
  48469. * * 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
  48470. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  48471. * * 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
  48472. * * 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.
  48473. * * If `enclose` is false, a ring surface is one element.
  48474. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  48475. * * 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
  48476. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  48477. * * 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
  48478. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48479. * @param name defines the name of the mesh
  48480. * @param options defines the options used to create the mesh
  48481. * @param scene defines the hosting scene
  48482. * @returns the cylinder mesh
  48483. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  48484. */
  48485. static CreateCylinder(name: string, options: {
  48486. height?: number;
  48487. diameterTop?: number;
  48488. diameterBottom?: number;
  48489. diameter?: number;
  48490. tessellation?: number;
  48491. subdivisions?: number;
  48492. arc?: number;
  48493. faceColors?: Color4[];
  48494. faceUV?: Vector4[];
  48495. updatable?: boolean;
  48496. hasRings?: boolean;
  48497. enclose?: boolean;
  48498. cap?: number;
  48499. sideOrientation?: number;
  48500. frontUVs?: Vector4;
  48501. backUVs?: Vector4;
  48502. }, scene: any): Mesh;
  48503. }
  48504. }
  48505. declare module "babylonjs/XR/webXRTypes" {
  48506. import { Nullable } from "babylonjs/types";
  48507. import { IDisposable } from "babylonjs/scene";
  48508. /**
  48509. * States of the webXR experience
  48510. */
  48511. export enum WebXRState {
  48512. /**
  48513. * Transitioning to being in XR mode
  48514. */
  48515. ENTERING_XR = 0,
  48516. /**
  48517. * Transitioning to non XR mode
  48518. */
  48519. EXITING_XR = 1,
  48520. /**
  48521. * In XR mode and presenting
  48522. */
  48523. IN_XR = 2,
  48524. /**
  48525. * Not entered XR mode
  48526. */
  48527. NOT_IN_XR = 3
  48528. }
  48529. /**
  48530. * Abstraction of the XR render target
  48531. */
  48532. export interface WebXRRenderTarget extends IDisposable {
  48533. /**
  48534. * xrpresent context of the canvas which can be used to display/mirror xr content
  48535. */
  48536. canvasContext: WebGLRenderingContext;
  48537. /**
  48538. * xr layer for the canvas
  48539. */
  48540. xrLayer: Nullable<XRWebGLLayer>;
  48541. /**
  48542. * Initializes the xr layer for the session
  48543. * @param xrSession xr session
  48544. * @returns a promise that will resolve once the XR Layer has been created
  48545. */
  48546. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  48547. }
  48548. }
  48549. declare module "babylonjs/XR/webXRManagedOutputCanvas" {
  48550. import { Nullable } from "babylonjs/types";
  48551. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  48552. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48553. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48554. import { Observable } from "babylonjs/Misc/observable";
  48555. /**
  48556. * COnfiguration object for WebXR output canvas
  48557. */
  48558. export class WebXRManagedOutputCanvasOptions {
  48559. /**
  48560. * An optional canvas in case you wish to create it yourself and provide it here.
  48561. * If not provided, a new canvas will be created
  48562. */
  48563. canvasElement?: HTMLCanvasElement;
  48564. /**
  48565. * Options for this XR Layer output
  48566. */
  48567. canvasOptions?: XRWebGLLayerOptions;
  48568. /**
  48569. * CSS styling for a newly created canvas (if not provided)
  48570. */
  48571. newCanvasCssStyle?: string;
  48572. /**
  48573. * Get the default values of the configuration object
  48574. * @param engine defines the engine to use (can be null)
  48575. * @returns default values of this configuration object
  48576. */
  48577. static GetDefaults(engine?: ThinEngine): WebXRManagedOutputCanvasOptions;
  48578. }
  48579. /**
  48580. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  48581. */
  48582. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  48583. private _options;
  48584. private _canvas;
  48585. private _engine;
  48586. private _originalCanvasSize;
  48587. /**
  48588. * Rendering context of the canvas which can be used to display/mirror xr content
  48589. */
  48590. canvasContext: WebGLRenderingContext;
  48591. /**
  48592. * xr layer for the canvas
  48593. */
  48594. xrLayer: Nullable<XRWebGLLayer>;
  48595. /**
  48596. * Obseervers registered here will be triggered when the xr layer was initialized
  48597. */
  48598. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  48599. /**
  48600. * Initializes the canvas to be added/removed upon entering/exiting xr
  48601. * @param _xrSessionManager The XR Session manager
  48602. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  48603. */
  48604. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  48605. /**
  48606. * Disposes of the object
  48607. */
  48608. dispose(): void;
  48609. /**
  48610. * Initializes the xr layer for the session
  48611. * @param xrSession xr session
  48612. * @returns a promise that will resolve once the XR Layer has been created
  48613. */
  48614. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  48615. private _addCanvas;
  48616. private _removeCanvas;
  48617. private _setCanvasSize;
  48618. private _setManagedOutputCanvas;
  48619. }
  48620. }
  48621. declare module "babylonjs/XR/webXRSessionManager" {
  48622. import { Observable } from "babylonjs/Misc/observable";
  48623. import { Nullable } from "babylonjs/types";
  48624. import { IDisposable, Scene } from "babylonjs/scene";
  48625. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  48626. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48627. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  48628. /**
  48629. * Manages an XRSession to work with Babylon's engine
  48630. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  48631. */
  48632. export class WebXRSessionManager implements IDisposable {
  48633. /** The scene which the session should be created for */
  48634. scene: Scene;
  48635. private _referenceSpace;
  48636. private _rttProvider;
  48637. private _sessionEnded;
  48638. private _xrNavigator;
  48639. private baseLayer;
  48640. /**
  48641. * The base reference space from which the session started. good if you want to reset your
  48642. * reference space
  48643. */
  48644. baseReferenceSpace: XRReferenceSpace;
  48645. /**
  48646. * Current XR frame
  48647. */
  48648. currentFrame: Nullable<XRFrame>;
  48649. /** WebXR timestamp updated every frame */
  48650. currentTimestamp: number;
  48651. /**
  48652. * Used just in case of a failure to initialize an immersive session.
  48653. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  48654. */
  48655. defaultHeightCompensation: number;
  48656. /**
  48657. * Fires every time a new xrFrame arrives which can be used to update the camera
  48658. */
  48659. onXRFrameObservable: Observable<XRFrame>;
  48660. /**
  48661. * Fires when the reference space changed
  48662. */
  48663. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  48664. /**
  48665. * Fires when the xr session is ended either by the device or manually done
  48666. */
  48667. onXRSessionEnded: Observable<any>;
  48668. /**
  48669. * Fires when the xr session is ended either by the device or manually done
  48670. */
  48671. onXRSessionInit: Observable<XRSession>;
  48672. /**
  48673. * Underlying xr session
  48674. */
  48675. session: XRSession;
  48676. /**
  48677. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  48678. * or get the offset the player is currently at.
  48679. */
  48680. viewerReferenceSpace: XRReferenceSpace;
  48681. /**
  48682. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  48683. * @param scene The scene which the session should be created for
  48684. */
  48685. constructor(
  48686. /** The scene which the session should be created for */
  48687. scene: Scene);
  48688. /**
  48689. * The current reference space used in this session. This reference space can constantly change!
  48690. * It is mainly used to offset the camera's position.
  48691. */
  48692. get referenceSpace(): XRReferenceSpace;
  48693. /**
  48694. * Set a new reference space and triggers the observable
  48695. */
  48696. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  48697. /**
  48698. * Disposes of the session manager
  48699. */
  48700. dispose(): void;
  48701. /**
  48702. * Stops the xrSession and restores the render loop
  48703. * @returns Promise which resolves after it exits XR
  48704. */
  48705. exitXRAsync(): Promise<void>;
  48706. /**
  48707. * Gets the correct render target texture to be rendered this frame for this eye
  48708. * @param eye the eye for which to get the render target
  48709. * @returns the render target for the specified eye
  48710. */
  48711. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  48712. /**
  48713. * Creates a WebXRRenderTarget object for the XR session
  48714. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  48715. * @param options optional options to provide when creating a new render target
  48716. * @returns a WebXR render target to which the session can render
  48717. */
  48718. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  48719. /**
  48720. * Initializes the manager
  48721. * After initialization enterXR can be called to start an XR session
  48722. * @returns Promise which resolves after it is initialized
  48723. */
  48724. initializeAsync(): Promise<void>;
  48725. /**
  48726. * Initializes an xr session
  48727. * @param xrSessionMode mode to initialize
  48728. * @param xrSessionInit defines optional and required values to pass to the session builder
  48729. * @returns a promise which will resolve once the session has been initialized
  48730. */
  48731. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  48732. /**
  48733. * Checks if a session would be supported for the creation options specified
  48734. * @param sessionMode session mode to check if supported eg. immersive-vr
  48735. * @returns A Promise that resolves to true if supported and false if not
  48736. */
  48737. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  48738. /**
  48739. * Resets the reference space to the one started the session
  48740. */
  48741. resetReferenceSpace(): void;
  48742. /**
  48743. * Starts rendering to the xr layer
  48744. */
  48745. runXRRenderLoop(): void;
  48746. /**
  48747. * Sets the reference space on the xr session
  48748. * @param referenceSpaceType space to set
  48749. * @returns a promise that will resolve once the reference space has been set
  48750. */
  48751. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  48752. /**
  48753. * Updates the render state of the session
  48754. * @param state state to set
  48755. * @returns a promise that resolves once the render state has been updated
  48756. */
  48757. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  48758. /**
  48759. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  48760. * @param sessionMode defines the session to test
  48761. * @returns a promise with boolean as final value
  48762. */
  48763. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  48764. private _createRenderTargetTexture;
  48765. }
  48766. }
  48767. declare module "babylonjs/XR/webXRCamera" {
  48768. import { Vector3 } from "babylonjs/Maths/math.vector";
  48769. import { Scene } from "babylonjs/scene";
  48770. import { Camera } from "babylonjs/Cameras/camera";
  48771. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  48772. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48773. import { Observable } from "babylonjs/Misc/observable";
  48774. /**
  48775. * WebXR Camera which holds the views for the xrSession
  48776. * @see https://doc.babylonjs.com/how_to/webxr_camera
  48777. */
  48778. export class WebXRCamera extends FreeCamera {
  48779. private _xrSessionManager;
  48780. private _firstFrame;
  48781. private _referenceQuaternion;
  48782. private _referencedPosition;
  48783. private _xrInvPositionCache;
  48784. private _xrInvQuaternionCache;
  48785. /**
  48786. * Observable raised before camera teleportation
  48787. */
  48788. onBeforeCameraTeleport: Observable<Vector3>;
  48789. /**
  48790. * Observable raised after camera teleportation
  48791. */
  48792. onAfterCameraTeleport: Observable<Vector3>;
  48793. /**
  48794. * Should position compensation execute on first frame.
  48795. * This is used when copying the position from a native (non XR) camera
  48796. */
  48797. compensateOnFirstFrame: boolean;
  48798. /**
  48799. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  48800. * @param name the name of the camera
  48801. * @param scene the scene to add the camera to
  48802. * @param _xrSessionManager a constructed xr session manager
  48803. */
  48804. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  48805. /**
  48806. * Return the user's height, unrelated to the current ground.
  48807. * This will be the y position of this camera, when ground level is 0.
  48808. */
  48809. get realWorldHeight(): number;
  48810. /** @hidden */
  48811. _updateForDualEyeDebugging(): void;
  48812. /**
  48813. * Sets this camera's transformation based on a non-vr camera
  48814. * @param otherCamera the non-vr camera to copy the transformation from
  48815. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  48816. */
  48817. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  48818. /**
  48819. * Gets the current instance class name ("WebXRCamera").
  48820. * @returns the class name
  48821. */
  48822. getClassName(): string;
  48823. private _rotate180;
  48824. private _updateFromXRSession;
  48825. private _updateNumberOfRigCameras;
  48826. private _updateReferenceSpace;
  48827. private _updateReferenceSpaceOffset;
  48828. }
  48829. }
  48830. declare module "babylonjs/XR/webXRFeaturesManager" {
  48831. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48832. import { IDisposable } from "babylonjs/scene";
  48833. /**
  48834. * Defining the interface required for a (webxr) feature
  48835. */
  48836. export interface IWebXRFeature extends IDisposable {
  48837. /**
  48838. * Is this feature attached
  48839. */
  48840. attached: boolean;
  48841. /**
  48842. * Should auto-attach be disabled?
  48843. */
  48844. disableAutoAttach: boolean;
  48845. /**
  48846. * Attach the feature to the session
  48847. * Will usually be called by the features manager
  48848. *
  48849. * @param force should attachment be forced (even when already attached)
  48850. * @returns true if successful.
  48851. */
  48852. attach(force?: boolean): boolean;
  48853. /**
  48854. * Detach the feature from the session
  48855. * Will usually be called by the features manager
  48856. *
  48857. * @returns true if successful.
  48858. */
  48859. detach(): boolean;
  48860. /**
  48861. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  48862. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  48863. *
  48864. * @returns whether or not the feature is compatible in this environment
  48865. */
  48866. isCompatible(): boolean;
  48867. /**
  48868. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  48869. */
  48870. xrNativeFeatureName?: string;
  48871. /**
  48872. * A list of (Babylon WebXR) features this feature depends on
  48873. */
  48874. dependsOn?: string[];
  48875. }
  48876. /**
  48877. * A list of the currently available features without referencing them
  48878. */
  48879. export class WebXRFeatureName {
  48880. /**
  48881. * The name of the anchor system feature
  48882. */
  48883. static readonly ANCHOR_SYSTEM: string;
  48884. /**
  48885. * The name of the background remover feature
  48886. */
  48887. static readonly BACKGROUND_REMOVER: string;
  48888. /**
  48889. * The name of the hit test feature
  48890. */
  48891. static readonly HIT_TEST: string;
  48892. /**
  48893. * physics impostors for xr controllers feature
  48894. */
  48895. static readonly PHYSICS_CONTROLLERS: string;
  48896. /**
  48897. * The name of the plane detection feature
  48898. */
  48899. static readonly PLANE_DETECTION: string;
  48900. /**
  48901. * The name of the pointer selection feature
  48902. */
  48903. static readonly POINTER_SELECTION: string;
  48904. /**
  48905. * The name of the teleportation feature
  48906. */
  48907. static readonly TELEPORTATION: string;
  48908. /**
  48909. * The name of the feature points feature.
  48910. */
  48911. static readonly FEATURE_POINTS: string;
  48912. /**
  48913. * The name of the hand tracking feature.
  48914. */
  48915. static readonly HAND_TRACKING: string;
  48916. }
  48917. /**
  48918. * Defining the constructor of a feature. Used to register the modules.
  48919. */
  48920. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  48921. /**
  48922. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  48923. * It is mainly used in AR sessions.
  48924. *
  48925. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  48926. */
  48927. export class WebXRFeaturesManager implements IDisposable {
  48928. private _xrSessionManager;
  48929. private static readonly _AvailableFeatures;
  48930. private _features;
  48931. /**
  48932. * constructs a new features manages.
  48933. *
  48934. * @param _xrSessionManager an instance of WebXRSessionManager
  48935. */
  48936. constructor(_xrSessionManager: WebXRSessionManager);
  48937. /**
  48938. * Used to register a module. After calling this function a developer can use this feature in the scene.
  48939. * Mainly used internally.
  48940. *
  48941. * @param featureName the name of the feature to register
  48942. * @param constructorFunction the function used to construct the module
  48943. * @param version the (babylon) version of the module
  48944. * @param stable is that a stable version of this module
  48945. */
  48946. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  48947. /**
  48948. * Returns a constructor of a specific feature.
  48949. *
  48950. * @param featureName the name of the feature to construct
  48951. * @param version the version of the feature to load
  48952. * @param xrSessionManager the xrSessionManager. Used to construct the module
  48953. * @param options optional options provided to the module.
  48954. * @returns a function that, when called, will return a new instance of this feature
  48955. */
  48956. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  48957. /**
  48958. * Can be used to return the list of features currently registered
  48959. *
  48960. * @returns an Array of available features
  48961. */
  48962. static GetAvailableFeatures(): string[];
  48963. /**
  48964. * Gets the versions available for a specific feature
  48965. * @param featureName the name of the feature
  48966. * @returns an array with the available versions
  48967. */
  48968. static GetAvailableVersions(featureName: string): string[];
  48969. /**
  48970. * Return the latest unstable version of this feature
  48971. * @param featureName the name of the feature to search
  48972. * @returns the version number. if not found will return -1
  48973. */
  48974. static GetLatestVersionOfFeature(featureName: string): number;
  48975. /**
  48976. * Return the latest stable version of this feature
  48977. * @param featureName the name of the feature to search
  48978. * @returns the version number. if not found will return -1
  48979. */
  48980. static GetStableVersionOfFeature(featureName: string): number;
  48981. /**
  48982. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  48983. * Can be used during a session to start a feature
  48984. * @param featureName the name of feature to attach
  48985. */
  48986. attachFeature(featureName: string): void;
  48987. /**
  48988. * Can be used inside a session or when the session ends to detach a specific feature
  48989. * @param featureName the name of the feature to detach
  48990. */
  48991. detachFeature(featureName: string): void;
  48992. /**
  48993. * Used to disable an already-enabled feature
  48994. * The feature will be disposed and will be recreated once enabled.
  48995. * @param featureName the feature to disable
  48996. * @returns true if disable was successful
  48997. */
  48998. disableFeature(featureName: string | {
  48999. Name: string;
  49000. }): boolean;
  49001. /**
  49002. * dispose this features manager
  49003. */
  49004. dispose(): void;
  49005. /**
  49006. * 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.
  49007. * 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.
  49008. *
  49009. * @param featureName the name of the feature to load or the class of the feature
  49010. * @param version optional version to load. if not provided the latest version will be enabled
  49011. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  49012. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  49013. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  49014. * @returns a new constructed feature or throws an error if feature not found.
  49015. */
  49016. enableFeature(featureName: string | {
  49017. Name: string;
  49018. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  49019. /**
  49020. * get the implementation of an enabled feature.
  49021. * @param featureName the name of the feature to load
  49022. * @returns the feature class, if found
  49023. */
  49024. getEnabledFeature(featureName: string): IWebXRFeature;
  49025. /**
  49026. * Get the list of enabled features
  49027. * @returns an array of enabled features
  49028. */
  49029. getEnabledFeatures(): string[];
  49030. /**
  49031. * This function will exten the session creation configuration object with enabled features.
  49032. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  49033. * according to the defined "required" variable, provided during enableFeature call
  49034. * @param xrSessionInit the xr Session init object to extend
  49035. *
  49036. * @returns an extended XRSessionInit object
  49037. */
  49038. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  49039. }
  49040. }
  49041. declare module "babylonjs/XR/webXRExperienceHelper" {
  49042. import { Observable } from "babylonjs/Misc/observable";
  49043. import { IDisposable, Scene } from "babylonjs/scene";
  49044. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  49045. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  49046. import { WebXRState, WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  49047. import { WebXRFeaturesManager } from "babylonjs/XR/webXRFeaturesManager";
  49048. /**
  49049. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  49050. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  49051. */
  49052. export class WebXRExperienceHelper implements IDisposable {
  49053. private scene;
  49054. private _nonVRCamera;
  49055. private _originalSceneAutoClear;
  49056. private _supported;
  49057. /**
  49058. * Camera used to render xr content
  49059. */
  49060. camera: WebXRCamera;
  49061. /** A features manager for this xr session */
  49062. featuresManager: WebXRFeaturesManager;
  49063. /**
  49064. * Observers registered here will be triggered after the camera's initial transformation is set
  49065. * This can be used to set a different ground level or an extra rotation.
  49066. *
  49067. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  49068. * to the position set after this observable is done executing.
  49069. */
  49070. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  49071. /**
  49072. * Fires when the state of the experience helper has changed
  49073. */
  49074. onStateChangedObservable: Observable<WebXRState>;
  49075. /** Session manager used to keep track of xr session */
  49076. sessionManager: WebXRSessionManager;
  49077. /**
  49078. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  49079. */
  49080. state: WebXRState;
  49081. /**
  49082. * Creates a WebXRExperienceHelper
  49083. * @param scene The scene the helper should be created in
  49084. */
  49085. private constructor();
  49086. /**
  49087. * Creates the experience helper
  49088. * @param scene the scene to attach the experience helper to
  49089. * @returns a promise for the experience helper
  49090. */
  49091. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  49092. /**
  49093. * Disposes of the experience helper
  49094. */
  49095. dispose(): void;
  49096. /**
  49097. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  49098. * @param sessionMode options for the XR session
  49099. * @param referenceSpaceType frame of reference of the XR session
  49100. * @param renderTarget the output canvas that will be used to enter XR mode
  49101. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  49102. * @returns promise that resolves after xr mode has entered
  49103. */
  49104. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  49105. /**
  49106. * Exits XR mode and returns the scene to its original state
  49107. * @returns promise that resolves after xr mode has exited
  49108. */
  49109. exitXRAsync(): Promise<void>;
  49110. private _nonXRToXRCamera;
  49111. private _setState;
  49112. }
  49113. }
  49114. declare module "babylonjs/XR/motionController/webXRControllerComponent" {
  49115. import { IMinimalMotionControllerObject, MotionControllerComponentType } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  49116. import { Observable } from "babylonjs/Misc/observable";
  49117. import { IDisposable } from "babylonjs/scene";
  49118. /**
  49119. * X-Y values for axes in WebXR
  49120. */
  49121. export interface IWebXRMotionControllerAxesValue {
  49122. /**
  49123. * The value of the x axis
  49124. */
  49125. x: number;
  49126. /**
  49127. * The value of the y-axis
  49128. */
  49129. y: number;
  49130. }
  49131. /**
  49132. * changed / previous values for the values of this component
  49133. */
  49134. export interface IWebXRMotionControllerComponentChangesValues<T> {
  49135. /**
  49136. * current (this frame) value
  49137. */
  49138. current: T;
  49139. /**
  49140. * previous (last change) value
  49141. */
  49142. previous: T;
  49143. }
  49144. /**
  49145. * Represents changes in the component between current frame and last values recorded
  49146. */
  49147. export interface IWebXRMotionControllerComponentChanges {
  49148. /**
  49149. * will be populated with previous and current values if axes changed
  49150. */
  49151. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  49152. /**
  49153. * will be populated with previous and current values if pressed changed
  49154. */
  49155. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  49156. /**
  49157. * will be populated with previous and current values if touched changed
  49158. */
  49159. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  49160. /**
  49161. * will be populated with previous and current values if value changed
  49162. */
  49163. value?: IWebXRMotionControllerComponentChangesValues<number>;
  49164. }
  49165. /**
  49166. * This class represents a single component (for example button or thumbstick) of a motion controller
  49167. */
  49168. export class WebXRControllerComponent implements IDisposable {
  49169. /**
  49170. * the id of this component
  49171. */
  49172. id: string;
  49173. /**
  49174. * the type of the component
  49175. */
  49176. type: MotionControllerComponentType;
  49177. private _buttonIndex;
  49178. private _axesIndices;
  49179. private _axes;
  49180. private _changes;
  49181. private _currentValue;
  49182. private _hasChanges;
  49183. private _pressed;
  49184. private _touched;
  49185. /**
  49186. * button component type
  49187. */
  49188. static BUTTON_TYPE: MotionControllerComponentType;
  49189. /**
  49190. * squeeze component type
  49191. */
  49192. static SQUEEZE_TYPE: MotionControllerComponentType;
  49193. /**
  49194. * Thumbstick component type
  49195. */
  49196. static THUMBSTICK_TYPE: MotionControllerComponentType;
  49197. /**
  49198. * Touchpad component type
  49199. */
  49200. static TOUCHPAD_TYPE: MotionControllerComponentType;
  49201. /**
  49202. * trigger component type
  49203. */
  49204. static TRIGGER_TYPE: MotionControllerComponentType;
  49205. /**
  49206. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  49207. * the axes data changes
  49208. */
  49209. onAxisValueChangedObservable: Observable<{
  49210. x: number;
  49211. y: number;
  49212. }>;
  49213. /**
  49214. * Observers registered here will be triggered when the state of a button changes
  49215. * State change is either pressed / touched / value
  49216. */
  49217. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  49218. /**
  49219. * Creates a new component for a motion controller.
  49220. * It is created by the motion controller itself
  49221. *
  49222. * @param id the id of this component
  49223. * @param type the type of the component
  49224. * @param _buttonIndex index in the buttons array of the gamepad
  49225. * @param _axesIndices indices of the values in the axes array of the gamepad
  49226. */
  49227. constructor(
  49228. /**
  49229. * the id of this component
  49230. */
  49231. id: string,
  49232. /**
  49233. * the type of the component
  49234. */
  49235. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  49236. /**
  49237. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  49238. */
  49239. get axes(): IWebXRMotionControllerAxesValue;
  49240. /**
  49241. * Get the changes. Elements will be populated only if they changed with their previous and current value
  49242. */
  49243. get changes(): IWebXRMotionControllerComponentChanges;
  49244. /**
  49245. * Return whether or not the component changed the last frame
  49246. */
  49247. get hasChanges(): boolean;
  49248. /**
  49249. * is the button currently pressed
  49250. */
  49251. get pressed(): boolean;
  49252. /**
  49253. * is the button currently touched
  49254. */
  49255. get touched(): boolean;
  49256. /**
  49257. * Get the current value of this component
  49258. */
  49259. get value(): number;
  49260. /**
  49261. * Dispose this component
  49262. */
  49263. dispose(): void;
  49264. /**
  49265. * Are there axes correlating to this component
  49266. * @return true is axes data is available
  49267. */
  49268. isAxes(): boolean;
  49269. /**
  49270. * Is this component a button (hence - pressable)
  49271. * @returns true if can be pressed
  49272. */
  49273. isButton(): boolean;
  49274. /**
  49275. * update this component using the gamepad object it is in. Called on every frame
  49276. * @param nativeController the native gamepad controller object
  49277. */
  49278. update(nativeController: IMinimalMotionControllerObject): void;
  49279. }
  49280. }
  49281. declare module "babylonjs/Loading/sceneLoader" {
  49282. import { Observable } from "babylonjs/Misc/observable";
  49283. import { Nullable } from "babylonjs/types";
  49284. import { Scene } from "babylonjs/scene";
  49285. import { Engine } from "babylonjs/Engines/engine";
  49286. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49287. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  49288. import { AssetContainer } from "babylonjs/assetContainer";
  49289. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  49290. import { Skeleton } from "babylonjs/Bones/skeleton";
  49291. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  49292. import { WebRequest } from "babylonjs/Misc/webRequest";
  49293. /**
  49294. * Interface used to represent data loading progression
  49295. */
  49296. export interface ISceneLoaderProgressEvent {
  49297. /**
  49298. * Defines if data length to load can be evaluated
  49299. */
  49300. readonly lengthComputable: boolean;
  49301. /**
  49302. * Defines the loaded data length
  49303. */
  49304. readonly loaded: number;
  49305. /**
  49306. * Defines the data length to load
  49307. */
  49308. readonly total: number;
  49309. }
  49310. /**
  49311. * Interface used by SceneLoader plugins to define supported file extensions
  49312. */
  49313. export interface ISceneLoaderPluginExtensions {
  49314. /**
  49315. * Defines the list of supported extensions
  49316. */
  49317. [extension: string]: {
  49318. isBinary: boolean;
  49319. };
  49320. }
  49321. /**
  49322. * Interface used by SceneLoader plugin factory
  49323. */
  49324. export interface ISceneLoaderPluginFactory {
  49325. /**
  49326. * Defines the name of the factory
  49327. */
  49328. name: string;
  49329. /**
  49330. * Function called to create a new plugin
  49331. * @return the new plugin
  49332. */
  49333. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  49334. /**
  49335. * The callback that returns true if the data can be directly loaded.
  49336. * @param data string containing the file data
  49337. * @returns if the data can be loaded directly
  49338. */
  49339. canDirectLoad?(data: string): boolean;
  49340. }
  49341. /**
  49342. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  49343. */
  49344. export interface ISceneLoaderPluginBase {
  49345. /**
  49346. * The friendly name of this plugin.
  49347. */
  49348. name: string;
  49349. /**
  49350. * The file extensions supported by this plugin.
  49351. */
  49352. extensions: string | ISceneLoaderPluginExtensions;
  49353. /**
  49354. * The callback called when loading from a url.
  49355. * @param scene scene loading this url
  49356. * @param url url to load
  49357. * @param onSuccess callback called when the file successfully loads
  49358. * @param onProgress callback called while file is loading (if the server supports this mode)
  49359. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  49360. * @param onError callback called when the file fails to load
  49361. * @returns a file request object
  49362. */
  49363. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  49364. /**
  49365. * The callback called when loading from a file object.
  49366. * @param scene scene loading this file
  49367. * @param file defines the file to load
  49368. * @param onSuccess defines the callback to call when data is loaded
  49369. * @param onProgress defines the callback to call during loading process
  49370. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  49371. * @param onError defines the callback to call when an error occurs
  49372. * @returns a file request object
  49373. */
  49374. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  49375. /**
  49376. * The callback that returns true if the data can be directly loaded.
  49377. * @param data string containing the file data
  49378. * @returns if the data can be loaded directly
  49379. */
  49380. canDirectLoad?(data: string): boolean;
  49381. /**
  49382. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  49383. * @param scene scene loading this data
  49384. * @param data string containing the data
  49385. * @returns data to pass to the plugin
  49386. */
  49387. directLoad?(scene: Scene, data: string): any;
  49388. /**
  49389. * The callback that allows custom handling of the root url based on the response url.
  49390. * @param rootUrl the original root url
  49391. * @param responseURL the response url if available
  49392. * @returns the new root url
  49393. */
  49394. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  49395. }
  49396. /**
  49397. * Interface used to define a SceneLoader plugin
  49398. */
  49399. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  49400. /**
  49401. * Import meshes into a scene.
  49402. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49403. * @param scene The scene to import into
  49404. * @param data The data to import
  49405. * @param rootUrl The root url for scene and resources
  49406. * @param meshes The meshes array to import into
  49407. * @param particleSystems The particle systems array to import into
  49408. * @param skeletons The skeletons array to import into
  49409. * @param onError The callback when import fails
  49410. * @returns True if successful or false otherwise
  49411. */
  49412. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  49413. /**
  49414. * Load into a scene.
  49415. * @param scene The scene to load into
  49416. * @param data The data to import
  49417. * @param rootUrl The root url for scene and resources
  49418. * @param onError The callback when import fails
  49419. * @returns True if successful or false otherwise
  49420. */
  49421. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  49422. /**
  49423. * Load into an asset container.
  49424. * @param scene The scene to load into
  49425. * @param data The data to import
  49426. * @param rootUrl The root url for scene and resources
  49427. * @param onError The callback when import fails
  49428. * @returns The loaded asset container
  49429. */
  49430. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  49431. }
  49432. /**
  49433. * Interface used to define an async SceneLoader plugin
  49434. */
  49435. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  49436. /**
  49437. * Import meshes into a scene.
  49438. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49439. * @param scene The scene to import into
  49440. * @param data The data to import
  49441. * @param rootUrl The root url for scene and resources
  49442. * @param onProgress The callback when the load progresses
  49443. * @param fileName Defines the name of the file to load
  49444. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  49445. */
  49446. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  49447. meshes: AbstractMesh[];
  49448. particleSystems: IParticleSystem[];
  49449. skeletons: Skeleton[];
  49450. animationGroups: AnimationGroup[];
  49451. }>;
  49452. /**
  49453. * Load into a scene.
  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 onProgress The callback when the load progresses
  49458. * @param fileName Defines the name of the file to load
  49459. * @returns Nothing
  49460. */
  49461. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  49462. /**
  49463. * Load into an asset container.
  49464. * @param scene The scene to load into
  49465. * @param data The data to import
  49466. * @param rootUrl The root url for scene and resources
  49467. * @param onProgress The callback when the load progresses
  49468. * @param fileName Defines the name of the file to load
  49469. * @returns The loaded asset container
  49470. */
  49471. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  49472. }
  49473. /**
  49474. * Mode that determines how to handle old animation groups before loading new ones.
  49475. */
  49476. export enum SceneLoaderAnimationGroupLoadingMode {
  49477. /**
  49478. * Reset all old animations to initial state then dispose them.
  49479. */
  49480. Clean = 0,
  49481. /**
  49482. * Stop all old animations.
  49483. */
  49484. Stop = 1,
  49485. /**
  49486. * Restart old animations from first frame.
  49487. */
  49488. Sync = 2,
  49489. /**
  49490. * Old animations remains untouched.
  49491. */
  49492. NoSync = 3
  49493. }
  49494. /**
  49495. * Defines a plugin registered by the SceneLoader
  49496. */
  49497. interface IRegisteredPlugin {
  49498. /**
  49499. * Defines the plugin to use
  49500. */
  49501. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  49502. /**
  49503. * Defines if the plugin supports binary data
  49504. */
  49505. isBinary: boolean;
  49506. }
  49507. /**
  49508. * Class used to load scene from various file formats using registered plugins
  49509. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  49510. */
  49511. export class SceneLoader {
  49512. /**
  49513. * No logging while loading
  49514. */
  49515. static readonly NO_LOGGING: number;
  49516. /**
  49517. * Minimal logging while loading
  49518. */
  49519. static readonly MINIMAL_LOGGING: number;
  49520. /**
  49521. * Summary logging while loading
  49522. */
  49523. static readonly SUMMARY_LOGGING: number;
  49524. /**
  49525. * Detailled logging while loading
  49526. */
  49527. static readonly DETAILED_LOGGING: number;
  49528. /**
  49529. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  49530. */
  49531. static get ForceFullSceneLoadingForIncremental(): boolean;
  49532. static set ForceFullSceneLoadingForIncremental(value: boolean);
  49533. /**
  49534. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  49535. */
  49536. static get ShowLoadingScreen(): boolean;
  49537. static set ShowLoadingScreen(value: boolean);
  49538. /**
  49539. * Defines the current logging level (while loading the scene)
  49540. * @ignorenaming
  49541. */
  49542. static get loggingLevel(): number;
  49543. static set loggingLevel(value: number);
  49544. /**
  49545. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  49546. */
  49547. static get CleanBoneMatrixWeights(): boolean;
  49548. static set CleanBoneMatrixWeights(value: boolean);
  49549. /**
  49550. * Event raised when a plugin is used to load a scene
  49551. */
  49552. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  49553. private static _registeredPlugins;
  49554. private static _showingLoadingScreen;
  49555. /**
  49556. * Gets the default plugin (used to load Babylon files)
  49557. * @returns the .babylon plugin
  49558. */
  49559. static GetDefaultPlugin(): IRegisteredPlugin;
  49560. private static _GetPluginForExtension;
  49561. private static _GetPluginForDirectLoad;
  49562. private static _GetPluginForFilename;
  49563. private static _GetDirectLoad;
  49564. private static _LoadData;
  49565. private static _GetFileInfo;
  49566. /**
  49567. * Gets a plugin that can load the given extension
  49568. * @param extension defines the extension to load
  49569. * @returns a plugin or null if none works
  49570. */
  49571. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  49572. /**
  49573. * Gets a boolean indicating that the given extension can be loaded
  49574. * @param extension defines the extension to load
  49575. * @returns true if the extension is supported
  49576. */
  49577. static IsPluginForExtensionAvailable(extension: string): boolean;
  49578. /**
  49579. * Adds a new plugin to the list of registered plugins
  49580. * @param plugin defines the plugin to add
  49581. */
  49582. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  49583. /**
  49584. * Import meshes into a scene
  49585. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49586. * @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)
  49587. * @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)
  49588. * @param scene the instance of BABYLON.Scene to append to
  49589. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  49590. * @param onProgress a callback with a progress event for each file being loaded
  49591. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49592. * @param pluginExtension the extension used to determine the plugin
  49593. * @returns The loaded plugin
  49594. */
  49595. 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>;
  49596. /**
  49597. * Import meshes into a scene
  49598. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49599. * @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)
  49600. * @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)
  49601. * @param scene the instance of BABYLON.Scene to append to
  49602. * @param onProgress a callback with a progress event for each file being loaded
  49603. * @param pluginExtension the extension used to determine the plugin
  49604. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  49605. */
  49606. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  49607. meshes: AbstractMesh[];
  49608. particleSystems: IParticleSystem[];
  49609. skeletons: Skeleton[];
  49610. animationGroups: AnimationGroup[];
  49611. }>;
  49612. /**
  49613. * Load a scene
  49614. * @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)
  49615. * @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)
  49616. * @param engine is the instance of BABYLON.Engine to use to create the scene
  49617. * @param onSuccess a callback with the scene when import succeeds
  49618. * @param onProgress a callback with a progress event for each file being loaded
  49619. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49620. * @param pluginExtension the extension used to determine the plugin
  49621. * @returns The loaded plugin
  49622. */
  49623. 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>;
  49624. /**
  49625. * Load a scene
  49626. * @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)
  49627. * @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)
  49628. * @param engine is the instance of BABYLON.Engine to use to create the scene
  49629. * @param onProgress a callback with a progress event for each file being loaded
  49630. * @param pluginExtension the extension used to determine the plugin
  49631. * @returns The loaded scene
  49632. */
  49633. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  49634. /**
  49635. * Append a scene
  49636. * @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)
  49637. * @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)
  49638. * @param scene is the instance of BABYLON.Scene to append to
  49639. * @param onSuccess a callback with the scene when import succeeds
  49640. * @param onProgress a callback with a progress event for each file being loaded
  49641. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49642. * @param pluginExtension the extension used to determine the plugin
  49643. * @returns The loaded plugin
  49644. */
  49645. 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>;
  49646. /**
  49647. * Append a scene
  49648. * @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)
  49649. * @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)
  49650. * @param scene is the instance of BABYLON.Scene to append to
  49651. * @param onProgress a callback with a progress event for each file being loaded
  49652. * @param pluginExtension the extension used to determine the plugin
  49653. * @returns The given scene
  49654. */
  49655. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  49656. /**
  49657. * Load a scene into an asset container
  49658. * @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)
  49659. * @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)
  49660. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49661. * @param onSuccess a callback with the scene when import succeeds
  49662. * @param onProgress a callback with a progress event for each file being loaded
  49663. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49664. * @param pluginExtension the extension used to determine the plugin
  49665. * @returns The loaded plugin
  49666. */
  49667. 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>;
  49668. /**
  49669. * Load a scene into an asset container
  49670. * @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)
  49671. * @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)
  49672. * @param scene is the instance of Scene to append to
  49673. * @param onProgress a callback with a progress event for each file being loaded
  49674. * @param pluginExtension the extension used to determine the plugin
  49675. * @returns The loaded asset container
  49676. */
  49677. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  49678. /**
  49679. * Import animations from a file into a scene
  49680. * @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)
  49681. * @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)
  49682. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49683. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  49684. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  49685. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  49686. * @param onSuccess a callback with the scene when import succeeds
  49687. * @param onProgress a callback with a progress event for each file being loaded
  49688. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49689. * @param pluginExtension the extension used to determine the plugin
  49690. */
  49691. 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;
  49692. /**
  49693. * Import animations from a file into a scene
  49694. * @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)
  49695. * @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)
  49696. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49697. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  49698. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  49699. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  49700. * @param onSuccess a callback with the scene when import succeeds
  49701. * @param onProgress a callback with a progress event for each file being loaded
  49702. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49703. * @param pluginExtension the extension used to determine the plugin
  49704. * @returns the updated scene with imported animations
  49705. */
  49706. 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>;
  49707. }
  49708. }
  49709. declare module "babylonjs/XR/motionController/webXRAbstractMotionController" {
  49710. import { IDisposable, Scene } from "babylonjs/scene";
  49711. import { WebXRControllerComponent } from "babylonjs/XR/motionController/webXRControllerComponent";
  49712. import { Observable } from "babylonjs/Misc/observable";
  49713. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49714. import { Nullable } from "babylonjs/types";
  49715. /**
  49716. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  49717. */
  49718. export type MotionControllerHandedness = "none" | "left" | "right";
  49719. /**
  49720. * The type of components available in motion controllers.
  49721. * This is not the name of the component.
  49722. */
  49723. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  49724. /**
  49725. * The state of a controller component
  49726. */
  49727. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  49728. /**
  49729. * The schema of motion controller layout.
  49730. * No object will be initialized using this interface
  49731. * This is used just to define the profile.
  49732. */
  49733. export interface IMotionControllerLayout {
  49734. /**
  49735. * Path to load the assets. Usually relative to the base path
  49736. */
  49737. assetPath: string;
  49738. /**
  49739. * Available components (unsorted)
  49740. */
  49741. components: {
  49742. /**
  49743. * A map of component Ids
  49744. */
  49745. [componentId: string]: {
  49746. /**
  49747. * The type of input the component outputs
  49748. */
  49749. type: MotionControllerComponentType;
  49750. /**
  49751. * The indices of this component in the gamepad object
  49752. */
  49753. gamepadIndices: {
  49754. /**
  49755. * Index of button
  49756. */
  49757. button?: number;
  49758. /**
  49759. * If available, index of x-axis
  49760. */
  49761. xAxis?: number;
  49762. /**
  49763. * If available, index of y-axis
  49764. */
  49765. yAxis?: number;
  49766. };
  49767. /**
  49768. * The mesh's root node name
  49769. */
  49770. rootNodeName: string;
  49771. /**
  49772. * Animation definitions for this model
  49773. */
  49774. visualResponses: {
  49775. [stateKey: string]: {
  49776. /**
  49777. * What property will be animated
  49778. */
  49779. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  49780. /**
  49781. * What states influence this visual response
  49782. */
  49783. states: MotionControllerComponentStateType[];
  49784. /**
  49785. * Type of animation - movement or visibility
  49786. */
  49787. valueNodeProperty: "transform" | "visibility";
  49788. /**
  49789. * Base node name to move. Its position will be calculated according to the min and max nodes
  49790. */
  49791. valueNodeName?: string;
  49792. /**
  49793. * Minimum movement node
  49794. */
  49795. minNodeName?: string;
  49796. /**
  49797. * Max movement node
  49798. */
  49799. maxNodeName?: string;
  49800. };
  49801. };
  49802. /**
  49803. * If touch enabled, what is the name of node to display user feedback
  49804. */
  49805. touchPointNodeName?: string;
  49806. };
  49807. };
  49808. /**
  49809. * Is it xr standard mapping or not
  49810. */
  49811. gamepadMapping: "" | "xr-standard";
  49812. /**
  49813. * Base root node of this entire model
  49814. */
  49815. rootNodeName: string;
  49816. /**
  49817. * Defines the main button component id
  49818. */
  49819. selectComponentId: string;
  49820. }
  49821. /**
  49822. * A definition for the layout map in the input profile
  49823. */
  49824. export interface IMotionControllerLayoutMap {
  49825. /**
  49826. * Layouts with handedness type as a key
  49827. */
  49828. [handedness: string]: IMotionControllerLayout;
  49829. }
  49830. /**
  49831. * The XR Input profile schema
  49832. * Profiles can be found here:
  49833. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  49834. */
  49835. export interface IMotionControllerProfile {
  49836. /**
  49837. * fallback profiles for this profileId
  49838. */
  49839. fallbackProfileIds: string[];
  49840. /**
  49841. * The layout map, with handedness as key
  49842. */
  49843. layouts: IMotionControllerLayoutMap;
  49844. /**
  49845. * The id of this profile
  49846. * correlates to the profile(s) in the xrInput.profiles array
  49847. */
  49848. profileId: string;
  49849. }
  49850. /**
  49851. * A helper-interface for the 3 meshes needed for controller button animation
  49852. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  49853. */
  49854. export interface IMotionControllerButtonMeshMap {
  49855. /**
  49856. * the mesh that defines the pressed value mesh position.
  49857. * This is used to find the max-position of this button
  49858. */
  49859. pressedMesh: AbstractMesh;
  49860. /**
  49861. * the mesh that defines the unpressed value mesh position.
  49862. * This is used to find the min (or initial) position of this button
  49863. */
  49864. unpressedMesh: AbstractMesh;
  49865. /**
  49866. * The mesh that will be changed when value changes
  49867. */
  49868. valueMesh: AbstractMesh;
  49869. }
  49870. /**
  49871. * A helper-interface for the 3 meshes needed for controller axis animation.
  49872. * This will be expanded when touchpad animations are fully supported
  49873. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  49874. */
  49875. export interface IMotionControllerMeshMap {
  49876. /**
  49877. * the mesh that defines the maximum value mesh position.
  49878. */
  49879. maxMesh?: AbstractMesh;
  49880. /**
  49881. * the mesh that defines the minimum value mesh position.
  49882. */
  49883. minMesh?: AbstractMesh;
  49884. /**
  49885. * The mesh that will be changed when axis value changes
  49886. */
  49887. valueMesh?: AbstractMesh;
  49888. }
  49889. /**
  49890. * The elements needed for change-detection of the gamepad objects in motion controllers
  49891. */
  49892. export interface IMinimalMotionControllerObject {
  49893. /**
  49894. * Available axes of this controller
  49895. */
  49896. axes: number[];
  49897. /**
  49898. * An array of available buttons
  49899. */
  49900. buttons: Array<{
  49901. /**
  49902. * Value of the button/trigger
  49903. */
  49904. value: number;
  49905. /**
  49906. * If the button/trigger is currently touched
  49907. */
  49908. touched: boolean;
  49909. /**
  49910. * If the button/trigger is currently pressed
  49911. */
  49912. pressed: boolean;
  49913. }>;
  49914. /**
  49915. * EXPERIMENTAL haptic support.
  49916. */
  49917. hapticActuators?: Array<{
  49918. pulse: (value: number, duration: number) => Promise<boolean>;
  49919. }>;
  49920. }
  49921. /**
  49922. * An Abstract Motion controller
  49923. * This class receives an xrInput and a profile layout and uses those to initialize the components
  49924. * Each component has an observable to check for changes in value and state
  49925. */
  49926. export abstract class WebXRAbstractMotionController implements IDisposable {
  49927. protected scene: Scene;
  49928. protected layout: IMotionControllerLayout;
  49929. /**
  49930. * The gamepad object correlating to this controller
  49931. */
  49932. gamepadObject: IMinimalMotionControllerObject;
  49933. /**
  49934. * handedness (left/right/none) of this controller
  49935. */
  49936. handedness: MotionControllerHandedness;
  49937. private _initComponent;
  49938. private _modelReady;
  49939. /**
  49940. * A map of components (WebXRControllerComponent) in this motion controller
  49941. * Components have a ComponentType and can also have both button and axis definitions
  49942. */
  49943. readonly components: {
  49944. [id: string]: WebXRControllerComponent;
  49945. };
  49946. /**
  49947. * Disable the model's animation. Can be set at any time.
  49948. */
  49949. disableAnimation: boolean;
  49950. /**
  49951. * Observers registered here will be triggered when the model of this controller is done loading
  49952. */
  49953. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  49954. /**
  49955. * The profile id of this motion controller
  49956. */
  49957. abstract profileId: string;
  49958. /**
  49959. * The root mesh of the model. It is null if the model was not yet initialized
  49960. */
  49961. rootMesh: Nullable<AbstractMesh>;
  49962. /**
  49963. * constructs a new abstract motion controller
  49964. * @param scene the scene to which the model of the controller will be added
  49965. * @param layout The profile layout to load
  49966. * @param gamepadObject The gamepad object correlating to this controller
  49967. * @param handedness handedness (left/right/none) of this controller
  49968. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  49969. */
  49970. constructor(scene: Scene, layout: IMotionControllerLayout,
  49971. /**
  49972. * The gamepad object correlating to this controller
  49973. */
  49974. gamepadObject: IMinimalMotionControllerObject,
  49975. /**
  49976. * handedness (left/right/none) of this controller
  49977. */
  49978. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  49979. /**
  49980. * Dispose this controller, the model mesh and all its components
  49981. */
  49982. dispose(): void;
  49983. /**
  49984. * Returns all components of specific type
  49985. * @param type the type to search for
  49986. * @return an array of components with this type
  49987. */
  49988. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  49989. /**
  49990. * get a component based an its component id as defined in layout.components
  49991. * @param id the id of the component
  49992. * @returns the component correlates to the id or undefined if not found
  49993. */
  49994. getComponent(id: string): WebXRControllerComponent;
  49995. /**
  49996. * Get the list of components available in this motion controller
  49997. * @returns an array of strings correlating to available components
  49998. */
  49999. getComponentIds(): string[];
  50000. /**
  50001. * Get the first component of specific type
  50002. * @param type type of component to find
  50003. * @return a controller component or null if not found
  50004. */
  50005. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  50006. /**
  50007. * Get the main (Select) component of this controller as defined in the layout
  50008. * @returns the main component of this controller
  50009. */
  50010. getMainComponent(): WebXRControllerComponent;
  50011. /**
  50012. * Loads the model correlating to this controller
  50013. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  50014. * @returns A promise fulfilled with the result of the model loading
  50015. */
  50016. loadModel(): Promise<boolean>;
  50017. /**
  50018. * Update this model using the current XRFrame
  50019. * @param xrFrame the current xr frame to use and update the model
  50020. */
  50021. updateFromXRFrame(xrFrame: XRFrame): void;
  50022. /**
  50023. * Backwards compatibility due to a deeply-integrated typo
  50024. */
  50025. get handness(): XREye;
  50026. /**
  50027. * Pulse (vibrate) this controller
  50028. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  50029. * Consecutive calls to this function will cancel the last pulse call
  50030. *
  50031. * @param value the strength of the pulse in 0.0...1.0 range
  50032. * @param duration Duration of the pulse in milliseconds
  50033. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  50034. * @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
  50035. */
  50036. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  50037. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  50038. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  50039. /**
  50040. * Moves the axis on the controller mesh based on its current state
  50041. * @param axis the index of the axis
  50042. * @param axisValue the value of the axis which determines the meshes new position
  50043. * @hidden
  50044. */
  50045. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  50046. /**
  50047. * Update the model itself with the current frame data
  50048. * @param xrFrame the frame to use for updating the model mesh
  50049. */
  50050. protected updateModel(xrFrame: XRFrame): void;
  50051. /**
  50052. * Get the filename and path for this controller's model
  50053. * @returns a map of filename and path
  50054. */
  50055. protected abstract _getFilenameAndPath(): {
  50056. filename: string;
  50057. path: string;
  50058. };
  50059. /**
  50060. * This function is called before the mesh is loaded. It checks for loading constraints.
  50061. * For example, this function can check if the GLB loader is available
  50062. * If this function returns false, the generic controller will be loaded instead
  50063. * @returns Is the client ready to load the mesh
  50064. */
  50065. protected abstract _getModelLoadingConstraints(): boolean;
  50066. /**
  50067. * This function will be called after the model was successfully loaded and can be used
  50068. * for mesh transformations before it is available for the user
  50069. * @param meshes the loaded meshes
  50070. */
  50071. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  50072. /**
  50073. * Set the root mesh for this controller. Important for the WebXR controller class
  50074. * @param meshes the loaded meshes
  50075. */
  50076. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  50077. /**
  50078. * A function executed each frame that updates the mesh (if needed)
  50079. * @param xrFrame the current xrFrame
  50080. */
  50081. protected abstract _updateModel(xrFrame: XRFrame): void;
  50082. private _getGenericFilenameAndPath;
  50083. private _getGenericParentMesh;
  50084. }
  50085. }
  50086. declare module "babylonjs/XR/motionController/webXRGenericMotionController" {
  50087. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50088. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50089. import { Scene } from "babylonjs/scene";
  50090. /**
  50091. * A generic trigger-only motion controller for WebXR
  50092. */
  50093. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  50094. /**
  50095. * Static version of the profile id of this controller
  50096. */
  50097. static ProfileId: string;
  50098. profileId: string;
  50099. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  50100. protected _getFilenameAndPath(): {
  50101. filename: string;
  50102. path: string;
  50103. };
  50104. protected _getModelLoadingConstraints(): boolean;
  50105. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  50106. protected _setRootMesh(meshes: AbstractMesh[]): void;
  50107. protected _updateModel(): void;
  50108. }
  50109. }
  50110. declare module "babylonjs/Meshes/Builders/sphereBuilder" {
  50111. import { Vector4 } from "babylonjs/Maths/math.vector";
  50112. import { Mesh } from "babylonjs/Meshes/mesh";
  50113. import { Scene } from "babylonjs/scene";
  50114. import { Nullable } from "babylonjs/types";
  50115. /**
  50116. * Class containing static functions to help procedurally build meshes
  50117. */
  50118. export class SphereBuilder {
  50119. /**
  50120. * Creates a sphere mesh
  50121. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  50122. * * 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`)
  50123. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  50124. * * 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
  50125. * * 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)
  50126. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  50127. * * 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
  50128. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50129. * @param name defines the name of the mesh
  50130. * @param options defines the options used to create the mesh
  50131. * @param scene defines the hosting scene
  50132. * @returns the sphere mesh
  50133. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  50134. */
  50135. static CreateSphere(name: string, options: {
  50136. segments?: number;
  50137. diameter?: number;
  50138. diameterX?: number;
  50139. diameterY?: number;
  50140. diameterZ?: number;
  50141. arc?: number;
  50142. slice?: number;
  50143. sideOrientation?: number;
  50144. frontUVs?: Vector4;
  50145. backUVs?: Vector4;
  50146. updatable?: boolean;
  50147. }, scene?: Nullable<Scene>): Mesh;
  50148. }
  50149. }
  50150. declare module "babylonjs/XR/motionController/webXRProfiledMotionController" {
  50151. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50152. import { WebXRAbstractMotionController, IMotionControllerProfile } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50153. import { Scene } from "babylonjs/scene";
  50154. /**
  50155. * A profiled motion controller has its profile loaded from an online repository.
  50156. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  50157. */
  50158. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  50159. private _repositoryUrl;
  50160. private _buttonMeshMapping;
  50161. private _touchDots;
  50162. /**
  50163. * The profile ID of this controller. Will be populated when the controller initializes.
  50164. */
  50165. profileId: string;
  50166. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  50167. dispose(): void;
  50168. protected _getFilenameAndPath(): {
  50169. filename: string;
  50170. path: string;
  50171. };
  50172. protected _getModelLoadingConstraints(): boolean;
  50173. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  50174. protected _setRootMesh(meshes: AbstractMesh[]): void;
  50175. protected _updateModel(_xrFrame: XRFrame): void;
  50176. }
  50177. }
  50178. declare module "babylonjs/XR/motionController/webXRMotionControllerManager" {
  50179. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50180. import { Scene } from "babylonjs/scene";
  50181. /**
  50182. * A construction function type to create a new controller based on an xrInput object
  50183. */
  50184. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  50185. /**
  50186. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  50187. *
  50188. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  50189. * it should be replaced with auto-loaded controllers.
  50190. *
  50191. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  50192. */
  50193. export class WebXRMotionControllerManager {
  50194. private static _AvailableControllers;
  50195. private static _Fallbacks;
  50196. private static _ProfileLoadingPromises;
  50197. private static _ProfilesList;
  50198. /**
  50199. * The base URL of the online controller repository. Can be changed at any time.
  50200. */
  50201. static BaseRepositoryUrl: string;
  50202. /**
  50203. * Which repository gets priority - local or online
  50204. */
  50205. static PrioritizeOnlineRepository: boolean;
  50206. /**
  50207. * Use the online repository, or use only locally-defined controllers
  50208. */
  50209. static UseOnlineRepository: boolean;
  50210. /**
  50211. * Clear the cache used for profile loading and reload when requested again
  50212. */
  50213. static ClearProfilesCache(): void;
  50214. /**
  50215. * Register the default fallbacks.
  50216. * This function is called automatically when this file is imported.
  50217. */
  50218. static DefaultFallbacks(): void;
  50219. /**
  50220. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  50221. * @param profileId the profile to which a fallback needs to be found
  50222. * @return an array with corresponding fallback profiles
  50223. */
  50224. static FindFallbackWithProfileId(profileId: string): string[];
  50225. /**
  50226. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  50227. * The order of search:
  50228. *
  50229. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  50230. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  50231. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  50232. * 4) return the generic trigger controller if none were found
  50233. *
  50234. * @param xrInput the xrInput to which a new controller is initialized
  50235. * @param scene the scene to which the model will be added
  50236. * @param forceProfile force a certain profile for this controller
  50237. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  50238. */
  50239. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  50240. /**
  50241. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  50242. *
  50243. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  50244. *
  50245. * @param type the profile type to register
  50246. * @param constructFunction the function to be called when loading this profile
  50247. */
  50248. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  50249. /**
  50250. * Register a fallback to a specific profile.
  50251. * @param profileId the profileId that will receive the fallbacks
  50252. * @param fallbacks A list of fallback profiles
  50253. */
  50254. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  50255. /**
  50256. * Will update the list of profiles available in the repository
  50257. * @return a promise that resolves to a map of profiles available online
  50258. */
  50259. static UpdateProfilesList(): Promise<{
  50260. [profile: string]: string;
  50261. }>;
  50262. private static _LoadProfileFromRepository;
  50263. private static _LoadProfilesFromAvailableControllers;
  50264. }
  50265. }
  50266. declare module "babylonjs/XR/webXRInputSource" {
  50267. import { Observable } from "babylonjs/Misc/observable";
  50268. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50269. import { Ray } from "babylonjs/Culling/ray";
  50270. import { Scene } from "babylonjs/scene";
  50271. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50272. /**
  50273. * Configuration options for the WebXR controller creation
  50274. */
  50275. export interface IWebXRControllerOptions {
  50276. /**
  50277. * Should the controller mesh be animated when a user interacts with it
  50278. * The pressed buttons / thumbstick and touchpad animations will be disabled
  50279. */
  50280. disableMotionControllerAnimation?: boolean;
  50281. /**
  50282. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  50283. */
  50284. doNotLoadControllerMesh?: boolean;
  50285. /**
  50286. * Force a specific controller type for this controller.
  50287. * This can be used when creating your own profile or when testing different controllers
  50288. */
  50289. forceControllerProfile?: string;
  50290. /**
  50291. * Defines a rendering group ID for meshes that will be loaded.
  50292. * This is for the default controllers only.
  50293. */
  50294. renderingGroupId?: number;
  50295. }
  50296. /**
  50297. * Represents an XR controller
  50298. */
  50299. export class WebXRInputSource {
  50300. private _scene;
  50301. /** The underlying input source for the controller */
  50302. inputSource: XRInputSource;
  50303. private _options;
  50304. private _tmpVector;
  50305. private _uniqueId;
  50306. private _disposed;
  50307. /**
  50308. * 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
  50309. */
  50310. grip?: AbstractMesh;
  50311. /**
  50312. * If available, this is the gamepad object related to this controller.
  50313. * Using this object it is possible to get click events and trackpad changes of the
  50314. * webxr controller that is currently being used.
  50315. */
  50316. motionController?: WebXRAbstractMotionController;
  50317. /**
  50318. * Event that fires when the controller is removed/disposed.
  50319. * The object provided as event data is this controller, after associated assets were disposed.
  50320. * uniqueId is still available.
  50321. */
  50322. onDisposeObservable: Observable<WebXRInputSource>;
  50323. /**
  50324. * Will be triggered when the mesh associated with the motion controller is done loading.
  50325. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  50326. * A shortened version of controller -> motion controller -> on mesh loaded.
  50327. */
  50328. onMeshLoadedObservable: Observable<AbstractMesh>;
  50329. /**
  50330. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  50331. */
  50332. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  50333. /**
  50334. * Pointer which can be used to select objects or attach a visible laser to
  50335. */
  50336. pointer: AbstractMesh;
  50337. /**
  50338. * Creates the input source object
  50339. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  50340. * @param _scene the scene which the controller should be associated to
  50341. * @param inputSource the underlying input source for the controller
  50342. * @param _options options for this controller creation
  50343. */
  50344. constructor(_scene: Scene,
  50345. /** The underlying input source for the controller */
  50346. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  50347. /**
  50348. * Get this controllers unique id
  50349. */
  50350. get uniqueId(): string;
  50351. /**
  50352. * Disposes of the object
  50353. */
  50354. dispose(): void;
  50355. /**
  50356. * Gets a world space ray coming from the pointer or grip
  50357. * @param result the resulting ray
  50358. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  50359. */
  50360. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  50361. /**
  50362. * Updates the controller pose based on the given XRFrame
  50363. * @param xrFrame xr frame to update the pose with
  50364. * @param referenceSpace reference space to use
  50365. */
  50366. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  50367. }
  50368. }
  50369. declare module "babylonjs/XR/webXRInput" {
  50370. import { Observable } from "babylonjs/Misc/observable";
  50371. import { IDisposable } from "babylonjs/scene";
  50372. import { WebXRInputSource, IWebXRControllerOptions } from "babylonjs/XR/webXRInputSource";
  50373. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50374. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  50375. /**
  50376. * The schema for initialization options of the XR Input class
  50377. */
  50378. export interface IWebXRInputOptions {
  50379. /**
  50380. * If set to true no model will be automatically loaded
  50381. */
  50382. doNotLoadControllerMeshes?: boolean;
  50383. /**
  50384. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  50385. * If not found, the xr input profile data will be used.
  50386. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  50387. */
  50388. forceInputProfile?: string;
  50389. /**
  50390. * Do not send a request to the controller repository to load the profile.
  50391. *
  50392. * Instead, use the controllers available in babylon itself.
  50393. */
  50394. disableOnlineControllerRepository?: boolean;
  50395. /**
  50396. * A custom URL for the controllers repository
  50397. */
  50398. customControllersRepositoryURL?: string;
  50399. /**
  50400. * Should the controller model's components not move according to the user input
  50401. */
  50402. disableControllerAnimation?: boolean;
  50403. /**
  50404. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  50405. */
  50406. controllerOptions?: IWebXRControllerOptions;
  50407. }
  50408. /**
  50409. * XR input used to track XR inputs such as controllers/rays
  50410. */
  50411. export class WebXRInput implements IDisposable {
  50412. /**
  50413. * the xr session manager for this session
  50414. */
  50415. xrSessionManager: WebXRSessionManager;
  50416. /**
  50417. * the WebXR camera for this session. Mainly used for teleportation
  50418. */
  50419. xrCamera: WebXRCamera;
  50420. private readonly options;
  50421. /**
  50422. * XR controllers being tracked
  50423. */
  50424. controllers: Array<WebXRInputSource>;
  50425. private _frameObserver;
  50426. private _sessionEndedObserver;
  50427. private _sessionInitObserver;
  50428. /**
  50429. * Event when a controller has been connected/added
  50430. */
  50431. onControllerAddedObservable: Observable<WebXRInputSource>;
  50432. /**
  50433. * Event when a controller has been removed/disconnected
  50434. */
  50435. onControllerRemovedObservable: Observable<WebXRInputSource>;
  50436. /**
  50437. * Initializes the WebXRInput
  50438. * @param xrSessionManager the xr session manager for this session
  50439. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  50440. * @param options = initialization options for this xr input
  50441. */
  50442. constructor(
  50443. /**
  50444. * the xr session manager for this session
  50445. */
  50446. xrSessionManager: WebXRSessionManager,
  50447. /**
  50448. * the WebXR camera for this session. Mainly used for teleportation
  50449. */
  50450. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  50451. private _onInputSourcesChange;
  50452. private _addAndRemoveControllers;
  50453. /**
  50454. * Disposes of the object
  50455. */
  50456. dispose(): void;
  50457. }
  50458. }
  50459. declare module "babylonjs/XR/features/WebXRAbstractFeature" {
  50460. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  50461. import { Observable, EventState } from "babylonjs/Misc/observable";
  50462. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50463. /**
  50464. * This is the base class for all WebXR features.
  50465. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  50466. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  50467. */
  50468. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  50469. protected _xrSessionManager: WebXRSessionManager;
  50470. private _attached;
  50471. private _removeOnDetach;
  50472. /**
  50473. * Should auto-attach be disabled?
  50474. */
  50475. disableAutoAttach: boolean;
  50476. /**
  50477. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  50478. */
  50479. xrNativeFeatureName: string;
  50480. /**
  50481. * Construct a new (abstract) WebXR feature
  50482. * @param _xrSessionManager the xr session manager for this feature
  50483. */
  50484. constructor(_xrSessionManager: WebXRSessionManager);
  50485. /**
  50486. * Is this feature attached
  50487. */
  50488. get attached(): boolean;
  50489. /**
  50490. * attach this feature
  50491. *
  50492. * @param force should attachment be forced (even when already attached)
  50493. * @returns true if successful, false is failed or already attached
  50494. */
  50495. attach(force?: boolean): boolean;
  50496. /**
  50497. * detach this feature.
  50498. *
  50499. * @returns true if successful, false if failed or already detached
  50500. */
  50501. detach(): boolean;
  50502. /**
  50503. * Dispose this feature and all of the resources attached
  50504. */
  50505. dispose(): void;
  50506. /**
  50507. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  50508. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  50509. *
  50510. * @returns whether or not the feature is compatible in this environment
  50511. */
  50512. isCompatible(): boolean;
  50513. /**
  50514. * This is used to register callbacks that will automatically be removed when detach is called.
  50515. * @param observable the observable to which the observer will be attached
  50516. * @param callback the callback to register
  50517. */
  50518. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  50519. /**
  50520. * Code in this function will be executed on each xrFrame received from the browser.
  50521. * This function will not execute after the feature is detached.
  50522. * @param _xrFrame the current frame
  50523. */
  50524. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  50525. }
  50526. }
  50527. declare module "babylonjs/Rendering/utilityLayerRenderer" {
  50528. import { IDisposable, Scene } from "babylonjs/scene";
  50529. import { Nullable } from "babylonjs/types";
  50530. import { Observable } from "babylonjs/Misc/observable";
  50531. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50532. import { HemisphericLight } from "babylonjs/Lights/hemisphericLight";
  50533. import { Camera } from "babylonjs/Cameras/camera";
  50534. /**
  50535. * Renders a layer on top of an existing scene
  50536. */
  50537. export class UtilityLayerRenderer implements IDisposable {
  50538. /** the original scene that will be rendered on top of */
  50539. originalScene: Scene;
  50540. private _pointerCaptures;
  50541. private _lastPointerEvents;
  50542. private static _DefaultUtilityLayer;
  50543. private static _DefaultKeepDepthUtilityLayer;
  50544. private _sharedGizmoLight;
  50545. private _renderCamera;
  50546. /**
  50547. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  50548. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  50549. * @returns the camera that is used when rendering the utility layer
  50550. */
  50551. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  50552. /**
  50553. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  50554. * @param cam the camera that should be used when rendering the utility layer
  50555. */
  50556. setRenderCamera(cam: Nullable<Camera>): void;
  50557. /**
  50558. * @hidden
  50559. * Light which used by gizmos to get light shading
  50560. */
  50561. _getSharedGizmoLight(): HemisphericLight;
  50562. /**
  50563. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  50564. */
  50565. pickUtilitySceneFirst: boolean;
  50566. /**
  50567. * 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)
  50568. */
  50569. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  50570. /**
  50571. * 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)
  50572. */
  50573. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  50574. /**
  50575. * The scene that is rendered on top of the original scene
  50576. */
  50577. utilityLayerScene: Scene;
  50578. /**
  50579. * If the utility layer should automatically be rendered on top of existing scene
  50580. */
  50581. shouldRender: boolean;
  50582. /**
  50583. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  50584. */
  50585. onlyCheckPointerDownEvents: boolean;
  50586. /**
  50587. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  50588. */
  50589. processAllEvents: boolean;
  50590. /**
  50591. * Observable raised when the pointer move from the utility layer scene to the main scene
  50592. */
  50593. onPointerOutObservable: Observable<number>;
  50594. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  50595. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  50596. private _afterRenderObserver;
  50597. private _sceneDisposeObserver;
  50598. private _originalPointerObserver;
  50599. /**
  50600. * Instantiates a UtilityLayerRenderer
  50601. * @param originalScene the original scene that will be rendered on top of
  50602. * @param handleEvents boolean indicating if the utility layer should handle events
  50603. */
  50604. constructor(
  50605. /** the original scene that will be rendered on top of */
  50606. originalScene: Scene, handleEvents?: boolean);
  50607. private _notifyObservers;
  50608. /**
  50609. * Renders the utility layers scene on top of the original scene
  50610. */
  50611. render(): void;
  50612. /**
  50613. * Disposes of the renderer
  50614. */
  50615. dispose(): void;
  50616. private _updateCamera;
  50617. }
  50618. }
  50619. declare module "babylonjs/XR/features/WebXRControllerPointerSelection" {
  50620. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50621. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50622. import { WebXRInput } from "babylonjs/XR/webXRInput";
  50623. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  50624. import { Scene } from "babylonjs/scene";
  50625. import { Nullable } from "babylonjs/types";
  50626. import { Color3 } from "babylonjs/Maths/math.color";
  50627. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  50628. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  50629. /**
  50630. * Options interface for the pointer selection module
  50631. */
  50632. export interface IWebXRControllerPointerSelectionOptions {
  50633. /**
  50634. * if provided, this scene will be used to render meshes.
  50635. */
  50636. customUtilityLayerScene?: Scene;
  50637. /**
  50638. * 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)
  50639. * If not disabled, the last picked point will be used to execute a pointer up event
  50640. * If disabled, pointer up event will be triggered right after the pointer down event.
  50641. * Used in screen and gaze target ray mode only
  50642. */
  50643. disablePointerUpOnTouchOut: boolean;
  50644. /**
  50645. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  50646. */
  50647. forceGazeMode: boolean;
  50648. /**
  50649. * 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
  50650. * to start a new countdown to the pointer down event.
  50651. * Defaults to 1.
  50652. */
  50653. gazeModePointerMovedFactor?: number;
  50654. /**
  50655. * Different button type to use instead of the main component
  50656. */
  50657. overrideButtonId?: string;
  50658. /**
  50659. * use this rendering group id for the meshes (optional)
  50660. */
  50661. renderingGroupId?: number;
  50662. /**
  50663. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  50664. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  50665. * 3000 means 3 seconds between pointing at something and selecting it
  50666. */
  50667. timeToSelect?: number;
  50668. /**
  50669. * Should meshes created here be added to a utility layer or the main scene
  50670. */
  50671. useUtilityLayer?: boolean;
  50672. /**
  50673. * Optional WebXR camera to be used for gaze selection
  50674. */
  50675. gazeCamera?: WebXRCamera;
  50676. /**
  50677. * the xr input to use with this pointer selection
  50678. */
  50679. xrInput: WebXRInput;
  50680. }
  50681. /**
  50682. * A module that will enable pointer selection for motion controllers of XR Input Sources
  50683. */
  50684. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  50685. private readonly _options;
  50686. private static _idCounter;
  50687. private _attachController;
  50688. private _controllers;
  50689. private _scene;
  50690. private _tmpVectorForPickCompare;
  50691. /**
  50692. * The module's name
  50693. */
  50694. static readonly Name: string;
  50695. /**
  50696. * The (Babylon) version of this module.
  50697. * This is an integer representing the implementation version.
  50698. * This number does not correspond to the WebXR specs version
  50699. */
  50700. static readonly Version: number;
  50701. /**
  50702. * Disable lighting on the laser pointer (so it will always be visible)
  50703. */
  50704. disablePointerLighting: boolean;
  50705. /**
  50706. * Disable lighting on the selection mesh (so it will always be visible)
  50707. */
  50708. disableSelectionMeshLighting: boolean;
  50709. /**
  50710. * Should the laser pointer be displayed
  50711. */
  50712. displayLaserPointer: boolean;
  50713. /**
  50714. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  50715. */
  50716. displaySelectionMesh: boolean;
  50717. /**
  50718. * This color will be set to the laser pointer when selection is triggered
  50719. */
  50720. laserPointerPickedColor: Color3;
  50721. /**
  50722. * Default color of the laser pointer
  50723. */
  50724. laserPointerDefaultColor: Color3;
  50725. /**
  50726. * default color of the selection ring
  50727. */
  50728. selectionMeshDefaultColor: Color3;
  50729. /**
  50730. * This color will be applied to the selection ring when selection is triggered
  50731. */
  50732. selectionMeshPickedColor: Color3;
  50733. /**
  50734. * Optional filter to be used for ray selection. This predicate shares behavior with
  50735. * scene.pointerMovePredicate which takes priority if it is also assigned.
  50736. */
  50737. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  50738. /**
  50739. * constructs a new background remover module
  50740. * @param _xrSessionManager the session manager for this module
  50741. * @param _options read-only options to be used in this module
  50742. */
  50743. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  50744. /**
  50745. * attach this feature
  50746. * Will usually be called by the features manager
  50747. *
  50748. * @returns true if successful.
  50749. */
  50750. attach(): boolean;
  50751. /**
  50752. * detach this feature.
  50753. * Will usually be called by the features manager
  50754. *
  50755. * @returns true if successful.
  50756. */
  50757. detach(): boolean;
  50758. /**
  50759. * Will get the mesh under a specific pointer.
  50760. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  50761. * @param controllerId the controllerId to check
  50762. * @returns The mesh under pointer or null if no mesh is under the pointer
  50763. */
  50764. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  50765. /**
  50766. * Get the xr controller that correlates to the pointer id in the pointer event
  50767. *
  50768. * @param id the pointer id to search for
  50769. * @returns the controller that correlates to this id or null if not found
  50770. */
  50771. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  50772. protected _onXRFrame(_xrFrame: XRFrame): void;
  50773. private _attachGazeMode;
  50774. private _attachScreenRayMode;
  50775. private _attachTrackedPointerRayMode;
  50776. private _convertNormalToDirectionOfRay;
  50777. private _detachController;
  50778. private _generateNewMeshPair;
  50779. private _pickingMoved;
  50780. private _updatePointerDistance;
  50781. /** @hidden */
  50782. get lasterPointerDefaultColor(): Color3;
  50783. }
  50784. }
  50785. declare module "babylonjs/XR/webXREnterExitUI" {
  50786. import { Nullable } from "babylonjs/types";
  50787. import { Observable } from "babylonjs/Misc/observable";
  50788. import { IDisposable, Scene } from "babylonjs/scene";
  50789. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  50790. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  50791. /**
  50792. * Button which can be used to enter a different mode of XR
  50793. */
  50794. export class WebXREnterExitUIButton {
  50795. /** button element */
  50796. element: HTMLElement;
  50797. /** XR initialization options for the button */
  50798. sessionMode: XRSessionMode;
  50799. /** Reference space type */
  50800. referenceSpaceType: XRReferenceSpaceType;
  50801. /**
  50802. * Creates a WebXREnterExitUIButton
  50803. * @param element button element
  50804. * @param sessionMode XR initialization session mode
  50805. * @param referenceSpaceType the type of reference space to be used
  50806. */
  50807. constructor(
  50808. /** button element */
  50809. element: HTMLElement,
  50810. /** XR initialization options for the button */
  50811. sessionMode: XRSessionMode,
  50812. /** Reference space type */
  50813. referenceSpaceType: XRReferenceSpaceType);
  50814. /**
  50815. * Extendable function which can be used to update the button's visuals when the state changes
  50816. * @param activeButton the current active button in the UI
  50817. */
  50818. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  50819. }
  50820. /**
  50821. * Options to create the webXR UI
  50822. */
  50823. export class WebXREnterExitUIOptions {
  50824. /**
  50825. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  50826. */
  50827. customButtons?: Array<WebXREnterExitUIButton>;
  50828. /**
  50829. * A reference space type to use when creating the default button.
  50830. * Default is local-floor
  50831. */
  50832. referenceSpaceType?: XRReferenceSpaceType;
  50833. /**
  50834. * Context to enter xr with
  50835. */
  50836. renderTarget?: Nullable<WebXRRenderTarget>;
  50837. /**
  50838. * A session mode to use when creating the default button.
  50839. * Default is immersive-vr
  50840. */
  50841. sessionMode?: XRSessionMode;
  50842. /**
  50843. * A list of optional features to init the session with
  50844. */
  50845. optionalFeatures?: string[];
  50846. /**
  50847. * A list of optional features to init the session with
  50848. */
  50849. requiredFeatures?: string[];
  50850. }
  50851. /**
  50852. * UI to allow the user to enter/exit XR mode
  50853. */
  50854. export class WebXREnterExitUI implements IDisposable {
  50855. private scene;
  50856. /** version of the options passed to this UI */
  50857. options: WebXREnterExitUIOptions;
  50858. private _activeButton;
  50859. private _buttons;
  50860. /**
  50861. * The HTML Div Element to which buttons are added.
  50862. */
  50863. readonly overlay: HTMLDivElement;
  50864. /**
  50865. * Fired every time the active button is changed.
  50866. *
  50867. * When xr is entered via a button that launches xr that button will be the callback parameter
  50868. *
  50869. * When exiting xr the callback parameter will be null)
  50870. */
  50871. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  50872. /**
  50873. *
  50874. * @param scene babylon scene object to use
  50875. * @param options (read-only) version of the options passed to this UI
  50876. */
  50877. private constructor();
  50878. /**
  50879. * Creates UI to allow the user to enter/exit XR mode
  50880. * @param scene the scene to add the ui to
  50881. * @param helper the xr experience helper to enter/exit xr with
  50882. * @param options options to configure the UI
  50883. * @returns the created ui
  50884. */
  50885. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  50886. /**
  50887. * Disposes of the XR UI component
  50888. */
  50889. dispose(): void;
  50890. private _updateButtons;
  50891. }
  50892. }
  50893. declare module "babylonjs/Meshes/Builders/linesBuilder" {
  50894. import { Vector3 } from "babylonjs/Maths/math.vector";
  50895. import { Color4 } from "babylonjs/Maths/math.color";
  50896. import { Nullable } from "babylonjs/types";
  50897. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  50898. import { Scene } from "babylonjs/scene";
  50899. /**
  50900. * Class containing static functions to help procedurally build meshes
  50901. */
  50902. export class LinesBuilder {
  50903. /**
  50904. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  50905. * * 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
  50906. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  50907. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  50908. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  50909. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  50910. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  50911. * * 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
  50912. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  50913. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50914. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  50915. * @param name defines the name of the new line system
  50916. * @param options defines the options used to create the line system
  50917. * @param scene defines the hosting scene
  50918. * @returns a new line system mesh
  50919. */
  50920. static CreateLineSystem(name: string, options: {
  50921. lines: Vector3[][];
  50922. updatable?: boolean;
  50923. instance?: Nullable<LinesMesh>;
  50924. colors?: Nullable<Color4[][]>;
  50925. useVertexAlpha?: boolean;
  50926. }, scene: Nullable<Scene>): LinesMesh;
  50927. /**
  50928. * Creates a line mesh
  50929. * 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
  50930. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  50931. * * The parameter `points` is an array successive Vector3
  50932. * * 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
  50933. * * The optional parameter `colors` is an array of successive Color4, one per line point
  50934. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  50935. * * When updating an instance, remember that only point positions can change, not the number of points
  50936. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50937. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  50938. * @param name defines the name of the new line system
  50939. * @param options defines the options used to create the line system
  50940. * @param scene defines the hosting scene
  50941. * @returns a new line mesh
  50942. */
  50943. static CreateLines(name: string, options: {
  50944. points: Vector3[];
  50945. updatable?: boolean;
  50946. instance?: Nullable<LinesMesh>;
  50947. colors?: Color4[];
  50948. useVertexAlpha?: boolean;
  50949. }, scene?: Nullable<Scene>): LinesMesh;
  50950. /**
  50951. * Creates a dashed line mesh
  50952. * * 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
  50953. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  50954. * * The parameter `points` is an array successive Vector3
  50955. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  50956. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  50957. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  50958. * * 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
  50959. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  50960. * * When updating an instance, remember that only point positions can change, not the number of points
  50961. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50962. * @param name defines the name of the mesh
  50963. * @param options defines the options used to create the mesh
  50964. * @param scene defines the hosting scene
  50965. * @returns the dashed line mesh
  50966. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  50967. */
  50968. static CreateDashedLines(name: string, options: {
  50969. points: Vector3[];
  50970. dashSize?: number;
  50971. gapSize?: number;
  50972. dashNb?: number;
  50973. updatable?: boolean;
  50974. instance?: LinesMesh;
  50975. useVertexAlpha?: boolean;
  50976. }, scene?: Nullable<Scene>): LinesMesh;
  50977. }
  50978. }
  50979. declare module "babylonjs/Misc/timer" {
  50980. import { Observable, Observer } from "babylonjs/Misc/observable";
  50981. import { Nullable } from "babylonjs/types";
  50982. import { IDisposable } from "babylonjs/scene";
  50983. /**
  50984. * Construction options for a timer
  50985. */
  50986. export interface ITimerOptions<T> {
  50987. /**
  50988. * Time-to-end
  50989. */
  50990. timeout: number;
  50991. /**
  50992. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  50993. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  50994. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  50995. */
  50996. contextObservable: Observable<T>;
  50997. /**
  50998. * Optional parameters when adding an observer to the observable
  50999. */
  51000. observableParameters?: {
  51001. mask?: number;
  51002. insertFirst?: boolean;
  51003. scope?: any;
  51004. };
  51005. /**
  51006. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  51007. */
  51008. breakCondition?: (data?: ITimerData<T>) => boolean;
  51009. /**
  51010. * Will be triggered when the time condition has met
  51011. */
  51012. onEnded?: (data: ITimerData<any>) => void;
  51013. /**
  51014. * Will be triggered when the break condition has met (prematurely ended)
  51015. */
  51016. onAborted?: (data: ITimerData<any>) => void;
  51017. /**
  51018. * Optional function to execute on each tick (or count)
  51019. */
  51020. onTick?: (data: ITimerData<any>) => void;
  51021. }
  51022. /**
  51023. * An interface defining the data sent by the timer
  51024. */
  51025. export interface ITimerData<T> {
  51026. /**
  51027. * When did it start
  51028. */
  51029. startTime: number;
  51030. /**
  51031. * Time now
  51032. */
  51033. currentTime: number;
  51034. /**
  51035. * Time passed since started
  51036. */
  51037. deltaTime: number;
  51038. /**
  51039. * How much is completed, in [0.0...1.0].
  51040. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  51041. */
  51042. completeRate: number;
  51043. /**
  51044. * What the registered observable sent in the last count
  51045. */
  51046. payload: T;
  51047. }
  51048. /**
  51049. * The current state of the timer
  51050. */
  51051. export enum TimerState {
  51052. /**
  51053. * Timer initialized, not yet started
  51054. */
  51055. INIT = 0,
  51056. /**
  51057. * Timer started and counting
  51058. */
  51059. STARTED = 1,
  51060. /**
  51061. * Timer ended (whether aborted or time reached)
  51062. */
  51063. ENDED = 2
  51064. }
  51065. /**
  51066. * A simple version of the timer. Will take options and start the timer immediately after calling it
  51067. *
  51068. * @param options options with which to initialize this timer
  51069. */
  51070. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  51071. /**
  51072. * An advanced implementation of a timer class
  51073. */
  51074. export class AdvancedTimer<T = any> implements IDisposable {
  51075. /**
  51076. * Will notify each time the timer calculates the remaining time
  51077. */
  51078. onEachCountObservable: Observable<ITimerData<T>>;
  51079. /**
  51080. * Will trigger when the timer was aborted due to the break condition
  51081. */
  51082. onTimerAbortedObservable: Observable<ITimerData<T>>;
  51083. /**
  51084. * Will trigger when the timer ended successfully
  51085. */
  51086. onTimerEndedObservable: Observable<ITimerData<T>>;
  51087. /**
  51088. * Will trigger when the timer state has changed
  51089. */
  51090. onStateChangedObservable: Observable<TimerState>;
  51091. private _observer;
  51092. private _contextObservable;
  51093. private _observableParameters;
  51094. private _startTime;
  51095. private _timer;
  51096. private _state;
  51097. private _breakCondition;
  51098. private _timeToEnd;
  51099. private _breakOnNextTick;
  51100. /**
  51101. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  51102. * @param options construction options for this advanced timer
  51103. */
  51104. constructor(options: ITimerOptions<T>);
  51105. /**
  51106. * set a breaking condition for this timer. Default is to never break during count
  51107. * @param predicate the new break condition. Returns true to break, false otherwise
  51108. */
  51109. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  51110. /**
  51111. * Reset ALL associated observables in this advanced timer
  51112. */
  51113. clearObservables(): void;
  51114. /**
  51115. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  51116. *
  51117. * @param timeToEnd how much time to measure until timer ended
  51118. */
  51119. start(timeToEnd?: number): void;
  51120. /**
  51121. * Will force a stop on the next tick.
  51122. */
  51123. stop(): void;
  51124. /**
  51125. * Dispose this timer, clearing all resources
  51126. */
  51127. dispose(): void;
  51128. private _setState;
  51129. private _tick;
  51130. private _stop;
  51131. }
  51132. }
  51133. declare module "babylonjs/XR/features/WebXRControllerTeleportation" {
  51134. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  51135. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  51136. import { WebXRInput } from "babylonjs/XR/webXRInput";
  51137. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51138. import { Vector3 } from "babylonjs/Maths/math.vector";
  51139. import { Material } from "babylonjs/Materials/material";
  51140. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  51141. import { Scene } from "babylonjs/scene";
  51142. /**
  51143. * The options container for the teleportation module
  51144. */
  51145. export interface IWebXRTeleportationOptions {
  51146. /**
  51147. * if provided, this scene will be used to render meshes.
  51148. */
  51149. customUtilityLayerScene?: Scene;
  51150. /**
  51151. * Values to configure the default target mesh
  51152. */
  51153. defaultTargetMeshOptions?: {
  51154. /**
  51155. * Fill color of the teleportation area
  51156. */
  51157. teleportationFillColor?: string;
  51158. /**
  51159. * Border color for the teleportation area
  51160. */
  51161. teleportationBorderColor?: string;
  51162. /**
  51163. * Disable the mesh's animation sequence
  51164. */
  51165. disableAnimation?: boolean;
  51166. /**
  51167. * Disable lighting on the material or the ring and arrow
  51168. */
  51169. disableLighting?: boolean;
  51170. /**
  51171. * Override the default material of the torus and arrow
  51172. */
  51173. torusArrowMaterial?: Material;
  51174. };
  51175. /**
  51176. * A list of meshes to use as floor meshes.
  51177. * Meshes can be added and removed after initializing the feature using the
  51178. * addFloorMesh and removeFloorMesh functions
  51179. * If empty, rotation will still work
  51180. */
  51181. floorMeshes?: AbstractMesh[];
  51182. /**
  51183. * use this rendering group id for the meshes (optional)
  51184. */
  51185. renderingGroupId?: number;
  51186. /**
  51187. * Should teleportation move only to snap points
  51188. */
  51189. snapPointsOnly?: boolean;
  51190. /**
  51191. * An array of points to which the teleportation will snap to.
  51192. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  51193. */
  51194. snapPositions?: Vector3[];
  51195. /**
  51196. * How close should the teleportation ray be in order to snap to position.
  51197. * Default to 0.8 units (meters)
  51198. */
  51199. snapToPositionRadius?: number;
  51200. /**
  51201. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  51202. * If you want to support rotation, make sure your mesh has a direction indicator.
  51203. *
  51204. * When left untouched, the default mesh will be initialized.
  51205. */
  51206. teleportationTargetMesh?: AbstractMesh;
  51207. /**
  51208. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  51209. */
  51210. timeToTeleport?: number;
  51211. /**
  51212. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  51213. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  51214. */
  51215. useMainComponentOnly?: boolean;
  51216. /**
  51217. * Should meshes created here be added to a utility layer or the main scene
  51218. */
  51219. useUtilityLayer?: boolean;
  51220. /**
  51221. * Babylon XR Input class for controller
  51222. */
  51223. xrInput: WebXRInput;
  51224. }
  51225. /**
  51226. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  51227. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  51228. * the input of the attached controllers.
  51229. */
  51230. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  51231. private _options;
  51232. private _controllers;
  51233. private _currentTeleportationControllerId;
  51234. private _floorMeshes;
  51235. private _quadraticBezierCurve;
  51236. private _selectionFeature;
  51237. private _snapToPositions;
  51238. private _snappedToPoint;
  51239. private _teleportationRingMaterial?;
  51240. private _tmpRay;
  51241. private _tmpVector;
  51242. /**
  51243. * The module's name
  51244. */
  51245. static readonly Name: string;
  51246. /**
  51247. * The (Babylon) version of this module.
  51248. * This is an integer representing the implementation version.
  51249. * This number does not correspond to the webxr specs version
  51250. */
  51251. static readonly Version: number;
  51252. /**
  51253. * Is movement backwards enabled
  51254. */
  51255. backwardsMovementEnabled: boolean;
  51256. /**
  51257. * Distance to travel when moving backwards
  51258. */
  51259. backwardsTeleportationDistance: number;
  51260. /**
  51261. * The distance from the user to the inspection point in the direction of the controller
  51262. * A higher number will allow the user to move further
  51263. * defaults to 5 (meters, in xr units)
  51264. */
  51265. parabolicCheckRadius: number;
  51266. /**
  51267. * Should the module support parabolic ray on top of direct ray
  51268. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  51269. * Very helpful when moving between floors / different heights
  51270. */
  51271. parabolicRayEnabled: boolean;
  51272. /**
  51273. * How much rotation should be applied when rotating right and left
  51274. */
  51275. rotationAngle: number;
  51276. /**
  51277. * Is rotation enabled when moving forward?
  51278. * Disabling this feature will prevent the user from deciding the direction when teleporting
  51279. */
  51280. rotationEnabled: boolean;
  51281. /**
  51282. * constructs a new anchor system
  51283. * @param _xrSessionManager an instance of WebXRSessionManager
  51284. * @param _options configuration object for this feature
  51285. */
  51286. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  51287. /**
  51288. * Get the snapPointsOnly flag
  51289. */
  51290. get snapPointsOnly(): boolean;
  51291. /**
  51292. * Sets the snapPointsOnly flag
  51293. * @param snapToPoints should teleportation be exclusively to snap points
  51294. */
  51295. set snapPointsOnly(snapToPoints: boolean);
  51296. /**
  51297. * Add a new mesh to the floor meshes array
  51298. * @param mesh the mesh to use as floor mesh
  51299. */
  51300. addFloorMesh(mesh: AbstractMesh): void;
  51301. /**
  51302. * Add a new snap-to point to fix teleportation to this position
  51303. * @param newSnapPoint The new Snap-To point
  51304. */
  51305. addSnapPoint(newSnapPoint: Vector3): void;
  51306. attach(): boolean;
  51307. detach(): boolean;
  51308. dispose(): void;
  51309. /**
  51310. * Remove a mesh from the floor meshes array
  51311. * @param mesh the mesh to remove
  51312. */
  51313. removeFloorMesh(mesh: AbstractMesh): void;
  51314. /**
  51315. * Remove a mesh from the floor meshes array using its name
  51316. * @param name the mesh name to remove
  51317. */
  51318. removeFloorMeshByName(name: string): void;
  51319. /**
  51320. * 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
  51321. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  51322. * @returns was the point found and removed or not
  51323. */
  51324. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  51325. /**
  51326. * This function sets a selection feature that will be disabled when
  51327. * the forward ray is shown and will be reattached when hidden.
  51328. * This is used to remove the selection rays when moving.
  51329. * @param selectionFeature the feature to disable when forward movement is enabled
  51330. */
  51331. setSelectionFeature(selectionFeature: IWebXRFeature): void;
  51332. protected _onXRFrame(_xrFrame: XRFrame): void;
  51333. private _attachController;
  51334. private _createDefaultTargetMesh;
  51335. private _detachController;
  51336. private _findClosestSnapPointWithRadius;
  51337. private _setTargetMeshPosition;
  51338. private _setTargetMeshVisibility;
  51339. private _showParabolicPath;
  51340. private _teleportForward;
  51341. }
  51342. }
  51343. declare module "babylonjs/XR/webXRDefaultExperience" {
  51344. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  51345. import { Scene } from "babylonjs/scene";
  51346. import { WebXRInput, IWebXRInputOptions } from "babylonjs/XR/webXRInput";
  51347. import { WebXRControllerPointerSelection } from "babylonjs/XR/features/WebXRControllerPointerSelection";
  51348. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  51349. import { WebXREnterExitUI, WebXREnterExitUIOptions } from "babylonjs/XR/webXREnterExitUI";
  51350. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51351. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  51352. import { WebXRMotionControllerTeleportation } from "babylonjs/XR/features/WebXRControllerTeleportation";
  51353. /**
  51354. * Options for the default xr helper
  51355. */
  51356. export class WebXRDefaultExperienceOptions {
  51357. /**
  51358. * Enable or disable default UI to enter XR
  51359. */
  51360. disableDefaultUI?: boolean;
  51361. /**
  51362. * Should teleportation not initialize. defaults to false.
  51363. */
  51364. disableTeleportation?: boolean;
  51365. /**
  51366. * Floor meshes that will be used for teleport
  51367. */
  51368. floorMeshes?: Array<AbstractMesh>;
  51369. /**
  51370. * If set to true, the first frame will not be used to reset position
  51371. * The first frame is mainly used when copying transformation from the old camera
  51372. * Mainly used in AR
  51373. */
  51374. ignoreNativeCameraTransformation?: boolean;
  51375. /**
  51376. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  51377. */
  51378. inputOptions?: IWebXRInputOptions;
  51379. /**
  51380. * optional configuration for the output canvas
  51381. */
  51382. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  51383. /**
  51384. * optional UI options. This can be used among other to change session mode and reference space type
  51385. */
  51386. uiOptions?: WebXREnterExitUIOptions;
  51387. /**
  51388. * When loading teleportation and pointer select, use stable versions instead of latest.
  51389. */
  51390. useStablePlugins?: boolean;
  51391. /**
  51392. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  51393. */
  51394. renderingGroupId?: number;
  51395. /**
  51396. * A list of optional features to init the session with
  51397. * If set to true, all features we support will be added
  51398. */
  51399. optionalFeatures?: boolean | string[];
  51400. }
  51401. /**
  51402. * Default experience which provides a similar setup to the previous webVRExperience
  51403. */
  51404. export class WebXRDefaultExperience {
  51405. /**
  51406. * Base experience
  51407. */
  51408. baseExperience: WebXRExperienceHelper;
  51409. /**
  51410. * Enables ui for entering/exiting xr
  51411. */
  51412. enterExitUI: WebXREnterExitUI;
  51413. /**
  51414. * Input experience extension
  51415. */
  51416. input: WebXRInput;
  51417. /**
  51418. * Enables laser pointer and selection
  51419. */
  51420. pointerSelection: WebXRControllerPointerSelection;
  51421. /**
  51422. * Default target xr should render to
  51423. */
  51424. renderTarget: WebXRRenderTarget;
  51425. /**
  51426. * Enables teleportation
  51427. */
  51428. teleportation: WebXRMotionControllerTeleportation;
  51429. private constructor();
  51430. /**
  51431. * Creates the default xr experience
  51432. * @param scene scene
  51433. * @param options options for basic configuration
  51434. * @returns resulting WebXRDefaultExperience
  51435. */
  51436. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  51437. /**
  51438. * DIsposes of the experience helper
  51439. */
  51440. dispose(): void;
  51441. }
  51442. }
  51443. declare module "babylonjs/Cameras/VR/vrExperienceHelper" {
  51444. import { Observable } from "babylonjs/Misc/observable";
  51445. import { Nullable } from "babylonjs/types";
  51446. import { Camera } from "babylonjs/Cameras/camera";
  51447. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  51448. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  51449. import { WebVROptions, WebVRFreeCamera } from "babylonjs/Cameras/VR/webVRCamera";
  51450. import { Scene } from "babylonjs/scene";
  51451. import { Vector3 } from "babylonjs/Maths/math.vector";
  51452. import { Color3 } from "babylonjs/Maths/math.color";
  51453. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  51454. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51455. import { Mesh } from "babylonjs/Meshes/mesh";
  51456. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  51457. import { EasingFunction } from "babylonjs/Animations/easing";
  51458. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  51459. import "babylonjs/Meshes/Builders/groundBuilder";
  51460. import "babylonjs/Meshes/Builders/torusBuilder";
  51461. import "babylonjs/Meshes/Builders/cylinderBuilder";
  51462. import "babylonjs/Gamepads/gamepadSceneComponent";
  51463. import "babylonjs/Animations/animatable";
  51464. import { WebXRDefaultExperience } from "babylonjs/XR/webXRDefaultExperience";
  51465. /**
  51466. * Options to modify the vr teleportation behavior.
  51467. */
  51468. export interface VRTeleportationOptions {
  51469. /**
  51470. * The name of the mesh which should be used as the teleportation floor. (default: null)
  51471. */
  51472. floorMeshName?: string;
  51473. /**
  51474. * A list of meshes to be used as the teleportation floor. (default: empty)
  51475. */
  51476. floorMeshes?: Mesh[];
  51477. /**
  51478. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  51479. */
  51480. teleportationMode?: number;
  51481. /**
  51482. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  51483. */
  51484. teleportationTime?: number;
  51485. /**
  51486. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  51487. */
  51488. teleportationSpeed?: number;
  51489. /**
  51490. * The easing function used in the animation or null for Linear. (default CircleEase)
  51491. */
  51492. easingFunction?: EasingFunction;
  51493. }
  51494. /**
  51495. * Options to modify the vr experience helper's behavior.
  51496. */
  51497. export interface VRExperienceHelperOptions extends WebVROptions {
  51498. /**
  51499. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  51500. */
  51501. createDeviceOrientationCamera?: boolean;
  51502. /**
  51503. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  51504. */
  51505. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  51506. /**
  51507. * Uses the main button on the controller to toggle the laser casted. (default: true)
  51508. */
  51509. laserToggle?: boolean;
  51510. /**
  51511. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  51512. */
  51513. floorMeshes?: Mesh[];
  51514. /**
  51515. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  51516. */
  51517. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  51518. /**
  51519. * Defines if WebXR should be used instead of WebVR (if available)
  51520. */
  51521. useXR?: boolean;
  51522. }
  51523. /**
  51524. * Event containing information after VR has been entered
  51525. */
  51526. export class OnAfterEnteringVRObservableEvent {
  51527. /**
  51528. * If entering vr was successful
  51529. */
  51530. success: boolean;
  51531. }
  51532. /**
  51533. * Helps to quickly add VR support to an existing scene.
  51534. * See https://doc.babylonjs.com/how_to/webvr_helper
  51535. */
  51536. export class VRExperienceHelper {
  51537. /** Options to modify the vr experience helper's behavior. */
  51538. webVROptions: VRExperienceHelperOptions;
  51539. private _scene;
  51540. private _position;
  51541. private _btnVR;
  51542. private _btnVRDisplayed;
  51543. private _webVRsupported;
  51544. private _webVRready;
  51545. private _webVRrequesting;
  51546. private _webVRpresenting;
  51547. private _hasEnteredVR;
  51548. private _fullscreenVRpresenting;
  51549. private _inputElement;
  51550. private _webVRCamera;
  51551. private _vrDeviceOrientationCamera;
  51552. private _deviceOrientationCamera;
  51553. private _existingCamera;
  51554. private _onKeyDown;
  51555. private _onVrDisplayPresentChange;
  51556. private _onVRDisplayChanged;
  51557. private _onVRRequestPresentStart;
  51558. private _onVRRequestPresentComplete;
  51559. /**
  51560. * 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)
  51561. */
  51562. enableGazeEvenWhenNoPointerLock: boolean;
  51563. /**
  51564. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  51565. */
  51566. exitVROnDoubleTap: boolean;
  51567. /**
  51568. * Observable raised right before entering VR.
  51569. */
  51570. onEnteringVRObservable: Observable<VRExperienceHelper>;
  51571. /**
  51572. * Observable raised when entering VR has completed.
  51573. */
  51574. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  51575. /**
  51576. * Observable raised when exiting VR.
  51577. */
  51578. onExitingVRObservable: Observable<VRExperienceHelper>;
  51579. /**
  51580. * Observable raised when controller mesh is loaded.
  51581. */
  51582. onControllerMeshLoadedObservable: Observable<WebVRController>;
  51583. /** Return this.onEnteringVRObservable
  51584. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  51585. */
  51586. get onEnteringVR(): Observable<VRExperienceHelper>;
  51587. /** Return this.onExitingVRObservable
  51588. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  51589. */
  51590. get onExitingVR(): Observable<VRExperienceHelper>;
  51591. /** Return this.onControllerMeshLoadedObservable
  51592. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  51593. */
  51594. get onControllerMeshLoaded(): Observable<WebVRController>;
  51595. private _rayLength;
  51596. private _useCustomVRButton;
  51597. private _teleportationRequested;
  51598. private _teleportActive;
  51599. private _floorMeshName;
  51600. private _floorMeshesCollection;
  51601. private _teleportationMode;
  51602. private _teleportationTime;
  51603. private _teleportationSpeed;
  51604. private _teleportationEasing;
  51605. private _rotationAllowed;
  51606. private _teleportBackwardsVector;
  51607. private _teleportationTarget;
  51608. private _isDefaultTeleportationTarget;
  51609. private _postProcessMove;
  51610. private _teleportationFillColor;
  51611. private _teleportationBorderColor;
  51612. private _rotationAngle;
  51613. private _haloCenter;
  51614. private _cameraGazer;
  51615. private _padSensibilityUp;
  51616. private _padSensibilityDown;
  51617. private _leftController;
  51618. private _rightController;
  51619. private _gazeColor;
  51620. private _laserColor;
  51621. private _pickedLaserColor;
  51622. private _pickedGazeColor;
  51623. /**
  51624. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  51625. */
  51626. onNewMeshSelected: Observable<AbstractMesh>;
  51627. /**
  51628. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  51629. * This observable will provide the mesh and the controller used to select the mesh
  51630. */
  51631. onMeshSelectedWithController: Observable<{
  51632. mesh: AbstractMesh;
  51633. controller: WebVRController;
  51634. }>;
  51635. /**
  51636. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  51637. */
  51638. onNewMeshPicked: Observable<PickingInfo>;
  51639. private _circleEase;
  51640. /**
  51641. * Observable raised before camera teleportation
  51642. */
  51643. onBeforeCameraTeleport: Observable<Vector3>;
  51644. /**
  51645. * Observable raised after camera teleportation
  51646. */
  51647. onAfterCameraTeleport: Observable<Vector3>;
  51648. /**
  51649. * Observable raised when current selected mesh gets unselected
  51650. */
  51651. onSelectedMeshUnselected: Observable<AbstractMesh>;
  51652. private _raySelectionPredicate;
  51653. /**
  51654. * To be optionaly changed by user to define custom ray selection
  51655. */
  51656. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  51657. /**
  51658. * To be optionaly changed by user to define custom selection logic (after ray selection)
  51659. */
  51660. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  51661. /**
  51662. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  51663. */
  51664. teleportationEnabled: boolean;
  51665. private _defaultHeight;
  51666. private _teleportationInitialized;
  51667. private _interactionsEnabled;
  51668. private _interactionsRequested;
  51669. private _displayGaze;
  51670. private _displayLaserPointer;
  51671. /**
  51672. * The mesh used to display where the user is going to teleport.
  51673. */
  51674. get teleportationTarget(): Mesh;
  51675. /**
  51676. * Sets the mesh to be used to display where the user is going to teleport.
  51677. */
  51678. set teleportationTarget(value: Mesh);
  51679. /**
  51680. * 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
  51681. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  51682. * See https://doc.babylonjs.com/resources/baking_transformations
  51683. */
  51684. get gazeTrackerMesh(): Mesh;
  51685. set gazeTrackerMesh(value: Mesh);
  51686. /**
  51687. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  51688. */
  51689. updateGazeTrackerScale: boolean;
  51690. /**
  51691. * If the gaze trackers color should be updated when selecting meshes
  51692. */
  51693. updateGazeTrackerColor: boolean;
  51694. /**
  51695. * If the controller laser color should be updated when selecting meshes
  51696. */
  51697. updateControllerLaserColor: boolean;
  51698. /**
  51699. * The gaze tracking mesh corresponding to the left controller
  51700. */
  51701. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  51702. /**
  51703. * The gaze tracking mesh corresponding to the right controller
  51704. */
  51705. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  51706. /**
  51707. * If the ray of the gaze should be displayed.
  51708. */
  51709. get displayGaze(): boolean;
  51710. /**
  51711. * Sets if the ray of the gaze should be displayed.
  51712. */
  51713. set displayGaze(value: boolean);
  51714. /**
  51715. * If the ray of the LaserPointer should be displayed.
  51716. */
  51717. get displayLaserPointer(): boolean;
  51718. /**
  51719. * Sets if the ray of the LaserPointer should be displayed.
  51720. */
  51721. set displayLaserPointer(value: boolean);
  51722. /**
  51723. * The deviceOrientationCamera used as the camera when not in VR.
  51724. */
  51725. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  51726. /**
  51727. * Based on the current WebVR support, returns the current VR camera used.
  51728. */
  51729. get currentVRCamera(): Nullable<Camera>;
  51730. /**
  51731. * The webVRCamera which is used when in VR.
  51732. */
  51733. get webVRCamera(): WebVRFreeCamera;
  51734. /**
  51735. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  51736. */
  51737. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  51738. /**
  51739. * The html button that is used to trigger entering into VR.
  51740. */
  51741. get vrButton(): Nullable<HTMLButtonElement>;
  51742. private get _teleportationRequestInitiated();
  51743. /**
  51744. * Defines whether or not Pointer lock should be requested when switching to
  51745. * full screen.
  51746. */
  51747. requestPointerLockOnFullScreen: boolean;
  51748. /**
  51749. * If asking to force XR, this will be populated with the default xr experience
  51750. */
  51751. xr: WebXRDefaultExperience;
  51752. /**
  51753. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  51754. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  51755. */
  51756. xrTestDone: boolean;
  51757. /**
  51758. * Instantiates a VRExperienceHelper.
  51759. * Helps to quickly add VR support to an existing scene.
  51760. * @param scene The scene the VRExperienceHelper belongs to.
  51761. * @param webVROptions Options to modify the vr experience helper's behavior.
  51762. */
  51763. constructor(scene: Scene,
  51764. /** Options to modify the vr experience helper's behavior. */
  51765. webVROptions?: VRExperienceHelperOptions);
  51766. private completeVRInit;
  51767. private _onDefaultMeshLoaded;
  51768. private _onResize;
  51769. private _onFullscreenChange;
  51770. /**
  51771. * Gets a value indicating if we are currently in VR mode.
  51772. */
  51773. get isInVRMode(): boolean;
  51774. private onVrDisplayPresentChange;
  51775. private onVRDisplayChanged;
  51776. private moveButtonToBottomRight;
  51777. private displayVRButton;
  51778. private updateButtonVisibility;
  51779. private _cachedAngularSensibility;
  51780. /**
  51781. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  51782. * Otherwise, will use the fullscreen API.
  51783. */
  51784. enterVR(): void;
  51785. /**
  51786. * Attempt to exit VR, or fullscreen.
  51787. */
  51788. exitVR(): void;
  51789. /**
  51790. * The position of the vr experience helper.
  51791. */
  51792. get position(): Vector3;
  51793. /**
  51794. * Sets the position of the vr experience helper.
  51795. */
  51796. set position(value: Vector3);
  51797. /**
  51798. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  51799. */
  51800. enableInteractions(): void;
  51801. private get _noControllerIsActive();
  51802. private beforeRender;
  51803. private _isTeleportationFloor;
  51804. /**
  51805. * Adds a floor mesh to be used for teleportation.
  51806. * @param floorMesh the mesh to be used for teleportation.
  51807. */
  51808. addFloorMesh(floorMesh: Mesh): void;
  51809. /**
  51810. * Removes a floor mesh from being used for teleportation.
  51811. * @param floorMesh the mesh to be removed.
  51812. */
  51813. removeFloorMesh(floorMesh: Mesh): void;
  51814. /**
  51815. * Enables interactions and teleportation using the VR controllers and gaze.
  51816. * @param vrTeleportationOptions options to modify teleportation behavior.
  51817. */
  51818. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  51819. private _onNewGamepadConnected;
  51820. private _tryEnableInteractionOnController;
  51821. private _onNewGamepadDisconnected;
  51822. private _enableInteractionOnController;
  51823. private _checkTeleportWithRay;
  51824. private _checkRotate;
  51825. private _checkTeleportBackwards;
  51826. private _enableTeleportationOnController;
  51827. private _createTeleportationCircles;
  51828. private _displayTeleportationTarget;
  51829. private _hideTeleportationTarget;
  51830. private _rotateCamera;
  51831. private _moveTeleportationSelectorTo;
  51832. private _workingVector;
  51833. private _workingQuaternion;
  51834. private _workingMatrix;
  51835. /**
  51836. * Time Constant Teleportation Mode
  51837. */
  51838. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  51839. /**
  51840. * Speed Constant Teleportation Mode
  51841. */
  51842. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  51843. /**
  51844. * Teleports the users feet to the desired location
  51845. * @param location The location where the user's feet should be placed
  51846. */
  51847. teleportCamera(location: Vector3): void;
  51848. private _convertNormalToDirectionOfRay;
  51849. private _castRayAndSelectObject;
  51850. private _notifySelectedMeshUnselected;
  51851. /**
  51852. * Permanently set new colors for the laser pointer
  51853. * @param color the new laser color
  51854. * @param pickedColor the new laser color when picked mesh detected
  51855. */
  51856. setLaserColor(color: Color3, pickedColor?: Color3): void;
  51857. /**
  51858. * Set lighting enabled / disabled on the laser pointer of both controllers
  51859. * @param enabled should the lighting be enabled on the laser pointer
  51860. */
  51861. setLaserLightingState(enabled?: boolean): void;
  51862. /**
  51863. * Permanently set new colors for the gaze pointer
  51864. * @param color the new gaze color
  51865. * @param pickedColor the new gaze color when picked mesh detected
  51866. */
  51867. setGazeColor(color: Color3, pickedColor?: Color3): void;
  51868. /**
  51869. * Sets the color of the laser ray from the vr controllers.
  51870. * @param color new color for the ray.
  51871. */
  51872. changeLaserColor(color: Color3): void;
  51873. /**
  51874. * Sets the color of the ray from the vr headsets gaze.
  51875. * @param color new color for the ray.
  51876. */
  51877. changeGazeColor(color: Color3): void;
  51878. /**
  51879. * Exits VR and disposes of the vr experience helper
  51880. */
  51881. dispose(): void;
  51882. /**
  51883. * Gets the name of the VRExperienceHelper class
  51884. * @returns "VRExperienceHelper"
  51885. */
  51886. getClassName(): string;
  51887. }
  51888. }
  51889. declare module "babylonjs/Cameras/VR/index" {
  51890. export * from "babylonjs/Cameras/VR/vrCameraMetrics";
  51891. export * from "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera";
  51892. export * from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  51893. export * from "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera";
  51894. export * from "babylonjs/Cameras/VR/vrExperienceHelper";
  51895. export * from "babylonjs/Cameras/VR/webVRCamera";
  51896. }
  51897. declare module "babylonjs/Cameras/RigModes/index" {
  51898. export * from "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  51899. export * from "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  51900. export * from "babylonjs/Cameras/RigModes/vrRigMode";
  51901. export * from "babylonjs/Cameras/RigModes/webVRRigMode";
  51902. }
  51903. declare module "babylonjs/Cameras/index" {
  51904. export * from "babylonjs/Cameras/Inputs/index";
  51905. export * from "babylonjs/Cameras/cameraInputsManager";
  51906. export * from "babylonjs/Cameras/camera";
  51907. export * from "babylonjs/Cameras/targetCamera";
  51908. export * from "babylonjs/Cameras/freeCamera";
  51909. export * from "babylonjs/Cameras/freeCameraInputsManager";
  51910. export * from "babylonjs/Cameras/touchCamera";
  51911. export * from "babylonjs/Cameras/arcRotateCamera";
  51912. export * from "babylonjs/Cameras/arcRotateCameraInputsManager";
  51913. export * from "babylonjs/Cameras/deviceOrientationCamera";
  51914. export * from "babylonjs/Cameras/flyCamera";
  51915. export * from "babylonjs/Cameras/flyCameraInputsManager";
  51916. export * from "babylonjs/Cameras/followCamera";
  51917. export * from "babylonjs/Cameras/followCameraInputsManager";
  51918. export * from "babylonjs/Cameras/gamepadCamera";
  51919. export * from "babylonjs/Cameras/Stereoscopic/index";
  51920. export * from "babylonjs/Cameras/universalCamera";
  51921. export * from "babylonjs/Cameras/virtualJoysticksCamera";
  51922. export * from "babylonjs/Cameras/VR/index";
  51923. export * from "babylonjs/Cameras/RigModes/index";
  51924. }
  51925. declare module "babylonjs/Collisions/index" {
  51926. export * from "babylonjs/Collisions/collider";
  51927. export * from "babylonjs/Collisions/collisionCoordinator";
  51928. export * from "babylonjs/Collisions/pickingInfo";
  51929. export * from "babylonjs/Collisions/intersectionInfo";
  51930. export * from "babylonjs/Collisions/meshCollisionData";
  51931. }
  51932. declare module "babylonjs/Culling/Octrees/octreeBlock" {
  51933. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  51934. import { Vector3 } from "babylonjs/Maths/math.vector";
  51935. import { Ray } from "babylonjs/Culling/ray";
  51936. import { Plane } from "babylonjs/Maths/math.plane";
  51937. /**
  51938. * Contains an array of blocks representing the octree
  51939. */
  51940. export interface IOctreeContainer<T> {
  51941. /**
  51942. * Blocks within the octree
  51943. */
  51944. blocks: Array<OctreeBlock<T>>;
  51945. }
  51946. /**
  51947. * Class used to store a cell in an octree
  51948. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  51949. */
  51950. export class OctreeBlock<T> {
  51951. /**
  51952. * Gets the content of the current block
  51953. */
  51954. entries: T[];
  51955. /**
  51956. * Gets the list of block children
  51957. */
  51958. blocks: Array<OctreeBlock<T>>;
  51959. private _depth;
  51960. private _maxDepth;
  51961. private _capacity;
  51962. private _minPoint;
  51963. private _maxPoint;
  51964. private _boundingVectors;
  51965. private _creationFunc;
  51966. /**
  51967. * Creates a new block
  51968. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  51969. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  51970. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  51971. * @param depth defines the current depth of this block in the octree
  51972. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  51973. * @param creationFunc defines a callback to call when an element is added to the block
  51974. */
  51975. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  51976. /**
  51977. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  51978. */
  51979. get capacity(): number;
  51980. /**
  51981. * Gets the minimum vector (in world space) of the block's bounding box
  51982. */
  51983. get minPoint(): Vector3;
  51984. /**
  51985. * Gets the maximum vector (in world space) of the block's bounding box
  51986. */
  51987. get maxPoint(): Vector3;
  51988. /**
  51989. * Add a new element to this block
  51990. * @param entry defines the element to add
  51991. */
  51992. addEntry(entry: T): void;
  51993. /**
  51994. * Remove an element from this block
  51995. * @param entry defines the element to remove
  51996. */
  51997. removeEntry(entry: T): void;
  51998. /**
  51999. * Add an array of elements to this block
  52000. * @param entries defines the array of elements to add
  52001. */
  52002. addEntries(entries: T[]): void;
  52003. /**
  52004. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  52005. * @param frustumPlanes defines the frustum planes to test
  52006. * @param selection defines the array to store current content if selection is positive
  52007. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52008. */
  52009. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  52010. /**
  52011. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  52012. * @param sphereCenter defines the bounding sphere center
  52013. * @param sphereRadius defines the bounding sphere radius
  52014. * @param selection defines the array to store current content if selection is positive
  52015. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52016. */
  52017. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  52018. /**
  52019. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  52020. * @param ray defines the ray to test with
  52021. * @param selection defines the array to store current content if selection is positive
  52022. */
  52023. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  52024. /**
  52025. * Subdivide the content into child blocks (this block will then be empty)
  52026. */
  52027. createInnerBlocks(): void;
  52028. /**
  52029. * @hidden
  52030. */
  52031. 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;
  52032. }
  52033. }
  52034. declare module "babylonjs/Culling/Octrees/octree" {
  52035. import { SmartArray } from "babylonjs/Misc/smartArray";
  52036. import { Vector3 } from "babylonjs/Maths/math.vector";
  52037. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52038. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52039. import { Ray } from "babylonjs/Culling/ray";
  52040. import { OctreeBlock } from "babylonjs/Culling/Octrees/octreeBlock";
  52041. import { Plane } from "babylonjs/Maths/math.plane";
  52042. /**
  52043. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  52044. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52045. */
  52046. export class Octree<T> {
  52047. /** 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.) */
  52048. maxDepth: number;
  52049. /**
  52050. * Blocks within the octree containing objects
  52051. */
  52052. blocks: Array<OctreeBlock<T>>;
  52053. /**
  52054. * Content stored in the octree
  52055. */
  52056. dynamicContent: T[];
  52057. private _maxBlockCapacity;
  52058. private _selectionContent;
  52059. private _creationFunc;
  52060. /**
  52061. * Creates a octree
  52062. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52063. * @param creationFunc function to be used to instatiate the octree
  52064. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  52065. * @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.)
  52066. */
  52067. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  52068. /** 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.) */
  52069. maxDepth?: number);
  52070. /**
  52071. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  52072. * @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);
  52073. * @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);
  52074. * @param entries meshes to be added to the octree blocks
  52075. */
  52076. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  52077. /**
  52078. * Adds a mesh to the octree
  52079. * @param entry Mesh to add to the octree
  52080. */
  52081. addMesh(entry: T): void;
  52082. /**
  52083. * Remove an element from the octree
  52084. * @param entry defines the element to remove
  52085. */
  52086. removeMesh(entry: T): void;
  52087. /**
  52088. * Selects an array of meshes within the frustum
  52089. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  52090. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  52091. * @returns array of meshes within the frustum
  52092. */
  52093. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  52094. /**
  52095. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  52096. * @param sphereCenter defines the bounding sphere center
  52097. * @param sphereRadius defines the bounding sphere radius
  52098. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52099. * @returns an array of objects that intersect the sphere
  52100. */
  52101. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  52102. /**
  52103. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  52104. * @param ray defines the ray to test with
  52105. * @returns array of intersected objects
  52106. */
  52107. intersectsRay(ray: Ray): SmartArray<T>;
  52108. /**
  52109. * Adds a mesh into the octree block if it intersects the block
  52110. */
  52111. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  52112. /**
  52113. * Adds a submesh into the octree block if it intersects the block
  52114. */
  52115. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  52116. }
  52117. }
  52118. declare module "babylonjs/Culling/Octrees/octreeSceneComponent" {
  52119. import { ISmartArrayLike } from "babylonjs/Misc/smartArray";
  52120. import { Scene } from "babylonjs/scene";
  52121. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52122. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52123. import { Ray } from "babylonjs/Culling/ray";
  52124. import { Octree } from "babylonjs/Culling/Octrees/octree";
  52125. import { Collider } from "babylonjs/Collisions/collider";
  52126. module "babylonjs/scene" {
  52127. interface Scene {
  52128. /**
  52129. * @hidden
  52130. * Backing Filed
  52131. */
  52132. _selectionOctree: Octree<AbstractMesh>;
  52133. /**
  52134. * Gets the octree used to boost mesh selection (picking)
  52135. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52136. */
  52137. selectionOctree: Octree<AbstractMesh>;
  52138. /**
  52139. * Creates or updates the octree used to boost selection (picking)
  52140. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52141. * @param maxCapacity defines the maximum capacity per leaf
  52142. * @param maxDepth defines the maximum depth of the octree
  52143. * @returns an octree of AbstractMesh
  52144. */
  52145. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  52146. }
  52147. }
  52148. module "babylonjs/Meshes/abstractMesh" {
  52149. interface AbstractMesh {
  52150. /**
  52151. * @hidden
  52152. * Backing Field
  52153. */
  52154. _submeshesOctree: Octree<SubMesh>;
  52155. /**
  52156. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  52157. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  52158. * @param maxCapacity defines the maximum size of each block (64 by default)
  52159. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  52160. * @returns the new octree
  52161. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  52162. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52163. */
  52164. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  52165. }
  52166. }
  52167. /**
  52168. * Defines the octree scene component responsible to manage any octrees
  52169. * in a given scene.
  52170. */
  52171. export class OctreeSceneComponent {
  52172. /**
  52173. * The component name help to identify the component in the list of scene components.
  52174. */
  52175. readonly name: string;
  52176. /**
  52177. * The scene the component belongs to.
  52178. */
  52179. scene: Scene;
  52180. /**
  52181. * Indicates if the meshes have been checked to make sure they are isEnabled()
  52182. */
  52183. readonly checksIsEnabled: boolean;
  52184. /**
  52185. * Creates a new instance of the component for the given scene
  52186. * @param scene Defines the scene to register the component in
  52187. */
  52188. constructor(scene: Scene);
  52189. /**
  52190. * Registers the component in a given scene
  52191. */
  52192. register(): void;
  52193. /**
  52194. * Return the list of active meshes
  52195. * @returns the list of active meshes
  52196. */
  52197. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  52198. /**
  52199. * Return the list of active sub meshes
  52200. * @param mesh The mesh to get the candidates sub meshes from
  52201. * @returns the list of active sub meshes
  52202. */
  52203. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  52204. private _tempRay;
  52205. /**
  52206. * Return the list of sub meshes intersecting with a given local ray
  52207. * @param mesh defines the mesh to find the submesh for
  52208. * @param localRay defines the ray in local space
  52209. * @returns the list of intersecting sub meshes
  52210. */
  52211. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  52212. /**
  52213. * Return the list of sub meshes colliding with a collider
  52214. * @param mesh defines the mesh to find the submesh for
  52215. * @param collider defines the collider to evaluate the collision against
  52216. * @returns the list of colliding sub meshes
  52217. */
  52218. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  52219. /**
  52220. * Rebuilds the elements related to this component in case of
  52221. * context lost for instance.
  52222. */
  52223. rebuild(): void;
  52224. /**
  52225. * Disposes the component and the associated ressources.
  52226. */
  52227. dispose(): void;
  52228. }
  52229. }
  52230. declare module "babylonjs/Culling/Octrees/index" {
  52231. export * from "babylonjs/Culling/Octrees/octree";
  52232. export * from "babylonjs/Culling/Octrees/octreeBlock";
  52233. export * from "babylonjs/Culling/Octrees/octreeSceneComponent";
  52234. }
  52235. declare module "babylonjs/Culling/index" {
  52236. export * from "babylonjs/Culling/boundingBox";
  52237. export * from "babylonjs/Culling/boundingInfo";
  52238. export * from "babylonjs/Culling/boundingSphere";
  52239. export * from "babylonjs/Culling/Octrees/index";
  52240. export * from "babylonjs/Culling/ray";
  52241. }
  52242. declare module "babylonjs/Gizmos/gizmo" {
  52243. import { Nullable } from "babylonjs/types";
  52244. import { IDisposable } from "babylonjs/scene";
  52245. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52246. import { Mesh } from "babylonjs/Meshes/mesh";
  52247. import { Node } from "babylonjs/node";
  52248. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52249. /**
  52250. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  52251. */
  52252. export class Gizmo implements IDisposable {
  52253. /** The utility layer the gizmo will be added to */
  52254. gizmoLayer: UtilityLayerRenderer;
  52255. /**
  52256. * The root mesh of the gizmo
  52257. */
  52258. _rootMesh: Mesh;
  52259. private _attachedMesh;
  52260. private _attachedNode;
  52261. /**
  52262. * Ratio for the scale of the gizmo (Default: 1)
  52263. */
  52264. protected _scaleRatio: number;
  52265. /**
  52266. * Ratio for the scale of the gizmo (Default: 1)
  52267. */
  52268. set scaleRatio(value: number);
  52269. get scaleRatio(): number;
  52270. /**
  52271. * If a custom mesh has been set (Default: false)
  52272. */
  52273. protected _customMeshSet: boolean;
  52274. /**
  52275. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  52276. * * When set, interactions will be enabled
  52277. */
  52278. get attachedMesh(): Nullable<AbstractMesh>;
  52279. set attachedMesh(value: Nullable<AbstractMesh>);
  52280. /**
  52281. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  52282. * * When set, interactions will be enabled
  52283. */
  52284. get attachedNode(): Nullable<Node>;
  52285. set attachedNode(value: Nullable<Node>);
  52286. /**
  52287. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  52288. * @param mesh The mesh to replace the default mesh of the gizmo
  52289. */
  52290. setCustomMesh(mesh: Mesh): void;
  52291. protected _updateGizmoRotationToMatchAttachedMesh: boolean;
  52292. /**
  52293. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  52294. */
  52295. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  52296. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  52297. /**
  52298. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  52299. */
  52300. updateGizmoPositionToMatchAttachedMesh: boolean;
  52301. /**
  52302. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  52303. */
  52304. updateScale: boolean;
  52305. protected _interactionsEnabled: boolean;
  52306. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52307. private _beforeRenderObserver;
  52308. private _tempQuaternion;
  52309. private _tempVector;
  52310. private _tempVector2;
  52311. /**
  52312. * Creates a gizmo
  52313. * @param gizmoLayer The utility layer the gizmo will be added to
  52314. */
  52315. constructor(
  52316. /** The utility layer the gizmo will be added to */
  52317. gizmoLayer?: UtilityLayerRenderer);
  52318. /**
  52319. * Updates the gizmo to match the attached mesh's position/rotation
  52320. */
  52321. protected _update(): void;
  52322. /**
  52323. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  52324. * @param value Node, TransformNode or mesh
  52325. */
  52326. protected _matrixChanged(): void;
  52327. /**
  52328. * Disposes of the gizmo
  52329. */
  52330. dispose(): void;
  52331. }
  52332. }
  52333. declare module "babylonjs/Gizmos/planeDragGizmo" {
  52334. import { Observable } from "babylonjs/Misc/observable";
  52335. import { Nullable } from "babylonjs/types";
  52336. import { Vector3 } from "babylonjs/Maths/math.vector";
  52337. import { Color3 } from "babylonjs/Maths/math.color";
  52338. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52339. import { Node } from "babylonjs/node";
  52340. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  52341. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52342. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52343. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  52344. import { Scene } from "babylonjs/scene";
  52345. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  52346. /**
  52347. * Single plane drag gizmo
  52348. */
  52349. export class PlaneDragGizmo extends Gizmo {
  52350. /**
  52351. * Drag behavior responsible for the gizmos dragging interactions
  52352. */
  52353. dragBehavior: PointerDragBehavior;
  52354. private _pointerObserver;
  52355. /**
  52356. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52357. */
  52358. snapDistance: number;
  52359. /**
  52360. * Event that fires each time the gizmo snaps to a new location.
  52361. * * snapDistance is the the change in distance
  52362. */
  52363. onSnapObservable: Observable<{
  52364. snapDistance: number;
  52365. }>;
  52366. private _plane;
  52367. private _coloredMaterial;
  52368. private _hoverMaterial;
  52369. private _isEnabled;
  52370. private _parent;
  52371. /** @hidden */
  52372. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  52373. /** @hidden */
  52374. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  52375. /**
  52376. * Creates a PlaneDragGizmo
  52377. * @param gizmoLayer The utility layer the gizmo will be added to
  52378. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  52379. * @param color The color of the gizmo
  52380. */
  52381. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  52382. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52383. /**
  52384. * If the gizmo is enabled
  52385. */
  52386. set isEnabled(value: boolean);
  52387. get isEnabled(): boolean;
  52388. /**
  52389. * Disposes of the gizmo
  52390. */
  52391. dispose(): void;
  52392. }
  52393. }
  52394. declare module "babylonjs/Gizmos/positionGizmo" {
  52395. import { Observable } from "babylonjs/Misc/observable";
  52396. import { Nullable } from "babylonjs/types";
  52397. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52398. import { Node } from "babylonjs/node";
  52399. import { Mesh } from "babylonjs/Meshes/mesh";
  52400. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52401. import { AxisDragGizmo } from "babylonjs/Gizmos/axisDragGizmo";
  52402. import { PlaneDragGizmo } from "babylonjs/Gizmos/planeDragGizmo";
  52403. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52404. /**
  52405. * Gizmo that enables dragging a mesh along 3 axis
  52406. */
  52407. export class PositionGizmo extends Gizmo {
  52408. /**
  52409. * Internal gizmo used for interactions on the x axis
  52410. */
  52411. xGizmo: AxisDragGizmo;
  52412. /**
  52413. * Internal gizmo used for interactions on the y axis
  52414. */
  52415. yGizmo: AxisDragGizmo;
  52416. /**
  52417. * Internal gizmo used for interactions on the z axis
  52418. */
  52419. zGizmo: AxisDragGizmo;
  52420. /**
  52421. * Internal gizmo used for interactions on the yz plane
  52422. */
  52423. xPlaneGizmo: PlaneDragGizmo;
  52424. /**
  52425. * Internal gizmo used for interactions on the xz plane
  52426. */
  52427. yPlaneGizmo: PlaneDragGizmo;
  52428. /**
  52429. * Internal gizmo used for interactions on the xy plane
  52430. */
  52431. zPlaneGizmo: PlaneDragGizmo;
  52432. /**
  52433. * private variables
  52434. */
  52435. private _meshAttached;
  52436. private _nodeAttached;
  52437. private _snapDistance;
  52438. /** Fires an event when any of it's sub gizmos are dragged */
  52439. onDragStartObservable: Observable<unknown>;
  52440. /** Fires an event when any of it's sub gizmos are released from dragging */
  52441. onDragEndObservable: Observable<unknown>;
  52442. /**
  52443. * If set to true, planar drag is enabled
  52444. */
  52445. private _planarGizmoEnabled;
  52446. get attachedMesh(): Nullable<AbstractMesh>;
  52447. set attachedMesh(mesh: Nullable<AbstractMesh>);
  52448. get attachedNode(): Nullable<Node>;
  52449. set attachedNode(node: Nullable<Node>);
  52450. /**
  52451. * Creates a PositionGizmo
  52452. * @param gizmoLayer The utility layer the gizmo will be added to
  52453. @param thickness display gizmo axis thickness
  52454. */
  52455. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  52456. /**
  52457. * If the planar drag gizmo is enabled
  52458. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  52459. */
  52460. set planarGizmoEnabled(value: boolean);
  52461. get planarGizmoEnabled(): boolean;
  52462. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  52463. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  52464. /**
  52465. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52466. */
  52467. set snapDistance(value: number);
  52468. get snapDistance(): number;
  52469. /**
  52470. * Ratio for the scale of the gizmo (Default: 1)
  52471. */
  52472. set scaleRatio(value: number);
  52473. get scaleRatio(): number;
  52474. /**
  52475. * Disposes of the gizmo
  52476. */
  52477. dispose(): void;
  52478. /**
  52479. * CustomMeshes are not supported by this gizmo
  52480. * @param mesh The mesh to replace the default mesh of the gizmo
  52481. */
  52482. setCustomMesh(mesh: Mesh): void;
  52483. }
  52484. }
  52485. declare module "babylonjs/Gizmos/axisDragGizmo" {
  52486. import { Observable } from "babylonjs/Misc/observable";
  52487. import { Nullable } from "babylonjs/types";
  52488. import { Vector3 } from "babylonjs/Maths/math.vector";
  52489. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52490. import { Node } from "babylonjs/node";
  52491. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  52492. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52493. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52494. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  52495. import { Scene } from "babylonjs/scene";
  52496. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  52497. import { Color3 } from "babylonjs/Maths/math.color";
  52498. /**
  52499. * Single axis drag gizmo
  52500. */
  52501. export class AxisDragGizmo extends Gizmo {
  52502. /**
  52503. * Drag behavior responsible for the gizmos dragging interactions
  52504. */
  52505. dragBehavior: PointerDragBehavior;
  52506. private _pointerObserver;
  52507. /**
  52508. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52509. */
  52510. snapDistance: number;
  52511. /**
  52512. * Event that fires each time the gizmo snaps to a new location.
  52513. * * snapDistance is the the change in distance
  52514. */
  52515. onSnapObservable: Observable<{
  52516. snapDistance: number;
  52517. }>;
  52518. private _isEnabled;
  52519. private _parent;
  52520. private _arrow;
  52521. private _coloredMaterial;
  52522. private _hoverMaterial;
  52523. /** @hidden */
  52524. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  52525. /** @hidden */
  52526. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  52527. /**
  52528. * Creates an AxisDragGizmo
  52529. * @param gizmoLayer The utility layer the gizmo will be added to
  52530. * @param dragAxis The axis which the gizmo will be able to drag on
  52531. * @param color The color of the gizmo
  52532. * @param thickness display gizmo axis thickness
  52533. */
  52534. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  52535. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52536. /**
  52537. * If the gizmo is enabled
  52538. */
  52539. set isEnabled(value: boolean);
  52540. get isEnabled(): boolean;
  52541. /**
  52542. * Disposes of the gizmo
  52543. */
  52544. dispose(): void;
  52545. }
  52546. }
  52547. declare module "babylonjs/Debug/axesViewer" {
  52548. import { Vector3 } from "babylonjs/Maths/math.vector";
  52549. import { Nullable } from "babylonjs/types";
  52550. import { Scene } from "babylonjs/scene";
  52551. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52552. /**
  52553. * The Axes viewer will show 3 axes in a specific point in space
  52554. */
  52555. export class AxesViewer {
  52556. private _xAxis;
  52557. private _yAxis;
  52558. private _zAxis;
  52559. private _scaleLinesFactor;
  52560. private _instanced;
  52561. /**
  52562. * Gets the hosting scene
  52563. */
  52564. scene: Nullable<Scene>;
  52565. /**
  52566. * Gets or sets a number used to scale line length
  52567. */
  52568. scaleLines: number;
  52569. /** Gets the node hierarchy used to render x-axis */
  52570. get xAxis(): TransformNode;
  52571. /** Gets the node hierarchy used to render y-axis */
  52572. get yAxis(): TransformNode;
  52573. /** Gets the node hierarchy used to render z-axis */
  52574. get zAxis(): TransformNode;
  52575. /**
  52576. * Creates a new AxesViewer
  52577. * @param scene defines the hosting scene
  52578. * @param scaleLines defines a number used to scale line length (1 by default)
  52579. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  52580. * @param xAxis defines the node hierarchy used to render the x-axis
  52581. * @param yAxis defines the node hierarchy used to render the y-axis
  52582. * @param zAxis defines the node hierarchy used to render the z-axis
  52583. */
  52584. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  52585. /**
  52586. * Force the viewer to update
  52587. * @param position defines the position of the viewer
  52588. * @param xaxis defines the x axis of the viewer
  52589. * @param yaxis defines the y axis of the viewer
  52590. * @param zaxis defines the z axis of the viewer
  52591. */
  52592. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  52593. /**
  52594. * Creates an instance of this axes viewer.
  52595. * @returns a new axes viewer with instanced meshes
  52596. */
  52597. createInstance(): AxesViewer;
  52598. /** Releases resources */
  52599. dispose(): void;
  52600. private static _SetRenderingGroupId;
  52601. }
  52602. }
  52603. declare module "babylonjs/Debug/boneAxesViewer" {
  52604. import { Nullable } from "babylonjs/types";
  52605. import { AxesViewer } from "babylonjs/Debug/axesViewer";
  52606. import { Vector3 } from "babylonjs/Maths/math.vector";
  52607. import { Mesh } from "babylonjs/Meshes/mesh";
  52608. import { Bone } from "babylonjs/Bones/bone";
  52609. import { Scene } from "babylonjs/scene";
  52610. /**
  52611. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  52612. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  52613. */
  52614. export class BoneAxesViewer extends AxesViewer {
  52615. /**
  52616. * Gets or sets the target mesh where to display the axes viewer
  52617. */
  52618. mesh: Nullable<Mesh>;
  52619. /**
  52620. * Gets or sets the target bone where to display the axes viewer
  52621. */
  52622. bone: Nullable<Bone>;
  52623. /** Gets current position */
  52624. pos: Vector3;
  52625. /** Gets direction of X axis */
  52626. xaxis: Vector3;
  52627. /** Gets direction of Y axis */
  52628. yaxis: Vector3;
  52629. /** Gets direction of Z axis */
  52630. zaxis: Vector3;
  52631. /**
  52632. * Creates a new BoneAxesViewer
  52633. * @param scene defines the hosting scene
  52634. * @param bone defines the target bone
  52635. * @param mesh defines the target mesh
  52636. * @param scaleLines defines a scaling factor for line length (1 by default)
  52637. */
  52638. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  52639. /**
  52640. * Force the viewer to update
  52641. */
  52642. update(): void;
  52643. /** Releases resources */
  52644. dispose(): void;
  52645. }
  52646. }
  52647. declare module "babylonjs/Debug/debugLayer" {
  52648. import { Scene } from "babylonjs/scene";
  52649. /**
  52650. * Interface used to define scene explorer extensibility option
  52651. */
  52652. export interface IExplorerExtensibilityOption {
  52653. /**
  52654. * Define the option label
  52655. */
  52656. label: string;
  52657. /**
  52658. * Defines the action to execute on click
  52659. */
  52660. action: (entity: any) => void;
  52661. }
  52662. /**
  52663. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  52664. */
  52665. export interface IExplorerExtensibilityGroup {
  52666. /**
  52667. * Defines a predicate to test if a given type mut be extended
  52668. */
  52669. predicate: (entity: any) => boolean;
  52670. /**
  52671. * Gets the list of options added to a type
  52672. */
  52673. entries: IExplorerExtensibilityOption[];
  52674. }
  52675. /**
  52676. * Interface used to define the options to use to create the Inspector
  52677. */
  52678. export interface IInspectorOptions {
  52679. /**
  52680. * Display in overlay mode (default: false)
  52681. */
  52682. overlay?: boolean;
  52683. /**
  52684. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  52685. */
  52686. globalRoot?: HTMLElement;
  52687. /**
  52688. * Display the Scene explorer
  52689. */
  52690. showExplorer?: boolean;
  52691. /**
  52692. * Display the property inspector
  52693. */
  52694. showInspector?: boolean;
  52695. /**
  52696. * Display in embed mode (both panes on the right)
  52697. */
  52698. embedMode?: boolean;
  52699. /**
  52700. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  52701. */
  52702. handleResize?: boolean;
  52703. /**
  52704. * Allow the panes to popup (default: true)
  52705. */
  52706. enablePopup?: boolean;
  52707. /**
  52708. * Allow the panes to be closed by users (default: true)
  52709. */
  52710. enableClose?: boolean;
  52711. /**
  52712. * Optional list of extensibility entries
  52713. */
  52714. explorerExtensibility?: IExplorerExtensibilityGroup[];
  52715. /**
  52716. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  52717. */
  52718. inspectorURL?: string;
  52719. /**
  52720. * Optional initial tab (default to DebugLayerTab.Properties)
  52721. */
  52722. initialTab?: DebugLayerTab;
  52723. }
  52724. module "babylonjs/scene" {
  52725. interface Scene {
  52726. /**
  52727. * @hidden
  52728. * Backing field
  52729. */
  52730. _debugLayer: DebugLayer;
  52731. /**
  52732. * Gets the debug layer (aka Inspector) associated with the scene
  52733. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52734. */
  52735. debugLayer: DebugLayer;
  52736. }
  52737. }
  52738. /**
  52739. * Enum of inspector action tab
  52740. */
  52741. export enum DebugLayerTab {
  52742. /**
  52743. * Properties tag (default)
  52744. */
  52745. Properties = 0,
  52746. /**
  52747. * Debug tab
  52748. */
  52749. Debug = 1,
  52750. /**
  52751. * Statistics tab
  52752. */
  52753. Statistics = 2,
  52754. /**
  52755. * Tools tab
  52756. */
  52757. Tools = 3,
  52758. /**
  52759. * Settings tab
  52760. */
  52761. Settings = 4
  52762. }
  52763. /**
  52764. * The debug layer (aka Inspector) is the go to tool in order to better understand
  52765. * what is happening in your scene
  52766. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52767. */
  52768. export class DebugLayer {
  52769. /**
  52770. * Define the url to get the inspector script from.
  52771. * By default it uses the babylonjs CDN.
  52772. * @ignoreNaming
  52773. */
  52774. static InspectorURL: string;
  52775. private _scene;
  52776. private BJSINSPECTOR;
  52777. private _onPropertyChangedObservable?;
  52778. /**
  52779. * Observable triggered when a property is changed through the inspector.
  52780. */
  52781. get onPropertyChangedObservable(): any;
  52782. /**
  52783. * Instantiates a new debug layer.
  52784. * The debug layer (aka Inspector) is the go to tool in order to better understand
  52785. * what is happening in your scene
  52786. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52787. * @param scene Defines the scene to inspect
  52788. */
  52789. constructor(scene: Scene);
  52790. /** Creates the inspector window. */
  52791. private _createInspector;
  52792. /**
  52793. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  52794. * @param entity defines the entity to select
  52795. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  52796. */
  52797. select(entity: any, lineContainerTitles?: string | string[]): void;
  52798. /** Get the inspector from bundle or global */
  52799. private _getGlobalInspector;
  52800. /**
  52801. * Get if the inspector is visible or not.
  52802. * @returns true if visible otherwise, false
  52803. */
  52804. isVisible(): boolean;
  52805. /**
  52806. * Hide the inspector and close its window.
  52807. */
  52808. hide(): void;
  52809. /**
  52810. * Update the scene in the inspector
  52811. */
  52812. setAsActiveScene(): void;
  52813. /**
  52814. * Launch the debugLayer.
  52815. * @param config Define the configuration of the inspector
  52816. * @return a promise fulfilled when the debug layer is visible
  52817. */
  52818. show(config?: IInspectorOptions): Promise<DebugLayer>;
  52819. }
  52820. }
  52821. declare module "babylonjs/Meshes/Builders/boxBuilder" {
  52822. import { Nullable } from "babylonjs/types";
  52823. import { Scene } from "babylonjs/scene";
  52824. import { Vector4 } from "babylonjs/Maths/math.vector";
  52825. import { Color4 } from "babylonjs/Maths/math.color";
  52826. import { Mesh } from "babylonjs/Meshes/mesh";
  52827. /**
  52828. * Class containing static functions to help procedurally build meshes
  52829. */
  52830. export class BoxBuilder {
  52831. /**
  52832. * Creates a box mesh
  52833. * * The parameter `size` sets the size (float) of each box side (default 1)
  52834. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  52835. * * 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)
  52836. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  52837. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  52838. * * 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
  52839. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  52840. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  52841. * @param name defines the name of the mesh
  52842. * @param options defines the options used to create the mesh
  52843. * @param scene defines the hosting scene
  52844. * @returns the box mesh
  52845. */
  52846. static CreateBox(name: string, options: {
  52847. size?: number;
  52848. width?: number;
  52849. height?: number;
  52850. depth?: number;
  52851. faceUV?: Vector4[];
  52852. faceColors?: Color4[];
  52853. sideOrientation?: number;
  52854. frontUVs?: Vector4;
  52855. backUVs?: Vector4;
  52856. wrap?: boolean;
  52857. topBaseAt?: number;
  52858. bottomBaseAt?: number;
  52859. updatable?: boolean;
  52860. }, scene?: Nullable<Scene>): Mesh;
  52861. }
  52862. }
  52863. declare module "babylonjs/Debug/physicsViewer" {
  52864. import { Nullable } from "babylonjs/types";
  52865. import { Scene } from "babylonjs/scene";
  52866. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52867. import { Mesh } from "babylonjs/Meshes/mesh";
  52868. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  52869. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  52870. /**
  52871. * Used to show the physics impostor around the specific mesh
  52872. */
  52873. export class PhysicsViewer {
  52874. /** @hidden */
  52875. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  52876. /** @hidden */
  52877. protected _meshes: Array<Nullable<AbstractMesh>>;
  52878. /** @hidden */
  52879. protected _scene: Nullable<Scene>;
  52880. /** @hidden */
  52881. protected _numMeshes: number;
  52882. /** @hidden */
  52883. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  52884. private _renderFunction;
  52885. private _utilityLayer;
  52886. private _debugBoxMesh;
  52887. private _debugSphereMesh;
  52888. private _debugCylinderMesh;
  52889. private _debugMaterial;
  52890. private _debugMeshMeshes;
  52891. /**
  52892. * Creates a new PhysicsViewer
  52893. * @param scene defines the hosting scene
  52894. */
  52895. constructor(scene: Scene);
  52896. /** @hidden */
  52897. protected _updateDebugMeshes(): void;
  52898. /**
  52899. * Renders a specified physic impostor
  52900. * @param impostor defines the impostor to render
  52901. * @param targetMesh defines the mesh represented by the impostor
  52902. * @returns the new debug mesh used to render the impostor
  52903. */
  52904. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  52905. /**
  52906. * Hides a specified physic impostor
  52907. * @param impostor defines the impostor to hide
  52908. */
  52909. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  52910. private _getDebugMaterial;
  52911. private _getDebugBoxMesh;
  52912. private _getDebugSphereMesh;
  52913. private _getDebugCylinderMesh;
  52914. private _getDebugMeshMesh;
  52915. private _getDebugMesh;
  52916. /** Releases all resources */
  52917. dispose(): void;
  52918. }
  52919. }
  52920. declare module "babylonjs/Debug/rayHelper" {
  52921. import { Nullable } from "babylonjs/types";
  52922. import { Ray } from "babylonjs/Culling/ray";
  52923. import { Vector3 } from "babylonjs/Maths/math.vector";
  52924. import { Color3 } from "babylonjs/Maths/math.color";
  52925. import { Scene } from "babylonjs/scene";
  52926. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52927. import "babylonjs/Meshes/Builders/linesBuilder";
  52928. /**
  52929. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  52930. * in order to better appreciate the issue one might have.
  52931. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  52932. */
  52933. export class RayHelper {
  52934. /**
  52935. * Defines the ray we are currently tryin to visualize.
  52936. */
  52937. ray: Nullable<Ray>;
  52938. private _renderPoints;
  52939. private _renderLine;
  52940. private _renderFunction;
  52941. private _scene;
  52942. private _onAfterRenderObserver;
  52943. private _onAfterStepObserver;
  52944. private _attachedToMesh;
  52945. private _meshSpaceDirection;
  52946. private _meshSpaceOrigin;
  52947. /**
  52948. * Helper function to create a colored helper in a scene in one line.
  52949. * @param ray Defines the ray we are currently tryin to visualize
  52950. * @param scene Defines the scene the ray is used in
  52951. * @param color Defines the color we want to see the ray in
  52952. * @returns The newly created ray helper.
  52953. */
  52954. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  52955. /**
  52956. * Instantiate a new ray helper.
  52957. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  52958. * in order to better appreciate the issue one might have.
  52959. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  52960. * @param ray Defines the ray we are currently tryin to visualize
  52961. */
  52962. constructor(ray: Ray);
  52963. /**
  52964. * Shows the ray we are willing to debug.
  52965. * @param scene Defines the scene the ray needs to be rendered in
  52966. * @param color Defines the color the ray needs to be rendered in
  52967. */
  52968. show(scene: Scene, color?: Color3): void;
  52969. /**
  52970. * Hides the ray we are debugging.
  52971. */
  52972. hide(): void;
  52973. private _render;
  52974. /**
  52975. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  52976. * @param mesh Defines the mesh we want the helper attached to
  52977. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  52978. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  52979. * @param length Defines the length of the ray
  52980. */
  52981. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  52982. /**
  52983. * Detach the ray helper from the mesh it has previously been attached to.
  52984. */
  52985. detachFromMesh(): void;
  52986. private _updateToMesh;
  52987. /**
  52988. * Dispose the helper and release its associated resources.
  52989. */
  52990. dispose(): void;
  52991. }
  52992. }
  52993. declare module "babylonjs/Debug/ISkeletonViewer" {
  52994. /**
  52995. * Defines the options associated with the creation of a SkeletonViewer.
  52996. */
  52997. export interface ISkeletonViewerOptions {
  52998. /** Should the system pause animations before building the Viewer? */
  52999. pauseAnimations: boolean;
  53000. /** Should the system return the skeleton to rest before building? */
  53001. returnToRest: boolean;
  53002. /** public Display Mode of the Viewer */
  53003. displayMode: number;
  53004. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  53005. displayOptions: ISkeletonViewerDisplayOptions;
  53006. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  53007. computeBonesUsingShaders: boolean;
  53008. }
  53009. /**
  53010. * Defines how to display the various bone meshes for the viewer.
  53011. */
  53012. export interface ISkeletonViewerDisplayOptions {
  53013. /** How far down to start tapering the bone spurs */
  53014. midStep?: number;
  53015. /** How big is the midStep? */
  53016. midStepFactor?: number;
  53017. /** Base for the Sphere Size */
  53018. sphereBaseSize?: number;
  53019. /** The ratio of the sphere to the longest bone in units */
  53020. sphereScaleUnit?: number;
  53021. /** Ratio for the Sphere Size */
  53022. sphereFactor?: number;
  53023. }
  53024. }
  53025. declare module "babylonjs/Meshes/Builders/ribbonBuilder" {
  53026. import { Nullable } from "babylonjs/types";
  53027. import { Scene } from "babylonjs/scene";
  53028. import { Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  53029. import { Color4 } from "babylonjs/Maths/math.color";
  53030. import { Mesh } from "babylonjs/Meshes/mesh";
  53031. /**
  53032. * Class containing static functions to help procedurally build meshes
  53033. */
  53034. export class RibbonBuilder {
  53035. /**
  53036. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  53037. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  53038. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  53039. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  53040. * * 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
  53041. * * 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
  53042. * * 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
  53043. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53044. * * 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
  53045. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  53046. * * 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
  53047. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  53048. * * 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
  53049. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  53050. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53051. * @param name defines the name of the mesh
  53052. * @param options defines the options used to create the mesh
  53053. * @param scene defines the hosting scene
  53054. * @returns the ribbon mesh
  53055. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  53056. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53057. */
  53058. static CreateRibbon(name: string, options: {
  53059. pathArray: Vector3[][];
  53060. closeArray?: boolean;
  53061. closePath?: boolean;
  53062. offset?: number;
  53063. updatable?: boolean;
  53064. sideOrientation?: number;
  53065. frontUVs?: Vector4;
  53066. backUVs?: Vector4;
  53067. instance?: Mesh;
  53068. invertUV?: boolean;
  53069. uvs?: Vector2[];
  53070. colors?: Color4[];
  53071. }, scene?: Nullable<Scene>): Mesh;
  53072. }
  53073. }
  53074. declare module "babylonjs/Meshes/Builders/shapeBuilder" {
  53075. import { Nullable } from "babylonjs/types";
  53076. import { Scene } from "babylonjs/scene";
  53077. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  53078. import { Mesh } from "babylonjs/Meshes/mesh";
  53079. /**
  53080. * Class containing static functions to help procedurally build meshes
  53081. */
  53082. export class ShapeBuilder {
  53083. /**
  53084. * 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.
  53085. * * 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.
  53086. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  53087. * * 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.
  53088. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  53089. * * 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
  53090. * * 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
  53091. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  53092. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53093. * * 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
  53094. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  53095. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  53096. * @param name defines the name of the mesh
  53097. * @param options defines the options used to create the mesh
  53098. * @param scene defines the hosting scene
  53099. * @returns the extruded shape mesh
  53100. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53101. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  53102. */
  53103. static ExtrudeShape(name: string, options: {
  53104. shape: Vector3[];
  53105. path: Vector3[];
  53106. scale?: number;
  53107. rotation?: number;
  53108. cap?: number;
  53109. updatable?: boolean;
  53110. sideOrientation?: number;
  53111. frontUVs?: Vector4;
  53112. backUVs?: Vector4;
  53113. instance?: Mesh;
  53114. invertUV?: boolean;
  53115. }, scene?: Nullable<Scene>): Mesh;
  53116. /**
  53117. * Creates an custom extruded shape mesh.
  53118. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  53119. * * 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.
  53120. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  53121. * * 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
  53122. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  53123. * * 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
  53124. * * It must returns a float value that will be the scale value applied to the shape on each path point
  53125. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  53126. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  53127. * * 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
  53128. * * 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
  53129. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  53130. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53131. * * 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
  53132. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  53133. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53134. * @param name defines the name of the mesh
  53135. * @param options defines the options used to create the mesh
  53136. * @param scene defines the hosting scene
  53137. * @returns the custom extruded shape mesh
  53138. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  53139. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53140. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  53141. */
  53142. static ExtrudeShapeCustom(name: string, options: {
  53143. shape: Vector3[];
  53144. path: Vector3[];
  53145. scaleFunction?: any;
  53146. rotationFunction?: any;
  53147. ribbonCloseArray?: boolean;
  53148. ribbonClosePath?: boolean;
  53149. cap?: number;
  53150. updatable?: boolean;
  53151. sideOrientation?: number;
  53152. frontUVs?: Vector4;
  53153. backUVs?: Vector4;
  53154. instance?: Mesh;
  53155. invertUV?: boolean;
  53156. }, scene?: Nullable<Scene>): Mesh;
  53157. private static _ExtrudeShapeGeneric;
  53158. }
  53159. }
  53160. declare module "babylonjs/Debug/skeletonViewer" {
  53161. import { Color3 } from "babylonjs/Maths/math.color";
  53162. import { Scene } from "babylonjs/scene";
  53163. import { Nullable } from "babylonjs/types";
  53164. import { Skeleton } from "babylonjs/Bones/skeleton";
  53165. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53166. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  53167. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  53168. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  53169. import { ISkeletonViewerOptions } from "babylonjs/Debug/ISkeletonViewer";
  53170. /**
  53171. * Class used to render a debug view of a given skeleton
  53172. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  53173. */
  53174. export class SkeletonViewer {
  53175. /** defines the skeleton to render */
  53176. skeleton: Skeleton;
  53177. /** defines the mesh attached to the skeleton */
  53178. mesh: AbstractMesh;
  53179. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  53180. autoUpdateBonesMatrices: boolean;
  53181. /** defines the rendering group id to use with the viewer */
  53182. renderingGroupId: number;
  53183. /** is the options for the viewer */
  53184. options: Partial<ISkeletonViewerOptions>;
  53185. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_LINES */
  53186. static readonly DISPLAY_LINES: number;
  53187. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERES */
  53188. static readonly DISPLAY_SPHERES: number;
  53189. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERE_AND_SPURS */
  53190. static readonly DISPLAY_SPHERE_AND_SPURS: number;
  53191. /** If SkeletonViewer scene scope. */
  53192. private _scene;
  53193. /** Gets or sets the color used to render the skeleton */
  53194. color: Color3;
  53195. /** Array of the points of the skeleton fo the line view. */
  53196. private _debugLines;
  53197. /** The SkeletonViewers Mesh. */
  53198. private _debugMesh;
  53199. /** If SkeletonViewer is enabled. */
  53200. private _isEnabled;
  53201. /** If SkeletonViewer is ready. */
  53202. private _ready;
  53203. /** SkeletonViewer render observable. */
  53204. private _obs;
  53205. /** The Utility Layer to render the gizmos in. */
  53206. private _utilityLayer;
  53207. private _boneIndices;
  53208. /** Gets the Scene. */
  53209. get scene(): Scene;
  53210. /** Gets the utilityLayer. */
  53211. get utilityLayer(): Nullable<UtilityLayerRenderer>;
  53212. /** Checks Ready Status. */
  53213. get isReady(): Boolean;
  53214. /** Sets Ready Status. */
  53215. set ready(value: boolean);
  53216. /** Gets the debugMesh */
  53217. get debugMesh(): Nullable<AbstractMesh> | Nullable<LinesMesh>;
  53218. /** Sets the debugMesh */
  53219. set debugMesh(value: Nullable<AbstractMesh> | Nullable<LinesMesh>);
  53220. /** Gets the material */
  53221. get material(): StandardMaterial;
  53222. /** Sets the material */
  53223. set material(value: StandardMaterial);
  53224. /** Gets the material */
  53225. get displayMode(): number;
  53226. /** Sets the material */
  53227. set displayMode(value: number);
  53228. /**
  53229. * Creates a new SkeletonViewer
  53230. * @param skeleton defines the skeleton to render
  53231. * @param mesh defines the mesh attached to the skeleton
  53232. * @param scene defines the hosting scene
  53233. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  53234. * @param renderingGroupId defines the rendering group id to use with the viewer
  53235. * @param options All of the extra constructor options for the SkeletonViewer
  53236. */
  53237. constructor(
  53238. /** defines the skeleton to render */
  53239. skeleton: Skeleton,
  53240. /** defines the mesh attached to the skeleton */
  53241. mesh: AbstractMesh,
  53242. /** The Scene scope*/
  53243. scene: Scene,
  53244. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  53245. autoUpdateBonesMatrices?: boolean,
  53246. /** defines the rendering group id to use with the viewer */
  53247. renderingGroupId?: number,
  53248. /** is the options for the viewer */
  53249. options?: Partial<ISkeletonViewerOptions>);
  53250. /** The Dynamic bindings for the update functions */
  53251. private _bindObs;
  53252. /** Update the viewer to sync with current skeleton state, only used to manually update. */
  53253. update(): void;
  53254. /** Gets or sets a boolean indicating if the viewer is enabled */
  53255. set isEnabled(value: boolean);
  53256. get isEnabled(): boolean;
  53257. private _getBonePosition;
  53258. private _getLinesForBonesWithLength;
  53259. private _getLinesForBonesNoLength;
  53260. /** function to revert the mesh and scene back to the initial state. */
  53261. private _revert;
  53262. /** function to build and bind sphere joint points and spur bone representations. */
  53263. private _buildSpheresAndSpurs;
  53264. /** Update the viewer to sync with current skeleton state, only used for the line display. */
  53265. private _displayLinesUpdate;
  53266. /** Changes the displayMode of the skeleton viewer
  53267. * @param mode The displayMode numerical value
  53268. */
  53269. changeDisplayMode(mode: number): void;
  53270. /** Changes the displayMode of the skeleton viewer
  53271. * @param option String of the option name
  53272. * @param value The numerical option value
  53273. */
  53274. changeDisplayOptions(option: string, value: number): void;
  53275. /** Release associated resources */
  53276. dispose(): void;
  53277. }
  53278. }
  53279. declare module "babylonjs/Debug/index" {
  53280. export * from "babylonjs/Debug/axesViewer";
  53281. export * from "babylonjs/Debug/boneAxesViewer";
  53282. export * from "babylonjs/Debug/debugLayer";
  53283. export * from "babylonjs/Debug/physicsViewer";
  53284. export * from "babylonjs/Debug/rayHelper";
  53285. export * from "babylonjs/Debug/skeletonViewer";
  53286. export * from "babylonjs/Debug/ISkeletonViewer";
  53287. }
  53288. declare module "babylonjs/DeviceInput/InputDevices/deviceEnums" {
  53289. /**
  53290. * Enum for Device Types
  53291. */
  53292. export enum DeviceType {
  53293. /** Generic */
  53294. Generic = 0,
  53295. /** Keyboard */
  53296. Keyboard = 1,
  53297. /** Mouse */
  53298. Mouse = 2,
  53299. /** Touch Pointers */
  53300. Touch = 3,
  53301. /** PS4 Dual Shock */
  53302. DualShock = 4,
  53303. /** Xbox */
  53304. Xbox = 5,
  53305. /** Switch Controller */
  53306. Switch = 6
  53307. }
  53308. /**
  53309. * Enum for All Pointers (Touch/Mouse)
  53310. */
  53311. export enum PointerInput {
  53312. /** Horizontal Axis */
  53313. Horizontal = 0,
  53314. /** Vertical Axis */
  53315. Vertical = 1,
  53316. /** Left Click or Touch */
  53317. LeftClick = 2,
  53318. /** Middle Click */
  53319. MiddleClick = 3,
  53320. /** Right Click */
  53321. RightClick = 4,
  53322. /** Browser Back */
  53323. BrowserBack = 5,
  53324. /** Browser Forward */
  53325. BrowserForward = 6
  53326. }
  53327. /**
  53328. * Enum for Dual Shock Gamepad
  53329. */
  53330. export enum DualShockInput {
  53331. /** Cross */
  53332. Cross = 0,
  53333. /** Circle */
  53334. Circle = 1,
  53335. /** Square */
  53336. Square = 2,
  53337. /** Triangle */
  53338. Triangle = 3,
  53339. /** L1 */
  53340. L1 = 4,
  53341. /** R1 */
  53342. R1 = 5,
  53343. /** L2 */
  53344. L2 = 6,
  53345. /** R2 */
  53346. R2 = 7,
  53347. /** Share */
  53348. Share = 8,
  53349. /** Options */
  53350. Options = 9,
  53351. /** L3 */
  53352. L3 = 10,
  53353. /** R3 */
  53354. R3 = 11,
  53355. /** DPadUp */
  53356. DPadUp = 12,
  53357. /** DPadDown */
  53358. DPadDown = 13,
  53359. /** DPadLeft */
  53360. DPadLeft = 14,
  53361. /** DRight */
  53362. DPadRight = 15,
  53363. /** Home */
  53364. Home = 16,
  53365. /** TouchPad */
  53366. TouchPad = 17,
  53367. /** LStickXAxis */
  53368. LStickXAxis = 18,
  53369. /** LStickYAxis */
  53370. LStickYAxis = 19,
  53371. /** RStickXAxis */
  53372. RStickXAxis = 20,
  53373. /** RStickYAxis */
  53374. RStickYAxis = 21
  53375. }
  53376. /**
  53377. * Enum for Xbox Gamepad
  53378. */
  53379. export enum XboxInput {
  53380. /** A */
  53381. A = 0,
  53382. /** B */
  53383. B = 1,
  53384. /** X */
  53385. X = 2,
  53386. /** Y */
  53387. Y = 3,
  53388. /** LB */
  53389. LB = 4,
  53390. /** RB */
  53391. RB = 5,
  53392. /** LT */
  53393. LT = 6,
  53394. /** RT */
  53395. RT = 7,
  53396. /** Back */
  53397. Back = 8,
  53398. /** Start */
  53399. Start = 9,
  53400. /** LS */
  53401. LS = 10,
  53402. /** RS */
  53403. RS = 11,
  53404. /** DPadUp */
  53405. DPadUp = 12,
  53406. /** DPadDown */
  53407. DPadDown = 13,
  53408. /** DPadLeft */
  53409. DPadLeft = 14,
  53410. /** DRight */
  53411. DPadRight = 15,
  53412. /** Home */
  53413. Home = 16,
  53414. /** LStickXAxis */
  53415. LStickXAxis = 17,
  53416. /** LStickYAxis */
  53417. LStickYAxis = 18,
  53418. /** RStickXAxis */
  53419. RStickXAxis = 19,
  53420. /** RStickYAxis */
  53421. RStickYAxis = 20
  53422. }
  53423. /**
  53424. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  53425. */
  53426. export enum SwitchInput {
  53427. /** B */
  53428. B = 0,
  53429. /** A */
  53430. A = 1,
  53431. /** Y */
  53432. Y = 2,
  53433. /** X */
  53434. X = 3,
  53435. /** L */
  53436. L = 4,
  53437. /** R */
  53438. R = 5,
  53439. /** ZL */
  53440. ZL = 6,
  53441. /** ZR */
  53442. ZR = 7,
  53443. /** Minus */
  53444. Minus = 8,
  53445. /** Plus */
  53446. Plus = 9,
  53447. /** LS */
  53448. LS = 10,
  53449. /** RS */
  53450. RS = 11,
  53451. /** DPadUp */
  53452. DPadUp = 12,
  53453. /** DPadDown */
  53454. DPadDown = 13,
  53455. /** DPadLeft */
  53456. DPadLeft = 14,
  53457. /** DRight */
  53458. DPadRight = 15,
  53459. /** Home */
  53460. Home = 16,
  53461. /** Capture */
  53462. Capture = 17,
  53463. /** LStickXAxis */
  53464. LStickXAxis = 18,
  53465. /** LStickYAxis */
  53466. LStickYAxis = 19,
  53467. /** RStickXAxis */
  53468. RStickXAxis = 20,
  53469. /** RStickYAxis */
  53470. RStickYAxis = 21
  53471. }
  53472. }
  53473. declare module "babylonjs/DeviceInput/deviceInputSystem" {
  53474. import { Engine } from "babylonjs/Engines/engine";
  53475. import { IDisposable } from "babylonjs/scene";
  53476. import { Nullable } from "babylonjs/types";
  53477. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53478. /**
  53479. * This class will take all inputs from Keyboard, Pointer, and
  53480. * any Gamepads and provide a polling system that all devices
  53481. * will use. This class assumes that there will only be one
  53482. * pointer device and one keyboard.
  53483. */
  53484. export class DeviceInputSystem implements IDisposable {
  53485. /**
  53486. * Callback to be triggered when a device is connected
  53487. */
  53488. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  53489. /**
  53490. * Callback to be triggered when a device is disconnected
  53491. */
  53492. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  53493. /**
  53494. * Callback to be triggered when event driven input is updated
  53495. */
  53496. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  53497. private _inputs;
  53498. private _gamepads;
  53499. private _keyboardActive;
  53500. private _pointerActive;
  53501. private _elementToAttachTo;
  53502. private _keyboardDownEvent;
  53503. private _keyboardUpEvent;
  53504. private _pointerMoveEvent;
  53505. private _pointerDownEvent;
  53506. private _pointerUpEvent;
  53507. private _gamepadConnectedEvent;
  53508. private _gamepadDisconnectedEvent;
  53509. private static _MAX_KEYCODES;
  53510. private static _MAX_POINTER_INPUTS;
  53511. private constructor();
  53512. /**
  53513. * Creates a new DeviceInputSystem instance
  53514. * @param engine Engine to pull input element from
  53515. * @returns The new instance
  53516. */
  53517. static Create(engine: Engine): DeviceInputSystem;
  53518. /**
  53519. * Checks for current device input value, given an id and input index
  53520. * @param deviceName Id of connected device
  53521. * @param inputIndex Index of device input
  53522. * @returns Current value of input
  53523. */
  53524. /**
  53525. * Checks for current device input value, given an id and input index. Throws exception if requested device not initialized.
  53526. * @param deviceType Enum specifiying device type
  53527. * @param deviceSlot "Slot" or index that device is referenced in
  53528. * @param inputIndex Id of input to be checked
  53529. * @returns Current value of input
  53530. */
  53531. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): number;
  53532. /**
  53533. * Dispose of all the eventlisteners
  53534. */
  53535. dispose(): void;
  53536. /**
  53537. * Add device and inputs to device array
  53538. * @param deviceType Enum specifiying device type
  53539. * @param deviceSlot "Slot" or index that device is referenced in
  53540. * @param numberOfInputs Number of input entries to create for given device
  53541. */
  53542. private _registerDevice;
  53543. /**
  53544. * Given a specific device name, remove that device from the device map
  53545. * @param deviceType Enum specifiying device type
  53546. * @param deviceSlot "Slot" or index that device is referenced in
  53547. */
  53548. private _unregisterDevice;
  53549. /**
  53550. * Handle all actions that come from keyboard interaction
  53551. */
  53552. private _handleKeyActions;
  53553. /**
  53554. * Handle all actions that come from pointer interaction
  53555. */
  53556. private _handlePointerActions;
  53557. /**
  53558. * Handle all actions that come from gamepad interaction
  53559. */
  53560. private _handleGamepadActions;
  53561. /**
  53562. * Update all non-event based devices with each frame
  53563. * @param deviceType Enum specifiying device type
  53564. * @param deviceSlot "Slot" or index that device is referenced in
  53565. * @param inputIndex Id of input to be checked
  53566. */
  53567. private _updateDevice;
  53568. /**
  53569. * Gets DeviceType from the device name
  53570. * @param deviceName Name of Device from DeviceInputSystem
  53571. * @returns DeviceType enum value
  53572. */
  53573. private _getGamepadDeviceType;
  53574. }
  53575. }
  53576. declare module "babylonjs/DeviceInput/InputDevices/deviceTypes" {
  53577. import { DeviceType, PointerInput, DualShockInput, XboxInput, SwitchInput } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53578. /**
  53579. * Type to handle enforcement of inputs
  53580. */
  53581. 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;
  53582. }
  53583. declare module "babylonjs/DeviceInput/InputDevices/deviceSourceManager" {
  53584. import { DeviceInputSystem } from "babylonjs/DeviceInput/deviceInputSystem";
  53585. import { Engine } from "babylonjs/Engines/engine";
  53586. import { IDisposable } from "babylonjs/scene";
  53587. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53588. import { Nullable } from "babylonjs/types";
  53589. import { Observable } from "babylonjs/Misc/observable";
  53590. import { DeviceInput } from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  53591. /**
  53592. * Class that handles all input for a specific device
  53593. */
  53594. export class DeviceSource<T extends DeviceType> {
  53595. /** Type of device */
  53596. readonly deviceType: DeviceType;
  53597. /** "Slot" or index that device is referenced in */
  53598. readonly deviceSlot: number;
  53599. /**
  53600. * Observable to handle device input changes per device
  53601. */
  53602. readonly onInputChangedObservable: Observable<{
  53603. inputIndex: DeviceInput<T>;
  53604. previousState: Nullable<number>;
  53605. currentState: Nullable<number>;
  53606. }>;
  53607. private readonly _deviceInputSystem;
  53608. /**
  53609. * Default Constructor
  53610. * @param deviceInputSystem Reference to DeviceInputSystem
  53611. * @param deviceType Type of device
  53612. * @param deviceSlot "Slot" or index that device is referenced in
  53613. */
  53614. constructor(deviceInputSystem: DeviceInputSystem,
  53615. /** Type of device */
  53616. deviceType: DeviceType,
  53617. /** "Slot" or index that device is referenced in */
  53618. deviceSlot?: number);
  53619. /**
  53620. * Get input for specific input
  53621. * @param inputIndex index of specific input on device
  53622. * @returns Input value from DeviceInputSystem
  53623. */
  53624. getInput(inputIndex: DeviceInput<T>): Nullable<number>;
  53625. }
  53626. /**
  53627. * Class to keep track of devices
  53628. */
  53629. export class DeviceSourceManager implements IDisposable {
  53630. /**
  53631. * Observable to be triggered when before a device is connected
  53632. */
  53633. readonly onBeforeDeviceConnectedObservable: Observable<{
  53634. deviceType: DeviceType;
  53635. deviceSlot: number;
  53636. }>;
  53637. /**
  53638. * Observable to be triggered when before a device is disconnected
  53639. */
  53640. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  53641. deviceType: DeviceType;
  53642. deviceSlot: number;
  53643. }>;
  53644. /**
  53645. * Observable to be triggered when after a device is connected
  53646. */
  53647. readonly onAfterDeviceConnectedObservable: Observable<{
  53648. deviceType: DeviceType;
  53649. deviceSlot: number;
  53650. }>;
  53651. /**
  53652. * Observable to be triggered when after a device is disconnected
  53653. */
  53654. readonly onAfterDeviceDisconnectedObservable: Observable<{
  53655. deviceType: DeviceType;
  53656. deviceSlot: number;
  53657. }>;
  53658. private readonly _devices;
  53659. private readonly _firstDevice;
  53660. private readonly _deviceInputSystem;
  53661. /**
  53662. * Default Constructor
  53663. * @param engine engine to pull input element from
  53664. */
  53665. constructor(engine: Engine);
  53666. /**
  53667. * Gets a DeviceSource, given a type and slot
  53668. * @param deviceType Enum specifying device type
  53669. * @param deviceSlot "Slot" or index that device is referenced in
  53670. * @returns DeviceSource object
  53671. */
  53672. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  53673. /**
  53674. * Gets an array of DeviceSource objects for a given device type
  53675. * @param deviceType Enum specifying device type
  53676. * @returns Array of DeviceSource objects
  53677. */
  53678. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  53679. /**
  53680. * Dispose of DeviceInputSystem and other parts
  53681. */
  53682. dispose(): void;
  53683. /**
  53684. * Function to add device name to device list
  53685. * @param deviceType Enum specifying device type
  53686. * @param deviceSlot "Slot" or index that device is referenced in
  53687. */
  53688. private _addDevice;
  53689. /**
  53690. * Function to remove device name to device list
  53691. * @param deviceType Enum specifying device type
  53692. * @param deviceSlot "Slot" or index that device is referenced in
  53693. */
  53694. private _removeDevice;
  53695. /**
  53696. * Updates array storing first connected device of each type
  53697. * @param type Type of Device
  53698. */
  53699. private _updateFirstDevices;
  53700. }
  53701. }
  53702. declare module "babylonjs/DeviceInput/index" {
  53703. export * from "babylonjs/DeviceInput/deviceInputSystem";
  53704. export * from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53705. export * from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  53706. import "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  53707. export * from "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  53708. }
  53709. declare module "babylonjs/Engines/nullEngine" {
  53710. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  53711. import { Engine } from "babylonjs/Engines/engine";
  53712. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  53713. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  53714. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  53715. import { Effect } from "babylonjs/Materials/effect";
  53716. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  53717. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  53718. import { IColor4Like, IViewportLike } from "babylonjs/Maths/math.like";
  53719. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  53720. /**
  53721. * Options to create the null engine
  53722. */
  53723. export class NullEngineOptions {
  53724. /**
  53725. * Render width (Default: 512)
  53726. */
  53727. renderWidth: number;
  53728. /**
  53729. * Render height (Default: 256)
  53730. */
  53731. renderHeight: number;
  53732. /**
  53733. * Texture size (Default: 512)
  53734. */
  53735. textureSize: number;
  53736. /**
  53737. * If delta time between frames should be constant
  53738. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53739. */
  53740. deterministicLockstep: boolean;
  53741. /**
  53742. * Maximum about of steps between frames (Default: 4)
  53743. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53744. */
  53745. lockstepMaxSteps: number;
  53746. /**
  53747. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  53748. */
  53749. useHighPrecisionMatrix?: boolean;
  53750. }
  53751. /**
  53752. * The null engine class provides support for headless version of babylon.js.
  53753. * This can be used in server side scenario or for testing purposes
  53754. */
  53755. export class NullEngine extends Engine {
  53756. private _options;
  53757. /**
  53758. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  53759. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53760. * @returns true if engine is in deterministic lock step mode
  53761. */
  53762. isDeterministicLockStep(): boolean;
  53763. /**
  53764. * Gets the max steps when engine is running in deterministic lock step
  53765. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53766. * @returns the max steps
  53767. */
  53768. getLockstepMaxSteps(): number;
  53769. /**
  53770. * Gets the current hardware scaling level.
  53771. * By default the hardware scaling level is computed from the window device ratio.
  53772. * 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.
  53773. * @returns a number indicating the current hardware scaling level
  53774. */
  53775. getHardwareScalingLevel(): number;
  53776. constructor(options?: NullEngineOptions);
  53777. /**
  53778. * Creates a vertex buffer
  53779. * @param vertices the data for the vertex buffer
  53780. * @returns the new WebGL static buffer
  53781. */
  53782. createVertexBuffer(vertices: FloatArray): DataBuffer;
  53783. /**
  53784. * Creates a new index buffer
  53785. * @param indices defines the content of the index buffer
  53786. * @param updatable defines if the index buffer must be updatable
  53787. * @returns a new webGL buffer
  53788. */
  53789. createIndexBuffer(indices: IndicesArray): DataBuffer;
  53790. /**
  53791. * Clear the current render buffer or the current render target (if any is set up)
  53792. * @param color defines the color to use
  53793. * @param backBuffer defines if the back buffer must be cleared
  53794. * @param depth defines if the depth buffer must be cleared
  53795. * @param stencil defines if the stencil buffer must be cleared
  53796. */
  53797. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  53798. /**
  53799. * Gets the current render width
  53800. * @param useScreen defines if screen size must be used (or the current render target if any)
  53801. * @returns a number defining the current render width
  53802. */
  53803. getRenderWidth(useScreen?: boolean): number;
  53804. /**
  53805. * Gets the current render height
  53806. * @param useScreen defines if screen size must be used (or the current render target if any)
  53807. * @returns a number defining the current render height
  53808. */
  53809. getRenderHeight(useScreen?: boolean): number;
  53810. /**
  53811. * Set the WebGL's viewport
  53812. * @param viewport defines the viewport element to be used
  53813. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  53814. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  53815. */
  53816. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  53817. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  53818. /**
  53819. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  53820. * @param pipelineContext defines the pipeline context to use
  53821. * @param uniformsNames defines the list of uniform names
  53822. * @returns an array of webGL uniform locations
  53823. */
  53824. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  53825. /**
  53826. * Gets the lsit of active attributes for a given webGL program
  53827. * @param pipelineContext defines the pipeline context to use
  53828. * @param attributesNames defines the list of attribute names to get
  53829. * @returns an array of indices indicating the offset of each attribute
  53830. */
  53831. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  53832. /**
  53833. * Binds an effect to the webGL context
  53834. * @param effect defines the effect to bind
  53835. */
  53836. bindSamplers(effect: Effect): void;
  53837. /**
  53838. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  53839. * @param effect defines the effect to activate
  53840. */
  53841. enableEffect(effect: Effect): void;
  53842. /**
  53843. * Set various states to the webGL context
  53844. * @param culling defines backface culling state
  53845. * @param zOffset defines the value to apply to zOffset (0 by default)
  53846. * @param force defines if states must be applied even if cache is up to date
  53847. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  53848. */
  53849. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  53850. /**
  53851. * Set the value of an uniform to an array of int32
  53852. * @param uniform defines the webGL uniform location where to store the value
  53853. * @param array defines the array of int32 to store
  53854. */
  53855. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  53856. /**
  53857. * Set the value of an uniform to an array of int32 (stored as vec2)
  53858. * @param uniform defines the webGL uniform location where to store the value
  53859. * @param array defines the array of int32 to store
  53860. */
  53861. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  53862. /**
  53863. * Set the value of an uniform to an array of int32 (stored as vec3)
  53864. * @param uniform defines the webGL uniform location where to store the value
  53865. * @param array defines the array of int32 to store
  53866. */
  53867. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  53868. /**
  53869. * Set the value of an uniform to an array of int32 (stored as vec4)
  53870. * @param uniform defines the webGL uniform location where to store the value
  53871. * @param array defines the array of int32 to store
  53872. */
  53873. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  53874. /**
  53875. * Set the value of an uniform to an array of float32
  53876. * @param uniform defines the webGL uniform location where to store the value
  53877. * @param array defines the array of float32 to store
  53878. */
  53879. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  53880. /**
  53881. * Set the value of an uniform to an array of float32 (stored as vec2)
  53882. * @param uniform defines the webGL uniform location where to store the value
  53883. * @param array defines the array of float32 to store
  53884. */
  53885. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  53886. /**
  53887. * Set the value of an uniform to an array of float32 (stored as vec3)
  53888. * @param uniform defines the webGL uniform location where to store the value
  53889. * @param array defines the array of float32 to store
  53890. */
  53891. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  53892. /**
  53893. * Set the value of an uniform to an array of float32 (stored as vec4)
  53894. * @param uniform defines the webGL uniform location where to store the value
  53895. * @param array defines the array of float32 to store
  53896. */
  53897. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  53898. /**
  53899. * Set the value of an uniform to an array of number
  53900. * @param uniform defines the webGL uniform location where to store the value
  53901. * @param array defines the array of number to store
  53902. */
  53903. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  53904. /**
  53905. * Set the value of an uniform to an array of number (stored as vec2)
  53906. * @param uniform defines the webGL uniform location where to store the value
  53907. * @param array defines the array of number to store
  53908. */
  53909. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  53910. /**
  53911. * Set the value of an uniform to an array of number (stored as vec3)
  53912. * @param uniform defines the webGL uniform location where to store the value
  53913. * @param array defines the array of number to store
  53914. */
  53915. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  53916. /**
  53917. * Set the value of an uniform to an array of number (stored as vec4)
  53918. * @param uniform defines the webGL uniform location where to store the value
  53919. * @param array defines the array of number to store
  53920. */
  53921. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  53922. /**
  53923. * Set the value of an uniform to an array of float32 (stored as matrices)
  53924. * @param uniform defines the webGL uniform location where to store the value
  53925. * @param matrices defines the array of float32 to store
  53926. */
  53927. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  53928. /**
  53929. * Set the value of an uniform to a matrix (3x3)
  53930. * @param uniform defines the webGL uniform location where to store the value
  53931. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  53932. */
  53933. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  53934. /**
  53935. * Set the value of an uniform to a matrix (2x2)
  53936. * @param uniform defines the webGL uniform location where to store the value
  53937. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  53938. */
  53939. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  53940. /**
  53941. * Set the value of an uniform to a number (float)
  53942. * @param uniform defines the webGL uniform location where to store the value
  53943. * @param value defines the float number to store
  53944. */
  53945. setFloat(uniform: WebGLUniformLocation, value: number): void;
  53946. /**
  53947. * Set the value of an uniform to a vec2
  53948. * @param uniform defines the webGL uniform location where to store the value
  53949. * @param x defines the 1st component of the value
  53950. * @param y defines the 2nd component of the value
  53951. */
  53952. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  53953. /**
  53954. * Set the value of an uniform to a vec3
  53955. * @param uniform defines the webGL uniform location where to store the value
  53956. * @param x defines the 1st component of the value
  53957. * @param y defines the 2nd component of the value
  53958. * @param z defines the 3rd component of the value
  53959. */
  53960. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  53961. /**
  53962. * Set the value of an uniform to a boolean
  53963. * @param uniform defines the webGL uniform location where to store the value
  53964. * @param bool defines the boolean to store
  53965. */
  53966. setBool(uniform: WebGLUniformLocation, bool: number): void;
  53967. /**
  53968. * Set the value of an uniform to a vec4
  53969. * @param uniform defines the webGL uniform location where to store the value
  53970. * @param x defines the 1st component of the value
  53971. * @param y defines the 2nd component of the value
  53972. * @param z defines the 3rd component of the value
  53973. * @param w defines the 4th component of the value
  53974. */
  53975. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  53976. /**
  53977. * Sets the current alpha mode
  53978. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  53979. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  53980. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  53981. */
  53982. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  53983. /**
  53984. * Bind webGl buffers directly to the webGL context
  53985. * @param vertexBuffers defines the vertex buffer to bind
  53986. * @param indexBuffer defines the index buffer to bind
  53987. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  53988. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  53989. * @param effect defines the effect associated with the vertex buffer
  53990. */
  53991. bindBuffers(vertexBuffers: {
  53992. [key: string]: VertexBuffer;
  53993. }, indexBuffer: DataBuffer, effect: Effect): void;
  53994. /**
  53995. * Force the entire cache to be cleared
  53996. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  53997. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  53998. */
  53999. wipeCaches(bruteForce?: boolean): void;
  54000. /**
  54001. * Send a draw order
  54002. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  54003. * @param indexStart defines the starting index
  54004. * @param indexCount defines the number of index to draw
  54005. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54006. */
  54007. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  54008. /**
  54009. * Draw a list of indexed primitives
  54010. * @param fillMode defines the primitive to use
  54011. * @param indexStart defines the starting index
  54012. * @param indexCount defines the number of index to draw
  54013. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54014. */
  54015. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  54016. /**
  54017. * Draw a list of unindexed primitives
  54018. * @param fillMode defines the primitive to use
  54019. * @param verticesStart defines the index of first vertex to draw
  54020. * @param verticesCount defines the count of vertices to draw
  54021. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54022. */
  54023. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  54024. /** @hidden */
  54025. _createTexture(): WebGLTexture;
  54026. /** @hidden */
  54027. _releaseTexture(texture: InternalTexture): void;
  54028. /**
  54029. * Usually called from Texture.ts.
  54030. * Passed information to create a WebGLTexture
  54031. * @param urlArg defines a value which contains one of the following:
  54032. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  54033. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  54034. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  54035. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  54036. * @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)
  54037. * @param scene needed for loading to the correct scene
  54038. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  54039. * @param onLoad optional callback to be called upon successful completion
  54040. * @param onError optional callback to be called upon failure
  54041. * @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
  54042. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  54043. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  54044. * @param forcedExtension defines the extension to use to pick the right loader
  54045. * @param mimeType defines an optional mime type
  54046. * @returns a InternalTexture for assignment back into BABYLON.Texture
  54047. */
  54048. 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;
  54049. /**
  54050. * Creates a new render target texture
  54051. * @param size defines the size of the texture
  54052. * @param options defines the options used to create the texture
  54053. * @returns a new render target texture stored in an InternalTexture
  54054. */
  54055. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  54056. /**
  54057. * Update the sampling mode of a given texture
  54058. * @param samplingMode defines the required sampling mode
  54059. * @param texture defines the texture to update
  54060. */
  54061. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  54062. /**
  54063. * Binds the frame buffer to the specified texture.
  54064. * @param texture The texture to render to or null for the default canvas
  54065. * @param faceIndex The face of the texture to render to in case of cube texture
  54066. * @param requiredWidth The width of the target to render to
  54067. * @param requiredHeight The height of the target to render to
  54068. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  54069. * @param lodLevel defines le lod level to bind to the frame buffer
  54070. */
  54071. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  54072. /**
  54073. * Unbind the current render target texture from the webGL context
  54074. * @param texture defines the render target texture to unbind
  54075. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  54076. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  54077. */
  54078. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  54079. /**
  54080. * Creates a dynamic vertex buffer
  54081. * @param vertices the data for the dynamic vertex buffer
  54082. * @returns the new WebGL dynamic buffer
  54083. */
  54084. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  54085. /**
  54086. * Update the content of a dynamic texture
  54087. * @param texture defines the texture to update
  54088. * @param canvas defines the canvas containing the source
  54089. * @param invertY defines if data must be stored with Y axis inverted
  54090. * @param premulAlpha defines if alpha is stored as premultiplied
  54091. * @param format defines the format of the data
  54092. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  54093. */
  54094. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  54095. /**
  54096. * Gets a boolean indicating if all created effects are ready
  54097. * @returns true if all effects are ready
  54098. */
  54099. areAllEffectsReady(): boolean;
  54100. /**
  54101. * @hidden
  54102. * Get the current error code of the webGL context
  54103. * @returns the error code
  54104. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  54105. */
  54106. getError(): number;
  54107. /** @hidden */
  54108. _getUnpackAlignement(): number;
  54109. /** @hidden */
  54110. _unpackFlipY(value: boolean): void;
  54111. /**
  54112. * Update a dynamic index buffer
  54113. * @param indexBuffer defines the target index buffer
  54114. * @param indices defines the data to update
  54115. * @param offset defines the offset in the target index buffer where update should start
  54116. */
  54117. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  54118. /**
  54119. * Updates a dynamic vertex buffer.
  54120. * @param vertexBuffer the vertex buffer to update
  54121. * @param vertices the data used to update the vertex buffer
  54122. * @param byteOffset the byte offset of the data (optional)
  54123. * @param byteLength the byte length of the data (optional)
  54124. */
  54125. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  54126. /** @hidden */
  54127. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  54128. /** @hidden */
  54129. _bindTexture(channel: number, texture: InternalTexture): void;
  54130. protected _deleteBuffer(buffer: WebGLBuffer): void;
  54131. /**
  54132. * 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
  54133. */
  54134. releaseEffects(): void;
  54135. displayLoadingUI(): void;
  54136. hideLoadingUI(): void;
  54137. /** @hidden */
  54138. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54139. /** @hidden */
  54140. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54141. /** @hidden */
  54142. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54143. /** @hidden */
  54144. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  54145. }
  54146. }
  54147. declare module "babylonjs/Instrumentation/timeToken" {
  54148. import { Nullable } from "babylonjs/types";
  54149. /**
  54150. * @hidden
  54151. **/
  54152. export class _TimeToken {
  54153. _startTimeQuery: Nullable<WebGLQuery>;
  54154. _endTimeQuery: Nullable<WebGLQuery>;
  54155. _timeElapsedQuery: Nullable<WebGLQuery>;
  54156. _timeElapsedQueryEnded: boolean;
  54157. }
  54158. }
  54159. declare module "babylonjs/Engines/Extensions/engine.occlusionQuery" {
  54160. import { Nullable, int } from "babylonjs/types";
  54161. import { _TimeToken } from "babylonjs/Instrumentation/timeToken";
  54162. /** @hidden */
  54163. export class _OcclusionDataStorage {
  54164. /** @hidden */
  54165. occlusionInternalRetryCounter: number;
  54166. /** @hidden */
  54167. isOcclusionQueryInProgress: boolean;
  54168. /** @hidden */
  54169. isOccluded: boolean;
  54170. /** @hidden */
  54171. occlusionRetryCount: number;
  54172. /** @hidden */
  54173. occlusionType: number;
  54174. /** @hidden */
  54175. occlusionQueryAlgorithmType: number;
  54176. }
  54177. module "babylonjs/Engines/engine" {
  54178. interface Engine {
  54179. /**
  54180. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  54181. * @return the new query
  54182. */
  54183. createQuery(): WebGLQuery;
  54184. /**
  54185. * Delete and release a webGL query
  54186. * @param query defines the query to delete
  54187. * @return the current engine
  54188. */
  54189. deleteQuery(query: WebGLQuery): Engine;
  54190. /**
  54191. * Check if a given query has resolved and got its value
  54192. * @param query defines the query to check
  54193. * @returns true if the query got its value
  54194. */
  54195. isQueryResultAvailable(query: WebGLQuery): boolean;
  54196. /**
  54197. * Gets the value of a given query
  54198. * @param query defines the query to check
  54199. * @returns the value of the query
  54200. */
  54201. getQueryResult(query: WebGLQuery): number;
  54202. /**
  54203. * Initiates an occlusion query
  54204. * @param algorithmType defines the algorithm to use
  54205. * @param query defines the query to use
  54206. * @returns the current engine
  54207. * @see https://doc.babylonjs.com/features/occlusionquery
  54208. */
  54209. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  54210. /**
  54211. * Ends an occlusion query
  54212. * @see https://doc.babylonjs.com/features/occlusionquery
  54213. * @param algorithmType defines the algorithm to use
  54214. * @returns the current engine
  54215. */
  54216. endOcclusionQuery(algorithmType: number): Engine;
  54217. /**
  54218. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  54219. * Please note that only one query can be issued at a time
  54220. * @returns a time token used to track the time span
  54221. */
  54222. startTimeQuery(): Nullable<_TimeToken>;
  54223. /**
  54224. * Ends a time query
  54225. * @param token defines the token used to measure the time span
  54226. * @returns the time spent (in ns)
  54227. */
  54228. endTimeQuery(token: _TimeToken): int;
  54229. /** @hidden */
  54230. _currentNonTimestampToken: Nullable<_TimeToken>;
  54231. /** @hidden */
  54232. _createTimeQuery(): WebGLQuery;
  54233. /** @hidden */
  54234. _deleteTimeQuery(query: WebGLQuery): void;
  54235. /** @hidden */
  54236. _getGlAlgorithmType(algorithmType: number): number;
  54237. /** @hidden */
  54238. _getTimeQueryResult(query: WebGLQuery): any;
  54239. /** @hidden */
  54240. _getTimeQueryAvailability(query: WebGLQuery): any;
  54241. }
  54242. }
  54243. module "babylonjs/Meshes/abstractMesh" {
  54244. interface AbstractMesh {
  54245. /**
  54246. * Backing filed
  54247. * @hidden
  54248. */
  54249. __occlusionDataStorage: _OcclusionDataStorage;
  54250. /**
  54251. * Access property
  54252. * @hidden
  54253. */
  54254. _occlusionDataStorage: _OcclusionDataStorage;
  54255. /**
  54256. * 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.
  54257. * The default value is -1 which means don't break the query and wait till the result
  54258. * @see https://doc.babylonjs.com/features/occlusionquery
  54259. */
  54260. occlusionRetryCount: number;
  54261. /**
  54262. * 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:
  54263. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  54264. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  54265. * * 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.
  54266. * @see https://doc.babylonjs.com/features/occlusionquery
  54267. */
  54268. occlusionType: number;
  54269. /**
  54270. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  54271. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  54272. * * 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.
  54273. * @see https://doc.babylonjs.com/features/occlusionquery
  54274. */
  54275. occlusionQueryAlgorithmType: number;
  54276. /**
  54277. * 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
  54278. * @see https://doc.babylonjs.com/features/occlusionquery
  54279. */
  54280. isOccluded: boolean;
  54281. /**
  54282. * Flag to check the progress status of the query
  54283. * @see https://doc.babylonjs.com/features/occlusionquery
  54284. */
  54285. isOcclusionQueryInProgress: boolean;
  54286. }
  54287. }
  54288. }
  54289. declare module "babylonjs/Engines/Extensions/engine.transformFeedback" {
  54290. import { Nullable } from "babylonjs/types";
  54291. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  54292. /** @hidden */
  54293. export var _forceTransformFeedbackToBundle: boolean;
  54294. module "babylonjs/Engines/engine" {
  54295. interface Engine {
  54296. /**
  54297. * Creates a webGL transform feedback object
  54298. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  54299. * @returns the webGL transform feedback object
  54300. */
  54301. createTransformFeedback(): WebGLTransformFeedback;
  54302. /**
  54303. * Delete a webGL transform feedback object
  54304. * @param value defines the webGL transform feedback object to delete
  54305. */
  54306. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  54307. /**
  54308. * Bind a webGL transform feedback object to the webgl context
  54309. * @param value defines the webGL transform feedback object to bind
  54310. */
  54311. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  54312. /**
  54313. * Begins a transform feedback operation
  54314. * @param usePoints defines if points or triangles must be used
  54315. */
  54316. beginTransformFeedback(usePoints: boolean): void;
  54317. /**
  54318. * Ends a transform feedback operation
  54319. */
  54320. endTransformFeedback(): void;
  54321. /**
  54322. * Specify the varyings to use with transform feedback
  54323. * @param program defines the associated webGL program
  54324. * @param value defines the list of strings representing the varying names
  54325. */
  54326. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  54327. /**
  54328. * Bind a webGL buffer for a transform feedback operation
  54329. * @param value defines the webGL buffer to bind
  54330. */
  54331. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  54332. }
  54333. }
  54334. }
  54335. declare module "babylonjs/Engines/Extensions/engine.views" {
  54336. import { Camera } from "babylonjs/Cameras/camera";
  54337. import { Nullable } from "babylonjs/types";
  54338. /**
  54339. * Class used to define an additional view for the engine
  54340. * @see https://doc.babylonjs.com/how_to/multi_canvases
  54341. */
  54342. export class EngineView {
  54343. /** Defines the canvas where to render the view */
  54344. target: HTMLCanvasElement;
  54345. /** Defines an optional camera used to render the view (will use active camera else) */
  54346. camera?: Camera;
  54347. }
  54348. module "babylonjs/Engines/engine" {
  54349. interface Engine {
  54350. /**
  54351. * Gets or sets the HTML element to use for attaching events
  54352. */
  54353. inputElement: Nullable<HTMLElement>;
  54354. /**
  54355. * Gets the current engine view
  54356. * @see https://doc.babylonjs.com/how_to/multi_canvases
  54357. */
  54358. activeView: Nullable<EngineView>;
  54359. /** Gets or sets the list of views */
  54360. views: EngineView[];
  54361. /**
  54362. * Register a new child canvas
  54363. * @param canvas defines the canvas to register
  54364. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  54365. * @returns the associated view
  54366. */
  54367. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  54368. /**
  54369. * Remove a registered child canvas
  54370. * @param canvas defines the canvas to remove
  54371. * @returns the current engine
  54372. */
  54373. unRegisterView(canvas: HTMLCanvasElement): Engine;
  54374. }
  54375. }
  54376. }
  54377. declare module "babylonjs/Engines/Extensions/engine.textureSelector" {
  54378. import { Nullable } from "babylonjs/types";
  54379. module "babylonjs/Engines/engine" {
  54380. interface Engine {
  54381. /** @hidden */
  54382. _excludedCompressedTextures: string[];
  54383. /** @hidden */
  54384. _textureFormatInUse: string;
  54385. /**
  54386. * Gets the list of texture formats supported
  54387. */
  54388. readonly texturesSupported: Array<string>;
  54389. /**
  54390. * Gets the texture format in use
  54391. */
  54392. readonly textureFormatInUse: Nullable<string>;
  54393. /**
  54394. * Set the compressed texture extensions or file names to skip.
  54395. *
  54396. * @param skippedFiles defines the list of those texture files you want to skip
  54397. * Example: [".dds", ".env", "myfile.png"]
  54398. */
  54399. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  54400. /**
  54401. * Set the compressed texture format to use, based on the formats you have, and the formats
  54402. * supported by the hardware / browser.
  54403. *
  54404. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  54405. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  54406. * to API arguments needed to compressed textures. This puts the burden on the container
  54407. * generator to house the arcane code for determining these for current & future formats.
  54408. *
  54409. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  54410. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  54411. *
  54412. * Note: The result of this call is not taken into account when a texture is base64.
  54413. *
  54414. * @param formatsAvailable defines the list of those format families you have created
  54415. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  54416. *
  54417. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  54418. * @returns The extension selected.
  54419. */
  54420. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  54421. }
  54422. }
  54423. }
  54424. declare module "babylonjs/Engines/Extensions/index" {
  54425. export * from "babylonjs/Engines/Extensions/engine.alpha";
  54426. export * from "babylonjs/Engines/Extensions/engine.occlusionQuery";
  54427. export * from "babylonjs/Engines/Extensions/engine.transformFeedback";
  54428. export * from "babylonjs/Engines/Extensions/engine.multiview";
  54429. export * from "babylonjs/Engines/Extensions/engine.rawTexture";
  54430. export * from "babylonjs/Engines/Extensions/engine.dynamicTexture";
  54431. export * from "babylonjs/Engines/Extensions/engine.videoTexture";
  54432. export * from "babylonjs/Engines/Extensions/engine.multiRender";
  54433. export * from "babylonjs/Engines/Extensions/engine.cubeTexture";
  54434. export * from "babylonjs/Engines/Extensions/engine.renderTarget";
  54435. export * from "babylonjs/Engines/Extensions/engine.renderTargetCube";
  54436. export * from "babylonjs/Engines/Extensions/engine.webVR";
  54437. export * from "babylonjs/Engines/Extensions/engine.uniformBuffer";
  54438. export * from "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  54439. export * from "babylonjs/Engines/Extensions/engine.views";
  54440. export * from "babylonjs/Engines/Extensions/engine.readTexture";
  54441. import "babylonjs/Engines/Extensions/engine.textureSelector";
  54442. export * from "babylonjs/Engines/Extensions/engine.textureSelector";
  54443. }
  54444. declare module "babylonjs/Misc/HighDynamicRange/panoramaToCubemap" {
  54445. import { Nullable } from "babylonjs/types";
  54446. /**
  54447. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  54448. */
  54449. export interface CubeMapInfo {
  54450. /**
  54451. * The pixel array for the front face.
  54452. * This is stored in format, left to right, up to down format.
  54453. */
  54454. front: Nullable<ArrayBufferView>;
  54455. /**
  54456. * The pixel array for the back face.
  54457. * This is stored in format, left to right, up to down format.
  54458. */
  54459. back: Nullable<ArrayBufferView>;
  54460. /**
  54461. * The pixel array for the left face.
  54462. * This is stored in format, left to right, up to down format.
  54463. */
  54464. left: Nullable<ArrayBufferView>;
  54465. /**
  54466. * The pixel array for the right face.
  54467. * This is stored in format, left to right, up to down format.
  54468. */
  54469. right: Nullable<ArrayBufferView>;
  54470. /**
  54471. * The pixel array for the up face.
  54472. * This is stored in format, left to right, up to down format.
  54473. */
  54474. up: Nullable<ArrayBufferView>;
  54475. /**
  54476. * The pixel array for the down face.
  54477. * This is stored in format, left to right, up to down format.
  54478. */
  54479. down: Nullable<ArrayBufferView>;
  54480. /**
  54481. * The size of the cubemap stored.
  54482. *
  54483. * Each faces will be size * size pixels.
  54484. */
  54485. size: number;
  54486. /**
  54487. * The format of the texture.
  54488. *
  54489. * RGBA, RGB.
  54490. */
  54491. format: number;
  54492. /**
  54493. * The type of the texture data.
  54494. *
  54495. * UNSIGNED_INT, FLOAT.
  54496. */
  54497. type: number;
  54498. /**
  54499. * Specifies whether the texture is in gamma space.
  54500. */
  54501. gammaSpace: boolean;
  54502. }
  54503. /**
  54504. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  54505. */
  54506. export class PanoramaToCubeMapTools {
  54507. private static FACE_LEFT;
  54508. private static FACE_RIGHT;
  54509. private static FACE_FRONT;
  54510. private static FACE_BACK;
  54511. private static FACE_DOWN;
  54512. private static FACE_UP;
  54513. /**
  54514. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  54515. *
  54516. * @param float32Array The source data.
  54517. * @param inputWidth The width of the input panorama.
  54518. * @param inputHeight The height of the input panorama.
  54519. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  54520. * @return The cubemap data
  54521. */
  54522. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  54523. private static CreateCubemapTexture;
  54524. private static CalcProjectionSpherical;
  54525. }
  54526. }
  54527. declare module "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial" {
  54528. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54529. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54530. import { Nullable } from "babylonjs/types";
  54531. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  54532. /**
  54533. * Helper class dealing with the extraction of spherical polynomial dataArray
  54534. * from a cube map.
  54535. */
  54536. export class CubeMapToSphericalPolynomialTools {
  54537. private static FileFaces;
  54538. /**
  54539. * Converts a texture to the according Spherical Polynomial data.
  54540. * This extracts the first 3 orders only as they are the only one used in the lighting.
  54541. *
  54542. * @param texture The texture to extract the information from.
  54543. * @return The Spherical Polynomial data.
  54544. */
  54545. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  54546. /**
  54547. * Converts a cubemap to the according Spherical Polynomial data.
  54548. * This extracts the first 3 orders only as they are the only one used in the lighting.
  54549. *
  54550. * @param cubeInfo The Cube map to extract the information from.
  54551. * @return The Spherical Polynomial data.
  54552. */
  54553. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  54554. }
  54555. }
  54556. declare module "babylonjs/Materials/Textures/baseTexture.polynomial" {
  54557. import { Nullable } from "babylonjs/types";
  54558. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54559. module "babylonjs/Materials/Textures/baseTexture" {
  54560. interface BaseTexture {
  54561. /**
  54562. * Get the polynomial representation of the texture data.
  54563. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  54564. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  54565. */
  54566. sphericalPolynomial: Nullable<SphericalPolynomial>;
  54567. }
  54568. }
  54569. }
  54570. declare module "babylonjs/Shaders/rgbdEncode.fragment" {
  54571. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  54572. /** @hidden */
  54573. export var rgbdEncodePixelShader: {
  54574. name: string;
  54575. shader: string;
  54576. };
  54577. }
  54578. declare module "babylonjs/Shaders/rgbdDecode.fragment" {
  54579. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  54580. /** @hidden */
  54581. export var rgbdDecodePixelShader: {
  54582. name: string;
  54583. shader: string;
  54584. };
  54585. }
  54586. declare module "babylonjs/Misc/environmentTextureTools" {
  54587. import { Nullable } from "babylonjs/types";
  54588. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54589. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54590. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54591. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  54592. import "babylonjs/Engines/Extensions/engine.readTexture";
  54593. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  54594. import "babylonjs/Shaders/rgbdEncode.fragment";
  54595. import "babylonjs/Shaders/rgbdDecode.fragment";
  54596. /**
  54597. * Raw texture data and descriptor sufficient for WebGL texture upload
  54598. */
  54599. export interface EnvironmentTextureInfo {
  54600. /**
  54601. * Version of the environment map
  54602. */
  54603. version: number;
  54604. /**
  54605. * Width of image
  54606. */
  54607. width: number;
  54608. /**
  54609. * Irradiance information stored in the file.
  54610. */
  54611. irradiance: any;
  54612. /**
  54613. * Specular information stored in the file.
  54614. */
  54615. specular: any;
  54616. }
  54617. /**
  54618. * Defines One Image in the file. It requires only the position in the file
  54619. * as well as the length.
  54620. */
  54621. interface BufferImageData {
  54622. /**
  54623. * Length of the image data.
  54624. */
  54625. length: number;
  54626. /**
  54627. * Position of the data from the null terminator delimiting the end of the JSON.
  54628. */
  54629. position: number;
  54630. }
  54631. /**
  54632. * Defines the specular data enclosed in the file.
  54633. * This corresponds to the version 1 of the data.
  54634. */
  54635. export interface EnvironmentTextureSpecularInfoV1 {
  54636. /**
  54637. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  54638. */
  54639. specularDataPosition?: number;
  54640. /**
  54641. * This contains all the images data needed to reconstruct the cubemap.
  54642. */
  54643. mipmaps: Array<BufferImageData>;
  54644. /**
  54645. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  54646. */
  54647. lodGenerationScale: number;
  54648. }
  54649. /**
  54650. * Sets of helpers addressing the serialization and deserialization of environment texture
  54651. * stored in a BabylonJS env file.
  54652. * Those files are usually stored as .env files.
  54653. */
  54654. export class EnvironmentTextureTools {
  54655. /**
  54656. * Magic number identifying the env file.
  54657. */
  54658. private static _MagicBytes;
  54659. /**
  54660. * Gets the environment info from an env file.
  54661. * @param data The array buffer containing the .env bytes.
  54662. * @returns the environment file info (the json header) if successfully parsed.
  54663. */
  54664. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  54665. /**
  54666. * Creates an environment texture from a loaded cube texture.
  54667. * @param texture defines the cube texture to convert in env file
  54668. * @return a promise containing the environment data if succesfull.
  54669. */
  54670. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  54671. /**
  54672. * Creates a JSON representation of the spherical data.
  54673. * @param texture defines the texture containing the polynomials
  54674. * @return the JSON representation of the spherical info
  54675. */
  54676. private static _CreateEnvTextureIrradiance;
  54677. /**
  54678. * Creates the ArrayBufferViews used for initializing environment texture image data.
  54679. * @param data the image data
  54680. * @param info parameters that determine what views will be created for accessing the underlying buffer
  54681. * @return the views described by info providing access to the underlying buffer
  54682. */
  54683. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  54684. /**
  54685. * Uploads the texture info contained in the env file to the GPU.
  54686. * @param texture defines the internal texture to upload to
  54687. * @param data defines the data to load
  54688. * @param info defines the texture info retrieved through the GetEnvInfo method
  54689. * @returns a promise
  54690. */
  54691. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  54692. private static _OnImageReadyAsync;
  54693. /**
  54694. * Uploads the levels of image data to the GPU.
  54695. * @param texture defines the internal texture to upload to
  54696. * @param imageData defines the array buffer views of image data [mipmap][face]
  54697. * @returns a promise
  54698. */
  54699. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  54700. /**
  54701. * Uploads spherical polynomials information to the texture.
  54702. * @param texture defines the texture we are trying to upload the information to
  54703. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  54704. */
  54705. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  54706. /** @hidden */
  54707. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  54708. }
  54709. }
  54710. declare module "babylonjs/Engines/Processors/shaderCodeInliner" {
  54711. /**
  54712. * Class used to inline functions in shader code
  54713. */
  54714. export class ShaderCodeInliner {
  54715. private static readonly _RegexpFindFunctionNameAndType;
  54716. private _sourceCode;
  54717. private _functionDescr;
  54718. private _numMaxIterations;
  54719. /** Gets or sets the token used to mark the functions to inline */
  54720. inlineToken: string;
  54721. /** Gets or sets the debug mode */
  54722. debug: boolean;
  54723. /** Gets the code after the inlining process */
  54724. get code(): string;
  54725. /**
  54726. * Initializes the inliner
  54727. * @param sourceCode shader code source to inline
  54728. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  54729. */
  54730. constructor(sourceCode: string, numMaxIterations?: number);
  54731. /**
  54732. * Start the processing of the shader code
  54733. */
  54734. processCode(): void;
  54735. private _collectFunctions;
  54736. private _processInlining;
  54737. private _extractBetweenMarkers;
  54738. private _skipWhitespaces;
  54739. private _removeComments;
  54740. private _replaceFunctionCallsByCode;
  54741. private _findBackward;
  54742. private _escapeRegExp;
  54743. private _replaceNames;
  54744. }
  54745. }
  54746. declare module "babylonjs/Engines/nativeEngine" {
  54747. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  54748. import { Engine } from "babylonjs/Engines/engine";
  54749. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  54750. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54751. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54752. import { Effect } from "babylonjs/Materials/effect";
  54753. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  54754. import { Matrix, Viewport, Color3 } from "babylonjs/Maths/math";
  54755. import { IColor4Like } from "babylonjs/Maths/math.like";
  54756. import { Scene } from "babylonjs/scene";
  54757. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  54758. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  54759. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  54760. /**
  54761. * Container for accessors for natively-stored mesh data buffers.
  54762. */
  54763. class NativeDataBuffer extends DataBuffer {
  54764. /**
  54765. * Accessor value used to identify/retrieve a natively-stored index buffer.
  54766. */
  54767. nativeIndexBuffer?: any;
  54768. /**
  54769. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  54770. */
  54771. nativeVertexBuffer?: any;
  54772. }
  54773. /** @hidden */
  54774. class NativeTexture extends InternalTexture {
  54775. getInternalTexture(): InternalTexture;
  54776. getViewCount(): number;
  54777. }
  54778. /** @hidden */
  54779. export class NativeEngine extends Engine {
  54780. private readonly _native;
  54781. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  54782. private readonly INVALID_HANDLE;
  54783. private _boundBuffersVertexArray;
  54784. getHardwareScalingLevel(): number;
  54785. constructor();
  54786. dispose(): void;
  54787. /**
  54788. * Can be used to override the current requestAnimationFrame requester.
  54789. * @hidden
  54790. */
  54791. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  54792. /**
  54793. * Override default engine behavior.
  54794. * @param color
  54795. * @param backBuffer
  54796. * @param depth
  54797. * @param stencil
  54798. */
  54799. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  54800. /**
  54801. * Gets host document
  54802. * @returns the host document object
  54803. */
  54804. getHostDocument(): Nullable<Document>;
  54805. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  54806. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  54807. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  54808. protected _recordVertexArrayObject(vertexArray: any, vertexBuffers: {
  54809. [key: string]: VertexBuffer;
  54810. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  54811. bindBuffers(vertexBuffers: {
  54812. [key: string]: VertexBuffer;
  54813. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  54814. recordVertexArrayObject(vertexBuffers: {
  54815. [key: string]: VertexBuffer;
  54816. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  54817. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  54818. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  54819. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  54820. /**
  54821. * Draw a list of indexed primitives
  54822. * @param fillMode defines the primitive to use
  54823. * @param indexStart defines the starting index
  54824. * @param indexCount defines the number of index to draw
  54825. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54826. */
  54827. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  54828. /**
  54829. * Draw a list of unindexed primitives
  54830. * @param fillMode defines the primitive to use
  54831. * @param verticesStart defines the index of first vertex to draw
  54832. * @param verticesCount defines the count of vertices to draw
  54833. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54834. */
  54835. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  54836. createPipelineContext(): IPipelineContext;
  54837. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  54838. /** @hidden */
  54839. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  54840. /** @hidden */
  54841. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  54842. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  54843. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  54844. protected _setProgram(program: WebGLProgram): void;
  54845. _releaseEffect(effect: Effect): void;
  54846. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  54847. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  54848. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  54849. bindSamplers(effect: Effect): void;
  54850. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  54851. getRenderWidth(useScreen?: boolean): number;
  54852. getRenderHeight(useScreen?: boolean): number;
  54853. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  54854. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  54855. /**
  54856. * Set the z offset to apply to current rendering
  54857. * @param value defines the offset to apply
  54858. */
  54859. setZOffset(value: number): void;
  54860. /**
  54861. * Gets the current value of the zOffset
  54862. * @returns the current zOffset state
  54863. */
  54864. getZOffset(): number;
  54865. /**
  54866. * Enable or disable depth buffering
  54867. * @param enable defines the state to set
  54868. */
  54869. setDepthBuffer(enable: boolean): void;
  54870. /**
  54871. * Gets a boolean indicating if depth writing is enabled
  54872. * @returns the current depth writing state
  54873. */
  54874. getDepthWrite(): boolean;
  54875. /**
  54876. * Enable or disable depth writing
  54877. * @param enable defines the state to set
  54878. */
  54879. setDepthWrite(enable: boolean): void;
  54880. /**
  54881. * Enable or disable color writing
  54882. * @param enable defines the state to set
  54883. */
  54884. setColorWrite(enable: boolean): void;
  54885. /**
  54886. * Gets a boolean indicating if color writing is enabled
  54887. * @returns the current color writing state
  54888. */
  54889. getColorWrite(): boolean;
  54890. /**
  54891. * Sets alpha constants used by some alpha blending modes
  54892. * @param r defines the red component
  54893. * @param g defines the green component
  54894. * @param b defines the blue component
  54895. * @param a defines the alpha component
  54896. */
  54897. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  54898. /**
  54899. * Sets the current alpha mode
  54900. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  54901. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  54902. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  54903. */
  54904. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  54905. /**
  54906. * Gets the current alpha mode
  54907. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  54908. * @returns the current alpha mode
  54909. */
  54910. getAlphaMode(): number;
  54911. setInt(uniform: WebGLUniformLocation, int: number): void;
  54912. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  54913. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  54914. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  54915. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  54916. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  54917. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  54918. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  54919. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  54920. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  54921. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  54922. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  54923. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  54924. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  54925. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  54926. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  54927. setFloat(uniform: WebGLUniformLocation, value: number): void;
  54928. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  54929. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  54930. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  54931. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  54932. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  54933. wipeCaches(bruteForce?: boolean): void;
  54934. _createTexture(): WebGLTexture;
  54935. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  54936. /**
  54937. * Usually called from Texture.ts.
  54938. * Passed information to create a WebGLTexture
  54939. * @param url defines a value which contains one of the following:
  54940. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  54941. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  54942. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  54943. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  54944. * @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)
  54945. * @param scene needed for loading to the correct scene
  54946. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  54947. * @param onLoad optional callback to be called upon successful completion
  54948. * @param onError optional callback to be called upon failure
  54949. * @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
  54950. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  54951. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  54952. * @param forcedExtension defines the extension to use to pick the right loader
  54953. * @param mimeType defines an optional mime type
  54954. * @returns a InternalTexture for assignment back into BABYLON.Texture
  54955. */
  54956. 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;
  54957. /**
  54958. * Creates a cube texture
  54959. * @param rootUrl defines the url where the files to load is located
  54960. * @param scene defines the current scene
  54961. * @param files defines the list of files to load (1 per face)
  54962. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  54963. * @param onLoad defines an optional callback raised when the texture is loaded
  54964. * @param onError defines an optional callback raised if there is an issue to load the texture
  54965. * @param format defines the format of the data
  54966. * @param forcedExtension defines the extension to use to pick the right loader
  54967. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  54968. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  54969. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  54970. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  54971. * @returns the cube texture as an InternalTexture
  54972. */
  54973. 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;
  54974. private _getSamplingFilter;
  54975. private static _GetNativeTextureFormat;
  54976. createRenderTargetTexture(size: number | {
  54977. width: number;
  54978. height: number;
  54979. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  54980. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  54981. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  54982. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  54983. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  54984. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  54985. /**
  54986. * Updates a dynamic vertex buffer.
  54987. * @param vertexBuffer the vertex buffer to update
  54988. * @param data the data used to update the vertex buffer
  54989. * @param byteOffset the byte offset of the data (optional)
  54990. * @param byteLength the byte length of the data (optional)
  54991. */
  54992. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  54993. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  54994. private _updateAnisotropicLevel;
  54995. private _getAddressMode;
  54996. /** @hidden */
  54997. _bindTexture(channel: number, texture: InternalTexture): void;
  54998. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  54999. releaseEffects(): void;
  55000. /** @hidden */
  55001. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  55002. /** @hidden */
  55003. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  55004. /** @hidden */
  55005. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  55006. /** @hidden */
  55007. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  55008. }
  55009. }
  55010. declare module "babylonjs/Engines/index" {
  55011. export * from "babylonjs/Engines/constants";
  55012. export * from "babylonjs/Engines/engineCapabilities";
  55013. export * from "babylonjs/Engines/instancingAttributeInfo";
  55014. export * from "babylonjs/Engines/thinEngine";
  55015. export * from "babylonjs/Engines/engine";
  55016. export * from "babylonjs/Engines/engineStore";
  55017. export * from "babylonjs/Engines/nullEngine";
  55018. export * from "babylonjs/Engines/Extensions/index";
  55019. export * from "babylonjs/Engines/IPipelineContext";
  55020. export * from "babylonjs/Engines/WebGL/webGLPipelineContext";
  55021. export * from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  55022. export * from "babylonjs/Engines/nativeEngine";
  55023. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  55024. export * from "babylonjs/Engines/performanceConfigurator";
  55025. }
  55026. declare module "babylonjs/Events/clipboardEvents" {
  55027. /**
  55028. * Gather the list of clipboard event types as constants.
  55029. */
  55030. export class ClipboardEventTypes {
  55031. /**
  55032. * The clipboard event is fired when a copy command is active (pressed).
  55033. */
  55034. static readonly COPY: number;
  55035. /**
  55036. * The clipboard event is fired when a cut command is active (pressed).
  55037. */
  55038. static readonly CUT: number;
  55039. /**
  55040. * The clipboard event is fired when a paste command is active (pressed).
  55041. */
  55042. static readonly PASTE: number;
  55043. }
  55044. /**
  55045. * This class is used to store clipboard related info for the onClipboardObservable event.
  55046. */
  55047. export class ClipboardInfo {
  55048. /**
  55049. * Defines the type of event (BABYLON.ClipboardEventTypes)
  55050. */
  55051. type: number;
  55052. /**
  55053. * Defines the related dom event
  55054. */
  55055. event: ClipboardEvent;
  55056. /**
  55057. *Creates an instance of ClipboardInfo.
  55058. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  55059. * @param event Defines the related dom event
  55060. */
  55061. constructor(
  55062. /**
  55063. * Defines the type of event (BABYLON.ClipboardEventTypes)
  55064. */
  55065. type: number,
  55066. /**
  55067. * Defines the related dom event
  55068. */
  55069. event: ClipboardEvent);
  55070. /**
  55071. * Get the clipboard event's type from the keycode.
  55072. * @param keyCode Defines the keyCode for the current keyboard event.
  55073. * @return {number}
  55074. */
  55075. static GetTypeFromCharacter(keyCode: number): number;
  55076. }
  55077. }
  55078. declare module "babylonjs/Events/index" {
  55079. export * from "babylonjs/Events/keyboardEvents";
  55080. export * from "babylonjs/Events/pointerEvents";
  55081. export * from "babylonjs/Events/clipboardEvents";
  55082. }
  55083. declare module "babylonjs/Gamepads/Controllers/daydreamController" {
  55084. import { Scene } from "babylonjs/scene";
  55085. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55086. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55087. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55088. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55089. /**
  55090. * Google Daydream controller
  55091. */
  55092. export class DaydreamController extends WebVRController {
  55093. /**
  55094. * Base Url for the controller model.
  55095. */
  55096. static MODEL_BASE_URL: string;
  55097. /**
  55098. * File name for the controller model.
  55099. */
  55100. static MODEL_FILENAME: string;
  55101. /**
  55102. * Gamepad Id prefix used to identify Daydream Controller.
  55103. */
  55104. static readonly GAMEPAD_ID_PREFIX: string;
  55105. /**
  55106. * Creates a new DaydreamController from a gamepad
  55107. * @param vrGamepad the gamepad that the controller should be created from
  55108. */
  55109. constructor(vrGamepad: any);
  55110. /**
  55111. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55112. * @param scene scene in which to add meshes
  55113. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55114. */
  55115. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55116. /**
  55117. * Called once for each button that changed state since the last frame
  55118. * @param buttonIdx Which button index changed
  55119. * @param state New state of the button
  55120. * @param changes Which properties on the state changed since last frame
  55121. */
  55122. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55123. }
  55124. }
  55125. declare module "babylonjs/Gamepads/Controllers/gearVRController" {
  55126. import { Scene } from "babylonjs/scene";
  55127. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55128. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55129. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55130. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55131. /**
  55132. * Gear VR Controller
  55133. */
  55134. export class GearVRController extends WebVRController {
  55135. /**
  55136. * Base Url for the controller model.
  55137. */
  55138. static MODEL_BASE_URL: string;
  55139. /**
  55140. * File name for the controller model.
  55141. */
  55142. static MODEL_FILENAME: string;
  55143. /**
  55144. * Gamepad Id prefix used to identify this controller.
  55145. */
  55146. static readonly GAMEPAD_ID_PREFIX: string;
  55147. private readonly _buttonIndexToObservableNameMap;
  55148. /**
  55149. * Creates a new GearVRController from a gamepad
  55150. * @param vrGamepad the gamepad that the controller should be created from
  55151. */
  55152. constructor(vrGamepad: any);
  55153. /**
  55154. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55155. * @param scene scene in which to add meshes
  55156. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55157. */
  55158. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55159. /**
  55160. * Called once for each button that changed state since the last frame
  55161. * @param buttonIdx Which button index changed
  55162. * @param state New state of the button
  55163. * @param changes Which properties on the state changed since last frame
  55164. */
  55165. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55166. }
  55167. }
  55168. declare module "babylonjs/Gamepads/Controllers/genericController" {
  55169. import { Scene } from "babylonjs/scene";
  55170. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55171. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55172. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55173. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55174. /**
  55175. * Generic Controller
  55176. */
  55177. export class GenericController extends WebVRController {
  55178. /**
  55179. * Base Url for the controller model.
  55180. */
  55181. static readonly MODEL_BASE_URL: string;
  55182. /**
  55183. * File name for the controller model.
  55184. */
  55185. static readonly MODEL_FILENAME: string;
  55186. /**
  55187. * Creates a new GenericController from a gamepad
  55188. * @param vrGamepad the gamepad that the controller should be created from
  55189. */
  55190. constructor(vrGamepad: any);
  55191. /**
  55192. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55193. * @param scene scene in which to add meshes
  55194. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55195. */
  55196. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55197. /**
  55198. * Called once for each button that changed state since the last frame
  55199. * @param buttonIdx Which button index changed
  55200. * @param state New state of the button
  55201. * @param changes Which properties on the state changed since last frame
  55202. */
  55203. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55204. }
  55205. }
  55206. declare module "babylonjs/Gamepads/Controllers/oculusTouchController" {
  55207. import { Observable } from "babylonjs/Misc/observable";
  55208. import { Scene } from "babylonjs/scene";
  55209. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55210. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55211. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55212. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55213. /**
  55214. * Oculus Touch Controller
  55215. */
  55216. export class OculusTouchController extends WebVRController {
  55217. /**
  55218. * Base Url for the controller model.
  55219. */
  55220. static MODEL_BASE_URL: string;
  55221. /**
  55222. * File name for the left controller model.
  55223. */
  55224. static MODEL_LEFT_FILENAME: string;
  55225. /**
  55226. * File name for the right controller model.
  55227. */
  55228. static MODEL_RIGHT_FILENAME: string;
  55229. /**
  55230. * Base Url for the Quest controller model.
  55231. */
  55232. static QUEST_MODEL_BASE_URL: string;
  55233. /**
  55234. * @hidden
  55235. * If the controllers are running on a device that needs the updated Quest controller models
  55236. */
  55237. static _IsQuest: boolean;
  55238. /**
  55239. * Fired when the secondary trigger on this controller is modified
  55240. */
  55241. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  55242. /**
  55243. * Fired when the thumb rest on this controller is modified
  55244. */
  55245. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  55246. /**
  55247. * Creates a new OculusTouchController from a gamepad
  55248. * @param vrGamepad the gamepad that the controller should be created from
  55249. */
  55250. constructor(vrGamepad: any);
  55251. /**
  55252. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55253. * @param scene scene in which to add meshes
  55254. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55255. */
  55256. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55257. /**
  55258. * Fired when the A button on this controller is modified
  55259. */
  55260. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55261. /**
  55262. * Fired when the B button on this controller is modified
  55263. */
  55264. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55265. /**
  55266. * Fired when the X button on this controller is modified
  55267. */
  55268. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55269. /**
  55270. * Fired when the Y button on this controller is modified
  55271. */
  55272. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55273. /**
  55274. * Called once for each button that changed state since the last frame
  55275. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  55276. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  55277. * 2) secondary trigger (same)
  55278. * 3) A (right) X (left), touch, pressed = value
  55279. * 4) B / Y
  55280. * 5) thumb rest
  55281. * @param buttonIdx Which button index changed
  55282. * @param state New state of the button
  55283. * @param changes Which properties on the state changed since last frame
  55284. */
  55285. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55286. }
  55287. }
  55288. declare module "babylonjs/Gamepads/Controllers/viveController" {
  55289. import { Scene } from "babylonjs/scene";
  55290. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55291. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55292. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55293. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55294. import { Observable } from "babylonjs/Misc/observable";
  55295. /**
  55296. * Vive Controller
  55297. */
  55298. export class ViveController extends WebVRController {
  55299. /**
  55300. * Base Url for the controller model.
  55301. */
  55302. static MODEL_BASE_URL: string;
  55303. /**
  55304. * File name for the controller model.
  55305. */
  55306. static MODEL_FILENAME: string;
  55307. /**
  55308. * Creates a new ViveController from a gamepad
  55309. * @param vrGamepad the gamepad that the controller should be created from
  55310. */
  55311. constructor(vrGamepad: any);
  55312. /**
  55313. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55314. * @param scene scene in which to add meshes
  55315. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55316. */
  55317. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55318. /**
  55319. * Fired when the left button on this controller is modified
  55320. */
  55321. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55322. /**
  55323. * Fired when the right button on this controller is modified
  55324. */
  55325. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55326. /**
  55327. * Fired when the menu button on this controller is modified
  55328. */
  55329. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55330. /**
  55331. * Called once for each button that changed state since the last frame
  55332. * Vive mapping:
  55333. * 0: touchpad
  55334. * 1: trigger
  55335. * 2: left AND right buttons
  55336. * 3: menu button
  55337. * @param buttonIdx Which button index changed
  55338. * @param state New state of the button
  55339. * @param changes Which properties on the state changed since last frame
  55340. */
  55341. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55342. }
  55343. }
  55344. declare module "babylonjs/Gamepads/Controllers/windowsMotionController" {
  55345. import { Observable } from "babylonjs/Misc/observable";
  55346. import { Scene } from "babylonjs/scene";
  55347. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55348. import { Ray } from "babylonjs/Culling/ray";
  55349. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55350. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55351. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55352. /**
  55353. * Defines the WindowsMotionController object that the state of the windows motion controller
  55354. */
  55355. export class WindowsMotionController extends WebVRController {
  55356. /**
  55357. * The base url used to load the left and right controller models
  55358. */
  55359. static MODEL_BASE_URL: string;
  55360. /**
  55361. * The name of the left controller model file
  55362. */
  55363. static MODEL_LEFT_FILENAME: string;
  55364. /**
  55365. * The name of the right controller model file
  55366. */
  55367. static MODEL_RIGHT_FILENAME: string;
  55368. /**
  55369. * The controller name prefix for this controller type
  55370. */
  55371. static readonly GAMEPAD_ID_PREFIX: string;
  55372. /**
  55373. * The controller id pattern for this controller type
  55374. */
  55375. private static readonly GAMEPAD_ID_PATTERN;
  55376. private _loadedMeshInfo;
  55377. protected readonly _mapping: {
  55378. buttons: string[];
  55379. buttonMeshNames: {
  55380. trigger: string;
  55381. menu: string;
  55382. grip: string;
  55383. thumbstick: string;
  55384. trackpad: string;
  55385. };
  55386. buttonObservableNames: {
  55387. trigger: string;
  55388. menu: string;
  55389. grip: string;
  55390. thumbstick: string;
  55391. trackpad: string;
  55392. };
  55393. axisMeshNames: string[];
  55394. pointingPoseMeshName: string;
  55395. };
  55396. /**
  55397. * Fired when the trackpad on this controller is clicked
  55398. */
  55399. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  55400. /**
  55401. * Fired when the trackpad on this controller is modified
  55402. */
  55403. onTrackpadValuesChangedObservable: Observable<StickValues>;
  55404. /**
  55405. * The current x and y values of this controller's trackpad
  55406. */
  55407. trackpad: StickValues;
  55408. /**
  55409. * Creates a new WindowsMotionController from a gamepad
  55410. * @param vrGamepad the gamepad that the controller should be created from
  55411. */
  55412. constructor(vrGamepad: any);
  55413. /**
  55414. * Fired when the trigger on this controller is modified
  55415. */
  55416. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55417. /**
  55418. * Fired when the menu button on this controller is modified
  55419. */
  55420. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55421. /**
  55422. * Fired when the grip button on this controller is modified
  55423. */
  55424. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55425. /**
  55426. * Fired when the thumbstick button on this controller is modified
  55427. */
  55428. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55429. /**
  55430. * Fired when the touchpad button on this controller is modified
  55431. */
  55432. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55433. /**
  55434. * Fired when the touchpad values on this controller are modified
  55435. */
  55436. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  55437. protected _updateTrackpad(): void;
  55438. /**
  55439. * Called once per frame by the engine.
  55440. */
  55441. update(): void;
  55442. /**
  55443. * Called once for each button that changed state since the last frame
  55444. * @param buttonIdx Which button index changed
  55445. * @param state New state of the button
  55446. * @param changes Which properties on the state changed since last frame
  55447. */
  55448. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55449. /**
  55450. * Moves the buttons on the controller mesh based on their current state
  55451. * @param buttonName the name of the button to move
  55452. * @param buttonValue the value of the button which determines the buttons new position
  55453. */
  55454. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  55455. /**
  55456. * Moves the axis on the controller mesh based on its current state
  55457. * @param axis the index of the axis
  55458. * @param axisValue the value of the axis which determines the meshes new position
  55459. * @hidden
  55460. */
  55461. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  55462. /**
  55463. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55464. * @param scene scene in which to add meshes
  55465. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55466. */
  55467. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  55468. /**
  55469. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  55470. * can be transformed by button presses and axes values, based on this._mapping.
  55471. *
  55472. * @param scene scene in which the meshes exist
  55473. * @param meshes list of meshes that make up the controller model to process
  55474. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  55475. */
  55476. private processModel;
  55477. private createMeshInfo;
  55478. /**
  55479. * Gets the ray of the controller in the direction the controller is pointing
  55480. * @param length the length the resulting ray should be
  55481. * @returns a ray in the direction the controller is pointing
  55482. */
  55483. getForwardRay(length?: number): Ray;
  55484. /**
  55485. * Disposes of the controller
  55486. */
  55487. dispose(): void;
  55488. }
  55489. /**
  55490. * This class represents a new windows motion controller in XR.
  55491. */
  55492. export class XRWindowsMotionController extends WindowsMotionController {
  55493. /**
  55494. * Changing the original WIndowsMotionController mapping to fir the new mapping
  55495. */
  55496. protected readonly _mapping: {
  55497. buttons: string[];
  55498. buttonMeshNames: {
  55499. trigger: string;
  55500. menu: string;
  55501. grip: string;
  55502. thumbstick: string;
  55503. trackpad: string;
  55504. };
  55505. buttonObservableNames: {
  55506. trigger: string;
  55507. menu: string;
  55508. grip: string;
  55509. thumbstick: string;
  55510. trackpad: string;
  55511. };
  55512. axisMeshNames: string[];
  55513. pointingPoseMeshName: string;
  55514. };
  55515. /**
  55516. * Construct a new XR-Based windows motion controller
  55517. *
  55518. * @param gamepadInfo the gamepad object from the browser
  55519. */
  55520. constructor(gamepadInfo: any);
  55521. /**
  55522. * holds the thumbstick values (X,Y)
  55523. */
  55524. thumbstickValues: StickValues;
  55525. /**
  55526. * Fired when the thumbstick on this controller is clicked
  55527. */
  55528. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  55529. /**
  55530. * Fired when the thumbstick on this controller is modified
  55531. */
  55532. onThumbstickValuesChangedObservable: Observable<StickValues>;
  55533. /**
  55534. * Fired when the touchpad button on this controller is modified
  55535. */
  55536. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  55537. /**
  55538. * Fired when the touchpad values on this controller are modified
  55539. */
  55540. onTrackpadValuesChangedObservable: Observable<StickValues>;
  55541. /**
  55542. * Fired when the thumbstick button on this controller is modified
  55543. * here to prevent breaking changes
  55544. */
  55545. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55546. /**
  55547. * updating the thumbstick(!) and not the trackpad.
  55548. * This is named this way due to the difference between WebVR and XR and to avoid
  55549. * changing the parent class.
  55550. */
  55551. protected _updateTrackpad(): void;
  55552. /**
  55553. * Disposes the class with joy
  55554. */
  55555. dispose(): void;
  55556. }
  55557. }
  55558. declare module "babylonjs/Gamepads/Controllers/index" {
  55559. export * from "babylonjs/Gamepads/Controllers/daydreamController";
  55560. export * from "babylonjs/Gamepads/Controllers/gearVRController";
  55561. export * from "babylonjs/Gamepads/Controllers/genericController";
  55562. export * from "babylonjs/Gamepads/Controllers/oculusTouchController";
  55563. export * from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55564. export * from "babylonjs/Gamepads/Controllers/viveController";
  55565. export * from "babylonjs/Gamepads/Controllers/webVRController";
  55566. export * from "babylonjs/Gamepads/Controllers/windowsMotionController";
  55567. }
  55568. declare module "babylonjs/Gamepads/index" {
  55569. export * from "babylonjs/Gamepads/Controllers/index";
  55570. export * from "babylonjs/Gamepads/gamepad";
  55571. export * from "babylonjs/Gamepads/gamepadManager";
  55572. export * from "babylonjs/Gamepads/gamepadSceneComponent";
  55573. export * from "babylonjs/Gamepads/xboxGamepad";
  55574. export * from "babylonjs/Gamepads/dualShockGamepad";
  55575. }
  55576. declare module "babylonjs/Meshes/Builders/polyhedronBuilder" {
  55577. import { Scene } from "babylonjs/scene";
  55578. import { Vector4 } from "babylonjs/Maths/math.vector";
  55579. import { Color4 } from "babylonjs/Maths/math.color";
  55580. import { Mesh } from "babylonjs/Meshes/mesh";
  55581. import { Nullable } from "babylonjs/types";
  55582. /**
  55583. * Class containing static functions to help procedurally build meshes
  55584. */
  55585. export class PolyhedronBuilder {
  55586. /**
  55587. * Creates a polyhedron mesh
  55588. * * 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
  55589. * * The parameter `size` (positive float, default 1) sets the polygon size
  55590. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  55591. * * 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`
  55592. * * 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
  55593. * * 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)`)
  55594. * * 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
  55595. * * 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
  55596. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  55597. * * 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
  55598. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  55599. * @param name defines the name of the mesh
  55600. * @param options defines the options used to create the mesh
  55601. * @param scene defines the hosting scene
  55602. * @returns the polyhedron mesh
  55603. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  55604. */
  55605. static CreatePolyhedron(name: string, options: {
  55606. type?: number;
  55607. size?: number;
  55608. sizeX?: number;
  55609. sizeY?: number;
  55610. sizeZ?: number;
  55611. custom?: any;
  55612. faceUV?: Vector4[];
  55613. faceColors?: Color4[];
  55614. flat?: boolean;
  55615. updatable?: boolean;
  55616. sideOrientation?: number;
  55617. frontUVs?: Vector4;
  55618. backUVs?: Vector4;
  55619. }, scene?: Nullable<Scene>): Mesh;
  55620. }
  55621. }
  55622. declare module "babylonjs/Gizmos/scaleGizmo" {
  55623. import { Observable } from "babylonjs/Misc/observable";
  55624. import { Nullable } from "babylonjs/types";
  55625. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55626. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55627. import { AxisScaleGizmo } from "babylonjs/Gizmos/axisScaleGizmo";
  55628. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55629. import { Node } from "babylonjs/node";
  55630. /**
  55631. * Gizmo that enables scaling a mesh along 3 axis
  55632. */
  55633. export class ScaleGizmo extends Gizmo {
  55634. /**
  55635. * Internal gizmo used for interactions on the x axis
  55636. */
  55637. xGizmo: AxisScaleGizmo;
  55638. /**
  55639. * Internal gizmo used for interactions on the y axis
  55640. */
  55641. yGizmo: AxisScaleGizmo;
  55642. /**
  55643. * Internal gizmo used for interactions on the z axis
  55644. */
  55645. zGizmo: AxisScaleGizmo;
  55646. /**
  55647. * Internal gizmo used to scale all axis equally
  55648. */
  55649. uniformScaleGizmo: AxisScaleGizmo;
  55650. private _meshAttached;
  55651. private _nodeAttached;
  55652. private _snapDistance;
  55653. private _uniformScalingMesh;
  55654. private _octahedron;
  55655. private _sensitivity;
  55656. /** Fires an event when any of it's sub gizmos are dragged */
  55657. onDragStartObservable: Observable<unknown>;
  55658. /** Fires an event when any of it's sub gizmos are released from dragging */
  55659. onDragEndObservable: Observable<unknown>;
  55660. get attachedMesh(): Nullable<AbstractMesh>;
  55661. set attachedMesh(mesh: Nullable<AbstractMesh>);
  55662. get attachedNode(): Nullable<Node>;
  55663. set attachedNode(node: Nullable<Node>);
  55664. /**
  55665. * Creates a ScaleGizmo
  55666. * @param gizmoLayer The utility layer the gizmo will be added to
  55667. * @param thickness display gizmo axis thickness
  55668. */
  55669. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  55670. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  55671. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  55672. /**
  55673. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55674. */
  55675. set snapDistance(value: number);
  55676. get snapDistance(): number;
  55677. /**
  55678. * Ratio for the scale of the gizmo (Default: 1)
  55679. */
  55680. set scaleRatio(value: number);
  55681. get scaleRatio(): number;
  55682. /**
  55683. * Sensitivity factor for dragging (Default: 1)
  55684. */
  55685. set sensitivity(value: number);
  55686. get sensitivity(): number;
  55687. /**
  55688. * Disposes of the gizmo
  55689. */
  55690. dispose(): void;
  55691. }
  55692. }
  55693. declare module "babylonjs/Gizmos/axisScaleGizmo" {
  55694. import { Observable } from "babylonjs/Misc/observable";
  55695. import { Nullable } from "babylonjs/types";
  55696. import { Vector3 } from "babylonjs/Maths/math.vector";
  55697. import { Node } from "babylonjs/node";
  55698. import { Mesh } from "babylonjs/Meshes/mesh";
  55699. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  55700. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55701. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55702. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  55703. import { Color3 } from "babylonjs/Maths/math.color";
  55704. /**
  55705. * Single axis scale gizmo
  55706. */
  55707. export class AxisScaleGizmo extends Gizmo {
  55708. /**
  55709. * Drag behavior responsible for the gizmos dragging interactions
  55710. */
  55711. dragBehavior: PointerDragBehavior;
  55712. private _pointerObserver;
  55713. /**
  55714. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55715. */
  55716. snapDistance: number;
  55717. /**
  55718. * Event that fires each time the gizmo snaps to a new location.
  55719. * * snapDistance is the the change in distance
  55720. */
  55721. onSnapObservable: Observable<{
  55722. snapDistance: number;
  55723. }>;
  55724. /**
  55725. * If the scaling operation should be done on all axis (default: false)
  55726. */
  55727. uniformScaling: boolean;
  55728. /**
  55729. * Custom sensitivity value for the drag strength
  55730. */
  55731. sensitivity: number;
  55732. private _isEnabled;
  55733. private _parent;
  55734. private _arrow;
  55735. private _coloredMaterial;
  55736. private _hoverMaterial;
  55737. /**
  55738. * Creates an AxisScaleGizmo
  55739. * @param gizmoLayer The utility layer the gizmo will be added to
  55740. * @param dragAxis The axis which the gizmo will be able to scale on
  55741. * @param color The color of the gizmo
  55742. * @param thickness display gizmo axis thickness
  55743. */
  55744. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  55745. protected _attachedNodeChanged(value: Nullable<Node>): void;
  55746. /**
  55747. * If the gizmo is enabled
  55748. */
  55749. set isEnabled(value: boolean);
  55750. get isEnabled(): boolean;
  55751. /**
  55752. * Disposes of the gizmo
  55753. */
  55754. dispose(): void;
  55755. /**
  55756. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  55757. * @param mesh The mesh to replace the default mesh of the gizmo
  55758. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  55759. */
  55760. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  55761. }
  55762. }
  55763. declare module "babylonjs/Gizmos/boundingBoxGizmo" {
  55764. import { Observable } from "babylonjs/Misc/observable";
  55765. import { Nullable } from "babylonjs/types";
  55766. import { Vector3 } from "babylonjs/Maths/math.vector";
  55767. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55768. import { Mesh } from "babylonjs/Meshes/mesh";
  55769. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55770. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55771. import { Color3 } from "babylonjs/Maths/math.color";
  55772. import "babylonjs/Meshes/Builders/boxBuilder";
  55773. /**
  55774. * Bounding box gizmo
  55775. */
  55776. export class BoundingBoxGizmo extends Gizmo {
  55777. private _lineBoundingBox;
  55778. private _rotateSpheresParent;
  55779. private _scaleBoxesParent;
  55780. private _boundingDimensions;
  55781. private _renderObserver;
  55782. private _pointerObserver;
  55783. private _scaleDragSpeed;
  55784. private _tmpQuaternion;
  55785. private _tmpVector;
  55786. private _tmpRotationMatrix;
  55787. /**
  55788. * 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)
  55789. */
  55790. ignoreChildren: boolean;
  55791. /**
  55792. * 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)
  55793. */
  55794. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  55795. /**
  55796. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  55797. */
  55798. rotationSphereSize: number;
  55799. /**
  55800. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  55801. */
  55802. scaleBoxSize: number;
  55803. /**
  55804. * 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)
  55805. */
  55806. fixedDragMeshScreenSize: boolean;
  55807. /**
  55808. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  55809. */
  55810. fixedDragMeshScreenSizeDistanceFactor: number;
  55811. /**
  55812. * Fired when a rotation sphere or scale box is dragged
  55813. */
  55814. onDragStartObservable: Observable<{}>;
  55815. /**
  55816. * Fired when a scale box is dragged
  55817. */
  55818. onScaleBoxDragObservable: Observable<{}>;
  55819. /**
  55820. * Fired when a scale box drag is ended
  55821. */
  55822. onScaleBoxDragEndObservable: Observable<{}>;
  55823. /**
  55824. * Fired when a rotation sphere is dragged
  55825. */
  55826. onRotationSphereDragObservable: Observable<{}>;
  55827. /**
  55828. * Fired when a rotation sphere drag is ended
  55829. */
  55830. onRotationSphereDragEndObservable: Observable<{}>;
  55831. /**
  55832. * 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)
  55833. */
  55834. scalePivot: Nullable<Vector3>;
  55835. /**
  55836. * Mesh used as a pivot to rotate the attached node
  55837. */
  55838. private _anchorMesh;
  55839. private _existingMeshScale;
  55840. private _dragMesh;
  55841. private pointerDragBehavior;
  55842. private coloredMaterial;
  55843. private hoverColoredMaterial;
  55844. /**
  55845. * Sets the color of the bounding box gizmo
  55846. * @param color the color to set
  55847. */
  55848. setColor(color: Color3): void;
  55849. /**
  55850. * Creates an BoundingBoxGizmo
  55851. * @param gizmoLayer The utility layer the gizmo will be added to
  55852. * @param color The color of the gizmo
  55853. */
  55854. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  55855. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  55856. private _selectNode;
  55857. /**
  55858. * Updates the bounding box information for the Gizmo
  55859. */
  55860. updateBoundingBox(): void;
  55861. private _updateRotationSpheres;
  55862. private _updateScaleBoxes;
  55863. /**
  55864. * Enables rotation on the specified axis and disables rotation on the others
  55865. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  55866. */
  55867. setEnabledRotationAxis(axis: string): void;
  55868. /**
  55869. * Enables/disables scaling
  55870. * @param enable if scaling should be enabled
  55871. * @param homogeneousScaling defines if scaling should only be homogeneous
  55872. */
  55873. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  55874. private _updateDummy;
  55875. /**
  55876. * Enables a pointer drag behavior on the bounding box of the gizmo
  55877. */
  55878. enableDragBehavior(): void;
  55879. /**
  55880. * Disposes of the gizmo
  55881. */
  55882. dispose(): void;
  55883. /**
  55884. * 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)
  55885. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  55886. * @returns the bounding box mesh with the passed in mesh as a child
  55887. */
  55888. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  55889. /**
  55890. * CustomMeshes are not supported by this gizmo
  55891. * @param mesh The mesh to replace the default mesh of the gizmo
  55892. */
  55893. setCustomMesh(mesh: Mesh): void;
  55894. }
  55895. }
  55896. declare module "babylonjs/Gizmos/planeRotationGizmo" {
  55897. import { Observable } from "babylonjs/Misc/observable";
  55898. import { Nullable } from "babylonjs/types";
  55899. import { Vector3 } from "babylonjs/Maths/math.vector";
  55900. import { Color3 } from "babylonjs/Maths/math.color";
  55901. import { Node } from "babylonjs/node";
  55902. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  55903. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55904. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55905. import "babylonjs/Meshes/Builders/linesBuilder";
  55906. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  55907. /**
  55908. * Single plane rotation gizmo
  55909. */
  55910. export class PlaneRotationGizmo extends Gizmo {
  55911. /**
  55912. * Drag behavior responsible for the gizmos dragging interactions
  55913. */
  55914. dragBehavior: PointerDragBehavior;
  55915. private _pointerObserver;
  55916. /**
  55917. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  55918. */
  55919. snapDistance: number;
  55920. /**
  55921. * Event that fires each time the gizmo snaps to a new location.
  55922. * * snapDistance is the the change in distance
  55923. */
  55924. onSnapObservable: Observable<{
  55925. snapDistance: number;
  55926. }>;
  55927. private _isEnabled;
  55928. private _parent;
  55929. /**
  55930. * Creates a PlaneRotationGizmo
  55931. * @param gizmoLayer The utility layer the gizmo will be added to
  55932. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  55933. * @param color The color of the gizmo
  55934. * @param tessellation Amount of tessellation to be used when creating rotation circles
  55935. * @param useEulerRotation Use and update Euler angle instead of quaternion
  55936. * @param thickness display gizmo axis thickness
  55937. */
  55938. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  55939. protected _attachedNodeChanged(value: Nullable<Node>): void;
  55940. /**
  55941. * If the gizmo is enabled
  55942. */
  55943. set isEnabled(value: boolean);
  55944. get isEnabled(): boolean;
  55945. /**
  55946. * Disposes of the gizmo
  55947. */
  55948. dispose(): void;
  55949. }
  55950. }
  55951. declare module "babylonjs/Gizmos/rotationGizmo" {
  55952. import { Observable } from "babylonjs/Misc/observable";
  55953. import { Nullable } from "babylonjs/types";
  55954. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55955. import { Mesh } from "babylonjs/Meshes/mesh";
  55956. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55957. import { PlaneRotationGizmo } from "babylonjs/Gizmos/planeRotationGizmo";
  55958. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55959. import { Node } from "babylonjs/node";
  55960. /**
  55961. * Gizmo that enables rotating a mesh along 3 axis
  55962. */
  55963. export class RotationGizmo extends Gizmo {
  55964. /**
  55965. * Internal gizmo used for interactions on the x axis
  55966. */
  55967. xGizmo: PlaneRotationGizmo;
  55968. /**
  55969. * Internal gizmo used for interactions on the y axis
  55970. */
  55971. yGizmo: PlaneRotationGizmo;
  55972. /**
  55973. * Internal gizmo used for interactions on the z axis
  55974. */
  55975. zGizmo: PlaneRotationGizmo;
  55976. /** Fires an event when any of it's sub gizmos are dragged */
  55977. onDragStartObservable: Observable<unknown>;
  55978. /** Fires an event when any of it's sub gizmos are released from dragging */
  55979. onDragEndObservable: Observable<unknown>;
  55980. private _meshAttached;
  55981. private _nodeAttached;
  55982. get attachedMesh(): Nullable<AbstractMesh>;
  55983. set attachedMesh(mesh: Nullable<AbstractMesh>);
  55984. get attachedNode(): Nullable<Node>;
  55985. set attachedNode(node: Nullable<Node>);
  55986. /**
  55987. * Creates a RotationGizmo
  55988. * @param gizmoLayer The utility layer the gizmo will be added to
  55989. * @param tessellation Amount of tessellation to be used when creating rotation circles
  55990. * @param useEulerRotation Use and update Euler angle instead of quaternion
  55991. * @param thickness display gizmo axis thickness
  55992. */
  55993. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  55994. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  55995. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  55996. /**
  55997. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55998. */
  55999. set snapDistance(value: number);
  56000. get snapDistance(): number;
  56001. /**
  56002. * Ratio for the scale of the gizmo (Default: 1)
  56003. */
  56004. set scaleRatio(value: number);
  56005. get scaleRatio(): number;
  56006. /**
  56007. * Disposes of the gizmo
  56008. */
  56009. dispose(): void;
  56010. /**
  56011. * CustomMeshes are not supported by this gizmo
  56012. * @param mesh The mesh to replace the default mesh of the gizmo
  56013. */
  56014. setCustomMesh(mesh: Mesh): void;
  56015. }
  56016. }
  56017. declare module "babylonjs/Gizmos/gizmoManager" {
  56018. import { Observable } from "babylonjs/Misc/observable";
  56019. import { Nullable } from "babylonjs/types";
  56020. import { Scene, IDisposable } from "babylonjs/scene";
  56021. import { Node } from "babylonjs/node";
  56022. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56023. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56024. import { SixDofDragBehavior } from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  56025. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  56026. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  56027. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  56028. import { BoundingBoxGizmo } from "babylonjs/Gizmos/boundingBoxGizmo";
  56029. /**
  56030. * Helps setup gizmo's in the scene to rotate/scale/position nodes
  56031. */
  56032. export class GizmoManager implements IDisposable {
  56033. private scene;
  56034. /**
  56035. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  56036. */
  56037. gizmos: {
  56038. positionGizmo: Nullable<PositionGizmo>;
  56039. rotationGizmo: Nullable<RotationGizmo>;
  56040. scaleGizmo: Nullable<ScaleGizmo>;
  56041. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  56042. };
  56043. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  56044. clearGizmoOnEmptyPointerEvent: boolean;
  56045. /** Fires an event when the manager is attached to a mesh */
  56046. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  56047. /** Fires an event when the manager is attached to a node */
  56048. onAttachedToNodeObservable: Observable<Nullable<Node>>;
  56049. private _gizmosEnabled;
  56050. private _pointerObserver;
  56051. private _attachedMesh;
  56052. private _attachedNode;
  56053. private _boundingBoxColor;
  56054. private _defaultUtilityLayer;
  56055. private _defaultKeepDepthUtilityLayer;
  56056. private _thickness;
  56057. /**
  56058. * When bounding box gizmo is enabled, this can be used to track drag/end events
  56059. */
  56060. boundingBoxDragBehavior: SixDofDragBehavior;
  56061. /**
  56062. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  56063. */
  56064. attachableMeshes: Nullable<Array<AbstractMesh>>;
  56065. /**
  56066. * Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
  56067. */
  56068. attachableNodes: Nullable<Array<Node>>;
  56069. /**
  56070. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
  56071. */
  56072. usePointerToAttachGizmos: boolean;
  56073. /**
  56074. * Utility layer that the bounding box gizmo belongs to
  56075. */
  56076. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  56077. /**
  56078. * Utility layer that all gizmos besides bounding box belong to
  56079. */
  56080. get utilityLayer(): UtilityLayerRenderer;
  56081. /**
  56082. * Instatiates a gizmo manager
  56083. * @param scene the scene to overlay the gizmos on top of
  56084. * @param thickness display gizmo axis thickness
  56085. */
  56086. constructor(scene: Scene, thickness?: number);
  56087. /**
  56088. * Attaches a set of gizmos to the specified mesh
  56089. * @param mesh The mesh the gizmo's should be attached to
  56090. */
  56091. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  56092. /**
  56093. * Attaches a set of gizmos to the specified node
  56094. * @param node The node the gizmo's should be attached to
  56095. */
  56096. attachToNode(node: Nullable<Node>): void;
  56097. /**
  56098. * If the position gizmo is enabled
  56099. */
  56100. set positionGizmoEnabled(value: boolean);
  56101. get positionGizmoEnabled(): boolean;
  56102. /**
  56103. * If the rotation gizmo is enabled
  56104. */
  56105. set rotationGizmoEnabled(value: boolean);
  56106. get rotationGizmoEnabled(): boolean;
  56107. /**
  56108. * If the scale gizmo is enabled
  56109. */
  56110. set scaleGizmoEnabled(value: boolean);
  56111. get scaleGizmoEnabled(): boolean;
  56112. /**
  56113. * If the boundingBox gizmo is enabled
  56114. */
  56115. set boundingBoxGizmoEnabled(value: boolean);
  56116. get boundingBoxGizmoEnabled(): boolean;
  56117. /**
  56118. * Disposes of the gizmo manager
  56119. */
  56120. dispose(): void;
  56121. }
  56122. }
  56123. declare module "babylonjs/Lights/directionalLight" {
  56124. import { Camera } from "babylonjs/Cameras/camera";
  56125. import { Scene } from "babylonjs/scene";
  56126. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56127. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56128. import { Light } from "babylonjs/Lights/light";
  56129. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  56130. import { Effect } from "babylonjs/Materials/effect";
  56131. /**
  56132. * A directional light is defined by a direction (what a surprise!).
  56133. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  56134. * 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.
  56135. * Documentation: https://doc.babylonjs.com/babylon101/lights
  56136. */
  56137. export class DirectionalLight extends ShadowLight {
  56138. private _shadowFrustumSize;
  56139. /**
  56140. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  56141. */
  56142. get shadowFrustumSize(): number;
  56143. /**
  56144. * Specifies a fix frustum size for the shadow generation.
  56145. */
  56146. set shadowFrustumSize(value: number);
  56147. private _shadowOrthoScale;
  56148. /**
  56149. * Gets the shadow projection scale against the optimal computed one.
  56150. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  56151. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  56152. */
  56153. get shadowOrthoScale(): number;
  56154. /**
  56155. * Sets the shadow projection scale against the optimal computed one.
  56156. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  56157. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  56158. */
  56159. set shadowOrthoScale(value: number);
  56160. /**
  56161. * Automatically compute the projection matrix to best fit (including all the casters)
  56162. * on each frame.
  56163. */
  56164. autoUpdateExtends: boolean;
  56165. /**
  56166. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  56167. * on each frame. autoUpdateExtends must be set to true for this to work
  56168. */
  56169. autoCalcShadowZBounds: boolean;
  56170. private _orthoLeft;
  56171. private _orthoRight;
  56172. private _orthoTop;
  56173. private _orthoBottom;
  56174. /**
  56175. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  56176. * The directional light is emitted from everywhere in the given direction.
  56177. * It can cast shadows.
  56178. * Documentation : https://doc.babylonjs.com/babylon101/lights
  56179. * @param name The friendly name of the light
  56180. * @param direction The direction of the light
  56181. * @param scene The scene the light belongs to
  56182. */
  56183. constructor(name: string, direction: Vector3, scene: Scene);
  56184. /**
  56185. * Returns the string "DirectionalLight".
  56186. * @return The class name
  56187. */
  56188. getClassName(): string;
  56189. /**
  56190. * Returns the integer 1.
  56191. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  56192. */
  56193. getTypeID(): number;
  56194. /**
  56195. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  56196. * Returns the DirectionalLight Shadow projection matrix.
  56197. */
  56198. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56199. /**
  56200. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  56201. * Returns the DirectionalLight Shadow projection matrix.
  56202. */
  56203. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  56204. /**
  56205. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  56206. * Returns the DirectionalLight Shadow projection matrix.
  56207. */
  56208. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56209. protected _buildUniformLayout(): void;
  56210. /**
  56211. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  56212. * @param effect The effect to update
  56213. * @param lightIndex The index of the light in the effect to update
  56214. * @returns The directional light
  56215. */
  56216. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  56217. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  56218. /**
  56219. * Gets the minZ used for shadow according to both the scene and the light.
  56220. *
  56221. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  56222. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  56223. * @param activeCamera The camera we are returning the min for
  56224. * @returns the depth min z
  56225. */
  56226. getDepthMinZ(activeCamera: Camera): number;
  56227. /**
  56228. * Gets the maxZ used for shadow according to both the scene and the light.
  56229. *
  56230. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  56231. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  56232. * @param activeCamera The camera we are returning the max for
  56233. * @returns the depth max z
  56234. */
  56235. getDepthMaxZ(activeCamera: Camera): number;
  56236. /**
  56237. * Prepares the list of defines specific to the light type.
  56238. * @param defines the list of defines
  56239. * @param lightIndex defines the index of the light for the effect
  56240. */
  56241. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  56242. }
  56243. }
  56244. declare module "babylonjs/Meshes/Builders/hemisphereBuilder" {
  56245. import { Mesh } from "babylonjs/Meshes/mesh";
  56246. /**
  56247. * Class containing static functions to help procedurally build meshes
  56248. */
  56249. export class HemisphereBuilder {
  56250. /**
  56251. * Creates a hemisphere mesh
  56252. * @param name defines the name of the mesh
  56253. * @param options defines the options used to create the mesh
  56254. * @param scene defines the hosting scene
  56255. * @returns the hemisphere mesh
  56256. */
  56257. static CreateHemisphere(name: string, options: {
  56258. segments?: number;
  56259. diameter?: number;
  56260. sideOrientation?: number;
  56261. }, scene: any): Mesh;
  56262. }
  56263. }
  56264. declare module "babylonjs/Lights/spotLight" {
  56265. import { Nullable } from "babylonjs/types";
  56266. import { Scene } from "babylonjs/scene";
  56267. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56268. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56269. import { Effect } from "babylonjs/Materials/effect";
  56270. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56271. import { Light } from "babylonjs/Lights/light";
  56272. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  56273. /**
  56274. * A spot light is defined by a position, a direction, an angle, and an exponent.
  56275. * These values define a cone of light starting from the position, emitting toward the direction.
  56276. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  56277. * and the exponent defines the speed of the decay of the light with distance (reach).
  56278. * Documentation: https://doc.babylonjs.com/babylon101/lights
  56279. */
  56280. export class SpotLight extends ShadowLight {
  56281. private _angle;
  56282. private _innerAngle;
  56283. private _cosHalfAngle;
  56284. private _lightAngleScale;
  56285. private _lightAngleOffset;
  56286. /**
  56287. * Gets the cone angle of the spot light in Radians.
  56288. */
  56289. get angle(): number;
  56290. /**
  56291. * Sets the cone angle of the spot light in Radians.
  56292. */
  56293. set angle(value: number);
  56294. /**
  56295. * Only used in gltf falloff mode, this defines the angle where
  56296. * the directional falloff will start before cutting at angle which could be seen
  56297. * as outer angle.
  56298. */
  56299. get innerAngle(): number;
  56300. /**
  56301. * Only used in gltf falloff mode, this defines the angle where
  56302. * the directional falloff will start before cutting at angle which could be seen
  56303. * as outer angle.
  56304. */
  56305. set innerAngle(value: number);
  56306. private _shadowAngleScale;
  56307. /**
  56308. * Allows scaling the angle of the light for shadow generation only.
  56309. */
  56310. get shadowAngleScale(): number;
  56311. /**
  56312. * Allows scaling the angle of the light for shadow generation only.
  56313. */
  56314. set shadowAngleScale(value: number);
  56315. /**
  56316. * The light decay speed with the distance from the emission spot.
  56317. */
  56318. exponent: number;
  56319. private _projectionTextureMatrix;
  56320. /**
  56321. * Allows reading the projecton texture
  56322. */
  56323. get projectionTextureMatrix(): Matrix;
  56324. protected _projectionTextureLightNear: number;
  56325. /**
  56326. * Gets the near clip of the Spotlight for texture projection.
  56327. */
  56328. get projectionTextureLightNear(): number;
  56329. /**
  56330. * Sets the near clip of the Spotlight for texture projection.
  56331. */
  56332. set projectionTextureLightNear(value: number);
  56333. protected _projectionTextureLightFar: number;
  56334. /**
  56335. * Gets the far clip of the Spotlight for texture projection.
  56336. */
  56337. get projectionTextureLightFar(): number;
  56338. /**
  56339. * Sets the far clip of the Spotlight for texture projection.
  56340. */
  56341. set projectionTextureLightFar(value: number);
  56342. protected _projectionTextureUpDirection: Vector3;
  56343. /**
  56344. * Gets the Up vector of the Spotlight for texture projection.
  56345. */
  56346. get projectionTextureUpDirection(): Vector3;
  56347. /**
  56348. * Sets the Up vector of the Spotlight for texture projection.
  56349. */
  56350. set projectionTextureUpDirection(value: Vector3);
  56351. private _projectionTexture;
  56352. /**
  56353. * Gets the projection texture of the light.
  56354. */
  56355. get projectionTexture(): Nullable<BaseTexture>;
  56356. /**
  56357. * Sets the projection texture of the light.
  56358. */
  56359. set projectionTexture(value: Nullable<BaseTexture>);
  56360. private _projectionTextureViewLightDirty;
  56361. private _projectionTextureProjectionLightDirty;
  56362. private _projectionTextureDirty;
  56363. private _projectionTextureViewTargetVector;
  56364. private _projectionTextureViewLightMatrix;
  56365. private _projectionTextureProjectionLightMatrix;
  56366. private _projectionTextureScalingMatrix;
  56367. /**
  56368. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  56369. * It can cast shadows.
  56370. * Documentation : https://doc.babylonjs.com/babylon101/lights
  56371. * @param name The light friendly name
  56372. * @param position The position of the spot light in the scene
  56373. * @param direction The direction of the light in the scene
  56374. * @param angle The cone angle of the light in Radians
  56375. * @param exponent The light decay speed with the distance from the emission spot
  56376. * @param scene The scene the lights belongs to
  56377. */
  56378. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  56379. /**
  56380. * Returns the string "SpotLight".
  56381. * @returns the class name
  56382. */
  56383. getClassName(): string;
  56384. /**
  56385. * Returns the integer 2.
  56386. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  56387. */
  56388. getTypeID(): number;
  56389. /**
  56390. * Overrides the direction setter to recompute the projection texture view light Matrix.
  56391. */
  56392. protected _setDirection(value: Vector3): void;
  56393. /**
  56394. * Overrides the position setter to recompute the projection texture view light Matrix.
  56395. */
  56396. protected _setPosition(value: Vector3): void;
  56397. /**
  56398. * 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.
  56399. * Returns the SpotLight.
  56400. */
  56401. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56402. protected _computeProjectionTextureViewLightMatrix(): void;
  56403. protected _computeProjectionTextureProjectionLightMatrix(): void;
  56404. /**
  56405. * Main function for light texture projection matrix computing.
  56406. */
  56407. protected _computeProjectionTextureMatrix(): void;
  56408. protected _buildUniformLayout(): void;
  56409. private _computeAngleValues;
  56410. /**
  56411. * Sets the passed Effect "effect" with the Light textures.
  56412. * @param effect The effect to update
  56413. * @param lightIndex The index of the light in the effect to update
  56414. * @returns The light
  56415. */
  56416. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  56417. /**
  56418. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  56419. * @param effect The effect to update
  56420. * @param lightIndex The index of the light in the effect to update
  56421. * @returns The spot light
  56422. */
  56423. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  56424. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  56425. /**
  56426. * Disposes the light and the associated resources.
  56427. */
  56428. dispose(): void;
  56429. /**
  56430. * Prepares the list of defines specific to the light type.
  56431. * @param defines the list of defines
  56432. * @param lightIndex defines the index of the light for the effect
  56433. */
  56434. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  56435. }
  56436. }
  56437. declare module "babylonjs/Gizmos/lightGizmo" {
  56438. import { Nullable } from "babylonjs/types";
  56439. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56440. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56441. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  56442. import { Light } from "babylonjs/Lights/light";
  56443. /**
  56444. * Gizmo that enables viewing a light
  56445. */
  56446. export class LightGizmo extends Gizmo {
  56447. private _lightMesh;
  56448. private _material;
  56449. private _cachedPosition;
  56450. private _cachedForward;
  56451. private _attachedMeshParent;
  56452. /**
  56453. * Creates a LightGizmo
  56454. * @param gizmoLayer The utility layer the gizmo will be added to
  56455. */
  56456. constructor(gizmoLayer?: UtilityLayerRenderer);
  56457. private _light;
  56458. /**
  56459. * The light that the gizmo is attached to
  56460. */
  56461. set light(light: Nullable<Light>);
  56462. get light(): Nullable<Light>;
  56463. /**
  56464. * Gets the material used to render the light gizmo
  56465. */
  56466. get material(): StandardMaterial;
  56467. /**
  56468. * @hidden
  56469. * Updates the gizmo to match the attached mesh's position/rotation
  56470. */
  56471. protected _update(): void;
  56472. private static _Scale;
  56473. /**
  56474. * Creates the lines for a light mesh
  56475. */
  56476. private static _CreateLightLines;
  56477. /**
  56478. * Disposes of the light gizmo
  56479. */
  56480. dispose(): void;
  56481. private static _CreateHemisphericLightMesh;
  56482. private static _CreatePointLightMesh;
  56483. private static _CreateSpotLightMesh;
  56484. private static _CreateDirectionalLightMesh;
  56485. }
  56486. }
  56487. declare module "babylonjs/Gizmos/cameraGizmo" {
  56488. import { Nullable } from "babylonjs/types";
  56489. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56490. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56491. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  56492. import { Camera } from "babylonjs/Cameras/camera";
  56493. /**
  56494. * Gizmo that enables viewing a camera
  56495. */
  56496. export class CameraGizmo extends Gizmo {
  56497. private _cameraMesh;
  56498. private _cameraLinesMesh;
  56499. private _material;
  56500. /**
  56501. * Creates a CameraGizmo
  56502. * @param gizmoLayer The utility layer the gizmo will be added to
  56503. */
  56504. constructor(gizmoLayer?: UtilityLayerRenderer);
  56505. private _camera;
  56506. /** Gets or sets a boolean indicating if frustum lines must be rendered (true by default)) */
  56507. get displayFrustum(): boolean;
  56508. set displayFrustum(value: boolean);
  56509. /**
  56510. * The camera that the gizmo is attached to
  56511. */
  56512. set camera(camera: Nullable<Camera>);
  56513. get camera(): Nullable<Camera>;
  56514. /**
  56515. * Gets the material used to render the camera gizmo
  56516. */
  56517. get material(): StandardMaterial;
  56518. /**
  56519. * @hidden
  56520. * Updates the gizmo to match the attached mesh's position/rotation
  56521. */
  56522. protected _update(): void;
  56523. private static _Scale;
  56524. private _invProjection;
  56525. /**
  56526. * Disposes of the camera gizmo
  56527. */
  56528. dispose(): void;
  56529. private static _CreateCameraMesh;
  56530. private static _CreateCameraFrustum;
  56531. }
  56532. }
  56533. declare module "babylonjs/Gizmos/index" {
  56534. export * from "babylonjs/Gizmos/axisDragGizmo";
  56535. export * from "babylonjs/Gizmos/axisScaleGizmo";
  56536. export * from "babylonjs/Gizmos/boundingBoxGizmo";
  56537. export * from "babylonjs/Gizmos/gizmo";
  56538. export * from "babylonjs/Gizmos/gizmoManager";
  56539. export * from "babylonjs/Gizmos/planeRotationGizmo";
  56540. export * from "babylonjs/Gizmos/positionGizmo";
  56541. export * from "babylonjs/Gizmos/rotationGizmo";
  56542. export * from "babylonjs/Gizmos/scaleGizmo";
  56543. export * from "babylonjs/Gizmos/lightGizmo";
  56544. export * from "babylonjs/Gizmos/cameraGizmo";
  56545. export * from "babylonjs/Gizmos/planeDragGizmo";
  56546. }
  56547. declare module "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration" {
  56548. /** @hidden */
  56549. export var backgroundFragmentDeclaration: {
  56550. name: string;
  56551. shader: string;
  56552. };
  56553. }
  56554. declare module "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration" {
  56555. /** @hidden */
  56556. export var backgroundUboDeclaration: {
  56557. name: string;
  56558. shader: string;
  56559. };
  56560. }
  56561. declare module "babylonjs/Shaders/background.fragment" {
  56562. import "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration";
  56563. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  56564. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  56565. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  56566. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  56567. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  56568. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56569. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  56570. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  56571. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  56572. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  56573. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  56574. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  56575. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  56576. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  56577. /** @hidden */
  56578. export var backgroundPixelShader: {
  56579. name: string;
  56580. shader: string;
  56581. };
  56582. }
  56583. declare module "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration" {
  56584. /** @hidden */
  56585. export var backgroundVertexDeclaration: {
  56586. name: string;
  56587. shader: string;
  56588. };
  56589. }
  56590. declare module "babylonjs/Shaders/background.vertex" {
  56591. import "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration";
  56592. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  56593. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56594. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  56595. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  56596. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  56597. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  56598. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  56599. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  56600. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  56601. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  56602. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  56603. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  56604. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  56605. /** @hidden */
  56606. export var backgroundVertexShader: {
  56607. name: string;
  56608. shader: string;
  56609. };
  56610. }
  56611. declare module "babylonjs/Materials/Background/backgroundMaterial" {
  56612. import { Nullable, int, float } from "babylonjs/types";
  56613. import { Scene } from "babylonjs/scene";
  56614. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56615. import { SubMesh } from "babylonjs/Meshes/subMesh";
  56616. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56617. import { Mesh } from "babylonjs/Meshes/mesh";
  56618. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  56619. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  56620. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  56621. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56622. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  56623. import { Color3 } from "babylonjs/Maths/math.color";
  56624. import "babylonjs/Shaders/background.fragment";
  56625. import "babylonjs/Shaders/background.vertex";
  56626. /**
  56627. * Background material used to create an efficient environement around your scene.
  56628. */
  56629. export class BackgroundMaterial extends PushMaterial {
  56630. /**
  56631. * Standard reflectance value at parallel view angle.
  56632. */
  56633. static StandardReflectance0: number;
  56634. /**
  56635. * Standard reflectance value at grazing angle.
  56636. */
  56637. static StandardReflectance90: number;
  56638. protected _primaryColor: Color3;
  56639. /**
  56640. * Key light Color (multiply against the environement texture)
  56641. */
  56642. primaryColor: Color3;
  56643. protected __perceptualColor: Nullable<Color3>;
  56644. /**
  56645. * Experimental Internal Use Only.
  56646. *
  56647. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  56648. * This acts as a helper to set the primary color to a more "human friendly" value.
  56649. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  56650. * output color as close as possible from the chosen value.
  56651. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  56652. * part of lighting setup.)
  56653. */
  56654. get _perceptualColor(): Nullable<Color3>;
  56655. set _perceptualColor(value: Nullable<Color3>);
  56656. protected _primaryColorShadowLevel: float;
  56657. /**
  56658. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  56659. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  56660. */
  56661. get primaryColorShadowLevel(): float;
  56662. set primaryColorShadowLevel(value: float);
  56663. protected _primaryColorHighlightLevel: float;
  56664. /**
  56665. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  56666. * The primary color is used at the level chosen to define what the white area would look.
  56667. */
  56668. get primaryColorHighlightLevel(): float;
  56669. set primaryColorHighlightLevel(value: float);
  56670. protected _reflectionTexture: Nullable<BaseTexture>;
  56671. /**
  56672. * Reflection Texture used in the material.
  56673. * Should be author in a specific way for the best result (refer to the documentation).
  56674. */
  56675. reflectionTexture: Nullable<BaseTexture>;
  56676. protected _reflectionBlur: float;
  56677. /**
  56678. * Reflection Texture level of blur.
  56679. *
  56680. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  56681. * texture twice.
  56682. */
  56683. reflectionBlur: float;
  56684. protected _diffuseTexture: Nullable<BaseTexture>;
  56685. /**
  56686. * Diffuse Texture used in the material.
  56687. * Should be author in a specific way for the best result (refer to the documentation).
  56688. */
  56689. diffuseTexture: Nullable<BaseTexture>;
  56690. protected _shadowLights: Nullable<IShadowLight[]>;
  56691. /**
  56692. * Specify the list of lights casting shadow on the material.
  56693. * All scene shadow lights will be included if null.
  56694. */
  56695. shadowLights: Nullable<IShadowLight[]>;
  56696. protected _shadowLevel: float;
  56697. /**
  56698. * Helps adjusting the shadow to a softer level if required.
  56699. * 0 means black shadows and 1 means no shadows.
  56700. */
  56701. shadowLevel: float;
  56702. protected _sceneCenter: Vector3;
  56703. /**
  56704. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  56705. * It is usually zero but might be interesting to modify according to your setup.
  56706. */
  56707. sceneCenter: Vector3;
  56708. protected _opacityFresnel: boolean;
  56709. /**
  56710. * This helps specifying that the material is falling off to the sky box at grazing angle.
  56711. * This helps ensuring a nice transition when the camera goes under the ground.
  56712. */
  56713. opacityFresnel: boolean;
  56714. protected _reflectionFresnel: boolean;
  56715. /**
  56716. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  56717. * This helps adding a mirror texture on the ground.
  56718. */
  56719. reflectionFresnel: boolean;
  56720. protected _reflectionFalloffDistance: number;
  56721. /**
  56722. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  56723. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  56724. */
  56725. reflectionFalloffDistance: number;
  56726. protected _reflectionAmount: number;
  56727. /**
  56728. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  56729. */
  56730. reflectionAmount: number;
  56731. protected _reflectionReflectance0: number;
  56732. /**
  56733. * This specifies the weight of the reflection at grazing angle.
  56734. */
  56735. reflectionReflectance0: number;
  56736. protected _reflectionReflectance90: number;
  56737. /**
  56738. * This specifies the weight of the reflection at a perpendicular point of view.
  56739. */
  56740. reflectionReflectance90: number;
  56741. /**
  56742. * Sets the reflection reflectance fresnel values according to the default standard
  56743. * empirically know to work well :-)
  56744. */
  56745. set reflectionStandardFresnelWeight(value: number);
  56746. protected _useRGBColor: boolean;
  56747. /**
  56748. * Helps to directly use the maps channels instead of their level.
  56749. */
  56750. useRGBColor: boolean;
  56751. protected _enableNoise: boolean;
  56752. /**
  56753. * This helps reducing the banding effect that could occur on the background.
  56754. */
  56755. enableNoise: boolean;
  56756. /**
  56757. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  56758. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  56759. * Recommended to be keep at 1.0 except for special cases.
  56760. */
  56761. get fovMultiplier(): number;
  56762. set fovMultiplier(value: number);
  56763. private _fovMultiplier;
  56764. /**
  56765. * Enable the FOV adjustment feature controlled by fovMultiplier.
  56766. */
  56767. useEquirectangularFOV: boolean;
  56768. private _maxSimultaneousLights;
  56769. /**
  56770. * Number of Simultaneous lights allowed on the material.
  56771. */
  56772. maxSimultaneousLights: int;
  56773. private _shadowOnly;
  56774. /**
  56775. * Make the material only render shadows
  56776. */
  56777. shadowOnly: boolean;
  56778. /**
  56779. * Default configuration related to image processing available in the Background Material.
  56780. */
  56781. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  56782. /**
  56783. * Keep track of the image processing observer to allow dispose and replace.
  56784. */
  56785. private _imageProcessingObserver;
  56786. /**
  56787. * Attaches a new image processing configuration to the PBR Material.
  56788. * @param configuration (if null the scene configuration will be use)
  56789. */
  56790. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  56791. /**
  56792. * Gets the image processing configuration used either in this material.
  56793. */
  56794. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  56795. /**
  56796. * Sets the Default image processing configuration used either in the this material.
  56797. *
  56798. * If sets to null, the scene one is in use.
  56799. */
  56800. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  56801. /**
  56802. * Gets wether the color curves effect is enabled.
  56803. */
  56804. get cameraColorCurvesEnabled(): boolean;
  56805. /**
  56806. * Sets wether the color curves effect is enabled.
  56807. */
  56808. set cameraColorCurvesEnabled(value: boolean);
  56809. /**
  56810. * Gets wether the color grading effect is enabled.
  56811. */
  56812. get cameraColorGradingEnabled(): boolean;
  56813. /**
  56814. * Gets wether the color grading effect is enabled.
  56815. */
  56816. set cameraColorGradingEnabled(value: boolean);
  56817. /**
  56818. * Gets wether tonemapping is enabled or not.
  56819. */
  56820. get cameraToneMappingEnabled(): boolean;
  56821. /**
  56822. * Sets wether tonemapping is enabled or not
  56823. */
  56824. set cameraToneMappingEnabled(value: boolean);
  56825. /**
  56826. * The camera exposure used on this material.
  56827. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  56828. * This corresponds to a photographic exposure.
  56829. */
  56830. get cameraExposure(): float;
  56831. /**
  56832. * The camera exposure used on this material.
  56833. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  56834. * This corresponds to a photographic exposure.
  56835. */
  56836. set cameraExposure(value: float);
  56837. /**
  56838. * Gets The camera contrast used on this material.
  56839. */
  56840. get cameraContrast(): float;
  56841. /**
  56842. * Sets The camera contrast used on this material.
  56843. */
  56844. set cameraContrast(value: float);
  56845. /**
  56846. * Gets the Color Grading 2D Lookup Texture.
  56847. */
  56848. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  56849. /**
  56850. * Sets the Color Grading 2D Lookup Texture.
  56851. */
  56852. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  56853. /**
  56854. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  56855. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  56856. * 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;
  56857. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  56858. */
  56859. get cameraColorCurves(): Nullable<ColorCurves>;
  56860. /**
  56861. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  56862. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  56863. * 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;
  56864. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  56865. */
  56866. set cameraColorCurves(value: Nullable<ColorCurves>);
  56867. /**
  56868. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  56869. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  56870. */
  56871. switchToBGR: boolean;
  56872. private _renderTargets;
  56873. private _reflectionControls;
  56874. private _white;
  56875. private _primaryShadowColor;
  56876. private _primaryHighlightColor;
  56877. /**
  56878. * Instantiates a Background Material in the given scene
  56879. * @param name The friendly name of the material
  56880. * @param scene The scene to add the material to
  56881. */
  56882. constructor(name: string, scene: Scene);
  56883. /**
  56884. * Gets a boolean indicating that current material needs to register RTT
  56885. */
  56886. get hasRenderTargetTextures(): boolean;
  56887. /**
  56888. * The entire material has been created in order to prevent overdraw.
  56889. * @returns false
  56890. */
  56891. needAlphaTesting(): boolean;
  56892. /**
  56893. * The entire material has been created in order to prevent overdraw.
  56894. * @returns true if blending is enable
  56895. */
  56896. needAlphaBlending(): boolean;
  56897. /**
  56898. * Checks wether the material is ready to be rendered for a given mesh.
  56899. * @param mesh The mesh to render
  56900. * @param subMesh The submesh to check against
  56901. * @param useInstances Specify wether or not the material is used with instances
  56902. * @returns true if all the dependencies are ready (Textures, Effects...)
  56903. */
  56904. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  56905. /**
  56906. * Compute the primary color according to the chosen perceptual color.
  56907. */
  56908. private _computePrimaryColorFromPerceptualColor;
  56909. /**
  56910. * Compute the highlights and shadow colors according to their chosen levels.
  56911. */
  56912. private _computePrimaryColors;
  56913. /**
  56914. * Build the uniform buffer used in the material.
  56915. */
  56916. buildUniformLayout(): void;
  56917. /**
  56918. * Unbind the material.
  56919. */
  56920. unbind(): void;
  56921. /**
  56922. * Bind only the world matrix to the material.
  56923. * @param world The world matrix to bind.
  56924. */
  56925. bindOnlyWorldMatrix(world: Matrix): void;
  56926. /**
  56927. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  56928. * @param world The world matrix to bind.
  56929. * @param subMesh The submesh to bind for.
  56930. */
  56931. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  56932. /**
  56933. * Checks to see if a texture is used in the material.
  56934. * @param texture - Base texture to use.
  56935. * @returns - Boolean specifying if a texture is used in the material.
  56936. */
  56937. hasTexture(texture: BaseTexture): boolean;
  56938. /**
  56939. * Dispose the material.
  56940. * @param forceDisposeEffect Force disposal of the associated effect.
  56941. * @param forceDisposeTextures Force disposal of the associated textures.
  56942. */
  56943. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  56944. /**
  56945. * Clones the material.
  56946. * @param name The cloned name.
  56947. * @returns The cloned material.
  56948. */
  56949. clone(name: string): BackgroundMaterial;
  56950. /**
  56951. * Serializes the current material to its JSON representation.
  56952. * @returns The JSON representation.
  56953. */
  56954. serialize(): any;
  56955. /**
  56956. * Gets the class name of the material
  56957. * @returns "BackgroundMaterial"
  56958. */
  56959. getClassName(): string;
  56960. /**
  56961. * Parse a JSON input to create back a background material.
  56962. * @param source The JSON data to parse
  56963. * @param scene The scene to create the parsed material in
  56964. * @param rootUrl The root url of the assets the material depends upon
  56965. * @returns the instantiated BackgroundMaterial.
  56966. */
  56967. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  56968. }
  56969. }
  56970. declare module "babylonjs/Helpers/environmentHelper" {
  56971. import { Observable } from "babylonjs/Misc/observable";
  56972. import { Nullable } from "babylonjs/types";
  56973. import { Scene } from "babylonjs/scene";
  56974. import { Vector3 } from "babylonjs/Maths/math.vector";
  56975. import { Color3 } from "babylonjs/Maths/math.color";
  56976. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56977. import { Mesh } from "babylonjs/Meshes/mesh";
  56978. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56979. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  56980. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  56981. import "babylonjs/Meshes/Builders/planeBuilder";
  56982. import "babylonjs/Meshes/Builders/boxBuilder";
  56983. /**
  56984. * Represents the different options available during the creation of
  56985. * a Environment helper.
  56986. *
  56987. * This can control the default ground, skybox and image processing setup of your scene.
  56988. */
  56989. export interface IEnvironmentHelperOptions {
  56990. /**
  56991. * Specifies whether or not to create a ground.
  56992. * True by default.
  56993. */
  56994. createGround: boolean;
  56995. /**
  56996. * Specifies the ground size.
  56997. * 15 by default.
  56998. */
  56999. groundSize: number;
  57000. /**
  57001. * The texture used on the ground for the main color.
  57002. * Comes from the BabylonJS CDN by default.
  57003. *
  57004. * Remarks: Can be either a texture or a url.
  57005. */
  57006. groundTexture: string | BaseTexture;
  57007. /**
  57008. * The color mixed in the ground texture by default.
  57009. * BabylonJS clearColor by default.
  57010. */
  57011. groundColor: Color3;
  57012. /**
  57013. * Specifies the ground opacity.
  57014. * 1 by default.
  57015. */
  57016. groundOpacity: number;
  57017. /**
  57018. * Enables the ground to receive shadows.
  57019. * True by default.
  57020. */
  57021. enableGroundShadow: boolean;
  57022. /**
  57023. * Helps preventing the shadow to be fully black on the ground.
  57024. * 0.5 by default.
  57025. */
  57026. groundShadowLevel: number;
  57027. /**
  57028. * Creates a mirror texture attach to the ground.
  57029. * false by default.
  57030. */
  57031. enableGroundMirror: boolean;
  57032. /**
  57033. * Specifies the ground mirror size ratio.
  57034. * 0.3 by default as the default kernel is 64.
  57035. */
  57036. groundMirrorSizeRatio: number;
  57037. /**
  57038. * Specifies the ground mirror blur kernel size.
  57039. * 64 by default.
  57040. */
  57041. groundMirrorBlurKernel: number;
  57042. /**
  57043. * Specifies the ground mirror visibility amount.
  57044. * 1 by default
  57045. */
  57046. groundMirrorAmount: number;
  57047. /**
  57048. * Specifies the ground mirror reflectance weight.
  57049. * This uses the standard weight of the background material to setup the fresnel effect
  57050. * of the mirror.
  57051. * 1 by default.
  57052. */
  57053. groundMirrorFresnelWeight: number;
  57054. /**
  57055. * Specifies the ground mirror Falloff distance.
  57056. * This can helps reducing the size of the reflection.
  57057. * 0 by Default.
  57058. */
  57059. groundMirrorFallOffDistance: number;
  57060. /**
  57061. * Specifies the ground mirror texture type.
  57062. * Unsigned Int by Default.
  57063. */
  57064. groundMirrorTextureType: number;
  57065. /**
  57066. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  57067. * the shown objects.
  57068. */
  57069. groundYBias: number;
  57070. /**
  57071. * Specifies whether or not to create a skybox.
  57072. * True by default.
  57073. */
  57074. createSkybox: boolean;
  57075. /**
  57076. * Specifies the skybox size.
  57077. * 20 by default.
  57078. */
  57079. skyboxSize: number;
  57080. /**
  57081. * The texture used on the skybox for the main color.
  57082. * Comes from the BabylonJS CDN by default.
  57083. *
  57084. * Remarks: Can be either a texture or a url.
  57085. */
  57086. skyboxTexture: string | BaseTexture;
  57087. /**
  57088. * The color mixed in the skybox texture by default.
  57089. * BabylonJS clearColor by default.
  57090. */
  57091. skyboxColor: Color3;
  57092. /**
  57093. * The background rotation around the Y axis of the scene.
  57094. * This helps aligning the key lights of your scene with the background.
  57095. * 0 by default.
  57096. */
  57097. backgroundYRotation: number;
  57098. /**
  57099. * Compute automatically the size of the elements to best fit with the scene.
  57100. */
  57101. sizeAuto: boolean;
  57102. /**
  57103. * Default position of the rootMesh if autoSize is not true.
  57104. */
  57105. rootPosition: Vector3;
  57106. /**
  57107. * Sets up the image processing in the scene.
  57108. * true by default.
  57109. */
  57110. setupImageProcessing: boolean;
  57111. /**
  57112. * The texture used as your environment texture in the scene.
  57113. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  57114. *
  57115. * Remarks: Can be either a texture or a url.
  57116. */
  57117. environmentTexture: string | BaseTexture;
  57118. /**
  57119. * The value of the exposure to apply to the scene.
  57120. * 0.6 by default if setupImageProcessing is true.
  57121. */
  57122. cameraExposure: number;
  57123. /**
  57124. * The value of the contrast to apply to the scene.
  57125. * 1.6 by default if setupImageProcessing is true.
  57126. */
  57127. cameraContrast: number;
  57128. /**
  57129. * Specifies whether or not tonemapping should be enabled in the scene.
  57130. * true by default if setupImageProcessing is true.
  57131. */
  57132. toneMappingEnabled: boolean;
  57133. }
  57134. /**
  57135. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  57136. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  57137. * It also helps with the default setup of your imageProcessing configuration.
  57138. */
  57139. export class EnvironmentHelper {
  57140. /**
  57141. * Default ground texture URL.
  57142. */
  57143. private static _groundTextureCDNUrl;
  57144. /**
  57145. * Default skybox texture URL.
  57146. */
  57147. private static _skyboxTextureCDNUrl;
  57148. /**
  57149. * Default environment texture URL.
  57150. */
  57151. private static _environmentTextureCDNUrl;
  57152. /**
  57153. * Creates the default options for the helper.
  57154. */
  57155. private static _getDefaultOptions;
  57156. private _rootMesh;
  57157. /**
  57158. * Gets the root mesh created by the helper.
  57159. */
  57160. get rootMesh(): Mesh;
  57161. private _skybox;
  57162. /**
  57163. * Gets the skybox created by the helper.
  57164. */
  57165. get skybox(): Nullable<Mesh>;
  57166. private _skyboxTexture;
  57167. /**
  57168. * Gets the skybox texture created by the helper.
  57169. */
  57170. get skyboxTexture(): Nullable<BaseTexture>;
  57171. private _skyboxMaterial;
  57172. /**
  57173. * Gets the skybox material created by the helper.
  57174. */
  57175. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  57176. private _ground;
  57177. /**
  57178. * Gets the ground mesh created by the helper.
  57179. */
  57180. get ground(): Nullable<Mesh>;
  57181. private _groundTexture;
  57182. /**
  57183. * Gets the ground texture created by the helper.
  57184. */
  57185. get groundTexture(): Nullable<BaseTexture>;
  57186. private _groundMirror;
  57187. /**
  57188. * Gets the ground mirror created by the helper.
  57189. */
  57190. get groundMirror(): Nullable<MirrorTexture>;
  57191. /**
  57192. * Gets the ground mirror render list to helps pushing the meshes
  57193. * you wish in the ground reflection.
  57194. */
  57195. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  57196. private _groundMaterial;
  57197. /**
  57198. * Gets the ground material created by the helper.
  57199. */
  57200. get groundMaterial(): Nullable<BackgroundMaterial>;
  57201. /**
  57202. * Stores the creation options.
  57203. */
  57204. private readonly _scene;
  57205. private _options;
  57206. /**
  57207. * This observable will be notified with any error during the creation of the environment,
  57208. * mainly texture creation errors.
  57209. */
  57210. onErrorObservable: Observable<{
  57211. message?: string;
  57212. exception?: any;
  57213. }>;
  57214. /**
  57215. * constructor
  57216. * @param options Defines the options we want to customize the helper
  57217. * @param scene The scene to add the material to
  57218. */
  57219. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  57220. /**
  57221. * Updates the background according to the new options
  57222. * @param options
  57223. */
  57224. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  57225. /**
  57226. * Sets the primary color of all the available elements.
  57227. * @param color the main color to affect to the ground and the background
  57228. */
  57229. setMainColor(color: Color3): void;
  57230. /**
  57231. * Setup the image processing according to the specified options.
  57232. */
  57233. private _setupImageProcessing;
  57234. /**
  57235. * Setup the environment texture according to the specified options.
  57236. */
  57237. private _setupEnvironmentTexture;
  57238. /**
  57239. * Setup the background according to the specified options.
  57240. */
  57241. private _setupBackground;
  57242. /**
  57243. * Get the scene sizes according to the setup.
  57244. */
  57245. private _getSceneSize;
  57246. /**
  57247. * Setup the ground according to the specified options.
  57248. */
  57249. private _setupGround;
  57250. /**
  57251. * Setup the ground material according to the specified options.
  57252. */
  57253. private _setupGroundMaterial;
  57254. /**
  57255. * Setup the ground diffuse texture according to the specified options.
  57256. */
  57257. private _setupGroundDiffuseTexture;
  57258. /**
  57259. * Setup the ground mirror texture according to the specified options.
  57260. */
  57261. private _setupGroundMirrorTexture;
  57262. /**
  57263. * Setup the ground to receive the mirror texture.
  57264. */
  57265. private _setupMirrorInGroundMaterial;
  57266. /**
  57267. * Setup the skybox according to the specified options.
  57268. */
  57269. private _setupSkybox;
  57270. /**
  57271. * Setup the skybox material according to the specified options.
  57272. */
  57273. private _setupSkyboxMaterial;
  57274. /**
  57275. * Setup the skybox reflection texture according to the specified options.
  57276. */
  57277. private _setupSkyboxReflectionTexture;
  57278. private _errorHandler;
  57279. /**
  57280. * Dispose all the elements created by the Helper.
  57281. */
  57282. dispose(): void;
  57283. }
  57284. }
  57285. declare module "babylonjs/Helpers/textureDome" {
  57286. import { Scene } from "babylonjs/scene";
  57287. import { TransformNode } from "babylonjs/Meshes/transformNode";
  57288. import { Mesh } from "babylonjs/Meshes/mesh";
  57289. import { Texture } from "babylonjs/Materials/Textures/texture";
  57290. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  57291. import "babylonjs/Meshes/Builders/sphereBuilder";
  57292. import { Nullable } from "babylonjs/types";
  57293. import { Observable } from "babylonjs/Misc/observable";
  57294. /**
  57295. * Display a 360/180 degree texture on an approximately spherical surface, useful for VR applications or skyboxes.
  57296. * As a subclass of TransformNode, this allow parenting to the camera or multiple textures with different locations in the scene.
  57297. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  57298. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  57299. */
  57300. export abstract class TextureDome<T extends Texture> extends TransformNode {
  57301. protected onError: Nullable<(message?: string, exception?: any) => void>;
  57302. /**
  57303. * Define the source as a Monoscopic panoramic 360/180.
  57304. */
  57305. static readonly MODE_MONOSCOPIC: number;
  57306. /**
  57307. * Define the source as a Stereoscopic TopBottom/OverUnder panoramic 360/180.
  57308. */
  57309. static readonly MODE_TOPBOTTOM: number;
  57310. /**
  57311. * Define the source as a Stereoscopic Side by Side panoramic 360/180.
  57312. */
  57313. static readonly MODE_SIDEBYSIDE: number;
  57314. private _halfDome;
  57315. protected _useDirectMapping: boolean;
  57316. /**
  57317. * The texture being displayed on the sphere
  57318. */
  57319. protected _texture: T;
  57320. /**
  57321. * Gets the texture being displayed on the sphere
  57322. */
  57323. get texture(): T;
  57324. /**
  57325. * Sets the texture being displayed on the sphere
  57326. */
  57327. set texture(newTexture: T);
  57328. /**
  57329. * The skybox material
  57330. */
  57331. protected _material: BackgroundMaterial;
  57332. /**
  57333. * The surface used for the dome
  57334. */
  57335. protected _mesh: Mesh;
  57336. /**
  57337. * Gets the mesh used for the dome.
  57338. */
  57339. get mesh(): Mesh;
  57340. /**
  57341. * A mesh that will be used to mask the back of the dome in case it is a 180 degree movie.
  57342. */
  57343. private _halfDomeMask;
  57344. /**
  57345. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  57346. * Also see the options.resolution property.
  57347. */
  57348. get fovMultiplier(): number;
  57349. set fovMultiplier(value: number);
  57350. protected _textureMode: number;
  57351. /**
  57352. * Gets or set the current texture mode for the texture. It can be:
  57353. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57354. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57355. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57356. */
  57357. get textureMode(): number;
  57358. /**
  57359. * Sets the current texture mode for the texture. It can be:
  57360. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57361. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57362. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57363. */
  57364. set textureMode(value: number);
  57365. /**
  57366. * Is it a 180 degrees dome (half dome) or 360 texture (full dome)
  57367. */
  57368. get halfDome(): boolean;
  57369. /**
  57370. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  57371. */
  57372. set halfDome(enabled: boolean);
  57373. /**
  57374. * Oberserver used in Stereoscopic VR Mode.
  57375. */
  57376. private _onBeforeCameraRenderObserver;
  57377. /**
  57378. * Observable raised when an error occured while loading the 360 image
  57379. */
  57380. onLoadErrorObservable: Observable<string>;
  57381. /**
  57382. * Create an instance of this class and pass through the parameters to the relevant classes- Texture, StandardMaterial, and Mesh.
  57383. * @param name Element's name, child elements will append suffixes for their own names.
  57384. * @param textureUrlOrElement defines the url(s) or the (video) HTML element to use
  57385. * @param options An object containing optional or exposed sub element properties
  57386. */
  57387. constructor(name: string, textureUrlOrElement: string | string[] | HTMLVideoElement, options: {
  57388. resolution?: number;
  57389. clickToPlay?: boolean;
  57390. autoPlay?: boolean;
  57391. loop?: boolean;
  57392. size?: number;
  57393. poster?: string;
  57394. faceForward?: boolean;
  57395. useDirectMapping?: boolean;
  57396. halfDomeMode?: boolean;
  57397. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  57398. protected abstract _initTexture(urlsOrElement: string | string[] | HTMLElement, scene: Scene, options: any): T;
  57399. protected _changeTextureMode(value: number): void;
  57400. /**
  57401. * Releases resources associated with this node.
  57402. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  57403. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  57404. */
  57405. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  57406. }
  57407. }
  57408. declare module "babylonjs/Helpers/photoDome" {
  57409. import { Scene } from "babylonjs/scene";
  57410. import { Texture } from "babylonjs/Materials/Textures/texture";
  57411. import { TextureDome } from "babylonjs/Helpers/textureDome";
  57412. /**
  57413. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  57414. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  57415. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  57416. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  57417. */
  57418. export class PhotoDome extends TextureDome<Texture> {
  57419. /**
  57420. * Define the image as a Monoscopic panoramic 360 image.
  57421. */
  57422. static readonly MODE_MONOSCOPIC: number;
  57423. /**
  57424. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  57425. */
  57426. static readonly MODE_TOPBOTTOM: number;
  57427. /**
  57428. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  57429. */
  57430. static readonly MODE_SIDEBYSIDE: number;
  57431. /**
  57432. * Gets or sets the texture being displayed on the sphere
  57433. */
  57434. get photoTexture(): Texture;
  57435. /**
  57436. * sets the texture being displayed on the sphere
  57437. */
  57438. set photoTexture(value: Texture);
  57439. /**
  57440. * Gets the current video mode for the video. It can be:
  57441. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57442. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57443. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57444. */
  57445. get imageMode(): number;
  57446. /**
  57447. * Sets the current video mode for the video. It can be:
  57448. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57449. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57450. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57451. */
  57452. set imageMode(value: number);
  57453. protected _initTexture(urlsOrElement: string, scene: Scene, options: any): Texture;
  57454. }
  57455. }
  57456. declare module "babylonjs/Misc/rgbdTextureTools" {
  57457. import "babylonjs/Shaders/rgbdDecode.fragment";
  57458. import "babylonjs/Engines/Extensions/engine.renderTarget";
  57459. import { Texture } from "babylonjs/Materials/Textures/texture";
  57460. /**
  57461. * Class used to host RGBD texture specific utilities
  57462. */
  57463. export class RGBDTextureTools {
  57464. /**
  57465. * Expand the RGBD Texture from RGBD to Half Float if possible.
  57466. * @param texture the texture to expand.
  57467. */
  57468. static ExpandRGBDTexture(texture: Texture): void;
  57469. }
  57470. }
  57471. declare module "babylonjs/Misc/brdfTextureTools" {
  57472. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57473. import { Scene } from "babylonjs/scene";
  57474. /**
  57475. * Class used to host texture specific utilities
  57476. */
  57477. export class BRDFTextureTools {
  57478. /**
  57479. * Prevents texture cache collision
  57480. */
  57481. private static _instanceNumber;
  57482. /**
  57483. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  57484. * @param scene defines the hosting scene
  57485. * @returns the environment BRDF texture
  57486. */
  57487. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  57488. private static _environmentBRDFBase64Texture;
  57489. }
  57490. }
  57491. declare module "babylonjs/Materials/PBR/pbrClearCoatConfiguration" {
  57492. import { Nullable } from "babylonjs/types";
  57493. import { Color3 } from "babylonjs/Maths/math.color";
  57494. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57495. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57496. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57497. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57498. import { Engine } from "babylonjs/Engines/engine";
  57499. import { Scene } from "babylonjs/scene";
  57500. /**
  57501. * @hidden
  57502. */
  57503. export interface IMaterialClearCoatDefines {
  57504. CLEARCOAT: boolean;
  57505. CLEARCOAT_DEFAULTIOR: boolean;
  57506. CLEARCOAT_TEXTURE: boolean;
  57507. CLEARCOAT_TEXTUREDIRECTUV: number;
  57508. CLEARCOAT_BUMP: boolean;
  57509. CLEARCOAT_BUMPDIRECTUV: number;
  57510. CLEARCOAT_TINT: boolean;
  57511. CLEARCOAT_TINT_TEXTURE: boolean;
  57512. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  57513. /** @hidden */
  57514. _areTexturesDirty: boolean;
  57515. }
  57516. /**
  57517. * Define the code related to the clear coat parameters of the pbr material.
  57518. */
  57519. export class PBRClearCoatConfiguration {
  57520. /**
  57521. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  57522. * The default fits with a polyurethane material.
  57523. */
  57524. private static readonly _DefaultIndexOfRefraction;
  57525. private _isEnabled;
  57526. /**
  57527. * Defines if the clear coat is enabled in the material.
  57528. */
  57529. isEnabled: boolean;
  57530. /**
  57531. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  57532. */
  57533. intensity: number;
  57534. /**
  57535. * Defines the clear coat layer roughness.
  57536. */
  57537. roughness: number;
  57538. private _indexOfRefraction;
  57539. /**
  57540. * Defines the index of refraction of the clear coat.
  57541. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  57542. * The default fits with a polyurethane material.
  57543. * Changing the default value is more performance intensive.
  57544. */
  57545. indexOfRefraction: number;
  57546. private _texture;
  57547. /**
  57548. * Stores the clear coat values in a texture.
  57549. */
  57550. texture: Nullable<BaseTexture>;
  57551. private _bumpTexture;
  57552. /**
  57553. * Define the clear coat specific bump texture.
  57554. */
  57555. bumpTexture: Nullable<BaseTexture>;
  57556. private _isTintEnabled;
  57557. /**
  57558. * Defines if the clear coat tint is enabled in the material.
  57559. */
  57560. isTintEnabled: boolean;
  57561. /**
  57562. * Defines the clear coat tint of the material.
  57563. * This is only use if tint is enabled
  57564. */
  57565. tintColor: Color3;
  57566. /**
  57567. * Defines the distance at which the tint color should be found in the
  57568. * clear coat media.
  57569. * This is only use if tint is enabled
  57570. */
  57571. tintColorAtDistance: number;
  57572. /**
  57573. * Defines the clear coat layer thickness.
  57574. * This is only use if tint is enabled
  57575. */
  57576. tintThickness: number;
  57577. private _tintTexture;
  57578. /**
  57579. * Stores the clear tint values in a texture.
  57580. * rgb is tint
  57581. * a is a thickness factor
  57582. */
  57583. tintTexture: Nullable<BaseTexture>;
  57584. /** @hidden */
  57585. private _internalMarkAllSubMeshesAsTexturesDirty;
  57586. /** @hidden */
  57587. _markAllSubMeshesAsTexturesDirty(): void;
  57588. /**
  57589. * Instantiate a new istance of clear coat configuration.
  57590. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57591. */
  57592. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  57593. /**
  57594. * Gets wehter the submesh is ready to be used or not.
  57595. * @param defines the list of "defines" to update.
  57596. * @param scene defines the scene the material belongs to.
  57597. * @param engine defines the engine the material belongs to.
  57598. * @param disableBumpMap defines wether the material disables bump or not.
  57599. * @returns - boolean indicating that the submesh is ready or not.
  57600. */
  57601. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  57602. /**
  57603. * Checks to see if a texture is used in the material.
  57604. * @param defines the list of "defines" to update.
  57605. * @param scene defines the scene to the material belongs to.
  57606. */
  57607. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  57608. /**
  57609. * Binds the material data.
  57610. * @param uniformBuffer defines the Uniform buffer to fill in.
  57611. * @param scene defines the scene the material belongs to.
  57612. * @param engine defines the engine the material belongs to.
  57613. * @param disableBumpMap defines wether the material disables bump or not.
  57614. * @param isFrozen defines wether the material is frozen or not.
  57615. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  57616. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  57617. */
  57618. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  57619. /**
  57620. * Checks to see if a texture is used in the material.
  57621. * @param texture - Base texture to use.
  57622. * @returns - Boolean specifying if a texture is used in the material.
  57623. */
  57624. hasTexture(texture: BaseTexture): boolean;
  57625. /**
  57626. * Returns an array of the actively used textures.
  57627. * @param activeTextures Array of BaseTextures
  57628. */
  57629. getActiveTextures(activeTextures: BaseTexture[]): void;
  57630. /**
  57631. * Returns the animatable textures.
  57632. * @param animatables Array of animatable textures.
  57633. */
  57634. getAnimatables(animatables: IAnimatable[]): void;
  57635. /**
  57636. * Disposes the resources of the material.
  57637. * @param forceDisposeTextures - Forces the disposal of all textures.
  57638. */
  57639. dispose(forceDisposeTextures?: boolean): void;
  57640. /**
  57641. * Get the current class name of the texture useful for serialization or dynamic coding.
  57642. * @returns "PBRClearCoatConfiguration"
  57643. */
  57644. getClassName(): string;
  57645. /**
  57646. * Add fallbacks to the effect fallbacks list.
  57647. * @param defines defines the Base texture to use.
  57648. * @param fallbacks defines the current fallback list.
  57649. * @param currentRank defines the current fallback rank.
  57650. * @returns the new fallback rank.
  57651. */
  57652. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57653. /**
  57654. * Add the required uniforms to the current list.
  57655. * @param uniforms defines the current uniform list.
  57656. */
  57657. static AddUniforms(uniforms: string[]): void;
  57658. /**
  57659. * Add the required samplers to the current list.
  57660. * @param samplers defines the current sampler list.
  57661. */
  57662. static AddSamplers(samplers: string[]): void;
  57663. /**
  57664. * Add the required uniforms to the current buffer.
  57665. * @param uniformBuffer defines the current uniform buffer.
  57666. */
  57667. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57668. /**
  57669. * Makes a duplicate of the current configuration into another one.
  57670. * @param clearCoatConfiguration define the config where to copy the info
  57671. */
  57672. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  57673. /**
  57674. * Serializes this clear coat configuration.
  57675. * @returns - An object with the serialized config.
  57676. */
  57677. serialize(): any;
  57678. /**
  57679. * Parses a anisotropy Configuration from a serialized object.
  57680. * @param source - Serialized object.
  57681. * @param scene Defines the scene we are parsing for
  57682. * @param rootUrl Defines the rootUrl to load from
  57683. */
  57684. parse(source: any, scene: Scene, rootUrl: string): void;
  57685. }
  57686. }
  57687. declare module "babylonjs/Materials/PBR/pbrAnisotropicConfiguration" {
  57688. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57689. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57690. import { Vector2 } from "babylonjs/Maths/math.vector";
  57691. import { Scene } from "babylonjs/scene";
  57692. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57693. import { Nullable } from "babylonjs/types";
  57694. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57695. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57696. /**
  57697. * @hidden
  57698. */
  57699. export interface IMaterialAnisotropicDefines {
  57700. ANISOTROPIC: boolean;
  57701. ANISOTROPIC_TEXTURE: boolean;
  57702. ANISOTROPIC_TEXTUREDIRECTUV: number;
  57703. MAINUV1: boolean;
  57704. _areTexturesDirty: boolean;
  57705. _needUVs: boolean;
  57706. }
  57707. /**
  57708. * Define the code related to the anisotropic parameters of the pbr material.
  57709. */
  57710. export class PBRAnisotropicConfiguration {
  57711. private _isEnabled;
  57712. /**
  57713. * Defines if the anisotropy is enabled in the material.
  57714. */
  57715. isEnabled: boolean;
  57716. /**
  57717. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  57718. */
  57719. intensity: number;
  57720. /**
  57721. * Defines if the effect is along the tangents, bitangents or in between.
  57722. * By default, the effect is "strectching" the highlights along the tangents.
  57723. */
  57724. direction: Vector2;
  57725. private _texture;
  57726. /**
  57727. * Stores the anisotropy values in a texture.
  57728. * rg is direction (like normal from -1 to 1)
  57729. * b is a intensity
  57730. */
  57731. texture: Nullable<BaseTexture>;
  57732. /** @hidden */
  57733. private _internalMarkAllSubMeshesAsTexturesDirty;
  57734. /** @hidden */
  57735. _markAllSubMeshesAsTexturesDirty(): void;
  57736. /**
  57737. * Instantiate a new istance of anisotropy configuration.
  57738. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57739. */
  57740. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  57741. /**
  57742. * Specifies that the submesh is ready to be used.
  57743. * @param defines the list of "defines" to update.
  57744. * @param scene defines the scene the material belongs to.
  57745. * @returns - boolean indicating that the submesh is ready or not.
  57746. */
  57747. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  57748. /**
  57749. * Checks to see if a texture is used in the material.
  57750. * @param defines the list of "defines" to update.
  57751. * @param mesh the mesh we are preparing the defines for.
  57752. * @param scene defines the scene the material belongs to.
  57753. */
  57754. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  57755. /**
  57756. * Binds the material data.
  57757. * @param uniformBuffer defines the Uniform buffer to fill in.
  57758. * @param scene defines the scene the material belongs to.
  57759. * @param isFrozen defines wether the material is frozen or not.
  57760. */
  57761. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  57762. /**
  57763. * Checks to see if a texture is used in the material.
  57764. * @param texture - Base texture to use.
  57765. * @returns - Boolean specifying if a texture is used in the material.
  57766. */
  57767. hasTexture(texture: BaseTexture): boolean;
  57768. /**
  57769. * Returns an array of the actively used textures.
  57770. * @param activeTextures Array of BaseTextures
  57771. */
  57772. getActiveTextures(activeTextures: BaseTexture[]): void;
  57773. /**
  57774. * Returns the animatable textures.
  57775. * @param animatables Array of animatable textures.
  57776. */
  57777. getAnimatables(animatables: IAnimatable[]): void;
  57778. /**
  57779. * Disposes the resources of the material.
  57780. * @param forceDisposeTextures - Forces the disposal of all textures.
  57781. */
  57782. dispose(forceDisposeTextures?: boolean): void;
  57783. /**
  57784. * Get the current class name of the texture useful for serialization or dynamic coding.
  57785. * @returns "PBRAnisotropicConfiguration"
  57786. */
  57787. getClassName(): string;
  57788. /**
  57789. * Add fallbacks to the effect fallbacks list.
  57790. * @param defines defines the Base texture to use.
  57791. * @param fallbacks defines the current fallback list.
  57792. * @param currentRank defines the current fallback rank.
  57793. * @returns the new fallback rank.
  57794. */
  57795. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57796. /**
  57797. * Add the required uniforms to the current list.
  57798. * @param uniforms defines the current uniform list.
  57799. */
  57800. static AddUniforms(uniforms: string[]): void;
  57801. /**
  57802. * Add the required uniforms to the current buffer.
  57803. * @param uniformBuffer defines the current uniform buffer.
  57804. */
  57805. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57806. /**
  57807. * Add the required samplers to the current list.
  57808. * @param samplers defines the current sampler list.
  57809. */
  57810. static AddSamplers(samplers: string[]): void;
  57811. /**
  57812. * Makes a duplicate of the current configuration into another one.
  57813. * @param anisotropicConfiguration define the config where to copy the info
  57814. */
  57815. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  57816. /**
  57817. * Serializes this anisotropy configuration.
  57818. * @returns - An object with the serialized config.
  57819. */
  57820. serialize(): any;
  57821. /**
  57822. * Parses a anisotropy Configuration from a serialized object.
  57823. * @param source - Serialized object.
  57824. * @param scene Defines the scene we are parsing for
  57825. * @param rootUrl Defines the rootUrl to load from
  57826. */
  57827. parse(source: any, scene: Scene, rootUrl: string): void;
  57828. }
  57829. }
  57830. declare module "babylonjs/Materials/PBR/pbrBRDFConfiguration" {
  57831. import { Scene } from "babylonjs/scene";
  57832. /**
  57833. * @hidden
  57834. */
  57835. export interface IMaterialBRDFDefines {
  57836. BRDF_V_HEIGHT_CORRELATED: boolean;
  57837. MS_BRDF_ENERGY_CONSERVATION: boolean;
  57838. SPHERICAL_HARMONICS: boolean;
  57839. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  57840. /** @hidden */
  57841. _areMiscDirty: boolean;
  57842. }
  57843. /**
  57844. * Define the code related to the BRDF parameters of the pbr material.
  57845. */
  57846. export class PBRBRDFConfiguration {
  57847. /**
  57848. * Default value used for the energy conservation.
  57849. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  57850. */
  57851. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  57852. /**
  57853. * Default value used for the Smith Visibility Height Correlated mode.
  57854. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  57855. */
  57856. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  57857. /**
  57858. * Default value used for the IBL diffuse part.
  57859. * This can help switching back to the polynomials mode globally which is a tiny bit
  57860. * less GPU intensive at the drawback of a lower quality.
  57861. */
  57862. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  57863. /**
  57864. * Default value used for activating energy conservation for the specular workflow.
  57865. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  57866. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  57867. */
  57868. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  57869. private _useEnergyConservation;
  57870. /**
  57871. * Defines if the material uses energy conservation.
  57872. */
  57873. useEnergyConservation: boolean;
  57874. private _useSmithVisibilityHeightCorrelated;
  57875. /**
  57876. * LEGACY Mode set to false
  57877. * Defines if the material uses height smith correlated visibility term.
  57878. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  57879. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  57880. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  57881. * Not relying on height correlated will also disable energy conservation.
  57882. */
  57883. useSmithVisibilityHeightCorrelated: boolean;
  57884. private _useSphericalHarmonics;
  57885. /**
  57886. * LEGACY Mode set to false
  57887. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  57888. * diffuse part of the IBL.
  57889. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  57890. * to the ground truth.
  57891. */
  57892. useSphericalHarmonics: boolean;
  57893. private _useSpecularGlossinessInputEnergyConservation;
  57894. /**
  57895. * Defines if the material uses energy conservation, when the specular workflow is active.
  57896. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  57897. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  57898. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  57899. */
  57900. useSpecularGlossinessInputEnergyConservation: boolean;
  57901. /** @hidden */
  57902. private _internalMarkAllSubMeshesAsMiscDirty;
  57903. /** @hidden */
  57904. _markAllSubMeshesAsMiscDirty(): void;
  57905. /**
  57906. * Instantiate a new istance of clear coat configuration.
  57907. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  57908. */
  57909. constructor(markAllSubMeshesAsMiscDirty: () => void);
  57910. /**
  57911. * Checks to see if a texture is used in the material.
  57912. * @param defines the list of "defines" to update.
  57913. */
  57914. prepareDefines(defines: IMaterialBRDFDefines): void;
  57915. /**
  57916. * Get the current class name of the texture useful for serialization or dynamic coding.
  57917. * @returns "PBRClearCoatConfiguration"
  57918. */
  57919. getClassName(): string;
  57920. /**
  57921. * Makes a duplicate of the current configuration into another one.
  57922. * @param brdfConfiguration define the config where to copy the info
  57923. */
  57924. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  57925. /**
  57926. * Serializes this BRDF configuration.
  57927. * @returns - An object with the serialized config.
  57928. */
  57929. serialize(): any;
  57930. /**
  57931. * Parses a anisotropy Configuration from a serialized object.
  57932. * @param source - Serialized object.
  57933. * @param scene Defines the scene we are parsing for
  57934. * @param rootUrl Defines the rootUrl to load from
  57935. */
  57936. parse(source: any, scene: Scene, rootUrl: string): void;
  57937. }
  57938. }
  57939. declare module "babylonjs/Materials/PBR/pbrSheenConfiguration" {
  57940. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57941. import { Color3 } from "babylonjs/Maths/math.color";
  57942. import { Scene } from "babylonjs/scene";
  57943. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57944. import { Nullable } from "babylonjs/types";
  57945. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57946. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57947. /**
  57948. * @hidden
  57949. */
  57950. export interface IMaterialSheenDefines {
  57951. SHEEN: boolean;
  57952. SHEEN_TEXTURE: boolean;
  57953. SHEEN_TEXTUREDIRECTUV: number;
  57954. SHEEN_LINKWITHALBEDO: boolean;
  57955. SHEEN_ROUGHNESS: boolean;
  57956. SHEEN_ALBEDOSCALING: boolean;
  57957. /** @hidden */
  57958. _areTexturesDirty: boolean;
  57959. }
  57960. /**
  57961. * Define the code related to the Sheen parameters of the pbr material.
  57962. */
  57963. export class PBRSheenConfiguration {
  57964. private _isEnabled;
  57965. /**
  57966. * Defines if the material uses sheen.
  57967. */
  57968. isEnabled: boolean;
  57969. private _linkSheenWithAlbedo;
  57970. /**
  57971. * Defines if the sheen is linked to the sheen color.
  57972. */
  57973. linkSheenWithAlbedo: boolean;
  57974. /**
  57975. * Defines the sheen intensity.
  57976. */
  57977. intensity: number;
  57978. /**
  57979. * Defines the sheen color.
  57980. */
  57981. color: Color3;
  57982. private _texture;
  57983. /**
  57984. * Stores the sheen tint values in a texture.
  57985. * rgb is tint
  57986. * a is a intensity or roughness if roughness has been defined
  57987. */
  57988. texture: Nullable<BaseTexture>;
  57989. private _roughness;
  57990. /**
  57991. * Defines the sheen roughness.
  57992. * It is not taken into account if linkSheenWithAlbedo is true.
  57993. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  57994. */
  57995. roughness: Nullable<number>;
  57996. private _albedoScaling;
  57997. /**
  57998. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  57999. * It allows the strength of the sheen effect to not depend on the base color of the material,
  58000. * making it easier to setup and tweak the effect
  58001. */
  58002. albedoScaling: boolean;
  58003. /** @hidden */
  58004. private _internalMarkAllSubMeshesAsTexturesDirty;
  58005. /** @hidden */
  58006. _markAllSubMeshesAsTexturesDirty(): void;
  58007. /**
  58008. * Instantiate a new istance of clear coat configuration.
  58009. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  58010. */
  58011. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  58012. /**
  58013. * Specifies that the submesh is ready to be used.
  58014. * @param defines the list of "defines" to update.
  58015. * @param scene defines the scene the material belongs to.
  58016. * @returns - boolean indicating that the submesh is ready or not.
  58017. */
  58018. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  58019. /**
  58020. * Checks to see if a texture is used in the material.
  58021. * @param defines the list of "defines" to update.
  58022. * @param scene defines the scene the material belongs to.
  58023. */
  58024. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  58025. /**
  58026. * Binds the material data.
  58027. * @param uniformBuffer defines the Uniform buffer to fill in.
  58028. * @param scene defines the scene the material belongs to.
  58029. * @param isFrozen defines wether the material is frozen or not.
  58030. */
  58031. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  58032. /**
  58033. * Checks to see if a texture is used in the material.
  58034. * @param texture - Base texture to use.
  58035. * @returns - Boolean specifying if a texture is used in the material.
  58036. */
  58037. hasTexture(texture: BaseTexture): boolean;
  58038. /**
  58039. * Returns an array of the actively used textures.
  58040. * @param activeTextures Array of BaseTextures
  58041. */
  58042. getActiveTextures(activeTextures: BaseTexture[]): void;
  58043. /**
  58044. * Returns the animatable textures.
  58045. * @param animatables Array of animatable textures.
  58046. */
  58047. getAnimatables(animatables: IAnimatable[]): void;
  58048. /**
  58049. * Disposes the resources of the material.
  58050. * @param forceDisposeTextures - Forces the disposal of all textures.
  58051. */
  58052. dispose(forceDisposeTextures?: boolean): void;
  58053. /**
  58054. * Get the current class name of the texture useful for serialization or dynamic coding.
  58055. * @returns "PBRSheenConfiguration"
  58056. */
  58057. getClassName(): string;
  58058. /**
  58059. * Add fallbacks to the effect fallbacks list.
  58060. * @param defines defines the Base texture to use.
  58061. * @param fallbacks defines the current fallback list.
  58062. * @param currentRank defines the current fallback rank.
  58063. * @returns the new fallback rank.
  58064. */
  58065. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  58066. /**
  58067. * Add the required uniforms to the current list.
  58068. * @param uniforms defines the current uniform list.
  58069. */
  58070. static AddUniforms(uniforms: string[]): void;
  58071. /**
  58072. * Add the required uniforms to the current buffer.
  58073. * @param uniformBuffer defines the current uniform buffer.
  58074. */
  58075. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  58076. /**
  58077. * Add the required samplers to the current list.
  58078. * @param samplers defines the current sampler list.
  58079. */
  58080. static AddSamplers(samplers: string[]): void;
  58081. /**
  58082. * Makes a duplicate of the current configuration into another one.
  58083. * @param sheenConfiguration define the config where to copy the info
  58084. */
  58085. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  58086. /**
  58087. * Serializes this BRDF configuration.
  58088. * @returns - An object with the serialized config.
  58089. */
  58090. serialize(): any;
  58091. /**
  58092. * Parses a anisotropy Configuration from a serialized object.
  58093. * @param source - Serialized object.
  58094. * @param scene Defines the scene we are parsing for
  58095. * @param rootUrl Defines the rootUrl to load from
  58096. */
  58097. parse(source: any, scene: Scene, rootUrl: string): void;
  58098. }
  58099. }
  58100. declare module "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration" {
  58101. import { Nullable } from "babylonjs/types";
  58102. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  58103. import { Color3 } from "babylonjs/Maths/math.color";
  58104. import { SmartArray } from "babylonjs/Misc/smartArray";
  58105. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58106. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  58107. import { Effect } from "babylonjs/Materials/effect";
  58108. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  58109. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  58110. import { Engine } from "babylonjs/Engines/engine";
  58111. import { Scene } from "babylonjs/scene";
  58112. /**
  58113. * @hidden
  58114. */
  58115. export interface IMaterialSubSurfaceDefines {
  58116. SUBSURFACE: boolean;
  58117. SS_REFRACTION: boolean;
  58118. SS_TRANSLUCENCY: boolean;
  58119. SS_SCATTERING: boolean;
  58120. SS_THICKNESSANDMASK_TEXTURE: boolean;
  58121. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  58122. SS_REFRACTIONMAP_3D: boolean;
  58123. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  58124. SS_LODINREFRACTIONALPHA: boolean;
  58125. SS_GAMMAREFRACTION: boolean;
  58126. SS_RGBDREFRACTION: boolean;
  58127. SS_LINEARSPECULARREFRACTION: boolean;
  58128. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  58129. SS_ALBEDOFORREFRACTIONTINT: boolean;
  58130. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  58131. /** @hidden */
  58132. _areTexturesDirty: boolean;
  58133. }
  58134. /**
  58135. * Define the code related to the sub surface parameters of the pbr material.
  58136. */
  58137. export class PBRSubSurfaceConfiguration {
  58138. private _isRefractionEnabled;
  58139. /**
  58140. * Defines if the refraction is enabled in the material.
  58141. */
  58142. isRefractionEnabled: boolean;
  58143. private _isTranslucencyEnabled;
  58144. /**
  58145. * Defines if the translucency is enabled in the material.
  58146. */
  58147. isTranslucencyEnabled: boolean;
  58148. private _isScatteringEnabled;
  58149. /**
  58150. * Defines if the sub surface scattering is enabled in the material.
  58151. */
  58152. isScatteringEnabled: boolean;
  58153. private _scatteringDiffusionProfileIndex;
  58154. /**
  58155. * Diffusion profile for subsurface scattering.
  58156. * Useful for better scattering in the skins or foliages.
  58157. */
  58158. get scatteringDiffusionProfile(): Nullable<Color3>;
  58159. set scatteringDiffusionProfile(c: Nullable<Color3>);
  58160. /**
  58161. * Defines the refraction intensity of the material.
  58162. * The refraction when enabled replaces the Diffuse part of the material.
  58163. * The intensity helps transitionning between diffuse and refraction.
  58164. */
  58165. refractionIntensity: number;
  58166. /**
  58167. * Defines the translucency intensity of the material.
  58168. * When translucency has been enabled, this defines how much of the "translucency"
  58169. * is addded to the diffuse part of the material.
  58170. */
  58171. translucencyIntensity: number;
  58172. /**
  58173. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  58174. */
  58175. useAlbedoToTintRefraction: boolean;
  58176. private _thicknessTexture;
  58177. /**
  58178. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  58179. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  58180. * 0 would mean minimumThickness
  58181. * 1 would mean maximumThickness
  58182. * The other channels might be use as a mask to vary the different effects intensity.
  58183. */
  58184. thicknessTexture: Nullable<BaseTexture>;
  58185. private _refractionTexture;
  58186. /**
  58187. * Defines the texture to use for refraction.
  58188. */
  58189. refractionTexture: Nullable<BaseTexture>;
  58190. private _indexOfRefraction;
  58191. /**
  58192. * Index of refraction of the material base layer.
  58193. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  58194. *
  58195. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  58196. *
  58197. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  58198. */
  58199. indexOfRefraction: number;
  58200. private _volumeIndexOfRefraction;
  58201. /**
  58202. * Index of refraction of the material's volume.
  58203. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  58204. *
  58205. * This ONLY impacts refraction. If not provided or given a non-valid value,
  58206. * the volume will use the same IOR as the surface.
  58207. */
  58208. get volumeIndexOfRefraction(): number;
  58209. set volumeIndexOfRefraction(value: number);
  58210. private _invertRefractionY;
  58211. /**
  58212. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  58213. */
  58214. invertRefractionY: boolean;
  58215. private _linkRefractionWithTransparency;
  58216. /**
  58217. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  58218. * Materials half opaque for instance using refraction could benefit from this control.
  58219. */
  58220. linkRefractionWithTransparency: boolean;
  58221. /**
  58222. * Defines the minimum thickness stored in the thickness map.
  58223. * If no thickness map is defined, this value will be used to simulate thickness.
  58224. */
  58225. minimumThickness: number;
  58226. /**
  58227. * Defines the maximum thickness stored in the thickness map.
  58228. */
  58229. maximumThickness: number;
  58230. /**
  58231. * Defines the volume tint of the material.
  58232. * This is used for both translucency and scattering.
  58233. */
  58234. tintColor: Color3;
  58235. /**
  58236. * Defines the distance at which the tint color should be found in the media.
  58237. * This is used for refraction only.
  58238. */
  58239. tintColorAtDistance: number;
  58240. /**
  58241. * Defines how far each channel transmit through the media.
  58242. * It is defined as a color to simplify it selection.
  58243. */
  58244. diffusionDistance: Color3;
  58245. private _useMaskFromThicknessTexture;
  58246. /**
  58247. * Stores the intensity of the different subsurface effects in the thickness texture.
  58248. * * the green channel is the translucency intensity.
  58249. * * the blue channel is the scattering intensity.
  58250. * * the alpha channel is the refraction intensity.
  58251. */
  58252. useMaskFromThicknessTexture: boolean;
  58253. private _scene;
  58254. /** @hidden */
  58255. private _internalMarkAllSubMeshesAsTexturesDirty;
  58256. private _internalMarkScenePrePassDirty;
  58257. /** @hidden */
  58258. _markAllSubMeshesAsTexturesDirty(): void;
  58259. /** @hidden */
  58260. _markScenePrePassDirty(): void;
  58261. /**
  58262. * Instantiate a new istance of sub surface configuration.
  58263. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  58264. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  58265. * @param scene The scene
  58266. */
  58267. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  58268. /**
  58269. * Gets wehter the submesh is ready to be used or not.
  58270. * @param defines the list of "defines" to update.
  58271. * @param scene defines the scene the material belongs to.
  58272. * @returns - boolean indicating that the submesh is ready or not.
  58273. */
  58274. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  58275. /**
  58276. * Checks to see if a texture is used in the material.
  58277. * @param defines the list of "defines" to update.
  58278. * @param scene defines the scene to the material belongs to.
  58279. */
  58280. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  58281. /**
  58282. * Binds the material data.
  58283. * @param uniformBuffer defines the Uniform buffer to fill in.
  58284. * @param scene defines the scene the material belongs to.
  58285. * @param engine defines the engine the material belongs to.
  58286. * @param isFrozen defines whether the material is frozen or not.
  58287. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  58288. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  58289. */
  58290. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  58291. /**
  58292. * Unbinds the material from the mesh.
  58293. * @param activeEffect defines the effect that should be unbound from.
  58294. * @returns true if unbound, otherwise false
  58295. */
  58296. unbind(activeEffect: Effect): boolean;
  58297. /**
  58298. * Returns the texture used for refraction or null if none is used.
  58299. * @param scene defines the scene the material belongs to.
  58300. * @returns - Refraction texture if present. If no refraction texture and refraction
  58301. * is linked with transparency, returns environment texture. Otherwise, returns null.
  58302. */
  58303. private _getRefractionTexture;
  58304. /**
  58305. * Returns true if alpha blending should be disabled.
  58306. */
  58307. get disableAlphaBlending(): boolean;
  58308. /**
  58309. * Fills the list of render target textures.
  58310. * @param renderTargets the list of render targets to update
  58311. */
  58312. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  58313. /**
  58314. * Checks to see if a texture is used in the material.
  58315. * @param texture - Base texture to use.
  58316. * @returns - Boolean specifying if a texture is used in the material.
  58317. */
  58318. hasTexture(texture: BaseTexture): boolean;
  58319. /**
  58320. * Gets a boolean indicating that current material needs to register RTT
  58321. * @returns true if this uses a render target otherwise false.
  58322. */
  58323. hasRenderTargetTextures(): boolean;
  58324. /**
  58325. * Returns an array of the actively used textures.
  58326. * @param activeTextures Array of BaseTextures
  58327. */
  58328. getActiveTextures(activeTextures: BaseTexture[]): void;
  58329. /**
  58330. * Returns the animatable textures.
  58331. * @param animatables Array of animatable textures.
  58332. */
  58333. getAnimatables(animatables: IAnimatable[]): void;
  58334. /**
  58335. * Disposes the resources of the material.
  58336. * @param forceDisposeTextures - Forces the disposal of all textures.
  58337. */
  58338. dispose(forceDisposeTextures?: boolean): void;
  58339. /**
  58340. * Get the current class name of the texture useful for serialization or dynamic coding.
  58341. * @returns "PBRSubSurfaceConfiguration"
  58342. */
  58343. getClassName(): string;
  58344. /**
  58345. * Add fallbacks to the effect fallbacks list.
  58346. * @param defines defines the Base texture to use.
  58347. * @param fallbacks defines the current fallback list.
  58348. * @param currentRank defines the current fallback rank.
  58349. * @returns the new fallback rank.
  58350. */
  58351. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  58352. /**
  58353. * Add the required uniforms to the current list.
  58354. * @param uniforms defines the current uniform list.
  58355. */
  58356. static AddUniforms(uniforms: string[]): void;
  58357. /**
  58358. * Add the required samplers to the current list.
  58359. * @param samplers defines the current sampler list.
  58360. */
  58361. static AddSamplers(samplers: string[]): void;
  58362. /**
  58363. * Add the required uniforms to the current buffer.
  58364. * @param uniformBuffer defines the current uniform buffer.
  58365. */
  58366. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  58367. /**
  58368. * Makes a duplicate of the current configuration into another one.
  58369. * @param configuration define the config where to copy the info
  58370. */
  58371. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  58372. /**
  58373. * Serializes this Sub Surface configuration.
  58374. * @returns - An object with the serialized config.
  58375. */
  58376. serialize(): any;
  58377. /**
  58378. * Parses a anisotropy Configuration from a serialized object.
  58379. * @param source - Serialized object.
  58380. * @param scene Defines the scene we are parsing for
  58381. * @param rootUrl Defines the rootUrl to load from
  58382. */
  58383. parse(source: any, scene: Scene, rootUrl: string): void;
  58384. }
  58385. }
  58386. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration" {
  58387. /** @hidden */
  58388. export var pbrFragmentDeclaration: {
  58389. name: string;
  58390. shader: string;
  58391. };
  58392. }
  58393. declare module "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration" {
  58394. /** @hidden */
  58395. export var pbrUboDeclaration: {
  58396. name: string;
  58397. shader: string;
  58398. };
  58399. }
  58400. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration" {
  58401. /** @hidden */
  58402. export var pbrFragmentExtraDeclaration: {
  58403. name: string;
  58404. shader: string;
  58405. };
  58406. }
  58407. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration" {
  58408. /** @hidden */
  58409. export var pbrFragmentSamplersDeclaration: {
  58410. name: string;
  58411. shader: string;
  58412. };
  58413. }
  58414. declare module "babylonjs/Shaders/ShadersInclude/importanceSampling" {
  58415. /** @hidden */
  58416. export var importanceSampling: {
  58417. name: string;
  58418. shader: string;
  58419. };
  58420. }
  58421. declare module "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions" {
  58422. /** @hidden */
  58423. export var pbrHelperFunctions: {
  58424. name: string;
  58425. shader: string;
  58426. };
  58427. }
  58428. declare module "babylonjs/Shaders/ShadersInclude/harmonicsFunctions" {
  58429. /** @hidden */
  58430. export var harmonicsFunctions: {
  58431. name: string;
  58432. shader: string;
  58433. };
  58434. }
  58435. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions" {
  58436. /** @hidden */
  58437. export var pbrDirectLightingSetupFunctions: {
  58438. name: string;
  58439. shader: string;
  58440. };
  58441. }
  58442. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions" {
  58443. /** @hidden */
  58444. export var pbrDirectLightingFalloffFunctions: {
  58445. name: string;
  58446. shader: string;
  58447. };
  58448. }
  58449. declare module "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions" {
  58450. /** @hidden */
  58451. export var pbrBRDFFunctions: {
  58452. name: string;
  58453. shader: string;
  58454. };
  58455. }
  58456. declare module "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions" {
  58457. /** @hidden */
  58458. export var hdrFilteringFunctions: {
  58459. name: string;
  58460. shader: string;
  58461. };
  58462. }
  58463. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions" {
  58464. /** @hidden */
  58465. export var pbrDirectLightingFunctions: {
  58466. name: string;
  58467. shader: string;
  58468. };
  58469. }
  58470. declare module "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions" {
  58471. /** @hidden */
  58472. export var pbrIBLFunctions: {
  58473. name: string;
  58474. shader: string;
  58475. };
  58476. }
  58477. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity" {
  58478. /** @hidden */
  58479. export var pbrBlockAlbedoOpacity: {
  58480. name: string;
  58481. shader: string;
  58482. };
  58483. }
  58484. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity" {
  58485. /** @hidden */
  58486. export var pbrBlockReflectivity: {
  58487. name: string;
  58488. shader: string;
  58489. };
  58490. }
  58491. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion" {
  58492. /** @hidden */
  58493. export var pbrBlockAmbientOcclusion: {
  58494. name: string;
  58495. shader: string;
  58496. };
  58497. }
  58498. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel" {
  58499. /** @hidden */
  58500. export var pbrBlockAlphaFresnel: {
  58501. name: string;
  58502. shader: string;
  58503. };
  58504. }
  58505. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic" {
  58506. /** @hidden */
  58507. export var pbrBlockAnisotropic: {
  58508. name: string;
  58509. shader: string;
  58510. };
  58511. }
  58512. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflection" {
  58513. /** @hidden */
  58514. export var pbrBlockReflection: {
  58515. name: string;
  58516. shader: string;
  58517. };
  58518. }
  58519. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSheen" {
  58520. /** @hidden */
  58521. export var pbrBlockSheen: {
  58522. name: string;
  58523. shader: string;
  58524. };
  58525. }
  58526. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat" {
  58527. /** @hidden */
  58528. export var pbrBlockClearcoat: {
  58529. name: string;
  58530. shader: string;
  58531. };
  58532. }
  58533. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface" {
  58534. /** @hidden */
  58535. export var pbrBlockSubSurface: {
  58536. name: string;
  58537. shader: string;
  58538. };
  58539. }
  58540. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric" {
  58541. /** @hidden */
  58542. export var pbrBlockNormalGeometric: {
  58543. name: string;
  58544. shader: string;
  58545. };
  58546. }
  58547. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal" {
  58548. /** @hidden */
  58549. export var pbrBlockNormalFinal: {
  58550. name: string;
  58551. shader: string;
  58552. };
  58553. }
  58554. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit" {
  58555. /** @hidden */
  58556. export var pbrBlockLightmapInit: {
  58557. name: string;
  58558. shader: string;
  58559. };
  58560. }
  58561. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo" {
  58562. /** @hidden */
  58563. export var pbrBlockGeometryInfo: {
  58564. name: string;
  58565. shader: string;
  58566. };
  58567. }
  58568. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0" {
  58569. /** @hidden */
  58570. export var pbrBlockReflectance0: {
  58571. name: string;
  58572. shader: string;
  58573. };
  58574. }
  58575. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance" {
  58576. /** @hidden */
  58577. export var pbrBlockReflectance: {
  58578. name: string;
  58579. shader: string;
  58580. };
  58581. }
  58582. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting" {
  58583. /** @hidden */
  58584. export var pbrBlockDirectLighting: {
  58585. name: string;
  58586. shader: string;
  58587. };
  58588. }
  58589. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents" {
  58590. /** @hidden */
  58591. export var pbrBlockFinalLitComponents: {
  58592. name: string;
  58593. shader: string;
  58594. };
  58595. }
  58596. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents" {
  58597. /** @hidden */
  58598. export var pbrBlockFinalUnlitComponents: {
  58599. name: string;
  58600. shader: string;
  58601. };
  58602. }
  58603. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition" {
  58604. /** @hidden */
  58605. export var pbrBlockFinalColorComposition: {
  58606. name: string;
  58607. shader: string;
  58608. };
  58609. }
  58610. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing" {
  58611. /** @hidden */
  58612. export var pbrBlockImageProcessing: {
  58613. name: string;
  58614. shader: string;
  58615. };
  58616. }
  58617. declare module "babylonjs/Shaders/ShadersInclude/pbrDebug" {
  58618. /** @hidden */
  58619. export var pbrDebug: {
  58620. name: string;
  58621. shader: string;
  58622. };
  58623. }
  58624. declare module "babylonjs/Shaders/pbr.fragment" {
  58625. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  58626. import "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration";
  58627. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  58628. import "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration";
  58629. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  58630. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  58631. import "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration";
  58632. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  58633. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  58634. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  58635. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  58636. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58637. import "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions";
  58638. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  58639. import "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions";
  58640. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  58641. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  58642. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  58643. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions";
  58644. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions";
  58645. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  58646. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  58647. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions";
  58648. import "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions";
  58649. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  58650. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  58651. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  58652. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity";
  58653. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity";
  58654. import "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion";
  58655. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel";
  58656. import "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic";
  58657. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflection";
  58658. import "babylonjs/Shaders/ShadersInclude/pbrBlockSheen";
  58659. import "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat";
  58660. import "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface";
  58661. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  58662. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric";
  58663. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  58664. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal";
  58665. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  58666. import "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit";
  58667. import "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo";
  58668. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0";
  58669. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance";
  58670. import "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting";
  58671. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  58672. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents";
  58673. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents";
  58674. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition";
  58675. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  58676. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  58677. import "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing";
  58678. import "babylonjs/Shaders/ShadersInclude/pbrDebug";
  58679. /** @hidden */
  58680. export var pbrPixelShader: {
  58681. name: string;
  58682. shader: string;
  58683. };
  58684. }
  58685. declare module "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration" {
  58686. /** @hidden */
  58687. export var pbrVertexDeclaration: {
  58688. name: string;
  58689. shader: string;
  58690. };
  58691. }
  58692. declare module "babylonjs/Shaders/pbr.vertex" {
  58693. import "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration";
  58694. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  58695. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58696. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  58697. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  58698. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  58699. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  58700. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  58701. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  58702. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  58703. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  58704. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  58705. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  58706. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  58707. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  58708. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  58709. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  58710. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  58711. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  58712. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  58713. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  58714. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  58715. /** @hidden */
  58716. export var pbrVertexShader: {
  58717. name: string;
  58718. shader: string;
  58719. };
  58720. }
  58721. declare module "babylonjs/Materials/PBR/pbrBaseMaterial" {
  58722. import { Nullable } from "babylonjs/types";
  58723. import { Scene } from "babylonjs/scene";
  58724. import { Matrix } from "babylonjs/Maths/math.vector";
  58725. import { SubMesh } from "babylonjs/Meshes/subMesh";
  58726. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  58727. import { Mesh } from "babylonjs/Meshes/mesh";
  58728. import { IMaterialClearCoatDefines, PBRClearCoatConfiguration } from "babylonjs/Materials/PBR/pbrClearCoatConfiguration";
  58729. import { IMaterialAnisotropicDefines, PBRAnisotropicConfiguration } from "babylonjs/Materials/PBR/pbrAnisotropicConfiguration";
  58730. import { IMaterialBRDFDefines, PBRBRDFConfiguration } from "babylonjs/Materials/PBR/pbrBRDFConfiguration";
  58731. import { IMaterialSheenDefines, PBRSheenConfiguration } from "babylonjs/Materials/PBR/pbrSheenConfiguration";
  58732. import { IMaterialSubSurfaceDefines, PBRSubSurfaceConfiguration } from "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration";
  58733. import { Color3 } from "babylonjs/Maths/math.color";
  58734. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  58735. import { Material, IMaterialCompilationOptions } from "babylonjs/Materials/material";
  58736. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  58737. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  58738. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58739. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  58740. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  58741. import "babylonjs/Shaders/pbr.fragment";
  58742. import "babylonjs/Shaders/pbr.vertex";
  58743. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  58744. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  58745. /**
  58746. * Manages the defines for the PBR Material.
  58747. * @hidden
  58748. */
  58749. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  58750. PBR: boolean;
  58751. NUM_SAMPLES: string;
  58752. REALTIME_FILTERING: boolean;
  58753. MAINUV1: boolean;
  58754. MAINUV2: boolean;
  58755. UV1: boolean;
  58756. UV2: boolean;
  58757. ALBEDO: boolean;
  58758. GAMMAALBEDO: boolean;
  58759. ALBEDODIRECTUV: number;
  58760. VERTEXCOLOR: boolean;
  58761. DETAIL: boolean;
  58762. DETAILDIRECTUV: number;
  58763. DETAIL_NORMALBLENDMETHOD: number;
  58764. AMBIENT: boolean;
  58765. AMBIENTDIRECTUV: number;
  58766. AMBIENTINGRAYSCALE: boolean;
  58767. OPACITY: boolean;
  58768. VERTEXALPHA: boolean;
  58769. OPACITYDIRECTUV: number;
  58770. OPACITYRGB: boolean;
  58771. ALPHATEST: boolean;
  58772. DEPTHPREPASS: boolean;
  58773. ALPHABLEND: boolean;
  58774. ALPHAFROMALBEDO: boolean;
  58775. ALPHATESTVALUE: string;
  58776. SPECULAROVERALPHA: boolean;
  58777. RADIANCEOVERALPHA: boolean;
  58778. ALPHAFRESNEL: boolean;
  58779. LINEARALPHAFRESNEL: boolean;
  58780. PREMULTIPLYALPHA: boolean;
  58781. EMISSIVE: boolean;
  58782. EMISSIVEDIRECTUV: number;
  58783. REFLECTIVITY: boolean;
  58784. REFLECTIVITYDIRECTUV: number;
  58785. SPECULARTERM: boolean;
  58786. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  58787. MICROSURFACEAUTOMATIC: boolean;
  58788. LODBASEDMICROSFURACE: boolean;
  58789. MICROSURFACEMAP: boolean;
  58790. MICROSURFACEMAPDIRECTUV: number;
  58791. METALLICWORKFLOW: boolean;
  58792. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  58793. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  58794. METALLNESSSTOREINMETALMAPBLUE: boolean;
  58795. AOSTOREINMETALMAPRED: boolean;
  58796. METALLIC_REFLECTANCE: boolean;
  58797. METALLIC_REFLECTANCEDIRECTUV: number;
  58798. ENVIRONMENTBRDF: boolean;
  58799. ENVIRONMENTBRDF_RGBD: boolean;
  58800. NORMAL: boolean;
  58801. TANGENT: boolean;
  58802. BUMP: boolean;
  58803. BUMPDIRECTUV: number;
  58804. OBJECTSPACE_NORMALMAP: boolean;
  58805. PARALLAX: boolean;
  58806. PARALLAXOCCLUSION: boolean;
  58807. NORMALXYSCALE: boolean;
  58808. LIGHTMAP: boolean;
  58809. LIGHTMAPDIRECTUV: number;
  58810. USELIGHTMAPASSHADOWMAP: boolean;
  58811. GAMMALIGHTMAP: boolean;
  58812. RGBDLIGHTMAP: boolean;
  58813. REFLECTION: boolean;
  58814. REFLECTIONMAP_3D: boolean;
  58815. REFLECTIONMAP_SPHERICAL: boolean;
  58816. REFLECTIONMAP_PLANAR: boolean;
  58817. REFLECTIONMAP_CUBIC: boolean;
  58818. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  58819. REFLECTIONMAP_PROJECTION: boolean;
  58820. REFLECTIONMAP_SKYBOX: boolean;
  58821. REFLECTIONMAP_EXPLICIT: boolean;
  58822. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  58823. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  58824. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  58825. INVERTCUBICMAP: boolean;
  58826. USESPHERICALFROMREFLECTIONMAP: boolean;
  58827. USEIRRADIANCEMAP: boolean;
  58828. SPHERICAL_HARMONICS: boolean;
  58829. USESPHERICALINVERTEX: boolean;
  58830. REFLECTIONMAP_OPPOSITEZ: boolean;
  58831. LODINREFLECTIONALPHA: boolean;
  58832. GAMMAREFLECTION: boolean;
  58833. RGBDREFLECTION: boolean;
  58834. LINEARSPECULARREFLECTION: boolean;
  58835. RADIANCEOCCLUSION: boolean;
  58836. HORIZONOCCLUSION: boolean;
  58837. INSTANCES: boolean;
  58838. THIN_INSTANCES: boolean;
  58839. PREPASS: boolean;
  58840. SCENE_MRT_COUNT: number;
  58841. NUM_BONE_INFLUENCERS: number;
  58842. BonesPerMesh: number;
  58843. BONETEXTURE: boolean;
  58844. NONUNIFORMSCALING: boolean;
  58845. MORPHTARGETS: boolean;
  58846. MORPHTARGETS_NORMAL: boolean;
  58847. MORPHTARGETS_TANGENT: boolean;
  58848. MORPHTARGETS_UV: boolean;
  58849. NUM_MORPH_INFLUENCERS: number;
  58850. IMAGEPROCESSING: boolean;
  58851. VIGNETTE: boolean;
  58852. VIGNETTEBLENDMODEMULTIPLY: boolean;
  58853. VIGNETTEBLENDMODEOPAQUE: boolean;
  58854. TONEMAPPING: boolean;
  58855. TONEMAPPING_ACES: boolean;
  58856. CONTRAST: boolean;
  58857. COLORCURVES: boolean;
  58858. COLORGRADING: boolean;
  58859. COLORGRADING3D: boolean;
  58860. SAMPLER3DGREENDEPTH: boolean;
  58861. SAMPLER3DBGRMAP: boolean;
  58862. IMAGEPROCESSINGPOSTPROCESS: boolean;
  58863. EXPOSURE: boolean;
  58864. MULTIVIEW: boolean;
  58865. USEPHYSICALLIGHTFALLOFF: boolean;
  58866. USEGLTFLIGHTFALLOFF: boolean;
  58867. TWOSIDEDLIGHTING: boolean;
  58868. SHADOWFLOAT: boolean;
  58869. CLIPPLANE: boolean;
  58870. CLIPPLANE2: boolean;
  58871. CLIPPLANE3: boolean;
  58872. CLIPPLANE4: boolean;
  58873. CLIPPLANE5: boolean;
  58874. CLIPPLANE6: boolean;
  58875. POINTSIZE: boolean;
  58876. FOG: boolean;
  58877. LOGARITHMICDEPTH: boolean;
  58878. FORCENORMALFORWARD: boolean;
  58879. SPECULARAA: boolean;
  58880. CLEARCOAT: boolean;
  58881. CLEARCOAT_DEFAULTIOR: boolean;
  58882. CLEARCOAT_TEXTURE: boolean;
  58883. CLEARCOAT_TEXTUREDIRECTUV: number;
  58884. CLEARCOAT_BUMP: boolean;
  58885. CLEARCOAT_BUMPDIRECTUV: number;
  58886. CLEARCOAT_TINT: boolean;
  58887. CLEARCOAT_TINT_TEXTURE: boolean;
  58888. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  58889. ANISOTROPIC: boolean;
  58890. ANISOTROPIC_TEXTURE: boolean;
  58891. ANISOTROPIC_TEXTUREDIRECTUV: number;
  58892. BRDF_V_HEIGHT_CORRELATED: boolean;
  58893. MS_BRDF_ENERGY_CONSERVATION: boolean;
  58894. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  58895. SHEEN: boolean;
  58896. SHEEN_TEXTURE: boolean;
  58897. SHEEN_TEXTUREDIRECTUV: number;
  58898. SHEEN_LINKWITHALBEDO: boolean;
  58899. SHEEN_ROUGHNESS: boolean;
  58900. SHEEN_ALBEDOSCALING: boolean;
  58901. SUBSURFACE: boolean;
  58902. SS_REFRACTION: boolean;
  58903. SS_TRANSLUCENCY: boolean;
  58904. SS_SCATTERING: boolean;
  58905. SS_THICKNESSANDMASK_TEXTURE: boolean;
  58906. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  58907. SS_REFRACTIONMAP_3D: boolean;
  58908. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  58909. SS_LODINREFRACTIONALPHA: boolean;
  58910. SS_GAMMAREFRACTION: boolean;
  58911. SS_RGBDREFRACTION: boolean;
  58912. SS_LINEARSPECULARREFRACTION: boolean;
  58913. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  58914. SS_ALBEDOFORREFRACTIONTINT: boolean;
  58915. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  58916. UNLIT: boolean;
  58917. DEBUGMODE: number;
  58918. /**
  58919. * Initializes the PBR Material defines.
  58920. */
  58921. constructor();
  58922. /**
  58923. * Resets the PBR Material defines.
  58924. */
  58925. reset(): void;
  58926. }
  58927. /**
  58928. * The Physically based material base class of BJS.
  58929. *
  58930. * This offers the main features of a standard PBR material.
  58931. * For more information, please refer to the documentation :
  58932. * https://doc.babylonjs.com/how_to/physically_based_rendering
  58933. */
  58934. export abstract class PBRBaseMaterial extends PushMaterial {
  58935. /**
  58936. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  58937. */
  58938. static readonly PBRMATERIAL_OPAQUE: number;
  58939. /**
  58940. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  58941. */
  58942. static readonly PBRMATERIAL_ALPHATEST: number;
  58943. /**
  58944. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  58945. */
  58946. static readonly PBRMATERIAL_ALPHABLEND: number;
  58947. /**
  58948. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  58949. * They are also discarded below the alpha cutoff threshold to improve performances.
  58950. */
  58951. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  58952. /**
  58953. * Defines the default value of how much AO map is occluding the analytical lights
  58954. * (point spot...).
  58955. */
  58956. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  58957. /**
  58958. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  58959. */
  58960. static readonly LIGHTFALLOFF_PHYSICAL: number;
  58961. /**
  58962. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  58963. * to enhance interoperability with other engines.
  58964. */
  58965. static readonly LIGHTFALLOFF_GLTF: number;
  58966. /**
  58967. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  58968. * to enhance interoperability with other materials.
  58969. */
  58970. static readonly LIGHTFALLOFF_STANDARD: number;
  58971. /**
  58972. * Intensity of the direct lights e.g. the four lights available in your scene.
  58973. * This impacts both the direct diffuse and specular highlights.
  58974. */
  58975. protected _directIntensity: number;
  58976. /**
  58977. * Intensity of the emissive part of the material.
  58978. * This helps controlling the emissive effect without modifying the emissive color.
  58979. */
  58980. protected _emissiveIntensity: number;
  58981. /**
  58982. * Intensity of the environment e.g. how much the environment will light the object
  58983. * either through harmonics for rough material or through the refelction for shiny ones.
  58984. */
  58985. protected _environmentIntensity: number;
  58986. /**
  58987. * This is a special control allowing the reduction of the specular highlights coming from the
  58988. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  58989. */
  58990. protected _specularIntensity: number;
  58991. /**
  58992. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  58993. */
  58994. private _lightingInfos;
  58995. /**
  58996. * Debug Control allowing disabling the bump map on this material.
  58997. */
  58998. protected _disableBumpMap: boolean;
  58999. /**
  59000. * AKA Diffuse Texture in standard nomenclature.
  59001. */
  59002. protected _albedoTexture: Nullable<BaseTexture>;
  59003. /**
  59004. * AKA Occlusion Texture in other nomenclature.
  59005. */
  59006. protected _ambientTexture: Nullable<BaseTexture>;
  59007. /**
  59008. * AKA Occlusion Texture Intensity in other nomenclature.
  59009. */
  59010. protected _ambientTextureStrength: number;
  59011. /**
  59012. * Defines how much the AO map is occluding the analytical lights (point spot...).
  59013. * 1 means it completely occludes it
  59014. * 0 mean it has no impact
  59015. */
  59016. protected _ambientTextureImpactOnAnalyticalLights: number;
  59017. /**
  59018. * Stores the alpha values in a texture.
  59019. */
  59020. protected _opacityTexture: Nullable<BaseTexture>;
  59021. /**
  59022. * Stores the reflection values in a texture.
  59023. */
  59024. protected _reflectionTexture: Nullable<BaseTexture>;
  59025. /**
  59026. * Stores the emissive values in a texture.
  59027. */
  59028. protected _emissiveTexture: Nullable<BaseTexture>;
  59029. /**
  59030. * AKA Specular texture in other nomenclature.
  59031. */
  59032. protected _reflectivityTexture: Nullable<BaseTexture>;
  59033. /**
  59034. * Used to switch from specular/glossiness to metallic/roughness workflow.
  59035. */
  59036. protected _metallicTexture: Nullable<BaseTexture>;
  59037. /**
  59038. * Specifies the metallic scalar of the metallic/roughness workflow.
  59039. * Can also be used to scale the metalness values of the metallic texture.
  59040. */
  59041. protected _metallic: Nullable<number>;
  59042. /**
  59043. * Specifies the roughness scalar of the metallic/roughness workflow.
  59044. * Can also be used to scale the roughness values of the metallic texture.
  59045. */
  59046. protected _roughness: Nullable<number>;
  59047. /**
  59048. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  59049. * By default the indexOfrefraction is used to compute F0;
  59050. *
  59051. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  59052. *
  59053. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  59054. * F90 = metallicReflectanceColor;
  59055. */
  59056. protected _metallicF0Factor: number;
  59057. /**
  59058. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  59059. * By default the F90 is always 1;
  59060. *
  59061. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  59062. *
  59063. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  59064. * F90 = metallicReflectanceColor;
  59065. */
  59066. protected _metallicReflectanceColor: Color3;
  59067. /**
  59068. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  59069. * This is multiply against the scalar values defined in the material.
  59070. */
  59071. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  59072. /**
  59073. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  59074. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  59075. */
  59076. protected _microSurfaceTexture: Nullable<BaseTexture>;
  59077. /**
  59078. * Stores surface normal data used to displace a mesh in a texture.
  59079. */
  59080. protected _bumpTexture: Nullable<BaseTexture>;
  59081. /**
  59082. * Stores the pre-calculated light information of a mesh in a texture.
  59083. */
  59084. protected _lightmapTexture: Nullable<BaseTexture>;
  59085. /**
  59086. * The color of a material in ambient lighting.
  59087. */
  59088. protected _ambientColor: Color3;
  59089. /**
  59090. * AKA Diffuse Color in other nomenclature.
  59091. */
  59092. protected _albedoColor: Color3;
  59093. /**
  59094. * AKA Specular Color in other nomenclature.
  59095. */
  59096. protected _reflectivityColor: Color3;
  59097. /**
  59098. * The color applied when light is reflected from a material.
  59099. */
  59100. protected _reflectionColor: Color3;
  59101. /**
  59102. * The color applied when light is emitted from a material.
  59103. */
  59104. protected _emissiveColor: Color3;
  59105. /**
  59106. * AKA Glossiness in other nomenclature.
  59107. */
  59108. protected _microSurface: number;
  59109. /**
  59110. * Specifies that the material will use the light map as a show map.
  59111. */
  59112. protected _useLightmapAsShadowmap: boolean;
  59113. /**
  59114. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  59115. * makes the reflect vector face the model (under horizon).
  59116. */
  59117. protected _useHorizonOcclusion: boolean;
  59118. /**
  59119. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  59120. * too much the area relying on ambient texture to define their ambient occlusion.
  59121. */
  59122. protected _useRadianceOcclusion: boolean;
  59123. /**
  59124. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  59125. */
  59126. protected _useAlphaFromAlbedoTexture: boolean;
  59127. /**
  59128. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  59129. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  59130. */
  59131. protected _useSpecularOverAlpha: boolean;
  59132. /**
  59133. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  59134. */
  59135. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  59136. /**
  59137. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  59138. */
  59139. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  59140. /**
  59141. * Specifies if the metallic texture contains the roughness information in its green channel.
  59142. */
  59143. protected _useRoughnessFromMetallicTextureGreen: boolean;
  59144. /**
  59145. * Specifies if the metallic texture contains the metallness information in its blue channel.
  59146. */
  59147. protected _useMetallnessFromMetallicTextureBlue: boolean;
  59148. /**
  59149. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  59150. */
  59151. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  59152. /**
  59153. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  59154. */
  59155. protected _useAmbientInGrayScale: boolean;
  59156. /**
  59157. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  59158. * The material will try to infer what glossiness each pixel should be.
  59159. */
  59160. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  59161. /**
  59162. * Defines the falloff type used in this material.
  59163. * It by default is Physical.
  59164. */
  59165. protected _lightFalloff: number;
  59166. /**
  59167. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  59168. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  59169. */
  59170. protected _useRadianceOverAlpha: boolean;
  59171. /**
  59172. * Allows using an object space normal map (instead of tangent space).
  59173. */
  59174. protected _useObjectSpaceNormalMap: boolean;
  59175. /**
  59176. * Allows using the bump map in parallax mode.
  59177. */
  59178. protected _useParallax: boolean;
  59179. /**
  59180. * Allows using the bump map in parallax occlusion mode.
  59181. */
  59182. protected _useParallaxOcclusion: boolean;
  59183. /**
  59184. * Controls the scale bias of the parallax mode.
  59185. */
  59186. protected _parallaxScaleBias: number;
  59187. /**
  59188. * If sets to true, disables all the lights affecting the material.
  59189. */
  59190. protected _disableLighting: boolean;
  59191. /**
  59192. * Number of Simultaneous lights allowed on the material.
  59193. */
  59194. protected _maxSimultaneousLights: number;
  59195. /**
  59196. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  59197. */
  59198. protected _invertNormalMapX: boolean;
  59199. /**
  59200. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  59201. */
  59202. protected _invertNormalMapY: boolean;
  59203. /**
  59204. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  59205. */
  59206. protected _twoSidedLighting: boolean;
  59207. /**
  59208. * Defines the alpha limits in alpha test mode.
  59209. */
  59210. protected _alphaCutOff: number;
  59211. /**
  59212. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  59213. */
  59214. protected _forceAlphaTest: boolean;
  59215. /**
  59216. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59217. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  59218. */
  59219. protected _useAlphaFresnel: boolean;
  59220. /**
  59221. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59222. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  59223. */
  59224. protected _useLinearAlphaFresnel: boolean;
  59225. /**
  59226. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  59227. * from cos thetav and roughness:
  59228. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  59229. */
  59230. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  59231. /**
  59232. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  59233. */
  59234. protected _forceIrradianceInFragment: boolean;
  59235. private _realTimeFiltering;
  59236. /**
  59237. * Enables realtime filtering on the texture.
  59238. */
  59239. get realTimeFiltering(): boolean;
  59240. set realTimeFiltering(b: boolean);
  59241. private _realTimeFilteringQuality;
  59242. /**
  59243. * Quality switch for realtime filtering
  59244. */
  59245. get realTimeFilteringQuality(): number;
  59246. set realTimeFilteringQuality(n: number);
  59247. /**
  59248. * Can this material render to several textures at once
  59249. */
  59250. get canRenderToMRT(): boolean;
  59251. /**
  59252. * Force normal to face away from face.
  59253. */
  59254. protected _forceNormalForward: boolean;
  59255. /**
  59256. * Enables specular anti aliasing in the PBR shader.
  59257. * It will both interacts on the Geometry for analytical and IBL lighting.
  59258. * It also prefilter the roughness map based on the bump values.
  59259. */
  59260. protected _enableSpecularAntiAliasing: boolean;
  59261. /**
  59262. * Default configuration related to image processing available in the PBR Material.
  59263. */
  59264. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  59265. /**
  59266. * Keep track of the image processing observer to allow dispose and replace.
  59267. */
  59268. private _imageProcessingObserver;
  59269. /**
  59270. * Attaches a new image processing configuration to the PBR Material.
  59271. * @param configuration
  59272. */
  59273. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  59274. /**
  59275. * Stores the available render targets.
  59276. */
  59277. private _renderTargets;
  59278. /**
  59279. * Sets the global ambient color for the material used in lighting calculations.
  59280. */
  59281. private _globalAmbientColor;
  59282. /**
  59283. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  59284. */
  59285. private _useLogarithmicDepth;
  59286. /**
  59287. * If set to true, no lighting calculations will be applied.
  59288. */
  59289. private _unlit;
  59290. private _debugMode;
  59291. /**
  59292. * @hidden
  59293. * This is reserved for the inspector.
  59294. * Defines the material debug mode.
  59295. * It helps seeing only some components of the material while troubleshooting.
  59296. */
  59297. debugMode: number;
  59298. /**
  59299. * @hidden
  59300. * This is reserved for the inspector.
  59301. * Specify from where on screen the debug mode should start.
  59302. * The value goes from -1 (full screen) to 1 (not visible)
  59303. * It helps with side by side comparison against the final render
  59304. * This defaults to -1
  59305. */
  59306. private debugLimit;
  59307. /**
  59308. * @hidden
  59309. * This is reserved for the inspector.
  59310. * As the default viewing range might not be enough (if the ambient is really small for instance)
  59311. * You can use the factor to better multiply the final value.
  59312. */
  59313. private debugFactor;
  59314. /**
  59315. * Defines the clear coat layer parameters for the material.
  59316. */
  59317. readonly clearCoat: PBRClearCoatConfiguration;
  59318. /**
  59319. * Defines the anisotropic parameters for the material.
  59320. */
  59321. readonly anisotropy: PBRAnisotropicConfiguration;
  59322. /**
  59323. * Defines the BRDF parameters for the material.
  59324. */
  59325. readonly brdf: PBRBRDFConfiguration;
  59326. /**
  59327. * Defines the Sheen parameters for the material.
  59328. */
  59329. readonly sheen: PBRSheenConfiguration;
  59330. /**
  59331. * Defines the SubSurface parameters for the material.
  59332. */
  59333. readonly subSurface: PBRSubSurfaceConfiguration;
  59334. /**
  59335. * Defines the detail map parameters for the material.
  59336. */
  59337. readonly detailMap: DetailMapConfiguration;
  59338. protected _rebuildInParallel: boolean;
  59339. /**
  59340. * Instantiates a new PBRMaterial instance.
  59341. *
  59342. * @param name The material name
  59343. * @param scene The scene the material will be use in.
  59344. */
  59345. constructor(name: string, scene: Scene);
  59346. /**
  59347. * Gets a boolean indicating that current material needs to register RTT
  59348. */
  59349. get hasRenderTargetTextures(): boolean;
  59350. /**
  59351. * Gets the name of the material class.
  59352. */
  59353. getClassName(): string;
  59354. /**
  59355. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  59356. */
  59357. get useLogarithmicDepth(): boolean;
  59358. /**
  59359. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  59360. */
  59361. set useLogarithmicDepth(value: boolean);
  59362. /**
  59363. * Returns true if alpha blending should be disabled.
  59364. */
  59365. protected get _disableAlphaBlending(): boolean;
  59366. /**
  59367. * Specifies whether or not this material should be rendered in alpha blend mode.
  59368. */
  59369. needAlphaBlending(): boolean;
  59370. /**
  59371. * Specifies whether or not this material should be rendered in alpha test mode.
  59372. */
  59373. needAlphaTesting(): boolean;
  59374. /**
  59375. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  59376. */
  59377. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  59378. /**
  59379. * Gets the texture used for the alpha test.
  59380. */
  59381. getAlphaTestTexture(): Nullable<BaseTexture>;
  59382. /**
  59383. * Specifies that the submesh is ready to be used.
  59384. * @param mesh - BJS mesh.
  59385. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  59386. * @param useInstances - Specifies that instances should be used.
  59387. * @returns - boolean indicating that the submesh is ready or not.
  59388. */
  59389. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  59390. /**
  59391. * Specifies if the material uses metallic roughness workflow.
  59392. * @returns boolean specifiying if the material uses metallic roughness workflow.
  59393. */
  59394. isMetallicWorkflow(): boolean;
  59395. private _prepareEffect;
  59396. private _prepareDefines;
  59397. /**
  59398. * Force shader compilation
  59399. */
  59400. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  59401. /**
  59402. * Initializes the uniform buffer layout for the shader.
  59403. */
  59404. buildUniformLayout(): void;
  59405. /**
  59406. * Unbinds the material from the mesh
  59407. */
  59408. unbind(): void;
  59409. /**
  59410. * Binds the submesh data.
  59411. * @param world - The world matrix.
  59412. * @param mesh - The BJS mesh.
  59413. * @param subMesh - A submesh of the BJS mesh.
  59414. */
  59415. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  59416. /**
  59417. * Returns the animatable textures.
  59418. * @returns - Array of animatable textures.
  59419. */
  59420. getAnimatables(): IAnimatable[];
  59421. /**
  59422. * Returns the texture used for reflections.
  59423. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  59424. */
  59425. private _getReflectionTexture;
  59426. /**
  59427. * Returns an array of the actively used textures.
  59428. * @returns - Array of BaseTextures
  59429. */
  59430. getActiveTextures(): BaseTexture[];
  59431. /**
  59432. * Checks to see if a texture is used in the material.
  59433. * @param texture - Base texture to use.
  59434. * @returns - Boolean specifying if a texture is used in the material.
  59435. */
  59436. hasTexture(texture: BaseTexture): boolean;
  59437. /**
  59438. * Sets the required values to the prepass renderer.
  59439. * @param prePassRenderer defines the prepass renderer to setup
  59440. */
  59441. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  59442. /**
  59443. * Disposes the resources of the material.
  59444. * @param forceDisposeEffect - Forces the disposal of effects.
  59445. * @param forceDisposeTextures - Forces the disposal of all textures.
  59446. */
  59447. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  59448. }
  59449. }
  59450. declare module "babylonjs/Materials/PBR/pbrMaterial" {
  59451. import { Nullable } from "babylonjs/types";
  59452. import { Scene } from "babylonjs/scene";
  59453. import { Color3 } from "babylonjs/Maths/math.color";
  59454. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  59455. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  59456. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  59457. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  59458. /**
  59459. * The Physically based material of BJS.
  59460. *
  59461. * This offers the main features of a standard PBR material.
  59462. * For more information, please refer to the documentation :
  59463. * https://doc.babylonjs.com/how_to/physically_based_rendering
  59464. */
  59465. export class PBRMaterial extends PBRBaseMaterial {
  59466. /**
  59467. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  59468. */
  59469. static readonly PBRMATERIAL_OPAQUE: number;
  59470. /**
  59471. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  59472. */
  59473. static readonly PBRMATERIAL_ALPHATEST: number;
  59474. /**
  59475. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59476. */
  59477. static readonly PBRMATERIAL_ALPHABLEND: number;
  59478. /**
  59479. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59480. * They are also discarded below the alpha cutoff threshold to improve performances.
  59481. */
  59482. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  59483. /**
  59484. * Defines the default value of how much AO map is occluding the analytical lights
  59485. * (point spot...).
  59486. */
  59487. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  59488. /**
  59489. * Intensity of the direct lights e.g. the four lights available in your scene.
  59490. * This impacts both the direct diffuse and specular highlights.
  59491. */
  59492. directIntensity: number;
  59493. /**
  59494. * Intensity of the emissive part of the material.
  59495. * This helps controlling the emissive effect without modifying the emissive color.
  59496. */
  59497. emissiveIntensity: number;
  59498. /**
  59499. * Intensity of the environment e.g. how much the environment will light the object
  59500. * either through harmonics for rough material or through the refelction for shiny ones.
  59501. */
  59502. environmentIntensity: number;
  59503. /**
  59504. * This is a special control allowing the reduction of the specular highlights coming from the
  59505. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  59506. */
  59507. specularIntensity: number;
  59508. /**
  59509. * Debug Control allowing disabling the bump map on this material.
  59510. */
  59511. disableBumpMap: boolean;
  59512. /**
  59513. * AKA Diffuse Texture in standard nomenclature.
  59514. */
  59515. albedoTexture: BaseTexture;
  59516. /**
  59517. * AKA Occlusion Texture in other nomenclature.
  59518. */
  59519. ambientTexture: BaseTexture;
  59520. /**
  59521. * AKA Occlusion Texture Intensity in other nomenclature.
  59522. */
  59523. ambientTextureStrength: number;
  59524. /**
  59525. * Defines how much the AO map is occluding the analytical lights (point spot...).
  59526. * 1 means it completely occludes it
  59527. * 0 mean it has no impact
  59528. */
  59529. ambientTextureImpactOnAnalyticalLights: number;
  59530. /**
  59531. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  59532. */
  59533. opacityTexture: BaseTexture;
  59534. /**
  59535. * Stores the reflection values in a texture.
  59536. */
  59537. reflectionTexture: Nullable<BaseTexture>;
  59538. /**
  59539. * Stores the emissive values in a texture.
  59540. */
  59541. emissiveTexture: BaseTexture;
  59542. /**
  59543. * AKA Specular texture in other nomenclature.
  59544. */
  59545. reflectivityTexture: BaseTexture;
  59546. /**
  59547. * Used to switch from specular/glossiness to metallic/roughness workflow.
  59548. */
  59549. metallicTexture: BaseTexture;
  59550. /**
  59551. * Specifies the metallic scalar of the metallic/roughness workflow.
  59552. * Can also be used to scale the metalness values of the metallic texture.
  59553. */
  59554. metallic: Nullable<number>;
  59555. /**
  59556. * Specifies the roughness scalar of the metallic/roughness workflow.
  59557. * Can also be used to scale the roughness values of the metallic texture.
  59558. */
  59559. roughness: Nullable<number>;
  59560. /**
  59561. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  59562. * By default the indexOfrefraction is used to compute F0;
  59563. *
  59564. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  59565. *
  59566. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  59567. * F90 = metallicReflectanceColor;
  59568. */
  59569. metallicF0Factor: number;
  59570. /**
  59571. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  59572. * By default the F90 is always 1;
  59573. *
  59574. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  59575. *
  59576. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  59577. * F90 = metallicReflectanceColor;
  59578. */
  59579. metallicReflectanceColor: Color3;
  59580. /**
  59581. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  59582. * This is multiply against the scalar values defined in the material.
  59583. */
  59584. metallicReflectanceTexture: Nullable<BaseTexture>;
  59585. /**
  59586. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  59587. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  59588. */
  59589. microSurfaceTexture: BaseTexture;
  59590. /**
  59591. * Stores surface normal data used to displace a mesh in a texture.
  59592. */
  59593. bumpTexture: BaseTexture;
  59594. /**
  59595. * Stores the pre-calculated light information of a mesh in a texture.
  59596. */
  59597. lightmapTexture: BaseTexture;
  59598. /**
  59599. * Stores the refracted light information in a texture.
  59600. */
  59601. get refractionTexture(): Nullable<BaseTexture>;
  59602. set refractionTexture(value: Nullable<BaseTexture>);
  59603. /**
  59604. * The color of a material in ambient lighting.
  59605. */
  59606. ambientColor: Color3;
  59607. /**
  59608. * AKA Diffuse Color in other nomenclature.
  59609. */
  59610. albedoColor: Color3;
  59611. /**
  59612. * AKA Specular Color in other nomenclature.
  59613. */
  59614. reflectivityColor: Color3;
  59615. /**
  59616. * The color reflected from the material.
  59617. */
  59618. reflectionColor: Color3;
  59619. /**
  59620. * The color emitted from the material.
  59621. */
  59622. emissiveColor: Color3;
  59623. /**
  59624. * AKA Glossiness in other nomenclature.
  59625. */
  59626. microSurface: number;
  59627. /**
  59628. * Index of refraction of the material base layer.
  59629. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  59630. *
  59631. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  59632. *
  59633. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  59634. */
  59635. get indexOfRefraction(): number;
  59636. set indexOfRefraction(value: number);
  59637. /**
  59638. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  59639. */
  59640. get invertRefractionY(): boolean;
  59641. set invertRefractionY(value: boolean);
  59642. /**
  59643. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  59644. * Materials half opaque for instance using refraction could benefit from this control.
  59645. */
  59646. get linkRefractionWithTransparency(): boolean;
  59647. set linkRefractionWithTransparency(value: boolean);
  59648. /**
  59649. * If true, the light map contains occlusion information instead of lighting info.
  59650. */
  59651. useLightmapAsShadowmap: boolean;
  59652. /**
  59653. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  59654. */
  59655. useAlphaFromAlbedoTexture: boolean;
  59656. /**
  59657. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  59658. */
  59659. forceAlphaTest: boolean;
  59660. /**
  59661. * Defines the alpha limits in alpha test mode.
  59662. */
  59663. alphaCutOff: number;
  59664. /**
  59665. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  59666. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  59667. */
  59668. useSpecularOverAlpha: boolean;
  59669. /**
  59670. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  59671. */
  59672. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  59673. /**
  59674. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  59675. */
  59676. useRoughnessFromMetallicTextureAlpha: boolean;
  59677. /**
  59678. * Specifies if the metallic texture contains the roughness information in its green channel.
  59679. */
  59680. useRoughnessFromMetallicTextureGreen: boolean;
  59681. /**
  59682. * Specifies if the metallic texture contains the metallness information in its blue channel.
  59683. */
  59684. useMetallnessFromMetallicTextureBlue: boolean;
  59685. /**
  59686. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  59687. */
  59688. useAmbientOcclusionFromMetallicTextureRed: boolean;
  59689. /**
  59690. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  59691. */
  59692. useAmbientInGrayScale: boolean;
  59693. /**
  59694. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  59695. * The material will try to infer what glossiness each pixel should be.
  59696. */
  59697. useAutoMicroSurfaceFromReflectivityMap: boolean;
  59698. /**
  59699. * BJS is using an harcoded light falloff based on a manually sets up range.
  59700. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  59701. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  59702. */
  59703. get usePhysicalLightFalloff(): boolean;
  59704. /**
  59705. * BJS is using an harcoded light falloff based on a manually sets up range.
  59706. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  59707. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  59708. */
  59709. set usePhysicalLightFalloff(value: boolean);
  59710. /**
  59711. * In order to support the falloff compatibility with gltf, a special mode has been added
  59712. * to reproduce the gltf light falloff.
  59713. */
  59714. get useGLTFLightFalloff(): boolean;
  59715. /**
  59716. * In order to support the falloff compatibility with gltf, a special mode has been added
  59717. * to reproduce the gltf light falloff.
  59718. */
  59719. set useGLTFLightFalloff(value: boolean);
  59720. /**
  59721. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  59722. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  59723. */
  59724. useRadianceOverAlpha: boolean;
  59725. /**
  59726. * Allows using an object space normal map (instead of tangent space).
  59727. */
  59728. useObjectSpaceNormalMap: boolean;
  59729. /**
  59730. * Allows using the bump map in parallax mode.
  59731. */
  59732. useParallax: boolean;
  59733. /**
  59734. * Allows using the bump map in parallax occlusion mode.
  59735. */
  59736. useParallaxOcclusion: boolean;
  59737. /**
  59738. * Controls the scale bias of the parallax mode.
  59739. */
  59740. parallaxScaleBias: number;
  59741. /**
  59742. * If sets to true, disables all the lights affecting the material.
  59743. */
  59744. disableLighting: boolean;
  59745. /**
  59746. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  59747. */
  59748. forceIrradianceInFragment: boolean;
  59749. /**
  59750. * Number of Simultaneous lights allowed on the material.
  59751. */
  59752. maxSimultaneousLights: number;
  59753. /**
  59754. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  59755. */
  59756. invertNormalMapX: boolean;
  59757. /**
  59758. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  59759. */
  59760. invertNormalMapY: boolean;
  59761. /**
  59762. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  59763. */
  59764. twoSidedLighting: boolean;
  59765. /**
  59766. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59767. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  59768. */
  59769. useAlphaFresnel: boolean;
  59770. /**
  59771. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59772. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  59773. */
  59774. useLinearAlphaFresnel: boolean;
  59775. /**
  59776. * Let user defines the brdf lookup texture used for IBL.
  59777. * A default 8bit version is embedded but you could point at :
  59778. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  59779. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  59780. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  59781. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  59782. */
  59783. environmentBRDFTexture: Nullable<BaseTexture>;
  59784. /**
  59785. * Force normal to face away from face.
  59786. */
  59787. forceNormalForward: boolean;
  59788. /**
  59789. * Enables specular anti aliasing in the PBR shader.
  59790. * It will both interacts on the Geometry for analytical and IBL lighting.
  59791. * It also prefilter the roughness map based on the bump values.
  59792. */
  59793. enableSpecularAntiAliasing: boolean;
  59794. /**
  59795. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  59796. * makes the reflect vector face the model (under horizon).
  59797. */
  59798. useHorizonOcclusion: boolean;
  59799. /**
  59800. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  59801. * too much the area relying on ambient texture to define their ambient occlusion.
  59802. */
  59803. useRadianceOcclusion: boolean;
  59804. /**
  59805. * If set to true, no lighting calculations will be applied.
  59806. */
  59807. unlit: boolean;
  59808. /**
  59809. * Gets the image processing configuration used either in this material.
  59810. */
  59811. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  59812. /**
  59813. * Sets the Default image processing configuration used either in the this material.
  59814. *
  59815. * If sets to null, the scene one is in use.
  59816. */
  59817. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  59818. /**
  59819. * Gets wether the color curves effect is enabled.
  59820. */
  59821. get cameraColorCurvesEnabled(): boolean;
  59822. /**
  59823. * Sets wether the color curves effect is enabled.
  59824. */
  59825. set cameraColorCurvesEnabled(value: boolean);
  59826. /**
  59827. * Gets wether the color grading effect is enabled.
  59828. */
  59829. get cameraColorGradingEnabled(): boolean;
  59830. /**
  59831. * Gets wether the color grading effect is enabled.
  59832. */
  59833. set cameraColorGradingEnabled(value: boolean);
  59834. /**
  59835. * Gets wether tonemapping is enabled or not.
  59836. */
  59837. get cameraToneMappingEnabled(): boolean;
  59838. /**
  59839. * Sets wether tonemapping is enabled or not
  59840. */
  59841. set cameraToneMappingEnabled(value: boolean);
  59842. /**
  59843. * The camera exposure used on this material.
  59844. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  59845. * This corresponds to a photographic exposure.
  59846. */
  59847. get cameraExposure(): number;
  59848. /**
  59849. * The camera exposure used on this material.
  59850. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  59851. * This corresponds to a photographic exposure.
  59852. */
  59853. set cameraExposure(value: number);
  59854. /**
  59855. * Gets The camera contrast used on this material.
  59856. */
  59857. get cameraContrast(): number;
  59858. /**
  59859. * Sets The camera contrast used on this material.
  59860. */
  59861. set cameraContrast(value: number);
  59862. /**
  59863. * Gets the Color Grading 2D Lookup Texture.
  59864. */
  59865. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  59866. /**
  59867. * Sets the Color Grading 2D Lookup Texture.
  59868. */
  59869. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  59870. /**
  59871. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  59872. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  59873. * 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;
  59874. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  59875. */
  59876. get cameraColorCurves(): Nullable<ColorCurves>;
  59877. /**
  59878. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  59879. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  59880. * 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;
  59881. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  59882. */
  59883. set cameraColorCurves(value: Nullable<ColorCurves>);
  59884. /**
  59885. * Instantiates a new PBRMaterial instance.
  59886. *
  59887. * @param name The material name
  59888. * @param scene The scene the material will be use in.
  59889. */
  59890. constructor(name: string, scene: Scene);
  59891. /**
  59892. * Returns the name of this material class.
  59893. */
  59894. getClassName(): string;
  59895. /**
  59896. * Makes a duplicate of the current material.
  59897. * @param name - name to use for the new material.
  59898. */
  59899. clone(name: string): PBRMaterial;
  59900. /**
  59901. * Serializes this PBR Material.
  59902. * @returns - An object with the serialized material.
  59903. */
  59904. serialize(): any;
  59905. /**
  59906. * Parses a PBR Material from a serialized object.
  59907. * @param source - Serialized object.
  59908. * @param scene - BJS scene instance.
  59909. * @param rootUrl - url for the scene object
  59910. * @returns - PBRMaterial
  59911. */
  59912. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  59913. }
  59914. }
  59915. declare module "babylonjs/Misc/dds" {
  59916. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  59917. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  59918. import { Nullable } from "babylonjs/types";
  59919. import { Scene } from "babylonjs/scene";
  59920. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  59921. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  59922. /**
  59923. * Direct draw surface info
  59924. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  59925. */
  59926. export interface DDSInfo {
  59927. /**
  59928. * Width of the texture
  59929. */
  59930. width: number;
  59931. /**
  59932. * Width of the texture
  59933. */
  59934. height: number;
  59935. /**
  59936. * Number of Mipmaps for the texture
  59937. * @see https://en.wikipedia.org/wiki/Mipmap
  59938. */
  59939. mipmapCount: number;
  59940. /**
  59941. * If the textures format is a known fourCC format
  59942. * @see https://www.fourcc.org/
  59943. */
  59944. isFourCC: boolean;
  59945. /**
  59946. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  59947. */
  59948. isRGB: boolean;
  59949. /**
  59950. * If the texture is a lumincance format
  59951. */
  59952. isLuminance: boolean;
  59953. /**
  59954. * If this is a cube texture
  59955. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  59956. */
  59957. isCube: boolean;
  59958. /**
  59959. * If the texture is a compressed format eg. FOURCC_DXT1
  59960. */
  59961. isCompressed: boolean;
  59962. /**
  59963. * The dxgiFormat of the texture
  59964. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  59965. */
  59966. dxgiFormat: number;
  59967. /**
  59968. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  59969. */
  59970. textureType: number;
  59971. /**
  59972. * Sphericle polynomial created for the dds texture
  59973. */
  59974. sphericalPolynomial?: SphericalPolynomial;
  59975. }
  59976. /**
  59977. * Class used to provide DDS decompression tools
  59978. */
  59979. export class DDSTools {
  59980. /**
  59981. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  59982. */
  59983. static StoreLODInAlphaChannel: boolean;
  59984. /**
  59985. * Gets DDS information from an array buffer
  59986. * @param data defines the array buffer view to read data from
  59987. * @returns the DDS information
  59988. */
  59989. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  59990. private static _FloatView;
  59991. private static _Int32View;
  59992. private static _ToHalfFloat;
  59993. private static _FromHalfFloat;
  59994. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  59995. private static _GetHalfFloatRGBAArrayBuffer;
  59996. private static _GetFloatRGBAArrayBuffer;
  59997. private static _GetFloatAsUIntRGBAArrayBuffer;
  59998. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  59999. private static _GetRGBAArrayBuffer;
  60000. private static _ExtractLongWordOrder;
  60001. private static _GetRGBArrayBuffer;
  60002. private static _GetLuminanceArrayBuffer;
  60003. /**
  60004. * Uploads DDS Levels to a Babylon Texture
  60005. * @hidden
  60006. */
  60007. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  60008. }
  60009. module "babylonjs/Engines/thinEngine" {
  60010. interface ThinEngine {
  60011. /**
  60012. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  60013. * @param rootUrl defines the url where the file to load is located
  60014. * @param scene defines the current scene
  60015. * @param lodScale defines scale to apply to the mip map selection
  60016. * @param lodOffset defines offset to apply to the mip map selection
  60017. * @param onLoad defines an optional callback raised when the texture is loaded
  60018. * @param onError defines an optional callback raised if there is an issue to load the texture
  60019. * @param format defines the format of the data
  60020. * @param forcedExtension defines the extension to use to pick the right loader
  60021. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  60022. * @returns the cube texture as an InternalTexture
  60023. */
  60024. 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;
  60025. }
  60026. }
  60027. }
  60028. declare module "babylonjs/Materials/Textures/Loaders/ddsTextureLoader" {
  60029. import { Nullable } from "babylonjs/types";
  60030. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60031. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60032. /**
  60033. * Implementation of the DDS Texture Loader.
  60034. * @hidden
  60035. */
  60036. export class _DDSTextureLoader implements IInternalTextureLoader {
  60037. /**
  60038. * Defines wether the loader supports cascade loading the different faces.
  60039. */
  60040. readonly supportCascades: boolean;
  60041. /**
  60042. * This returns if the loader support the current file information.
  60043. * @param extension defines the file extension of the file being loaded
  60044. * @returns true if the loader can load the specified file
  60045. */
  60046. canLoad(extension: string): boolean;
  60047. /**
  60048. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60049. * @param data contains the texture data
  60050. * @param texture defines the BabylonJS internal texture
  60051. * @param createPolynomials will be true if polynomials have been requested
  60052. * @param onLoad defines the callback to trigger once the texture is ready
  60053. * @param onError defines the callback to trigger in case of error
  60054. */
  60055. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60056. /**
  60057. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60058. * @param data contains the texture data
  60059. * @param texture defines the BabylonJS internal texture
  60060. * @param callback defines the method to call once ready to upload
  60061. */
  60062. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  60063. }
  60064. }
  60065. declare module "babylonjs/Materials/Textures/Loaders/envTextureLoader" {
  60066. import { Nullable } from "babylonjs/types";
  60067. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60068. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60069. /**
  60070. * Implementation of the ENV Texture Loader.
  60071. * @hidden
  60072. */
  60073. export class _ENVTextureLoader implements IInternalTextureLoader {
  60074. /**
  60075. * Defines wether the loader supports cascade loading the different faces.
  60076. */
  60077. readonly supportCascades: boolean;
  60078. /**
  60079. * This returns if the loader support the current file information.
  60080. * @param extension defines the file extension of the file being loaded
  60081. * @returns true if the loader can load the specified file
  60082. */
  60083. canLoad(extension: string): boolean;
  60084. /**
  60085. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60086. * @param data contains the texture data
  60087. * @param texture defines the BabylonJS internal texture
  60088. * @param createPolynomials will be true if polynomials have been requested
  60089. * @param onLoad defines the callback to trigger once the texture is ready
  60090. * @param onError defines the callback to trigger in case of error
  60091. */
  60092. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60093. /**
  60094. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60095. * @param data contains the texture data
  60096. * @param texture defines the BabylonJS internal texture
  60097. * @param callback defines the method to call once ready to upload
  60098. */
  60099. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  60100. }
  60101. }
  60102. declare module "babylonjs/Misc/khronosTextureContainer" {
  60103. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60104. /**
  60105. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  60106. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  60107. */
  60108. export class KhronosTextureContainer {
  60109. /** contents of the KTX container file */
  60110. data: ArrayBufferView;
  60111. private static HEADER_LEN;
  60112. private static COMPRESSED_2D;
  60113. private static COMPRESSED_3D;
  60114. private static TEX_2D;
  60115. private static TEX_3D;
  60116. /**
  60117. * Gets the openGL type
  60118. */
  60119. glType: number;
  60120. /**
  60121. * Gets the openGL type size
  60122. */
  60123. glTypeSize: number;
  60124. /**
  60125. * Gets the openGL format
  60126. */
  60127. glFormat: number;
  60128. /**
  60129. * Gets the openGL internal format
  60130. */
  60131. glInternalFormat: number;
  60132. /**
  60133. * Gets the base internal format
  60134. */
  60135. glBaseInternalFormat: number;
  60136. /**
  60137. * Gets image width in pixel
  60138. */
  60139. pixelWidth: number;
  60140. /**
  60141. * Gets image height in pixel
  60142. */
  60143. pixelHeight: number;
  60144. /**
  60145. * Gets image depth in pixels
  60146. */
  60147. pixelDepth: number;
  60148. /**
  60149. * Gets the number of array elements
  60150. */
  60151. numberOfArrayElements: number;
  60152. /**
  60153. * Gets the number of faces
  60154. */
  60155. numberOfFaces: number;
  60156. /**
  60157. * Gets the number of mipmap levels
  60158. */
  60159. numberOfMipmapLevels: number;
  60160. /**
  60161. * Gets the bytes of key value data
  60162. */
  60163. bytesOfKeyValueData: number;
  60164. /**
  60165. * Gets the load type
  60166. */
  60167. loadType: number;
  60168. /**
  60169. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  60170. */
  60171. isInvalid: boolean;
  60172. /**
  60173. * Creates a new KhronosTextureContainer
  60174. * @param data contents of the KTX container file
  60175. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  60176. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  60177. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  60178. */
  60179. constructor(
  60180. /** contents of the KTX container file */
  60181. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  60182. /**
  60183. * Uploads KTX content to a Babylon Texture.
  60184. * It is assumed that the texture has already been created & is currently bound
  60185. * @hidden
  60186. */
  60187. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  60188. private _upload2DCompressedLevels;
  60189. /**
  60190. * Checks if the given data starts with a KTX file identifier.
  60191. * @param data the data to check
  60192. * @returns true if the data is a KTX file or false otherwise
  60193. */
  60194. static IsValid(data: ArrayBufferView): boolean;
  60195. }
  60196. }
  60197. declare module "babylonjs/Misc/khronosTextureContainer2" {
  60198. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60199. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  60200. /**
  60201. * Class for loading KTX2 files
  60202. * !!! Experimental Extension Subject to Changes !!!
  60203. * @hidden
  60204. */
  60205. export class KhronosTextureContainer2 {
  60206. private static _ModulePromise;
  60207. private static _TranscodeFormat;
  60208. constructor(engine: ThinEngine);
  60209. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  60210. private _determineTranscodeFormat;
  60211. /**
  60212. * Checks if the given data starts with a KTX2 file identifier.
  60213. * @param data the data to check
  60214. * @returns true if the data is a KTX2 file or false otherwise
  60215. */
  60216. static IsValid(data: ArrayBufferView): boolean;
  60217. }
  60218. }
  60219. declare module "babylonjs/Materials/Textures/Loaders/ktxTextureLoader" {
  60220. import { Nullable } from "babylonjs/types";
  60221. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60222. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60223. /**
  60224. * Implementation of the KTX Texture Loader.
  60225. * @hidden
  60226. */
  60227. export class _KTXTextureLoader implements IInternalTextureLoader {
  60228. /**
  60229. * Defines wether the loader supports cascade loading the different faces.
  60230. */
  60231. readonly supportCascades: boolean;
  60232. /**
  60233. * This returns if the loader support the current file information.
  60234. * @param extension defines the file extension of the file being loaded
  60235. * @param mimeType defines the optional mime type of the file being loaded
  60236. * @returns true if the loader can load the specified file
  60237. */
  60238. canLoad(extension: string, mimeType?: string): boolean;
  60239. /**
  60240. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60241. * @param data contains the texture data
  60242. * @param texture defines the BabylonJS internal texture
  60243. * @param createPolynomials will be true if polynomials have been requested
  60244. * @param onLoad defines the callback to trigger once the texture is ready
  60245. * @param onError defines the callback to trigger in case of error
  60246. */
  60247. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60248. /**
  60249. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60250. * @param data contains the texture data
  60251. * @param texture defines the BabylonJS internal texture
  60252. * @param callback defines the method to call once ready to upload
  60253. */
  60254. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  60255. }
  60256. }
  60257. declare module "babylonjs/Helpers/sceneHelpers" {
  60258. import { Nullable } from "babylonjs/types";
  60259. import { Mesh } from "babylonjs/Meshes/mesh";
  60260. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  60261. import { IEnvironmentHelperOptions, EnvironmentHelper } from "babylonjs/Helpers/environmentHelper";
  60262. import { VRExperienceHelperOptions, VRExperienceHelper } from "babylonjs/Cameras/VR/vrExperienceHelper";
  60263. import "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  60264. import "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  60265. import "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  60266. import "babylonjs/Meshes/Builders/boxBuilder";
  60267. import { WebXRDefaultExperience, WebXRDefaultExperienceOptions } from "babylonjs/XR/webXRDefaultExperience";
  60268. /** @hidden */
  60269. export var _forceSceneHelpersToBundle: boolean;
  60270. module "babylonjs/scene" {
  60271. interface Scene {
  60272. /**
  60273. * Creates a default light for the scene.
  60274. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  60275. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  60276. */
  60277. createDefaultLight(replace?: boolean): void;
  60278. /**
  60279. * Creates a default camera for the scene.
  60280. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  60281. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  60282. * @param replace has default false, when true replaces the active camera in the scene
  60283. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  60284. */
  60285. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  60286. /**
  60287. * Creates a default camera and a default light.
  60288. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  60289. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  60290. * @param replace has the default false, when true replaces the active camera/light in the scene
  60291. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  60292. */
  60293. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  60294. /**
  60295. * Creates a new sky box
  60296. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  60297. * @param environmentTexture defines the texture to use as environment texture
  60298. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  60299. * @param scale defines the overall scale of the skybox
  60300. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  60301. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  60302. * @returns a new mesh holding the sky box
  60303. */
  60304. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  60305. /**
  60306. * Creates a new environment
  60307. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  60308. * @param options defines the options you can use to configure the environment
  60309. * @returns the new EnvironmentHelper
  60310. */
  60311. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  60312. /**
  60313. * Creates a new VREXperienceHelper
  60314. * @see https://doc.babylonjs.com/how_to/webvr_helper
  60315. * @param webVROptions defines the options used to create the new VREXperienceHelper
  60316. * @returns a new VREXperienceHelper
  60317. */
  60318. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  60319. /**
  60320. * Creates a new WebXRDefaultExperience
  60321. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  60322. * @param options experience options
  60323. * @returns a promise for a new WebXRDefaultExperience
  60324. */
  60325. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  60326. }
  60327. }
  60328. }
  60329. declare module "babylonjs/Helpers/videoDome" {
  60330. import { Scene } from "babylonjs/scene";
  60331. import { VideoTexture } from "babylonjs/Materials/Textures/videoTexture";
  60332. import { TextureDome } from "babylonjs/Helpers/textureDome";
  60333. /**
  60334. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  60335. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  60336. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  60337. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  60338. */
  60339. export class VideoDome extends TextureDome<VideoTexture> {
  60340. /**
  60341. * Define the video source as a Monoscopic panoramic 360 video.
  60342. */
  60343. static readonly MODE_MONOSCOPIC: number;
  60344. /**
  60345. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  60346. */
  60347. static readonly MODE_TOPBOTTOM: number;
  60348. /**
  60349. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  60350. */
  60351. static readonly MODE_SIDEBYSIDE: number;
  60352. /**
  60353. * Get the video texture associated with this video dome
  60354. */
  60355. get videoTexture(): VideoTexture;
  60356. /**
  60357. * Get the video mode of this dome
  60358. */
  60359. get videoMode(): number;
  60360. /**
  60361. * Set the video mode of this dome.
  60362. * @see textureMode
  60363. */
  60364. set videoMode(value: number);
  60365. protected _initTexture(urlsOrElement: string | string[] | HTMLVideoElement, scene: Scene, options: any): VideoTexture;
  60366. }
  60367. }
  60368. declare module "babylonjs/Helpers/index" {
  60369. export * from "babylonjs/Helpers/environmentHelper";
  60370. export * from "babylonjs/Helpers/photoDome";
  60371. export * from "babylonjs/Helpers/sceneHelpers";
  60372. export * from "babylonjs/Helpers/videoDome";
  60373. }
  60374. declare module "babylonjs/Instrumentation/engineInstrumentation" {
  60375. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  60376. import { IDisposable } from "babylonjs/scene";
  60377. import { Engine } from "babylonjs/Engines/engine";
  60378. /**
  60379. * This class can be used to get instrumentation data from a Babylon engine
  60380. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  60381. */
  60382. export class EngineInstrumentation implements IDisposable {
  60383. /**
  60384. * Define the instrumented engine.
  60385. */
  60386. engine: Engine;
  60387. private _captureGPUFrameTime;
  60388. private _gpuFrameTimeToken;
  60389. private _gpuFrameTime;
  60390. private _captureShaderCompilationTime;
  60391. private _shaderCompilationTime;
  60392. private _onBeginFrameObserver;
  60393. private _onEndFrameObserver;
  60394. private _onBeforeShaderCompilationObserver;
  60395. private _onAfterShaderCompilationObserver;
  60396. /**
  60397. * Gets the perf counter used for GPU frame time
  60398. */
  60399. get gpuFrameTimeCounter(): PerfCounter;
  60400. /**
  60401. * Gets the GPU frame time capture status
  60402. */
  60403. get captureGPUFrameTime(): boolean;
  60404. /**
  60405. * Enable or disable the GPU frame time capture
  60406. */
  60407. set captureGPUFrameTime(value: boolean);
  60408. /**
  60409. * Gets the perf counter used for shader compilation time
  60410. */
  60411. get shaderCompilationTimeCounter(): PerfCounter;
  60412. /**
  60413. * Gets the shader compilation time capture status
  60414. */
  60415. get captureShaderCompilationTime(): boolean;
  60416. /**
  60417. * Enable or disable the shader compilation time capture
  60418. */
  60419. set captureShaderCompilationTime(value: boolean);
  60420. /**
  60421. * Instantiates a new engine instrumentation.
  60422. * This class can be used to get instrumentation data from a Babylon engine
  60423. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  60424. * @param engine Defines the engine to instrument
  60425. */
  60426. constructor(
  60427. /**
  60428. * Define the instrumented engine.
  60429. */
  60430. engine: Engine);
  60431. /**
  60432. * Dispose and release associated resources.
  60433. */
  60434. dispose(): void;
  60435. }
  60436. }
  60437. declare module "babylonjs/Instrumentation/sceneInstrumentation" {
  60438. import { Scene, IDisposable } from "babylonjs/scene";
  60439. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  60440. /**
  60441. * This class can be used to get instrumentation data from a Babylon engine
  60442. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  60443. */
  60444. export class SceneInstrumentation implements IDisposable {
  60445. /**
  60446. * Defines the scene to instrument
  60447. */
  60448. scene: Scene;
  60449. private _captureActiveMeshesEvaluationTime;
  60450. private _activeMeshesEvaluationTime;
  60451. private _captureRenderTargetsRenderTime;
  60452. private _renderTargetsRenderTime;
  60453. private _captureFrameTime;
  60454. private _frameTime;
  60455. private _captureRenderTime;
  60456. private _renderTime;
  60457. private _captureInterFrameTime;
  60458. private _interFrameTime;
  60459. private _captureParticlesRenderTime;
  60460. private _particlesRenderTime;
  60461. private _captureSpritesRenderTime;
  60462. private _spritesRenderTime;
  60463. private _capturePhysicsTime;
  60464. private _physicsTime;
  60465. private _captureAnimationsTime;
  60466. private _animationsTime;
  60467. private _captureCameraRenderTime;
  60468. private _cameraRenderTime;
  60469. private _onBeforeActiveMeshesEvaluationObserver;
  60470. private _onAfterActiveMeshesEvaluationObserver;
  60471. private _onBeforeRenderTargetsRenderObserver;
  60472. private _onAfterRenderTargetsRenderObserver;
  60473. private _onAfterRenderObserver;
  60474. private _onBeforeDrawPhaseObserver;
  60475. private _onAfterDrawPhaseObserver;
  60476. private _onBeforeAnimationsObserver;
  60477. private _onBeforeParticlesRenderingObserver;
  60478. private _onAfterParticlesRenderingObserver;
  60479. private _onBeforeSpritesRenderingObserver;
  60480. private _onAfterSpritesRenderingObserver;
  60481. private _onBeforePhysicsObserver;
  60482. private _onAfterPhysicsObserver;
  60483. private _onAfterAnimationsObserver;
  60484. private _onBeforeCameraRenderObserver;
  60485. private _onAfterCameraRenderObserver;
  60486. /**
  60487. * Gets the perf counter used for active meshes evaluation time
  60488. */
  60489. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  60490. /**
  60491. * Gets the active meshes evaluation time capture status
  60492. */
  60493. get captureActiveMeshesEvaluationTime(): boolean;
  60494. /**
  60495. * Enable or disable the active meshes evaluation time capture
  60496. */
  60497. set captureActiveMeshesEvaluationTime(value: boolean);
  60498. /**
  60499. * Gets the perf counter used for render targets render time
  60500. */
  60501. get renderTargetsRenderTimeCounter(): PerfCounter;
  60502. /**
  60503. * Gets the render targets render time capture status
  60504. */
  60505. get captureRenderTargetsRenderTime(): boolean;
  60506. /**
  60507. * Enable or disable the render targets render time capture
  60508. */
  60509. set captureRenderTargetsRenderTime(value: boolean);
  60510. /**
  60511. * Gets the perf counter used for particles render time
  60512. */
  60513. get particlesRenderTimeCounter(): PerfCounter;
  60514. /**
  60515. * Gets the particles render time capture status
  60516. */
  60517. get captureParticlesRenderTime(): boolean;
  60518. /**
  60519. * Enable or disable the particles render time capture
  60520. */
  60521. set captureParticlesRenderTime(value: boolean);
  60522. /**
  60523. * Gets the perf counter used for sprites render time
  60524. */
  60525. get spritesRenderTimeCounter(): PerfCounter;
  60526. /**
  60527. * Gets the sprites render time capture status
  60528. */
  60529. get captureSpritesRenderTime(): boolean;
  60530. /**
  60531. * Enable or disable the sprites render time capture
  60532. */
  60533. set captureSpritesRenderTime(value: boolean);
  60534. /**
  60535. * Gets the perf counter used for physics time
  60536. */
  60537. get physicsTimeCounter(): PerfCounter;
  60538. /**
  60539. * Gets the physics time capture status
  60540. */
  60541. get capturePhysicsTime(): boolean;
  60542. /**
  60543. * Enable or disable the physics time capture
  60544. */
  60545. set capturePhysicsTime(value: boolean);
  60546. /**
  60547. * Gets the perf counter used for animations time
  60548. */
  60549. get animationsTimeCounter(): PerfCounter;
  60550. /**
  60551. * Gets the animations time capture status
  60552. */
  60553. get captureAnimationsTime(): boolean;
  60554. /**
  60555. * Enable or disable the animations time capture
  60556. */
  60557. set captureAnimationsTime(value: boolean);
  60558. /**
  60559. * Gets the perf counter used for frame time capture
  60560. */
  60561. get frameTimeCounter(): PerfCounter;
  60562. /**
  60563. * Gets the frame time capture status
  60564. */
  60565. get captureFrameTime(): boolean;
  60566. /**
  60567. * Enable or disable the frame time capture
  60568. */
  60569. set captureFrameTime(value: boolean);
  60570. /**
  60571. * Gets the perf counter used for inter-frames time capture
  60572. */
  60573. get interFrameTimeCounter(): PerfCounter;
  60574. /**
  60575. * Gets the inter-frames time capture status
  60576. */
  60577. get captureInterFrameTime(): boolean;
  60578. /**
  60579. * Enable or disable the inter-frames time capture
  60580. */
  60581. set captureInterFrameTime(value: boolean);
  60582. /**
  60583. * Gets the perf counter used for render time capture
  60584. */
  60585. get renderTimeCounter(): PerfCounter;
  60586. /**
  60587. * Gets the render time capture status
  60588. */
  60589. get captureRenderTime(): boolean;
  60590. /**
  60591. * Enable or disable the render time capture
  60592. */
  60593. set captureRenderTime(value: boolean);
  60594. /**
  60595. * Gets the perf counter used for camera render time capture
  60596. */
  60597. get cameraRenderTimeCounter(): PerfCounter;
  60598. /**
  60599. * Gets the camera render time capture status
  60600. */
  60601. get captureCameraRenderTime(): boolean;
  60602. /**
  60603. * Enable or disable the camera render time capture
  60604. */
  60605. set captureCameraRenderTime(value: boolean);
  60606. /**
  60607. * Gets the perf counter used for draw calls
  60608. */
  60609. get drawCallsCounter(): PerfCounter;
  60610. /**
  60611. * Instantiates a new scene instrumentation.
  60612. * This class can be used to get instrumentation data from a Babylon engine
  60613. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  60614. * @param scene Defines the scene to instrument
  60615. */
  60616. constructor(
  60617. /**
  60618. * Defines the scene to instrument
  60619. */
  60620. scene: Scene);
  60621. /**
  60622. * Dispose and release associated resources.
  60623. */
  60624. dispose(): void;
  60625. }
  60626. }
  60627. declare module "babylonjs/Instrumentation/index" {
  60628. export * from "babylonjs/Instrumentation/engineInstrumentation";
  60629. export * from "babylonjs/Instrumentation/sceneInstrumentation";
  60630. export * from "babylonjs/Instrumentation/timeToken";
  60631. }
  60632. declare module "babylonjs/Shaders/glowMapGeneration.fragment" {
  60633. /** @hidden */
  60634. export var glowMapGenerationPixelShader: {
  60635. name: string;
  60636. shader: string;
  60637. };
  60638. }
  60639. declare module "babylonjs/Shaders/glowMapGeneration.vertex" {
  60640. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  60641. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  60642. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  60643. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  60644. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  60645. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  60646. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  60647. /** @hidden */
  60648. export var glowMapGenerationVertexShader: {
  60649. name: string;
  60650. shader: string;
  60651. };
  60652. }
  60653. declare module "babylonjs/Layers/effectLayer" {
  60654. import { Observable } from "babylonjs/Misc/observable";
  60655. import { Nullable } from "babylonjs/types";
  60656. import { Camera } from "babylonjs/Cameras/camera";
  60657. import { Scene } from "babylonjs/scene";
  60658. import { ISize } from "babylonjs/Maths/math.size";
  60659. import { Color4 } from "babylonjs/Maths/math.color";
  60660. import { Engine } from "babylonjs/Engines/engine";
  60661. import { SubMesh } from "babylonjs/Meshes/subMesh";
  60662. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  60663. import { Mesh } from "babylonjs/Meshes/mesh";
  60664. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  60665. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  60666. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  60667. import { Effect } from "babylonjs/Materials/effect";
  60668. import { Material } from "babylonjs/Materials/material";
  60669. import "babylonjs/Shaders/glowMapGeneration.fragment";
  60670. import "babylonjs/Shaders/glowMapGeneration.vertex";
  60671. /**
  60672. * Effect layer options. This helps customizing the behaviour
  60673. * of the effect layer.
  60674. */
  60675. export interface IEffectLayerOptions {
  60676. /**
  60677. * Multiplication factor apply to the canvas size to compute the render target size
  60678. * used to generated the objects (the smaller the faster).
  60679. */
  60680. mainTextureRatio: number;
  60681. /**
  60682. * Enforces a fixed size texture to ensure effect stability across devices.
  60683. */
  60684. mainTextureFixedSize?: number;
  60685. /**
  60686. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  60687. */
  60688. alphaBlendingMode: number;
  60689. /**
  60690. * The camera attached to the layer.
  60691. */
  60692. camera: Nullable<Camera>;
  60693. /**
  60694. * The rendering group to draw the layer in.
  60695. */
  60696. renderingGroupId: number;
  60697. }
  60698. /**
  60699. * The effect layer Helps adding post process effect blended with the main pass.
  60700. *
  60701. * This can be for instance use to generate glow or higlight effects on the scene.
  60702. *
  60703. * The effect layer class can not be used directly and is intented to inherited from to be
  60704. * customized per effects.
  60705. */
  60706. export abstract class EffectLayer {
  60707. private _vertexBuffers;
  60708. private _indexBuffer;
  60709. private _cachedDefines;
  60710. private _effectLayerMapGenerationEffect;
  60711. private _effectLayerOptions;
  60712. private _mergeEffect;
  60713. protected _scene: Scene;
  60714. protected _engine: Engine;
  60715. protected _maxSize: number;
  60716. protected _mainTextureDesiredSize: ISize;
  60717. protected _mainTexture: RenderTargetTexture;
  60718. protected _shouldRender: boolean;
  60719. protected _postProcesses: PostProcess[];
  60720. protected _textures: BaseTexture[];
  60721. protected _emissiveTextureAndColor: {
  60722. texture: Nullable<BaseTexture>;
  60723. color: Color4;
  60724. };
  60725. /**
  60726. * The name of the layer
  60727. */
  60728. name: string;
  60729. /**
  60730. * The clear color of the texture used to generate the glow map.
  60731. */
  60732. neutralColor: Color4;
  60733. /**
  60734. * Specifies whether the highlight layer is enabled or not.
  60735. */
  60736. isEnabled: boolean;
  60737. /**
  60738. * Gets the camera attached to the layer.
  60739. */
  60740. get camera(): Nullable<Camera>;
  60741. /**
  60742. * Gets the rendering group id the layer should render in.
  60743. */
  60744. get renderingGroupId(): number;
  60745. set renderingGroupId(renderingGroupId: number);
  60746. /**
  60747. * An event triggered when the effect layer has been disposed.
  60748. */
  60749. onDisposeObservable: Observable<EffectLayer>;
  60750. /**
  60751. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  60752. */
  60753. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  60754. /**
  60755. * An event triggered when the generated texture is being merged in the scene.
  60756. */
  60757. onBeforeComposeObservable: Observable<EffectLayer>;
  60758. /**
  60759. * An event triggered when the mesh is rendered into the effect render target.
  60760. */
  60761. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  60762. /**
  60763. * An event triggered after the mesh has been rendered into the effect render target.
  60764. */
  60765. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  60766. /**
  60767. * An event triggered when the generated texture has been merged in the scene.
  60768. */
  60769. onAfterComposeObservable: Observable<EffectLayer>;
  60770. /**
  60771. * An event triggered when the efffect layer changes its size.
  60772. */
  60773. onSizeChangedObservable: Observable<EffectLayer>;
  60774. /** @hidden */
  60775. static _SceneComponentInitialization: (scene: Scene) => void;
  60776. /**
  60777. * Instantiates a new effect Layer and references it in the scene.
  60778. * @param name The name of the layer
  60779. * @param scene The scene to use the layer in
  60780. */
  60781. constructor(
  60782. /** The Friendly of the effect in the scene */
  60783. name: string, scene: Scene);
  60784. /**
  60785. * Get the effect name of the layer.
  60786. * @return The effect name
  60787. */
  60788. abstract getEffectName(): string;
  60789. /**
  60790. * Checks for the readiness of the element composing the layer.
  60791. * @param subMesh the mesh to check for
  60792. * @param useInstances specify whether or not to use instances to render the mesh
  60793. * @return true if ready otherwise, false
  60794. */
  60795. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  60796. /**
  60797. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  60798. * @returns true if the effect requires stencil during the main canvas render pass.
  60799. */
  60800. abstract needStencil(): boolean;
  60801. /**
  60802. * Create the merge effect. This is the shader use to blit the information back
  60803. * to the main canvas at the end of the scene rendering.
  60804. * @returns The effect containing the shader used to merge the effect on the main canvas
  60805. */
  60806. protected abstract _createMergeEffect(): Effect;
  60807. /**
  60808. * Creates the render target textures and post processes used in the effect layer.
  60809. */
  60810. protected abstract _createTextureAndPostProcesses(): void;
  60811. /**
  60812. * Implementation specific of rendering the generating effect on the main canvas.
  60813. * @param effect The effect used to render through
  60814. */
  60815. protected abstract _internalRender(effect: Effect): void;
  60816. /**
  60817. * Sets the required values for both the emissive texture and and the main color.
  60818. */
  60819. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  60820. /**
  60821. * Free any resources and references associated to a mesh.
  60822. * Internal use
  60823. * @param mesh The mesh to free.
  60824. */
  60825. abstract _disposeMesh(mesh: Mesh): void;
  60826. /**
  60827. * Serializes this layer (Glow or Highlight for example)
  60828. * @returns a serialized layer object
  60829. */
  60830. abstract serialize?(): any;
  60831. /**
  60832. * Initializes the effect layer with the required options.
  60833. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  60834. */
  60835. protected _init(options: Partial<IEffectLayerOptions>): void;
  60836. /**
  60837. * Generates the index buffer of the full screen quad blending to the main canvas.
  60838. */
  60839. private _generateIndexBuffer;
  60840. /**
  60841. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  60842. */
  60843. private _generateVertexBuffer;
  60844. /**
  60845. * Sets the main texture desired size which is the closest power of two
  60846. * of the engine canvas size.
  60847. */
  60848. private _setMainTextureSize;
  60849. /**
  60850. * Creates the main texture for the effect layer.
  60851. */
  60852. protected _createMainTexture(): void;
  60853. /**
  60854. * Adds specific effects defines.
  60855. * @param defines The defines to add specifics to.
  60856. */
  60857. protected _addCustomEffectDefines(defines: string[]): void;
  60858. /**
  60859. * Checks for the readiness of the element composing the layer.
  60860. * @param subMesh the mesh to check for
  60861. * @param useInstances specify whether or not to use instances to render the mesh
  60862. * @param emissiveTexture the associated emissive texture used to generate the glow
  60863. * @return true if ready otherwise, false
  60864. */
  60865. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  60866. /**
  60867. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  60868. */
  60869. render(): void;
  60870. /**
  60871. * Determine if a given mesh will be used in the current effect.
  60872. * @param mesh mesh to test
  60873. * @returns true if the mesh will be used
  60874. */
  60875. hasMesh(mesh: AbstractMesh): boolean;
  60876. /**
  60877. * Returns true if the layer contains information to display, otherwise false.
  60878. * @returns true if the glow layer should be rendered
  60879. */
  60880. shouldRender(): boolean;
  60881. /**
  60882. * Returns true if the mesh should render, otherwise false.
  60883. * @param mesh The mesh to render
  60884. * @returns true if it should render otherwise false
  60885. */
  60886. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  60887. /**
  60888. * Returns true if the mesh can be rendered, otherwise false.
  60889. * @param mesh The mesh to render
  60890. * @param material The material used on the mesh
  60891. * @returns true if it can be rendered otherwise false
  60892. */
  60893. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  60894. /**
  60895. * Returns true if the mesh should render, otherwise false.
  60896. * @param mesh The mesh to render
  60897. * @returns true if it should render otherwise false
  60898. */
  60899. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  60900. /**
  60901. * Renders the submesh passed in parameter to the generation map.
  60902. */
  60903. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  60904. /**
  60905. * Defines whether the current material of the mesh should be use to render the effect.
  60906. * @param mesh defines the current mesh to render
  60907. */
  60908. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  60909. /**
  60910. * Rebuild the required buffers.
  60911. * @hidden Internal use only.
  60912. */
  60913. _rebuild(): void;
  60914. /**
  60915. * Dispose only the render target textures and post process.
  60916. */
  60917. private _disposeTextureAndPostProcesses;
  60918. /**
  60919. * Dispose the highlight layer and free resources.
  60920. */
  60921. dispose(): void;
  60922. /**
  60923. * Gets the class name of the effect layer
  60924. * @returns the string with the class name of the effect layer
  60925. */
  60926. getClassName(): string;
  60927. /**
  60928. * Creates an effect layer from parsed effect layer data
  60929. * @param parsedEffectLayer defines effect layer data
  60930. * @param scene defines the current scene
  60931. * @param rootUrl defines the root URL containing the effect layer information
  60932. * @returns a parsed effect Layer
  60933. */
  60934. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  60935. }
  60936. }
  60937. declare module "babylonjs/Layers/effectLayerSceneComponent" {
  60938. import { Scene } from "babylonjs/scene";
  60939. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  60940. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  60941. import { AbstractScene } from "babylonjs/abstractScene";
  60942. module "babylonjs/abstractScene" {
  60943. interface AbstractScene {
  60944. /**
  60945. * The list of effect layers (highlights/glow) added to the scene
  60946. * @see https://doc.babylonjs.com/how_to/highlight_layer
  60947. * @see https://doc.babylonjs.com/how_to/glow_layer
  60948. */
  60949. effectLayers: Array<EffectLayer>;
  60950. /**
  60951. * Removes the given effect layer from this scene.
  60952. * @param toRemove defines the effect layer to remove
  60953. * @returns the index of the removed effect layer
  60954. */
  60955. removeEffectLayer(toRemove: EffectLayer): number;
  60956. /**
  60957. * Adds the given effect layer to this scene
  60958. * @param newEffectLayer defines the effect layer to add
  60959. */
  60960. addEffectLayer(newEffectLayer: EffectLayer): void;
  60961. }
  60962. }
  60963. /**
  60964. * Defines the layer scene component responsible to manage any effect layers
  60965. * in a given scene.
  60966. */
  60967. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  60968. /**
  60969. * The component name helpfull to identify the component in the list of scene components.
  60970. */
  60971. readonly name: string;
  60972. /**
  60973. * The scene the component belongs to.
  60974. */
  60975. scene: Scene;
  60976. private _engine;
  60977. private _renderEffects;
  60978. private _needStencil;
  60979. private _previousStencilState;
  60980. /**
  60981. * Creates a new instance of the component for the given scene
  60982. * @param scene Defines the scene to register the component in
  60983. */
  60984. constructor(scene: Scene);
  60985. /**
  60986. * Registers the component in a given scene
  60987. */
  60988. register(): void;
  60989. /**
  60990. * Rebuilds the elements related to this component in case of
  60991. * context lost for instance.
  60992. */
  60993. rebuild(): void;
  60994. /**
  60995. * Serializes the component data to the specified json object
  60996. * @param serializationObject The object to serialize to
  60997. */
  60998. serialize(serializationObject: any): void;
  60999. /**
  61000. * Adds all the elements from the container to the scene
  61001. * @param container the container holding the elements
  61002. */
  61003. addFromContainer(container: AbstractScene): void;
  61004. /**
  61005. * Removes all the elements in the container from the scene
  61006. * @param container contains the elements to remove
  61007. * @param dispose if the removed element should be disposed (default: false)
  61008. */
  61009. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  61010. /**
  61011. * Disposes the component and the associated ressources.
  61012. */
  61013. dispose(): void;
  61014. private _isReadyForMesh;
  61015. private _renderMainTexture;
  61016. private _setStencil;
  61017. private _setStencilBack;
  61018. private _draw;
  61019. private _drawCamera;
  61020. private _drawRenderingGroup;
  61021. }
  61022. }
  61023. declare module "babylonjs/Shaders/glowMapMerge.fragment" {
  61024. /** @hidden */
  61025. export var glowMapMergePixelShader: {
  61026. name: string;
  61027. shader: string;
  61028. };
  61029. }
  61030. declare module "babylonjs/Shaders/glowMapMerge.vertex" {
  61031. /** @hidden */
  61032. export var glowMapMergeVertexShader: {
  61033. name: string;
  61034. shader: string;
  61035. };
  61036. }
  61037. declare module "babylonjs/Layers/glowLayer" {
  61038. import { Nullable } from "babylonjs/types";
  61039. import { Camera } from "babylonjs/Cameras/camera";
  61040. import { Scene } from "babylonjs/scene";
  61041. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61042. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61043. import { Mesh } from "babylonjs/Meshes/mesh";
  61044. import { Texture } from "babylonjs/Materials/Textures/texture";
  61045. import { Effect } from "babylonjs/Materials/effect";
  61046. import { Material } from "babylonjs/Materials/material";
  61047. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  61048. import { Color4 } from "babylonjs/Maths/math.color";
  61049. import "babylonjs/Shaders/glowMapMerge.fragment";
  61050. import "babylonjs/Shaders/glowMapMerge.vertex";
  61051. import "babylonjs/Layers/effectLayerSceneComponent";
  61052. module "babylonjs/abstractScene" {
  61053. interface AbstractScene {
  61054. /**
  61055. * Return a the first highlight layer of the scene with a given name.
  61056. * @param name The name of the highlight layer to look for.
  61057. * @return The highlight layer if found otherwise null.
  61058. */
  61059. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  61060. }
  61061. }
  61062. /**
  61063. * Glow layer options. This helps customizing the behaviour
  61064. * of the glow layer.
  61065. */
  61066. export interface IGlowLayerOptions {
  61067. /**
  61068. * Multiplication factor apply to the canvas size to compute the render target size
  61069. * used to generated the glowing objects (the smaller the faster).
  61070. */
  61071. mainTextureRatio: number;
  61072. /**
  61073. * Enforces a fixed size texture to ensure resize independant blur.
  61074. */
  61075. mainTextureFixedSize?: number;
  61076. /**
  61077. * How big is the kernel of the blur texture.
  61078. */
  61079. blurKernelSize: number;
  61080. /**
  61081. * The camera attached to the layer.
  61082. */
  61083. camera: Nullable<Camera>;
  61084. /**
  61085. * Enable MSAA by chosing the number of samples.
  61086. */
  61087. mainTextureSamples?: number;
  61088. /**
  61089. * The rendering group to draw the layer in.
  61090. */
  61091. renderingGroupId: number;
  61092. }
  61093. /**
  61094. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  61095. *
  61096. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  61097. *
  61098. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  61099. */
  61100. export class GlowLayer extends EffectLayer {
  61101. /**
  61102. * Effect Name of the layer.
  61103. */
  61104. static readonly EffectName: string;
  61105. /**
  61106. * The default blur kernel size used for the glow.
  61107. */
  61108. static DefaultBlurKernelSize: number;
  61109. /**
  61110. * The default texture size ratio used for the glow.
  61111. */
  61112. static DefaultTextureRatio: number;
  61113. /**
  61114. * Sets the kernel size of the blur.
  61115. */
  61116. set blurKernelSize(value: number);
  61117. /**
  61118. * Gets the kernel size of the blur.
  61119. */
  61120. get blurKernelSize(): number;
  61121. /**
  61122. * Sets the glow intensity.
  61123. */
  61124. set intensity(value: number);
  61125. /**
  61126. * Gets the glow intensity.
  61127. */
  61128. get intensity(): number;
  61129. private _options;
  61130. private _intensity;
  61131. private _horizontalBlurPostprocess1;
  61132. private _verticalBlurPostprocess1;
  61133. private _horizontalBlurPostprocess2;
  61134. private _verticalBlurPostprocess2;
  61135. private _blurTexture1;
  61136. private _blurTexture2;
  61137. private _postProcesses1;
  61138. private _postProcesses2;
  61139. private _includedOnlyMeshes;
  61140. private _excludedMeshes;
  61141. private _meshesUsingTheirOwnMaterials;
  61142. /**
  61143. * Callback used to let the user override the color selection on a per mesh basis
  61144. */
  61145. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  61146. /**
  61147. * Callback used to let the user override the texture selection on a per mesh basis
  61148. */
  61149. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  61150. /**
  61151. * Instantiates a new glow Layer and references it to the scene.
  61152. * @param name The name of the layer
  61153. * @param scene The scene to use the layer in
  61154. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  61155. */
  61156. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  61157. /**
  61158. * Get the effect name of the layer.
  61159. * @return The effect name
  61160. */
  61161. getEffectName(): string;
  61162. /**
  61163. * Create the merge effect. This is the shader use to blit the information back
  61164. * to the main canvas at the end of the scene rendering.
  61165. */
  61166. protected _createMergeEffect(): Effect;
  61167. /**
  61168. * Creates the render target textures and post processes used in the glow layer.
  61169. */
  61170. protected _createTextureAndPostProcesses(): void;
  61171. /**
  61172. * Checks for the readiness of the element composing the layer.
  61173. * @param subMesh the mesh to check for
  61174. * @param useInstances specify wether or not to use instances to render the mesh
  61175. * @param emissiveTexture the associated emissive texture used to generate the glow
  61176. * @return true if ready otherwise, false
  61177. */
  61178. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61179. /**
  61180. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  61181. */
  61182. needStencil(): boolean;
  61183. /**
  61184. * Returns true if the mesh can be rendered, otherwise false.
  61185. * @param mesh The mesh to render
  61186. * @param material The material used on the mesh
  61187. * @returns true if it can be rendered otherwise false
  61188. */
  61189. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  61190. /**
  61191. * Implementation specific of rendering the generating effect on the main canvas.
  61192. * @param effect The effect used to render through
  61193. */
  61194. protected _internalRender(effect: Effect): void;
  61195. /**
  61196. * Sets the required values for both the emissive texture and and the main color.
  61197. */
  61198. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  61199. /**
  61200. * Returns true if the mesh should render, otherwise false.
  61201. * @param mesh The mesh to render
  61202. * @returns true if it should render otherwise false
  61203. */
  61204. protected _shouldRenderMesh(mesh: Mesh): boolean;
  61205. /**
  61206. * Adds specific effects defines.
  61207. * @param defines The defines to add specifics to.
  61208. */
  61209. protected _addCustomEffectDefines(defines: string[]): void;
  61210. /**
  61211. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  61212. * @param mesh The mesh to exclude from the glow layer
  61213. */
  61214. addExcludedMesh(mesh: Mesh): void;
  61215. /**
  61216. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  61217. * @param mesh The mesh to remove
  61218. */
  61219. removeExcludedMesh(mesh: Mesh): void;
  61220. /**
  61221. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  61222. * @param mesh The mesh to include in the glow layer
  61223. */
  61224. addIncludedOnlyMesh(mesh: Mesh): void;
  61225. /**
  61226. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  61227. * @param mesh The mesh to remove
  61228. */
  61229. removeIncludedOnlyMesh(mesh: Mesh): void;
  61230. /**
  61231. * Determine if a given mesh will be used in the glow layer
  61232. * @param mesh The mesh to test
  61233. * @returns true if the mesh will be highlighted by the current glow layer
  61234. */
  61235. hasMesh(mesh: AbstractMesh): boolean;
  61236. /**
  61237. * Defines whether the current material of the mesh should be use to render the effect.
  61238. * @param mesh defines the current mesh to render
  61239. */
  61240. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  61241. /**
  61242. * Add a mesh to be rendered through its own material and not with emissive only.
  61243. * @param mesh The mesh for which we need to use its material
  61244. */
  61245. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  61246. /**
  61247. * Remove a mesh from being rendered through its own material and not with emissive only.
  61248. * @param mesh The mesh for which we need to not use its material
  61249. */
  61250. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  61251. /**
  61252. * Free any resources and references associated to a mesh.
  61253. * Internal use
  61254. * @param mesh The mesh to free.
  61255. * @hidden
  61256. */
  61257. _disposeMesh(mesh: Mesh): void;
  61258. /**
  61259. * Gets the class name of the effect layer
  61260. * @returns the string with the class name of the effect layer
  61261. */
  61262. getClassName(): string;
  61263. /**
  61264. * Serializes this glow layer
  61265. * @returns a serialized glow layer object
  61266. */
  61267. serialize(): any;
  61268. /**
  61269. * Creates a Glow Layer from parsed glow layer data
  61270. * @param parsedGlowLayer defines glow layer data
  61271. * @param scene defines the current scene
  61272. * @param rootUrl defines the root URL containing the glow layer information
  61273. * @returns a parsed Glow Layer
  61274. */
  61275. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  61276. }
  61277. }
  61278. declare module "babylonjs/Shaders/glowBlurPostProcess.fragment" {
  61279. /** @hidden */
  61280. export var glowBlurPostProcessPixelShader: {
  61281. name: string;
  61282. shader: string;
  61283. };
  61284. }
  61285. declare module "babylonjs/Layers/highlightLayer" {
  61286. import { Observable } from "babylonjs/Misc/observable";
  61287. import { Nullable } from "babylonjs/types";
  61288. import { Camera } from "babylonjs/Cameras/camera";
  61289. import { Scene } from "babylonjs/scene";
  61290. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61291. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61292. import { Mesh } from "babylonjs/Meshes/mesh";
  61293. import { Effect } from "babylonjs/Materials/effect";
  61294. import { Material } from "babylonjs/Materials/material";
  61295. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  61296. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  61297. import "babylonjs/Shaders/glowMapMerge.fragment";
  61298. import "babylonjs/Shaders/glowMapMerge.vertex";
  61299. import "babylonjs/Shaders/glowBlurPostProcess.fragment";
  61300. module "babylonjs/abstractScene" {
  61301. interface AbstractScene {
  61302. /**
  61303. * Return a the first highlight layer of the scene with a given name.
  61304. * @param name The name of the highlight layer to look for.
  61305. * @return The highlight layer if found otherwise null.
  61306. */
  61307. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  61308. }
  61309. }
  61310. /**
  61311. * Highlight layer options. This helps customizing the behaviour
  61312. * of the highlight layer.
  61313. */
  61314. export interface IHighlightLayerOptions {
  61315. /**
  61316. * Multiplication factor apply to the canvas size to compute the render target size
  61317. * used to generated the glowing objects (the smaller the faster).
  61318. */
  61319. mainTextureRatio: number;
  61320. /**
  61321. * Enforces a fixed size texture to ensure resize independant blur.
  61322. */
  61323. mainTextureFixedSize?: number;
  61324. /**
  61325. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  61326. * of the picture to blur (the smaller the faster).
  61327. */
  61328. blurTextureSizeRatio: number;
  61329. /**
  61330. * How big in texel of the blur texture is the vertical blur.
  61331. */
  61332. blurVerticalSize: number;
  61333. /**
  61334. * How big in texel of the blur texture is the horizontal blur.
  61335. */
  61336. blurHorizontalSize: number;
  61337. /**
  61338. * Alpha blending mode used to apply the blur. Default is combine.
  61339. */
  61340. alphaBlendingMode: number;
  61341. /**
  61342. * The camera attached to the layer.
  61343. */
  61344. camera: Nullable<Camera>;
  61345. /**
  61346. * Should we display highlight as a solid stroke?
  61347. */
  61348. isStroke?: boolean;
  61349. /**
  61350. * The rendering group to draw the layer in.
  61351. */
  61352. renderingGroupId: number;
  61353. }
  61354. /**
  61355. * The highlight layer Helps adding a glow effect around a mesh.
  61356. *
  61357. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  61358. * glowy meshes to your scene.
  61359. *
  61360. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  61361. */
  61362. export class HighlightLayer extends EffectLayer {
  61363. name: string;
  61364. /**
  61365. * Effect Name of the highlight layer.
  61366. */
  61367. static readonly EffectName: string;
  61368. /**
  61369. * The neutral color used during the preparation of the glow effect.
  61370. * This is black by default as the blend operation is a blend operation.
  61371. */
  61372. static NeutralColor: Color4;
  61373. /**
  61374. * Stencil value used for glowing meshes.
  61375. */
  61376. static GlowingMeshStencilReference: number;
  61377. /**
  61378. * Stencil value used for the other meshes in the scene.
  61379. */
  61380. static NormalMeshStencilReference: number;
  61381. /**
  61382. * Specifies whether or not the inner glow is ACTIVE in the layer.
  61383. */
  61384. innerGlow: boolean;
  61385. /**
  61386. * Specifies whether or not the outer glow is ACTIVE in the layer.
  61387. */
  61388. outerGlow: boolean;
  61389. /**
  61390. * Specifies the horizontal size of the blur.
  61391. */
  61392. set blurHorizontalSize(value: number);
  61393. /**
  61394. * Specifies the vertical size of the blur.
  61395. */
  61396. set blurVerticalSize(value: number);
  61397. /**
  61398. * Gets the horizontal size of the blur.
  61399. */
  61400. get blurHorizontalSize(): number;
  61401. /**
  61402. * Gets the vertical size of the blur.
  61403. */
  61404. get blurVerticalSize(): number;
  61405. /**
  61406. * An event triggered when the highlight layer is being blurred.
  61407. */
  61408. onBeforeBlurObservable: Observable<HighlightLayer>;
  61409. /**
  61410. * An event triggered when the highlight layer has been blurred.
  61411. */
  61412. onAfterBlurObservable: Observable<HighlightLayer>;
  61413. private _instanceGlowingMeshStencilReference;
  61414. private _options;
  61415. private _downSamplePostprocess;
  61416. private _horizontalBlurPostprocess;
  61417. private _verticalBlurPostprocess;
  61418. private _blurTexture;
  61419. private _meshes;
  61420. private _excludedMeshes;
  61421. /**
  61422. * Instantiates a new highlight Layer and references it to the scene..
  61423. * @param name The name of the layer
  61424. * @param scene The scene to use the layer in
  61425. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  61426. */
  61427. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  61428. /**
  61429. * Get the effect name of the layer.
  61430. * @return The effect name
  61431. */
  61432. getEffectName(): string;
  61433. /**
  61434. * Create the merge effect. This is the shader use to blit the information back
  61435. * to the main canvas at the end of the scene rendering.
  61436. */
  61437. protected _createMergeEffect(): Effect;
  61438. /**
  61439. * Creates the render target textures and post processes used in the highlight layer.
  61440. */
  61441. protected _createTextureAndPostProcesses(): void;
  61442. /**
  61443. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  61444. */
  61445. needStencil(): boolean;
  61446. /**
  61447. * Checks for the readiness of the element composing the layer.
  61448. * @param subMesh the mesh to check for
  61449. * @param useInstances specify wether or not to use instances to render the mesh
  61450. * @param emissiveTexture the associated emissive texture used to generate the glow
  61451. * @return true if ready otherwise, false
  61452. */
  61453. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61454. /**
  61455. * Implementation specific of rendering the generating effect on the main canvas.
  61456. * @param effect The effect used to render through
  61457. */
  61458. protected _internalRender(effect: Effect): void;
  61459. /**
  61460. * Returns true if the layer contains information to display, otherwise false.
  61461. */
  61462. shouldRender(): boolean;
  61463. /**
  61464. * Returns true if the mesh should render, otherwise false.
  61465. * @param mesh The mesh to render
  61466. * @returns true if it should render otherwise false
  61467. */
  61468. protected _shouldRenderMesh(mesh: Mesh): boolean;
  61469. /**
  61470. * Returns true if the mesh can be rendered, otherwise false.
  61471. * @param mesh The mesh to render
  61472. * @param material The material used on the mesh
  61473. * @returns true if it can be rendered otherwise false
  61474. */
  61475. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  61476. /**
  61477. * Adds specific effects defines.
  61478. * @param defines The defines to add specifics to.
  61479. */
  61480. protected _addCustomEffectDefines(defines: string[]): void;
  61481. /**
  61482. * Sets the required values for both the emissive texture and and the main color.
  61483. */
  61484. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  61485. /**
  61486. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  61487. * @param mesh The mesh to exclude from the highlight layer
  61488. */
  61489. addExcludedMesh(mesh: Mesh): void;
  61490. /**
  61491. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  61492. * @param mesh The mesh to highlight
  61493. */
  61494. removeExcludedMesh(mesh: Mesh): void;
  61495. /**
  61496. * Determine if a given mesh will be highlighted by the current HighlightLayer
  61497. * @param mesh mesh to test
  61498. * @returns true if the mesh will be highlighted by the current HighlightLayer
  61499. */
  61500. hasMesh(mesh: AbstractMesh): boolean;
  61501. /**
  61502. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  61503. * @param mesh The mesh to highlight
  61504. * @param color The color of the highlight
  61505. * @param glowEmissiveOnly Extract the glow from the emissive texture
  61506. */
  61507. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  61508. /**
  61509. * Remove a mesh from the highlight layer in order to make it stop glowing.
  61510. * @param mesh The mesh to highlight
  61511. */
  61512. removeMesh(mesh: Mesh): void;
  61513. /**
  61514. * Remove all the meshes currently referenced in the highlight layer
  61515. */
  61516. removeAllMeshes(): void;
  61517. /**
  61518. * Force the stencil to the normal expected value for none glowing parts
  61519. */
  61520. private _defaultStencilReference;
  61521. /**
  61522. * Free any resources and references associated to a mesh.
  61523. * Internal use
  61524. * @param mesh The mesh to free.
  61525. * @hidden
  61526. */
  61527. _disposeMesh(mesh: Mesh): void;
  61528. /**
  61529. * Dispose the highlight layer and free resources.
  61530. */
  61531. dispose(): void;
  61532. /**
  61533. * Gets the class name of the effect layer
  61534. * @returns the string with the class name of the effect layer
  61535. */
  61536. getClassName(): string;
  61537. /**
  61538. * Serializes this Highlight layer
  61539. * @returns a serialized Highlight layer object
  61540. */
  61541. serialize(): any;
  61542. /**
  61543. * Creates a Highlight layer from parsed Highlight layer data
  61544. * @param parsedHightlightLayer defines the Highlight layer data
  61545. * @param scene defines the current scene
  61546. * @param rootUrl defines the root URL containing the Highlight layer information
  61547. * @returns a parsed Highlight layer
  61548. */
  61549. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  61550. }
  61551. }
  61552. declare module "babylonjs/Layers/layerSceneComponent" {
  61553. import { Scene } from "babylonjs/scene";
  61554. import { ISceneComponent } from "babylonjs/sceneComponent";
  61555. import { Layer } from "babylonjs/Layers/layer";
  61556. import { AbstractScene } from "babylonjs/abstractScene";
  61557. module "babylonjs/abstractScene" {
  61558. interface AbstractScene {
  61559. /**
  61560. * The list of layers (background and foreground) of the scene
  61561. */
  61562. layers: Array<Layer>;
  61563. }
  61564. }
  61565. /**
  61566. * Defines the layer scene component responsible to manage any layers
  61567. * in a given scene.
  61568. */
  61569. export class LayerSceneComponent implements ISceneComponent {
  61570. /**
  61571. * The component name helpfull to identify the component in the list of scene components.
  61572. */
  61573. readonly name: string;
  61574. /**
  61575. * The scene the component belongs to.
  61576. */
  61577. scene: Scene;
  61578. private _engine;
  61579. /**
  61580. * Creates a new instance of the component for the given scene
  61581. * @param scene Defines the scene to register the component in
  61582. */
  61583. constructor(scene: Scene);
  61584. /**
  61585. * Registers the component in a given scene
  61586. */
  61587. register(): void;
  61588. /**
  61589. * Rebuilds the elements related to this component in case of
  61590. * context lost for instance.
  61591. */
  61592. rebuild(): void;
  61593. /**
  61594. * Disposes the component and the associated ressources.
  61595. */
  61596. dispose(): void;
  61597. private _draw;
  61598. private _drawCameraPredicate;
  61599. private _drawCameraBackground;
  61600. private _drawCameraForeground;
  61601. private _drawRenderTargetPredicate;
  61602. private _drawRenderTargetBackground;
  61603. private _drawRenderTargetForeground;
  61604. /**
  61605. * Adds all the elements from the container to the scene
  61606. * @param container the container holding the elements
  61607. */
  61608. addFromContainer(container: AbstractScene): void;
  61609. /**
  61610. * Removes all the elements in the container from the scene
  61611. * @param container contains the elements to remove
  61612. * @param dispose if the removed element should be disposed (default: false)
  61613. */
  61614. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  61615. }
  61616. }
  61617. declare module "babylonjs/Shaders/layer.fragment" {
  61618. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  61619. /** @hidden */
  61620. export var layerPixelShader: {
  61621. name: string;
  61622. shader: string;
  61623. };
  61624. }
  61625. declare module "babylonjs/Shaders/layer.vertex" {
  61626. /** @hidden */
  61627. export var layerVertexShader: {
  61628. name: string;
  61629. shader: string;
  61630. };
  61631. }
  61632. declare module "babylonjs/Layers/layer" {
  61633. import { Observable } from "babylonjs/Misc/observable";
  61634. import { Nullable } from "babylonjs/types";
  61635. import { Scene } from "babylonjs/scene";
  61636. import { Vector2 } from "babylonjs/Maths/math.vector";
  61637. import { Color4 } from "babylonjs/Maths/math.color";
  61638. import { Texture } from "babylonjs/Materials/Textures/texture";
  61639. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  61640. import "babylonjs/Shaders/layer.fragment";
  61641. import "babylonjs/Shaders/layer.vertex";
  61642. /**
  61643. * This represents a full screen 2d layer.
  61644. * This can be useful to display a picture in the background of your scene for instance.
  61645. * @see https://www.babylonjs-playground.com/#08A2BS#1
  61646. */
  61647. export class Layer {
  61648. /**
  61649. * Define the name of the layer.
  61650. */
  61651. name: string;
  61652. /**
  61653. * Define the texture the layer should display.
  61654. */
  61655. texture: Nullable<Texture>;
  61656. /**
  61657. * Is the layer in background or foreground.
  61658. */
  61659. isBackground: boolean;
  61660. /**
  61661. * Define the color of the layer (instead of texture).
  61662. */
  61663. color: Color4;
  61664. /**
  61665. * Define the scale of the layer in order to zoom in out of the texture.
  61666. */
  61667. scale: Vector2;
  61668. /**
  61669. * Define an offset for the layer in order to shift the texture.
  61670. */
  61671. offset: Vector2;
  61672. /**
  61673. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  61674. */
  61675. alphaBlendingMode: number;
  61676. /**
  61677. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  61678. * Alpha test will not mix with the background color in case of transparency.
  61679. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  61680. */
  61681. alphaTest: boolean;
  61682. /**
  61683. * Define a mask to restrict the layer to only some of the scene cameras.
  61684. */
  61685. layerMask: number;
  61686. /**
  61687. * Define the list of render target the layer is visible into.
  61688. */
  61689. renderTargetTextures: RenderTargetTexture[];
  61690. /**
  61691. * Define if the layer is only used in renderTarget or if it also
  61692. * renders in the main frame buffer of the canvas.
  61693. */
  61694. renderOnlyInRenderTargetTextures: boolean;
  61695. private _scene;
  61696. private _vertexBuffers;
  61697. private _indexBuffer;
  61698. private _effect;
  61699. private _previousDefines;
  61700. /**
  61701. * An event triggered when the layer is disposed.
  61702. */
  61703. onDisposeObservable: Observable<Layer>;
  61704. private _onDisposeObserver;
  61705. /**
  61706. * Back compatibility with callback before the onDisposeObservable existed.
  61707. * The set callback will be triggered when the layer has been disposed.
  61708. */
  61709. set onDispose(callback: () => void);
  61710. /**
  61711. * An event triggered before rendering the scene
  61712. */
  61713. onBeforeRenderObservable: Observable<Layer>;
  61714. private _onBeforeRenderObserver;
  61715. /**
  61716. * Back compatibility with callback before the onBeforeRenderObservable existed.
  61717. * The set callback will be triggered just before rendering the layer.
  61718. */
  61719. set onBeforeRender(callback: () => void);
  61720. /**
  61721. * An event triggered after rendering the scene
  61722. */
  61723. onAfterRenderObservable: Observable<Layer>;
  61724. private _onAfterRenderObserver;
  61725. /**
  61726. * Back compatibility with callback before the onAfterRenderObservable existed.
  61727. * The set callback will be triggered just after rendering the layer.
  61728. */
  61729. set onAfterRender(callback: () => void);
  61730. /**
  61731. * Instantiates a new layer.
  61732. * This represents a full screen 2d layer.
  61733. * This can be useful to display a picture in the background of your scene for instance.
  61734. * @see https://www.babylonjs-playground.com/#08A2BS#1
  61735. * @param name Define the name of the layer in the scene
  61736. * @param imgUrl Define the url of the texture to display in the layer
  61737. * @param scene Define the scene the layer belongs to
  61738. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  61739. * @param color Defines a color for the layer
  61740. */
  61741. constructor(
  61742. /**
  61743. * Define the name of the layer.
  61744. */
  61745. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  61746. private _createIndexBuffer;
  61747. /** @hidden */
  61748. _rebuild(): void;
  61749. /**
  61750. * Renders the layer in the scene.
  61751. */
  61752. render(): void;
  61753. /**
  61754. * Disposes and releases the associated ressources.
  61755. */
  61756. dispose(): void;
  61757. }
  61758. }
  61759. declare module "babylonjs/Layers/index" {
  61760. export * from "babylonjs/Layers/effectLayer";
  61761. export * from "babylonjs/Layers/effectLayerSceneComponent";
  61762. export * from "babylonjs/Layers/glowLayer";
  61763. export * from "babylonjs/Layers/highlightLayer";
  61764. export * from "babylonjs/Layers/layer";
  61765. export * from "babylonjs/Layers/layerSceneComponent";
  61766. }
  61767. declare module "babylonjs/Shaders/lensFlare.fragment" {
  61768. /** @hidden */
  61769. export var lensFlarePixelShader: {
  61770. name: string;
  61771. shader: string;
  61772. };
  61773. }
  61774. declare module "babylonjs/Shaders/lensFlare.vertex" {
  61775. /** @hidden */
  61776. export var lensFlareVertexShader: {
  61777. name: string;
  61778. shader: string;
  61779. };
  61780. }
  61781. declare module "babylonjs/LensFlares/lensFlareSystem" {
  61782. import { Scene } from "babylonjs/scene";
  61783. import { Vector3 } from "babylonjs/Maths/math.vector";
  61784. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61785. import { LensFlare } from "babylonjs/LensFlares/lensFlare";
  61786. import "babylonjs/Shaders/lensFlare.fragment";
  61787. import "babylonjs/Shaders/lensFlare.vertex";
  61788. import { Viewport } from "babylonjs/Maths/math.viewport";
  61789. /**
  61790. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  61791. * It is usually composed of several `lensFlare`.
  61792. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61793. */
  61794. export class LensFlareSystem {
  61795. /**
  61796. * Define the name of the lens flare system
  61797. */
  61798. name: string;
  61799. /**
  61800. * List of lens flares used in this system.
  61801. */
  61802. lensFlares: LensFlare[];
  61803. /**
  61804. * Define a limit from the border the lens flare can be visible.
  61805. */
  61806. borderLimit: number;
  61807. /**
  61808. * Define a viewport border we do not want to see the lens flare in.
  61809. */
  61810. viewportBorder: number;
  61811. /**
  61812. * Define a predicate which could limit the list of meshes able to occlude the effect.
  61813. */
  61814. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  61815. /**
  61816. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  61817. */
  61818. layerMask: number;
  61819. /**
  61820. * Define the id of the lens flare system in the scene.
  61821. * (equal to name by default)
  61822. */
  61823. id: string;
  61824. private _scene;
  61825. private _emitter;
  61826. private _vertexBuffers;
  61827. private _indexBuffer;
  61828. private _effect;
  61829. private _positionX;
  61830. private _positionY;
  61831. private _isEnabled;
  61832. /** @hidden */
  61833. static _SceneComponentInitialization: (scene: Scene) => void;
  61834. /**
  61835. * Instantiates a lens flare system.
  61836. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  61837. * It is usually composed of several `lensFlare`.
  61838. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61839. * @param name Define the name of the lens flare system in the scene
  61840. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  61841. * @param scene Define the scene the lens flare system belongs to
  61842. */
  61843. constructor(
  61844. /**
  61845. * Define the name of the lens flare system
  61846. */
  61847. name: string, emitter: any, scene: Scene);
  61848. /**
  61849. * Define if the lens flare system is enabled.
  61850. */
  61851. get isEnabled(): boolean;
  61852. set isEnabled(value: boolean);
  61853. /**
  61854. * Get the scene the effects belongs to.
  61855. * @returns the scene holding the lens flare system
  61856. */
  61857. getScene(): Scene;
  61858. /**
  61859. * Get the emitter of the lens flare system.
  61860. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  61861. * @returns the emitter of the lens flare system
  61862. */
  61863. getEmitter(): any;
  61864. /**
  61865. * Set the emitter of the lens flare system.
  61866. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  61867. * @param newEmitter Define the new emitter of the system
  61868. */
  61869. setEmitter(newEmitter: any): void;
  61870. /**
  61871. * Get the lens flare system emitter position.
  61872. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  61873. * @returns the position
  61874. */
  61875. getEmitterPosition(): Vector3;
  61876. /**
  61877. * @hidden
  61878. */
  61879. computeEffectivePosition(globalViewport: Viewport): boolean;
  61880. /** @hidden */
  61881. _isVisible(): boolean;
  61882. /**
  61883. * @hidden
  61884. */
  61885. render(): boolean;
  61886. /**
  61887. * Dispose and release the lens flare with its associated resources.
  61888. */
  61889. dispose(): void;
  61890. /**
  61891. * Parse a lens flare system from a JSON repressentation
  61892. * @param parsedLensFlareSystem Define the JSON to parse
  61893. * @param scene Define the scene the parsed system should be instantiated in
  61894. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  61895. * @returns the parsed system
  61896. */
  61897. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  61898. /**
  61899. * Serialize the current Lens Flare System into a JSON representation.
  61900. * @returns the serialized JSON
  61901. */
  61902. serialize(): any;
  61903. }
  61904. }
  61905. declare module "babylonjs/LensFlares/lensFlare" {
  61906. import { Nullable } from "babylonjs/types";
  61907. import { Color3 } from "babylonjs/Maths/math.color";
  61908. import { Texture } from "babylonjs/Materials/Textures/texture";
  61909. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  61910. /**
  61911. * This represents one of the lens effect in a `lensFlareSystem`.
  61912. * It controls one of the indiviual texture used in the effect.
  61913. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61914. */
  61915. export class LensFlare {
  61916. /**
  61917. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  61918. */
  61919. size: number;
  61920. /**
  61921. * 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.
  61922. */
  61923. position: number;
  61924. /**
  61925. * Define the lens color.
  61926. */
  61927. color: Color3;
  61928. /**
  61929. * Define the lens texture.
  61930. */
  61931. texture: Nullable<Texture>;
  61932. /**
  61933. * Define the alpha mode to render this particular lens.
  61934. */
  61935. alphaMode: number;
  61936. private _system;
  61937. /**
  61938. * Creates a new Lens Flare.
  61939. * This represents one of the lens effect in a `lensFlareSystem`.
  61940. * It controls one of the indiviual texture used in the effect.
  61941. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61942. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  61943. * @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.
  61944. * @param color Define the lens color
  61945. * @param imgUrl Define the lens texture url
  61946. * @param system Define the `lensFlareSystem` this flare is part of
  61947. * @returns The newly created Lens Flare
  61948. */
  61949. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  61950. /**
  61951. * Instantiates a new Lens Flare.
  61952. * This represents one of the lens effect in a `lensFlareSystem`.
  61953. * It controls one of the indiviual texture used in the effect.
  61954. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61955. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  61956. * @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.
  61957. * @param color Define the lens color
  61958. * @param imgUrl Define the lens texture url
  61959. * @param system Define the `lensFlareSystem` this flare is part of
  61960. */
  61961. constructor(
  61962. /**
  61963. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  61964. */
  61965. size: number,
  61966. /**
  61967. * 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.
  61968. */
  61969. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  61970. /**
  61971. * Dispose and release the lens flare with its associated resources.
  61972. */
  61973. dispose(): void;
  61974. }
  61975. }
  61976. declare module "babylonjs/LensFlares/lensFlareSystemSceneComponent" {
  61977. import { Nullable } from "babylonjs/types";
  61978. import { Scene } from "babylonjs/scene";
  61979. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  61980. import { AbstractScene } from "babylonjs/abstractScene";
  61981. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  61982. module "babylonjs/abstractScene" {
  61983. interface AbstractScene {
  61984. /**
  61985. * The list of lens flare system added to the scene
  61986. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61987. */
  61988. lensFlareSystems: Array<LensFlareSystem>;
  61989. /**
  61990. * Removes the given lens flare system from this scene.
  61991. * @param toRemove The lens flare system to remove
  61992. * @returns The index of the removed lens flare system
  61993. */
  61994. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  61995. /**
  61996. * Adds the given lens flare system to this scene
  61997. * @param newLensFlareSystem The lens flare system to add
  61998. */
  61999. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  62000. /**
  62001. * Gets a lens flare system using its name
  62002. * @param name defines the name to look for
  62003. * @returns the lens flare system or null if not found
  62004. */
  62005. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  62006. /**
  62007. * Gets a lens flare system using its id
  62008. * @param id defines the id to look for
  62009. * @returns the lens flare system or null if not found
  62010. */
  62011. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  62012. }
  62013. }
  62014. /**
  62015. * Defines the lens flare scene component responsible to manage any lens flares
  62016. * in a given scene.
  62017. */
  62018. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  62019. /**
  62020. * The component name helpfull to identify the component in the list of scene components.
  62021. */
  62022. readonly name: string;
  62023. /**
  62024. * The scene the component belongs to.
  62025. */
  62026. scene: Scene;
  62027. /**
  62028. * Creates a new instance of the component for the given scene
  62029. * @param scene Defines the scene to register the component in
  62030. */
  62031. constructor(scene: Scene);
  62032. /**
  62033. * Registers the component in a given scene
  62034. */
  62035. register(): void;
  62036. /**
  62037. * Rebuilds the elements related to this component in case of
  62038. * context lost for instance.
  62039. */
  62040. rebuild(): void;
  62041. /**
  62042. * Adds all the elements from the container to the scene
  62043. * @param container the container holding the elements
  62044. */
  62045. addFromContainer(container: AbstractScene): void;
  62046. /**
  62047. * Removes all the elements in the container from the scene
  62048. * @param container contains the elements to remove
  62049. * @param dispose if the removed element should be disposed (default: false)
  62050. */
  62051. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  62052. /**
  62053. * Serializes the component data to the specified json object
  62054. * @param serializationObject The object to serialize to
  62055. */
  62056. serialize(serializationObject: any): void;
  62057. /**
  62058. * Disposes the component and the associated ressources.
  62059. */
  62060. dispose(): void;
  62061. private _draw;
  62062. }
  62063. }
  62064. declare module "babylonjs/LensFlares/index" {
  62065. export * from "babylonjs/LensFlares/lensFlare";
  62066. export * from "babylonjs/LensFlares/lensFlareSystem";
  62067. export * from "babylonjs/LensFlares/lensFlareSystemSceneComponent";
  62068. }
  62069. declare module "babylonjs/Shaders/depth.fragment" {
  62070. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  62071. /** @hidden */
  62072. export var depthPixelShader: {
  62073. name: string;
  62074. shader: string;
  62075. };
  62076. }
  62077. declare module "babylonjs/Shaders/depth.vertex" {
  62078. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  62079. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  62080. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  62081. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  62082. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  62083. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  62084. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  62085. /** @hidden */
  62086. export var depthVertexShader: {
  62087. name: string;
  62088. shader: string;
  62089. };
  62090. }
  62091. declare module "babylonjs/Rendering/depthRenderer" {
  62092. import { Nullable } from "babylonjs/types";
  62093. import { SubMesh } from "babylonjs/Meshes/subMesh";
  62094. import { Scene } from "babylonjs/scene";
  62095. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62096. import { Camera } from "babylonjs/Cameras/camera";
  62097. import "babylonjs/Shaders/depth.fragment";
  62098. import "babylonjs/Shaders/depth.vertex";
  62099. /**
  62100. * This represents a depth renderer in Babylon.
  62101. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  62102. */
  62103. export class DepthRenderer {
  62104. private _scene;
  62105. private _depthMap;
  62106. private _effect;
  62107. private readonly _storeNonLinearDepth;
  62108. private readonly _clearColor;
  62109. /** Get if the depth renderer is using packed depth or not */
  62110. readonly isPacked: boolean;
  62111. private _cachedDefines;
  62112. private _camera;
  62113. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  62114. enabled: boolean;
  62115. /**
  62116. * Specifiess that the depth renderer will only be used within
  62117. * the camera it is created for.
  62118. * This can help forcing its rendering during the camera processing.
  62119. */
  62120. useOnlyInActiveCamera: boolean;
  62121. /** @hidden */
  62122. static _SceneComponentInitialization: (scene: Scene) => void;
  62123. /**
  62124. * Instantiates a depth renderer
  62125. * @param scene The scene the renderer belongs to
  62126. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  62127. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  62128. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  62129. */
  62130. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  62131. /**
  62132. * Creates the depth rendering effect and checks if the effect is ready.
  62133. * @param subMesh The submesh to be used to render the depth map of
  62134. * @param useInstances If multiple world instances should be used
  62135. * @returns if the depth renderer is ready to render the depth map
  62136. */
  62137. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  62138. /**
  62139. * Gets the texture which the depth map will be written to.
  62140. * @returns The depth map texture
  62141. */
  62142. getDepthMap(): RenderTargetTexture;
  62143. /**
  62144. * Disposes of the depth renderer.
  62145. */
  62146. dispose(): void;
  62147. }
  62148. }
  62149. declare module "babylonjs/Shaders/minmaxRedux.fragment" {
  62150. /** @hidden */
  62151. export var minmaxReduxPixelShader: {
  62152. name: string;
  62153. shader: string;
  62154. };
  62155. }
  62156. declare module "babylonjs/Misc/minMaxReducer" {
  62157. import { Nullable } from "babylonjs/types";
  62158. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62159. import { Camera } from "babylonjs/Cameras/camera";
  62160. import { Observer } from "babylonjs/Misc/observable";
  62161. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  62162. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  62163. import { Observable } from "babylonjs/Misc/observable";
  62164. import "babylonjs/Shaders/minmaxRedux.fragment";
  62165. /**
  62166. * This class computes a min/max reduction from a texture: it means it computes the minimum
  62167. * and maximum values from all values of the texture.
  62168. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  62169. * The source values are read from the red channel of the texture.
  62170. */
  62171. export class MinMaxReducer {
  62172. /**
  62173. * Observable triggered when the computation has been performed
  62174. */
  62175. onAfterReductionPerformed: Observable<{
  62176. min: number;
  62177. max: number;
  62178. }>;
  62179. protected _camera: Camera;
  62180. protected _sourceTexture: Nullable<RenderTargetTexture>;
  62181. protected _reductionSteps: Nullable<Array<PostProcess>>;
  62182. protected _postProcessManager: PostProcessManager;
  62183. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  62184. protected _forceFullscreenViewport: boolean;
  62185. /**
  62186. * Creates a min/max reducer
  62187. * @param camera The camera to use for the post processes
  62188. */
  62189. constructor(camera: Camera);
  62190. /**
  62191. * Gets the texture used to read the values from.
  62192. */
  62193. get sourceTexture(): Nullable<RenderTargetTexture>;
  62194. /**
  62195. * Sets the source texture to read the values from.
  62196. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  62197. * because in such textures '1' value must not be taken into account to compute the maximum
  62198. * as this value is used to clear the texture.
  62199. * Note that the computation is not activated by calling this function, you must call activate() for that!
  62200. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  62201. * @param depthRedux Indicates if the texture is a depth texture or not
  62202. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  62203. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  62204. */
  62205. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  62206. /**
  62207. * Defines the refresh rate of the computation.
  62208. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  62209. */
  62210. get refreshRate(): number;
  62211. set refreshRate(value: number);
  62212. protected _activated: boolean;
  62213. /**
  62214. * Gets the activation status of the reducer
  62215. */
  62216. get activated(): boolean;
  62217. /**
  62218. * Activates the reduction computation.
  62219. * When activated, the observers registered in onAfterReductionPerformed are
  62220. * called after the compuation is performed
  62221. */
  62222. activate(): void;
  62223. /**
  62224. * Deactivates the reduction computation.
  62225. */
  62226. deactivate(): void;
  62227. /**
  62228. * Disposes the min/max reducer
  62229. * @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.
  62230. */
  62231. dispose(disposeAll?: boolean): void;
  62232. }
  62233. }
  62234. declare module "babylonjs/Misc/depthReducer" {
  62235. import { Nullable } from "babylonjs/types";
  62236. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62237. import { Camera } from "babylonjs/Cameras/camera";
  62238. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  62239. import { MinMaxReducer } from "babylonjs/Misc/minMaxReducer";
  62240. /**
  62241. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  62242. */
  62243. export class DepthReducer extends MinMaxReducer {
  62244. private _depthRenderer;
  62245. private _depthRendererId;
  62246. /**
  62247. * Gets the depth renderer used for the computation.
  62248. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  62249. */
  62250. get depthRenderer(): Nullable<DepthRenderer>;
  62251. /**
  62252. * Creates a depth reducer
  62253. * @param camera The camera used to render the depth texture
  62254. */
  62255. constructor(camera: Camera);
  62256. /**
  62257. * Sets the depth renderer to use to generate the depth map
  62258. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  62259. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  62260. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  62261. */
  62262. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  62263. /** @hidden */
  62264. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  62265. /**
  62266. * Activates the reduction computation.
  62267. * When activated, the observers registered in onAfterReductionPerformed are
  62268. * called after the compuation is performed
  62269. */
  62270. activate(): void;
  62271. /**
  62272. * Deactivates the reduction computation.
  62273. */
  62274. deactivate(): void;
  62275. /**
  62276. * Disposes the depth reducer
  62277. * @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.
  62278. */
  62279. dispose(disposeAll?: boolean): void;
  62280. }
  62281. }
  62282. declare module "babylonjs/Lights/Shadows/cascadedShadowGenerator" {
  62283. import { Nullable } from "babylonjs/types";
  62284. import { Scene } from "babylonjs/scene";
  62285. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  62286. import { SubMesh } from "babylonjs/Meshes/subMesh";
  62287. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62288. import { Effect } from "babylonjs/Materials/effect";
  62289. import "babylonjs/Shaders/shadowMap.fragment";
  62290. import "babylonjs/Shaders/shadowMap.vertex";
  62291. import "babylonjs/Shaders/depthBoxBlur.fragment";
  62292. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  62293. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  62294. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  62295. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  62296. /**
  62297. * A CSM implementation allowing casting shadows on large scenes.
  62298. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  62299. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  62300. */
  62301. export class CascadedShadowGenerator extends ShadowGenerator {
  62302. private static readonly frustumCornersNDCSpace;
  62303. /**
  62304. * Name of the CSM class
  62305. */
  62306. static CLASSNAME: string;
  62307. /**
  62308. * Defines the default number of cascades used by the CSM.
  62309. */
  62310. static readonly DEFAULT_CASCADES_COUNT: number;
  62311. /**
  62312. * Defines the minimum number of cascades used by the CSM.
  62313. */
  62314. static readonly MIN_CASCADES_COUNT: number;
  62315. /**
  62316. * Defines the maximum number of cascades used by the CSM.
  62317. */
  62318. static readonly MAX_CASCADES_COUNT: number;
  62319. protected _validateFilter(filter: number): number;
  62320. /**
  62321. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  62322. */
  62323. penumbraDarkness: number;
  62324. private _numCascades;
  62325. /**
  62326. * Gets or set the number of cascades used by the CSM.
  62327. */
  62328. get numCascades(): number;
  62329. set numCascades(value: number);
  62330. /**
  62331. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  62332. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  62333. */
  62334. stabilizeCascades: boolean;
  62335. private _freezeShadowCastersBoundingInfo;
  62336. private _freezeShadowCastersBoundingInfoObservable;
  62337. /**
  62338. * Enables or disables the shadow casters bounding info computation.
  62339. * If your shadow casters don't move, you can disable this feature.
  62340. * If it is enabled, the bounding box computation is done every frame.
  62341. */
  62342. get freezeShadowCastersBoundingInfo(): boolean;
  62343. set freezeShadowCastersBoundingInfo(freeze: boolean);
  62344. private _scbiMin;
  62345. private _scbiMax;
  62346. protected _computeShadowCastersBoundingInfo(): void;
  62347. protected _shadowCastersBoundingInfo: BoundingInfo;
  62348. /**
  62349. * Gets or sets the shadow casters bounding info.
  62350. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  62351. * so that the system won't overwrite the bounds you provide
  62352. */
  62353. get shadowCastersBoundingInfo(): BoundingInfo;
  62354. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  62355. protected _breaksAreDirty: boolean;
  62356. protected _minDistance: number;
  62357. protected _maxDistance: number;
  62358. /**
  62359. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  62360. *
  62361. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  62362. * If you don't know these values, simply leave them to their defaults and don't call this function.
  62363. * @param min minimal distance for the breaks (default to 0.)
  62364. * @param max maximal distance for the breaks (default to 1.)
  62365. */
  62366. setMinMaxDistance(min: number, max: number): void;
  62367. /** Gets the minimal distance used in the cascade break computation */
  62368. get minDistance(): number;
  62369. /** Gets the maximal distance used in the cascade break computation */
  62370. get maxDistance(): number;
  62371. /**
  62372. * Gets the class name of that object
  62373. * @returns "CascadedShadowGenerator"
  62374. */
  62375. getClassName(): string;
  62376. private _cascadeMinExtents;
  62377. private _cascadeMaxExtents;
  62378. /**
  62379. * Gets a cascade minimum extents
  62380. * @param cascadeIndex index of the cascade
  62381. * @returns the minimum cascade extents
  62382. */
  62383. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  62384. /**
  62385. * Gets a cascade maximum extents
  62386. * @param cascadeIndex index of the cascade
  62387. * @returns the maximum cascade extents
  62388. */
  62389. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  62390. private _cascades;
  62391. private _currentLayer;
  62392. private _viewSpaceFrustumsZ;
  62393. private _viewMatrices;
  62394. private _projectionMatrices;
  62395. private _transformMatrices;
  62396. private _transformMatricesAsArray;
  62397. private _frustumLengths;
  62398. private _lightSizeUVCorrection;
  62399. private _depthCorrection;
  62400. private _frustumCornersWorldSpace;
  62401. private _frustumCenter;
  62402. private _shadowCameraPos;
  62403. private _shadowMaxZ;
  62404. /**
  62405. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  62406. * It defaults to camera.maxZ
  62407. */
  62408. get shadowMaxZ(): number;
  62409. /**
  62410. * Sets the shadow max z distance.
  62411. */
  62412. set shadowMaxZ(value: number);
  62413. protected _debug: boolean;
  62414. /**
  62415. * Gets or sets the debug flag.
  62416. * When enabled, the cascades are materialized by different colors on the screen.
  62417. */
  62418. get debug(): boolean;
  62419. set debug(dbg: boolean);
  62420. private _depthClamp;
  62421. /**
  62422. * Gets or sets the depth clamping value.
  62423. *
  62424. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  62425. * to account for the shadow casters far away.
  62426. *
  62427. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  62428. */
  62429. get depthClamp(): boolean;
  62430. set depthClamp(value: boolean);
  62431. private _cascadeBlendPercentage;
  62432. /**
  62433. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  62434. * It defaults to 0.1 (10% blending).
  62435. */
  62436. get cascadeBlendPercentage(): number;
  62437. set cascadeBlendPercentage(value: number);
  62438. private _lambda;
  62439. /**
  62440. * Gets or set the lambda parameter.
  62441. * This parameter is used to split the camera frustum and create the cascades.
  62442. * 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.
  62443. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  62444. */
  62445. get lambda(): number;
  62446. set lambda(value: number);
  62447. /**
  62448. * Gets the view matrix corresponding to a given cascade
  62449. * @param cascadeNum cascade to retrieve the view matrix from
  62450. * @returns the cascade view matrix
  62451. */
  62452. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  62453. /**
  62454. * Gets the projection matrix corresponding to a given cascade
  62455. * @param cascadeNum cascade to retrieve the projection matrix from
  62456. * @returns the cascade projection matrix
  62457. */
  62458. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  62459. /**
  62460. * Gets the transformation matrix corresponding to a given cascade
  62461. * @param cascadeNum cascade to retrieve the transformation matrix from
  62462. * @returns the cascade transformation matrix
  62463. */
  62464. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  62465. private _depthRenderer;
  62466. /**
  62467. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  62468. *
  62469. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  62470. *
  62471. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  62472. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  62473. * @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
  62474. */
  62475. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  62476. private _depthReducer;
  62477. private _autoCalcDepthBounds;
  62478. /**
  62479. * Gets or sets the autoCalcDepthBounds property.
  62480. *
  62481. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  62482. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  62483. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  62484. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  62485. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  62486. */
  62487. get autoCalcDepthBounds(): boolean;
  62488. set autoCalcDepthBounds(value: boolean);
  62489. /**
  62490. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  62491. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  62492. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  62493. * for setting the refresh rate on the renderer yourself!
  62494. */
  62495. get autoCalcDepthBoundsRefreshRate(): number;
  62496. set autoCalcDepthBoundsRefreshRate(value: number);
  62497. /**
  62498. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  62499. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  62500. * you change the camera near/far planes!
  62501. */
  62502. splitFrustum(): void;
  62503. private _splitFrustum;
  62504. private _computeMatrices;
  62505. private _computeFrustumInWorldSpace;
  62506. private _computeCascadeFrustum;
  62507. /**
  62508. * Support test.
  62509. */
  62510. static get IsSupported(): boolean;
  62511. /** @hidden */
  62512. static _SceneComponentInitialization: (scene: Scene) => void;
  62513. /**
  62514. * Creates a Cascaded Shadow Generator object.
  62515. * A ShadowGenerator is the required tool to use the shadows.
  62516. * Each directional light casting shadows needs to use its own ShadowGenerator.
  62517. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  62518. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  62519. * @param light The directional light object generating the shadows.
  62520. * @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.
  62521. */
  62522. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  62523. protected _initializeGenerator(): void;
  62524. protected _createTargetRenderTexture(): void;
  62525. protected _initializeShadowMap(): void;
  62526. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  62527. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  62528. /**
  62529. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  62530. * @param defines Defines of the material we want to update
  62531. * @param lightIndex Index of the light in the enabled light list of the material
  62532. */
  62533. prepareDefines(defines: any, lightIndex: number): void;
  62534. /**
  62535. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  62536. * defined in the generator but impacting the effect).
  62537. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  62538. * @param effect The effect we are binfing the information for
  62539. */
  62540. bindShadowLight(lightIndex: string, effect: Effect): void;
  62541. /**
  62542. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  62543. * (eq to view projection * shadow projection matrices)
  62544. * @returns The transform matrix used to create the shadow map
  62545. */
  62546. getTransformMatrix(): Matrix;
  62547. /**
  62548. * Disposes the ShadowGenerator.
  62549. * Returns nothing.
  62550. */
  62551. dispose(): void;
  62552. /**
  62553. * Serializes the shadow generator setup to a json object.
  62554. * @returns The serialized JSON object
  62555. */
  62556. serialize(): any;
  62557. /**
  62558. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  62559. * @param parsedShadowGenerator The JSON object to parse
  62560. * @param scene The scene to create the shadow map for
  62561. * @returns The parsed shadow generator
  62562. */
  62563. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  62564. }
  62565. }
  62566. declare module "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent" {
  62567. import { Scene } from "babylonjs/scene";
  62568. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  62569. import { AbstractScene } from "babylonjs/abstractScene";
  62570. /**
  62571. * Defines the shadow generator component responsible to manage any shadow generators
  62572. * in a given scene.
  62573. */
  62574. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  62575. /**
  62576. * The component name helpfull to identify the component in the list of scene components.
  62577. */
  62578. readonly name: string;
  62579. /**
  62580. * The scene the component belongs to.
  62581. */
  62582. scene: Scene;
  62583. /**
  62584. * Creates a new instance of the component for the given scene
  62585. * @param scene Defines the scene to register the component in
  62586. */
  62587. constructor(scene: Scene);
  62588. /**
  62589. * Registers the component in a given scene
  62590. */
  62591. register(): void;
  62592. /**
  62593. * Rebuilds the elements related to this component in case of
  62594. * context lost for instance.
  62595. */
  62596. rebuild(): void;
  62597. /**
  62598. * Serializes the component data to the specified json object
  62599. * @param serializationObject The object to serialize to
  62600. */
  62601. serialize(serializationObject: any): void;
  62602. /**
  62603. * Adds all the elements from the container to the scene
  62604. * @param container the container holding the elements
  62605. */
  62606. addFromContainer(container: AbstractScene): void;
  62607. /**
  62608. * Removes all the elements in the container from the scene
  62609. * @param container contains the elements to remove
  62610. * @param dispose if the removed element should be disposed (default: false)
  62611. */
  62612. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  62613. /**
  62614. * Rebuilds the elements related to this component in case of
  62615. * context lost for instance.
  62616. */
  62617. dispose(): void;
  62618. private _gatherRenderTargets;
  62619. }
  62620. }
  62621. declare module "babylonjs/Lights/Shadows/index" {
  62622. export * from "babylonjs/Lights/Shadows/shadowGenerator";
  62623. export * from "babylonjs/Lights/Shadows/cascadedShadowGenerator";
  62624. export * from "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent";
  62625. }
  62626. declare module "babylonjs/Lights/pointLight" {
  62627. import { Scene } from "babylonjs/scene";
  62628. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  62629. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62630. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  62631. import { Effect } from "babylonjs/Materials/effect";
  62632. /**
  62633. * A point light is a light defined by an unique point in world space.
  62634. * The light is emitted in every direction from this point.
  62635. * A good example of a point light is a standard light bulb.
  62636. * Documentation: https://doc.babylonjs.com/babylon101/lights
  62637. */
  62638. export class PointLight extends ShadowLight {
  62639. private _shadowAngle;
  62640. /**
  62641. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62642. * This specifies what angle the shadow will use to be created.
  62643. *
  62644. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  62645. */
  62646. get shadowAngle(): number;
  62647. /**
  62648. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62649. * This specifies what angle the shadow will use to be created.
  62650. *
  62651. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  62652. */
  62653. set shadowAngle(value: number);
  62654. /**
  62655. * Gets the direction if it has been set.
  62656. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62657. */
  62658. get direction(): Vector3;
  62659. /**
  62660. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62661. */
  62662. set direction(value: Vector3);
  62663. /**
  62664. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  62665. * A PointLight emits the light in every direction.
  62666. * It can cast shadows.
  62667. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  62668. * ```javascript
  62669. * var pointLight = new PointLight("pl", camera.position, scene);
  62670. * ```
  62671. * Documentation : https://doc.babylonjs.com/babylon101/lights
  62672. * @param name The light friendly name
  62673. * @param position The position of the point light in the scene
  62674. * @param scene The scene the lights belongs to
  62675. */
  62676. constructor(name: string, position: Vector3, scene: Scene);
  62677. /**
  62678. * Returns the string "PointLight"
  62679. * @returns the class name
  62680. */
  62681. getClassName(): string;
  62682. /**
  62683. * Returns the integer 0.
  62684. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  62685. */
  62686. getTypeID(): number;
  62687. /**
  62688. * Specifies wether or not the shadowmap should be a cube texture.
  62689. * @returns true if the shadowmap needs to be a cube texture.
  62690. */
  62691. needCube(): boolean;
  62692. /**
  62693. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  62694. * @param faceIndex The index of the face we are computed the direction to generate shadow
  62695. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  62696. */
  62697. getShadowDirection(faceIndex?: number): Vector3;
  62698. /**
  62699. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  62700. * - fov = PI / 2
  62701. * - aspect ratio : 1.0
  62702. * - z-near and far equal to the active camera minZ and maxZ.
  62703. * Returns the PointLight.
  62704. */
  62705. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  62706. protected _buildUniformLayout(): void;
  62707. /**
  62708. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  62709. * @param effect The effect to update
  62710. * @param lightIndex The index of the light in the effect to update
  62711. * @returns The point light
  62712. */
  62713. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  62714. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  62715. /**
  62716. * Prepares the list of defines specific to the light type.
  62717. * @param defines the list of defines
  62718. * @param lightIndex defines the index of the light for the effect
  62719. */
  62720. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  62721. }
  62722. }
  62723. declare module "babylonjs/Lights/index" {
  62724. export * from "babylonjs/Lights/light";
  62725. export * from "babylonjs/Lights/shadowLight";
  62726. export * from "babylonjs/Lights/Shadows/index";
  62727. export * from "babylonjs/Lights/directionalLight";
  62728. export * from "babylonjs/Lights/hemisphericLight";
  62729. export * from "babylonjs/Lights/pointLight";
  62730. export * from "babylonjs/Lights/spotLight";
  62731. }
  62732. declare module "babylonjs/Misc/HighDynamicRange/hdr" {
  62733. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  62734. /**
  62735. * Header information of HDR texture files.
  62736. */
  62737. export interface HDRInfo {
  62738. /**
  62739. * The height of the texture in pixels.
  62740. */
  62741. height: number;
  62742. /**
  62743. * The width of the texture in pixels.
  62744. */
  62745. width: number;
  62746. /**
  62747. * The index of the beginning of the data in the binary file.
  62748. */
  62749. dataPosition: number;
  62750. }
  62751. /**
  62752. * This groups tools to convert HDR texture to native colors array.
  62753. */
  62754. export class HDRTools {
  62755. private static Ldexp;
  62756. private static Rgbe2float;
  62757. private static readStringLine;
  62758. /**
  62759. * Reads header information from an RGBE texture stored in a native array.
  62760. * More information on this format are available here:
  62761. * https://en.wikipedia.org/wiki/RGBE_image_format
  62762. *
  62763. * @param uint8array The binary file stored in native array.
  62764. * @return The header information.
  62765. */
  62766. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  62767. /**
  62768. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  62769. * This RGBE texture needs to store the information as a panorama.
  62770. *
  62771. * More information on this format are available here:
  62772. * https://en.wikipedia.org/wiki/RGBE_image_format
  62773. *
  62774. * @param buffer The binary file stored in an array buffer.
  62775. * @param size The expected size of the extracted cubemap.
  62776. * @return The Cube Map information.
  62777. */
  62778. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  62779. /**
  62780. * Returns the pixels data extracted from an RGBE texture.
  62781. * This pixels will be stored left to right up to down in the R G B order in one array.
  62782. *
  62783. * More information on this format are available here:
  62784. * https://en.wikipedia.org/wiki/RGBE_image_format
  62785. *
  62786. * @param uint8array The binary file stored in an array buffer.
  62787. * @param hdrInfo The header information of the file.
  62788. * @return The pixels data in RGB right to left up to down order.
  62789. */
  62790. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  62791. private static RGBE_ReadPixels_RLE;
  62792. private static RGBE_ReadPixels_NOT_RLE;
  62793. }
  62794. }
  62795. declare module "babylonjs/Materials/effectRenderer" {
  62796. import { Nullable } from "babylonjs/types";
  62797. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  62798. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62799. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  62800. import { Viewport } from "babylonjs/Maths/math.viewport";
  62801. import { Observable } from "babylonjs/Misc/observable";
  62802. import { Effect } from "babylonjs/Materials/effect";
  62803. import "babylonjs/Shaders/postprocess.vertex";
  62804. /**
  62805. * Effect Render Options
  62806. */
  62807. export interface IEffectRendererOptions {
  62808. /**
  62809. * Defines the vertices positions.
  62810. */
  62811. positions?: number[];
  62812. /**
  62813. * Defines the indices.
  62814. */
  62815. indices?: number[];
  62816. }
  62817. /**
  62818. * Helper class to render one or more effects.
  62819. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  62820. */
  62821. export class EffectRenderer {
  62822. private engine;
  62823. private static _DefaultOptions;
  62824. private _vertexBuffers;
  62825. private _indexBuffer;
  62826. private _fullscreenViewport;
  62827. /**
  62828. * Creates an effect renderer
  62829. * @param engine the engine to use for rendering
  62830. * @param options defines the options of the effect renderer
  62831. */
  62832. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  62833. /**
  62834. * Sets the current viewport in normalized coordinates 0-1
  62835. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  62836. */
  62837. setViewport(viewport?: Viewport): void;
  62838. /**
  62839. * Binds the embedded attributes buffer to the effect.
  62840. * @param effect Defines the effect to bind the attributes for
  62841. */
  62842. bindBuffers(effect: Effect): void;
  62843. /**
  62844. * Sets the current effect wrapper to use during draw.
  62845. * The effect needs to be ready before calling this api.
  62846. * This also sets the default full screen position attribute.
  62847. * @param effectWrapper Defines the effect to draw with
  62848. */
  62849. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  62850. /**
  62851. * Restores engine states
  62852. */
  62853. restoreStates(): void;
  62854. /**
  62855. * Draws a full screen quad.
  62856. */
  62857. draw(): void;
  62858. private isRenderTargetTexture;
  62859. /**
  62860. * renders one or more effects to a specified texture
  62861. * @param effectWrapper the effect to renderer
  62862. * @param outputTexture texture to draw to, if null it will render to the screen.
  62863. */
  62864. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  62865. /**
  62866. * Disposes of the effect renderer
  62867. */
  62868. dispose(): void;
  62869. }
  62870. /**
  62871. * Options to create an EffectWrapper
  62872. */
  62873. interface EffectWrapperCreationOptions {
  62874. /**
  62875. * Engine to use to create the effect
  62876. */
  62877. engine: ThinEngine;
  62878. /**
  62879. * Fragment shader for the effect
  62880. */
  62881. fragmentShader: string;
  62882. /**
  62883. * Use the shader store instead of direct source code
  62884. */
  62885. useShaderStore?: boolean;
  62886. /**
  62887. * Vertex shader for the effect
  62888. */
  62889. vertexShader?: string;
  62890. /**
  62891. * Attributes to use in the shader
  62892. */
  62893. attributeNames?: Array<string>;
  62894. /**
  62895. * Uniforms to use in the shader
  62896. */
  62897. uniformNames?: Array<string>;
  62898. /**
  62899. * Texture sampler names to use in the shader
  62900. */
  62901. samplerNames?: Array<string>;
  62902. /**
  62903. * Defines to use in the shader
  62904. */
  62905. defines?: Array<string>;
  62906. /**
  62907. * Callback when effect is compiled
  62908. */
  62909. onCompiled?: Nullable<(effect: Effect) => void>;
  62910. /**
  62911. * The friendly name of the effect displayed in Spector.
  62912. */
  62913. name?: string;
  62914. }
  62915. /**
  62916. * Wraps an effect to be used for rendering
  62917. */
  62918. export class EffectWrapper {
  62919. /**
  62920. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  62921. */
  62922. onApplyObservable: Observable<{}>;
  62923. /**
  62924. * The underlying effect
  62925. */
  62926. effect: Effect;
  62927. /**
  62928. * Creates an effect to be renderer
  62929. * @param creationOptions options to create the effect
  62930. */
  62931. constructor(creationOptions: EffectWrapperCreationOptions);
  62932. /**
  62933. * Disposes of the effect wrapper
  62934. */
  62935. dispose(): void;
  62936. }
  62937. }
  62938. declare module "babylonjs/Shaders/hdrFiltering.vertex" {
  62939. /** @hidden */
  62940. export var hdrFilteringVertexShader: {
  62941. name: string;
  62942. shader: string;
  62943. };
  62944. }
  62945. declare module "babylonjs/Shaders/hdrFiltering.fragment" {
  62946. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  62947. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  62948. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  62949. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  62950. /** @hidden */
  62951. export var hdrFilteringPixelShader: {
  62952. name: string;
  62953. shader: string;
  62954. };
  62955. }
  62956. declare module "babylonjs/Materials/Textures/Filtering/hdrFiltering" {
  62957. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  62958. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  62959. import { Nullable } from "babylonjs/types";
  62960. import "babylonjs/Shaders/hdrFiltering.vertex";
  62961. import "babylonjs/Shaders/hdrFiltering.fragment";
  62962. /**
  62963. * Options for texture filtering
  62964. */
  62965. interface IHDRFilteringOptions {
  62966. /**
  62967. * Scales pixel intensity for the input HDR map.
  62968. */
  62969. hdrScale?: number;
  62970. /**
  62971. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  62972. */
  62973. quality?: number;
  62974. }
  62975. /**
  62976. * Filters HDR maps to get correct renderings of PBR reflections
  62977. */
  62978. export class HDRFiltering {
  62979. private _engine;
  62980. private _effectRenderer;
  62981. private _effectWrapper;
  62982. private _lodGenerationOffset;
  62983. private _lodGenerationScale;
  62984. /**
  62985. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  62986. * you care about baking speed.
  62987. */
  62988. quality: number;
  62989. /**
  62990. * Scales pixel intensity for the input HDR map.
  62991. */
  62992. hdrScale: number;
  62993. /**
  62994. * Instantiates HDR filter for reflection maps
  62995. *
  62996. * @param engine Thin engine
  62997. * @param options Options
  62998. */
  62999. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  63000. private _createRenderTarget;
  63001. private _prefilterInternal;
  63002. private _createEffect;
  63003. /**
  63004. * Get a value indicating if the filter is ready to be used
  63005. * @param texture Texture to filter
  63006. * @returns true if the filter is ready
  63007. */
  63008. isReady(texture: BaseTexture): boolean;
  63009. /**
  63010. * Prefilters a cube texture to have mipmap levels representing roughness values.
  63011. * Prefiltering will be invoked at the end of next rendering pass.
  63012. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  63013. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  63014. * @param texture Texture to filter
  63015. * @param onFinished Callback when filtering is done
  63016. * @return Promise called when prefiltering is done
  63017. */
  63018. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  63019. }
  63020. }
  63021. declare module "babylonjs/Materials/Textures/hdrCubeTexture" {
  63022. import { Nullable } from "babylonjs/types";
  63023. import { Scene } from "babylonjs/scene";
  63024. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  63025. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63026. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  63027. import "babylonjs/Engines/Extensions/engine.rawTexture";
  63028. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  63029. /**
  63030. * This represents a texture coming from an HDR input.
  63031. *
  63032. * The only supported format is currently panorama picture stored in RGBE format.
  63033. * Example of such files can be found on HDRLib: http://hdrlib.com/
  63034. */
  63035. export class HDRCubeTexture extends BaseTexture {
  63036. private static _facesMapping;
  63037. private _generateHarmonics;
  63038. private _noMipmap;
  63039. private _prefilterOnLoad;
  63040. private _textureMatrix;
  63041. private _size;
  63042. private _onLoad;
  63043. private _onError;
  63044. /**
  63045. * The texture URL.
  63046. */
  63047. url: string;
  63048. protected _isBlocking: boolean;
  63049. /**
  63050. * Sets wether or not the texture is blocking during loading.
  63051. */
  63052. set isBlocking(value: boolean);
  63053. /**
  63054. * Gets wether or not the texture is blocking during loading.
  63055. */
  63056. get isBlocking(): boolean;
  63057. protected _rotationY: number;
  63058. /**
  63059. * Sets texture matrix rotation angle around Y axis in radians.
  63060. */
  63061. set rotationY(value: number);
  63062. /**
  63063. * Gets texture matrix rotation angle around Y axis radians.
  63064. */
  63065. get rotationY(): number;
  63066. /**
  63067. * Gets or sets the center of the bounding box associated with the cube texture
  63068. * It must define where the camera used to render the texture was set
  63069. */
  63070. boundingBoxPosition: Vector3;
  63071. private _boundingBoxSize;
  63072. /**
  63073. * Gets or sets the size of the bounding box associated with the cube texture
  63074. * When defined, the cubemap will switch to local mode
  63075. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  63076. * @example https://www.babylonjs-playground.com/#RNASML
  63077. */
  63078. set boundingBoxSize(value: Vector3);
  63079. get boundingBoxSize(): Vector3;
  63080. /**
  63081. * Instantiates an HDRTexture from the following parameters.
  63082. *
  63083. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  63084. * @param sceneOrEngine The scene or engine the texture will be used in
  63085. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  63086. * @param noMipmap Forces to not generate the mipmap if true
  63087. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  63088. * @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)
  63089. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  63090. */
  63091. 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>);
  63092. /**
  63093. * Get the current class name of the texture useful for serialization or dynamic coding.
  63094. * @returns "HDRCubeTexture"
  63095. */
  63096. getClassName(): string;
  63097. /**
  63098. * Occurs when the file is raw .hdr file.
  63099. */
  63100. private loadTexture;
  63101. clone(): HDRCubeTexture;
  63102. delayLoad(): void;
  63103. /**
  63104. * Get the texture reflection matrix used to rotate/transform the reflection.
  63105. * @returns the reflection matrix
  63106. */
  63107. getReflectionTextureMatrix(): Matrix;
  63108. /**
  63109. * Set the texture reflection matrix used to rotate/transform the reflection.
  63110. * @param value Define the reflection matrix to set
  63111. */
  63112. setReflectionTextureMatrix(value: Matrix): void;
  63113. /**
  63114. * Parses a JSON representation of an HDR Texture in order to create the texture
  63115. * @param parsedTexture Define the JSON representation
  63116. * @param scene Define the scene the texture should be created in
  63117. * @param rootUrl Define the root url in case we need to load relative dependencies
  63118. * @returns the newly created texture after parsing
  63119. */
  63120. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  63121. serialize(): any;
  63122. }
  63123. }
  63124. declare module "babylonjs/Physics/physicsEngine" {
  63125. import { Nullable } from "babylonjs/types";
  63126. import { Vector3 } from "babylonjs/Maths/math.vector";
  63127. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  63128. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  63129. import { PhysicsJoint } from "babylonjs/Physics/physicsJoint";
  63130. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63131. /**
  63132. * Class used to control physics engine
  63133. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  63134. */
  63135. export class PhysicsEngine implements IPhysicsEngine {
  63136. private _physicsPlugin;
  63137. /**
  63138. * Global value used to control the smallest number supported by the simulation
  63139. */
  63140. static Epsilon: number;
  63141. private _impostors;
  63142. private _joints;
  63143. private _subTimeStep;
  63144. /**
  63145. * Gets the gravity vector used by the simulation
  63146. */
  63147. gravity: Vector3;
  63148. /**
  63149. * Factory used to create the default physics plugin.
  63150. * @returns The default physics plugin
  63151. */
  63152. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  63153. /**
  63154. * Creates a new Physics Engine
  63155. * @param gravity defines the gravity vector used by the simulation
  63156. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  63157. */
  63158. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  63159. /**
  63160. * Sets the gravity vector used by the simulation
  63161. * @param gravity defines the gravity vector to use
  63162. */
  63163. setGravity(gravity: Vector3): void;
  63164. /**
  63165. * Set the time step of the physics engine.
  63166. * Default is 1/60.
  63167. * To slow it down, enter 1/600 for example.
  63168. * To speed it up, 1/30
  63169. * @param newTimeStep defines the new timestep to apply to this world.
  63170. */
  63171. setTimeStep(newTimeStep?: number): void;
  63172. /**
  63173. * Get the time step of the physics engine.
  63174. * @returns the current time step
  63175. */
  63176. getTimeStep(): number;
  63177. /**
  63178. * Set the sub time step of the physics engine.
  63179. * Default is 0 meaning there is no sub steps
  63180. * To increase physics resolution precision, set a small value (like 1 ms)
  63181. * @param subTimeStep defines the new sub timestep used for physics resolution.
  63182. */
  63183. setSubTimeStep(subTimeStep?: number): void;
  63184. /**
  63185. * Get the sub time step of the physics engine.
  63186. * @returns the current sub time step
  63187. */
  63188. getSubTimeStep(): number;
  63189. /**
  63190. * Release all resources
  63191. */
  63192. dispose(): void;
  63193. /**
  63194. * Gets the name of the current physics plugin
  63195. * @returns the name of the plugin
  63196. */
  63197. getPhysicsPluginName(): string;
  63198. /**
  63199. * Adding a new impostor for the impostor tracking.
  63200. * This will be done by the impostor itself.
  63201. * @param impostor the impostor to add
  63202. */
  63203. addImpostor(impostor: PhysicsImpostor): void;
  63204. /**
  63205. * Remove an impostor from the engine.
  63206. * This impostor and its mesh will not longer be updated by the physics engine.
  63207. * @param impostor the impostor to remove
  63208. */
  63209. removeImpostor(impostor: PhysicsImpostor): void;
  63210. /**
  63211. * Add a joint to the physics engine
  63212. * @param mainImpostor defines the main impostor to which the joint is added.
  63213. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  63214. * @param joint defines the joint that will connect both impostors.
  63215. */
  63216. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  63217. /**
  63218. * Removes a joint from the simulation
  63219. * @param mainImpostor defines the impostor used with the joint
  63220. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  63221. * @param joint defines the joint to remove
  63222. */
  63223. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  63224. /**
  63225. * Called by the scene. No need to call it.
  63226. * @param delta defines the timespam between frames
  63227. */
  63228. _step(delta: number): void;
  63229. /**
  63230. * Gets the current plugin used to run the simulation
  63231. * @returns current plugin
  63232. */
  63233. getPhysicsPlugin(): IPhysicsEnginePlugin;
  63234. /**
  63235. * Gets the list of physic impostors
  63236. * @returns an array of PhysicsImpostor
  63237. */
  63238. getImpostors(): Array<PhysicsImpostor>;
  63239. /**
  63240. * Gets the impostor for a physics enabled object
  63241. * @param object defines the object impersonated by the impostor
  63242. * @returns the PhysicsImpostor or null if not found
  63243. */
  63244. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  63245. /**
  63246. * Gets the impostor for a physics body object
  63247. * @param body defines physics body used by the impostor
  63248. * @returns the PhysicsImpostor or null if not found
  63249. */
  63250. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  63251. /**
  63252. * Does a raycast in the physics world
  63253. * @param from when should the ray start?
  63254. * @param to when should the ray end?
  63255. * @returns PhysicsRaycastResult
  63256. */
  63257. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63258. }
  63259. }
  63260. declare module "babylonjs/Physics/Plugins/cannonJSPlugin" {
  63261. import { Nullable } from "babylonjs/types";
  63262. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  63263. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63264. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63265. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63266. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63267. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63268. /** @hidden */
  63269. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  63270. private _useDeltaForWorldStep;
  63271. world: any;
  63272. name: string;
  63273. private _physicsMaterials;
  63274. private _fixedTimeStep;
  63275. private _cannonRaycastResult;
  63276. private _raycastResult;
  63277. private _physicsBodysToRemoveAfterStep;
  63278. private _firstFrame;
  63279. BJSCANNON: any;
  63280. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  63281. setGravity(gravity: Vector3): void;
  63282. setTimeStep(timeStep: number): void;
  63283. getTimeStep(): number;
  63284. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63285. private _removeMarkedPhysicsBodiesFromWorld;
  63286. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63287. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63288. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63289. private _processChildMeshes;
  63290. removePhysicsBody(impostor: PhysicsImpostor): void;
  63291. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63292. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63293. private _addMaterial;
  63294. private _checkWithEpsilon;
  63295. private _createShape;
  63296. private _createHeightmap;
  63297. private _minus90X;
  63298. private _plus90X;
  63299. private _tmpPosition;
  63300. private _tmpDeltaPosition;
  63301. private _tmpUnityRotation;
  63302. private _updatePhysicsBodyTransformation;
  63303. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63304. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63305. isSupported(): boolean;
  63306. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63307. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63308. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63309. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63310. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63311. getBodyMass(impostor: PhysicsImpostor): number;
  63312. getBodyFriction(impostor: PhysicsImpostor): number;
  63313. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63314. getBodyRestitution(impostor: PhysicsImpostor): number;
  63315. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63316. sleepBody(impostor: PhysicsImpostor): void;
  63317. wakeUpBody(impostor: PhysicsImpostor): void;
  63318. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  63319. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  63320. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  63321. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63322. getRadius(impostor: PhysicsImpostor): number;
  63323. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63324. dispose(): void;
  63325. private _extendNamespace;
  63326. /**
  63327. * Does a raycast in the physics world
  63328. * @param from when should the ray start?
  63329. * @param to when should the ray end?
  63330. * @returns PhysicsRaycastResult
  63331. */
  63332. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63333. }
  63334. }
  63335. declare module "babylonjs/Physics/Plugins/oimoJSPlugin" {
  63336. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63337. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63338. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63339. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63340. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  63341. import { Nullable } from "babylonjs/types";
  63342. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63343. /** @hidden */
  63344. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  63345. private _useDeltaForWorldStep;
  63346. world: any;
  63347. name: string;
  63348. BJSOIMO: any;
  63349. private _raycastResult;
  63350. private _fixedTimeStep;
  63351. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  63352. setGravity(gravity: Vector3): void;
  63353. setTimeStep(timeStep: number): void;
  63354. getTimeStep(): number;
  63355. private _tmpImpostorsArray;
  63356. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63357. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63358. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63359. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63360. private _tmpPositionVector;
  63361. removePhysicsBody(impostor: PhysicsImpostor): void;
  63362. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63363. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63364. isSupported(): boolean;
  63365. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63366. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63367. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63368. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63369. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63370. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63371. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63372. getBodyMass(impostor: PhysicsImpostor): number;
  63373. getBodyFriction(impostor: PhysicsImpostor): number;
  63374. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63375. getBodyRestitution(impostor: PhysicsImpostor): number;
  63376. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63377. sleepBody(impostor: PhysicsImpostor): void;
  63378. wakeUpBody(impostor: PhysicsImpostor): void;
  63379. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  63380. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  63381. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  63382. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63383. getRadius(impostor: PhysicsImpostor): number;
  63384. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63385. dispose(): void;
  63386. /**
  63387. * Does a raycast in the physics world
  63388. * @param from when should the ray start?
  63389. * @param to when should the ray end?
  63390. * @returns PhysicsRaycastResult
  63391. */
  63392. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63393. }
  63394. }
  63395. declare module "babylonjs/Physics/Plugins/ammoJSPlugin" {
  63396. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  63397. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63398. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63399. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63400. import { Nullable } from "babylonjs/types";
  63401. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63402. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63403. /**
  63404. * AmmoJS Physics plugin
  63405. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  63406. * @see https://github.com/kripken/ammo.js/
  63407. */
  63408. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  63409. private _useDeltaForWorldStep;
  63410. /**
  63411. * Reference to the Ammo library
  63412. */
  63413. bjsAMMO: any;
  63414. /**
  63415. * Created ammoJS world which physics bodies are added to
  63416. */
  63417. world: any;
  63418. /**
  63419. * Name of the plugin
  63420. */
  63421. name: string;
  63422. private _timeStep;
  63423. private _fixedTimeStep;
  63424. private _maxSteps;
  63425. private _tmpQuaternion;
  63426. private _tmpAmmoTransform;
  63427. private _tmpAmmoQuaternion;
  63428. private _tmpAmmoConcreteContactResultCallback;
  63429. private _collisionConfiguration;
  63430. private _dispatcher;
  63431. private _overlappingPairCache;
  63432. private _solver;
  63433. private _softBodySolver;
  63434. private _tmpAmmoVectorA;
  63435. private _tmpAmmoVectorB;
  63436. private _tmpAmmoVectorC;
  63437. private _tmpAmmoVectorD;
  63438. private _tmpContactCallbackResult;
  63439. private _tmpAmmoVectorRCA;
  63440. private _tmpAmmoVectorRCB;
  63441. private _raycastResult;
  63442. private static readonly DISABLE_COLLISION_FLAG;
  63443. private static readonly KINEMATIC_FLAG;
  63444. private static readonly DISABLE_DEACTIVATION_FLAG;
  63445. /**
  63446. * Initializes the ammoJS plugin
  63447. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  63448. * @param ammoInjection can be used to inject your own ammo reference
  63449. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  63450. */
  63451. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  63452. /**
  63453. * Sets the gravity of the physics world (m/(s^2))
  63454. * @param gravity Gravity to set
  63455. */
  63456. setGravity(gravity: Vector3): void;
  63457. /**
  63458. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  63459. * @param timeStep timestep to use in seconds
  63460. */
  63461. setTimeStep(timeStep: number): void;
  63462. /**
  63463. * 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)
  63464. * @param fixedTimeStep fixedTimeStep to use in seconds
  63465. */
  63466. setFixedTimeStep(fixedTimeStep: number): void;
  63467. /**
  63468. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  63469. * @param maxSteps the maximum number of steps by the physics engine per frame
  63470. */
  63471. setMaxSteps(maxSteps: number): void;
  63472. /**
  63473. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  63474. * @returns the current timestep in seconds
  63475. */
  63476. getTimeStep(): number;
  63477. /**
  63478. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  63479. */
  63480. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  63481. private _isImpostorInContact;
  63482. private _isImpostorPairInContact;
  63483. private _stepSimulation;
  63484. /**
  63485. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  63486. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  63487. * After the step the babylon meshes are set to the position of the physics imposters
  63488. * @param delta amount of time to step forward
  63489. * @param impostors array of imposters to update before/after the step
  63490. */
  63491. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63492. /**
  63493. * Update babylon mesh to match physics world object
  63494. * @param impostor imposter to match
  63495. */
  63496. private _afterSoftStep;
  63497. /**
  63498. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  63499. * @param impostor imposter to match
  63500. */
  63501. private _ropeStep;
  63502. /**
  63503. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  63504. * @param impostor imposter to match
  63505. */
  63506. private _softbodyOrClothStep;
  63507. private _tmpMatrix;
  63508. /**
  63509. * Applies an impulse on the imposter
  63510. * @param impostor imposter to apply impulse to
  63511. * @param force amount of force to be applied to the imposter
  63512. * @param contactPoint the location to apply the impulse on the imposter
  63513. */
  63514. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63515. /**
  63516. * Applies a force on the imposter
  63517. * @param impostor imposter to apply force
  63518. * @param force amount of force to be applied to the imposter
  63519. * @param contactPoint the location to apply the force on the imposter
  63520. */
  63521. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63522. /**
  63523. * Creates a physics body using the plugin
  63524. * @param impostor the imposter to create the physics body on
  63525. */
  63526. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63527. /**
  63528. * Removes the physics body from the imposter and disposes of the body's memory
  63529. * @param impostor imposter to remove the physics body from
  63530. */
  63531. removePhysicsBody(impostor: PhysicsImpostor): void;
  63532. /**
  63533. * Generates a joint
  63534. * @param impostorJoint the imposter joint to create the joint with
  63535. */
  63536. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63537. /**
  63538. * Removes a joint
  63539. * @param impostorJoint the imposter joint to remove the joint from
  63540. */
  63541. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63542. private _addMeshVerts;
  63543. /**
  63544. * Initialise the soft body vertices to match its object's (mesh) vertices
  63545. * Softbody vertices (nodes) are in world space and to match this
  63546. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  63547. * @param impostor to create the softbody for
  63548. */
  63549. private _softVertexData;
  63550. /**
  63551. * Create an impostor's soft body
  63552. * @param impostor to create the softbody for
  63553. */
  63554. private _createSoftbody;
  63555. /**
  63556. * Create cloth for an impostor
  63557. * @param impostor to create the softbody for
  63558. */
  63559. private _createCloth;
  63560. /**
  63561. * Create rope for an impostor
  63562. * @param impostor to create the softbody for
  63563. */
  63564. private _createRope;
  63565. /**
  63566. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  63567. * @param impostor to create the custom physics shape for
  63568. */
  63569. private _createCustom;
  63570. private _addHullVerts;
  63571. private _createShape;
  63572. /**
  63573. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  63574. * @param impostor imposter containing the physics body and babylon object
  63575. */
  63576. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63577. /**
  63578. * Sets the babylon object's position/rotation from the physics body's position/rotation
  63579. * @param impostor imposter containing the physics body and babylon object
  63580. * @param newPosition new position
  63581. * @param newRotation new rotation
  63582. */
  63583. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63584. /**
  63585. * If this plugin is supported
  63586. * @returns true if its supported
  63587. */
  63588. isSupported(): boolean;
  63589. /**
  63590. * Sets the linear velocity of the physics body
  63591. * @param impostor imposter to set the velocity on
  63592. * @param velocity velocity to set
  63593. */
  63594. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63595. /**
  63596. * Sets the angular velocity of the physics body
  63597. * @param impostor imposter to set the velocity on
  63598. * @param velocity velocity to set
  63599. */
  63600. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63601. /**
  63602. * gets the linear velocity
  63603. * @param impostor imposter to get linear velocity from
  63604. * @returns linear velocity
  63605. */
  63606. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63607. /**
  63608. * gets the angular velocity
  63609. * @param impostor imposter to get angular velocity from
  63610. * @returns angular velocity
  63611. */
  63612. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63613. /**
  63614. * Sets the mass of physics body
  63615. * @param impostor imposter to set the mass on
  63616. * @param mass mass to set
  63617. */
  63618. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63619. /**
  63620. * Gets the mass of the physics body
  63621. * @param impostor imposter to get the mass from
  63622. * @returns mass
  63623. */
  63624. getBodyMass(impostor: PhysicsImpostor): number;
  63625. /**
  63626. * Gets friction of the impostor
  63627. * @param impostor impostor to get friction from
  63628. * @returns friction value
  63629. */
  63630. getBodyFriction(impostor: PhysicsImpostor): number;
  63631. /**
  63632. * Sets friction of the impostor
  63633. * @param impostor impostor to set friction on
  63634. * @param friction friction value
  63635. */
  63636. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63637. /**
  63638. * Gets restitution of the impostor
  63639. * @param impostor impostor to get restitution from
  63640. * @returns restitution value
  63641. */
  63642. getBodyRestitution(impostor: PhysicsImpostor): number;
  63643. /**
  63644. * Sets resitution of the impostor
  63645. * @param impostor impostor to set resitution on
  63646. * @param restitution resitution value
  63647. */
  63648. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63649. /**
  63650. * Gets pressure inside the impostor
  63651. * @param impostor impostor to get pressure from
  63652. * @returns pressure value
  63653. */
  63654. getBodyPressure(impostor: PhysicsImpostor): number;
  63655. /**
  63656. * Sets pressure inside a soft body impostor
  63657. * Cloth and rope must remain 0 pressure
  63658. * @param impostor impostor to set pressure on
  63659. * @param pressure pressure value
  63660. */
  63661. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  63662. /**
  63663. * Gets stiffness of the impostor
  63664. * @param impostor impostor to get stiffness from
  63665. * @returns pressure value
  63666. */
  63667. getBodyStiffness(impostor: PhysicsImpostor): number;
  63668. /**
  63669. * Sets stiffness of the impostor
  63670. * @param impostor impostor to set stiffness on
  63671. * @param stiffness stiffness value from 0 to 1
  63672. */
  63673. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  63674. /**
  63675. * Gets velocityIterations of the impostor
  63676. * @param impostor impostor to get velocity iterations from
  63677. * @returns velocityIterations value
  63678. */
  63679. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  63680. /**
  63681. * Sets velocityIterations of the impostor
  63682. * @param impostor impostor to set velocity iterations on
  63683. * @param velocityIterations velocityIterations value
  63684. */
  63685. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  63686. /**
  63687. * Gets positionIterations of the impostor
  63688. * @param impostor impostor to get position iterations from
  63689. * @returns positionIterations value
  63690. */
  63691. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  63692. /**
  63693. * Sets positionIterations of the impostor
  63694. * @param impostor impostor to set position on
  63695. * @param positionIterations positionIterations value
  63696. */
  63697. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  63698. /**
  63699. * Append an anchor to a cloth object
  63700. * @param impostor is the cloth impostor to add anchor to
  63701. * @param otherImpostor is the rigid impostor to anchor to
  63702. * @param width ratio across width from 0 to 1
  63703. * @param height ratio up height from 0 to 1
  63704. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  63705. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  63706. */
  63707. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  63708. /**
  63709. * Append an hook to a rope object
  63710. * @param impostor is the rope impostor to add hook to
  63711. * @param otherImpostor is the rigid impostor to hook to
  63712. * @param length ratio along the rope from 0 to 1
  63713. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  63714. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  63715. */
  63716. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  63717. /**
  63718. * Sleeps the physics body and stops it from being active
  63719. * @param impostor impostor to sleep
  63720. */
  63721. sleepBody(impostor: PhysicsImpostor): void;
  63722. /**
  63723. * Activates the physics body
  63724. * @param impostor impostor to activate
  63725. */
  63726. wakeUpBody(impostor: PhysicsImpostor): void;
  63727. /**
  63728. * Updates the distance parameters of the joint
  63729. * @param joint joint to update
  63730. * @param maxDistance maximum distance of the joint
  63731. * @param minDistance minimum distance of the joint
  63732. */
  63733. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  63734. /**
  63735. * Sets a motor on the joint
  63736. * @param joint joint to set motor on
  63737. * @param speed speed of the motor
  63738. * @param maxForce maximum force of the motor
  63739. * @param motorIndex index of the motor
  63740. */
  63741. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  63742. /**
  63743. * Sets the motors limit
  63744. * @param joint joint to set limit on
  63745. * @param upperLimit upper limit
  63746. * @param lowerLimit lower limit
  63747. */
  63748. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  63749. /**
  63750. * Syncs the position and rotation of a mesh with the impostor
  63751. * @param mesh mesh to sync
  63752. * @param impostor impostor to update the mesh with
  63753. */
  63754. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63755. /**
  63756. * Gets the radius of the impostor
  63757. * @param impostor impostor to get radius from
  63758. * @returns the radius
  63759. */
  63760. getRadius(impostor: PhysicsImpostor): number;
  63761. /**
  63762. * Gets the box size of the impostor
  63763. * @param impostor impostor to get box size from
  63764. * @param result the resulting box size
  63765. */
  63766. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63767. /**
  63768. * Disposes of the impostor
  63769. */
  63770. dispose(): void;
  63771. /**
  63772. * Does a raycast in the physics world
  63773. * @param from when should the ray start?
  63774. * @param to when should the ray end?
  63775. * @returns PhysicsRaycastResult
  63776. */
  63777. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63778. }
  63779. }
  63780. declare module "babylonjs/Probes/reflectionProbe" {
  63781. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63782. import { Vector3 } from "babylonjs/Maths/math.vector";
  63783. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63784. import { Nullable } from "babylonjs/types";
  63785. import { Scene } from "babylonjs/scene";
  63786. module "babylonjs/abstractScene" {
  63787. interface AbstractScene {
  63788. /**
  63789. * The list of reflection probes added to the scene
  63790. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  63791. */
  63792. reflectionProbes: Array<ReflectionProbe>;
  63793. /**
  63794. * Removes the given reflection probe from this scene.
  63795. * @param toRemove The reflection probe to remove
  63796. * @returns The index of the removed reflection probe
  63797. */
  63798. removeReflectionProbe(toRemove: ReflectionProbe): number;
  63799. /**
  63800. * Adds the given reflection probe to this scene.
  63801. * @param newReflectionProbe The reflection probe to add
  63802. */
  63803. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  63804. }
  63805. }
  63806. /**
  63807. * Class used to generate realtime reflection / refraction cube textures
  63808. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  63809. */
  63810. export class ReflectionProbe {
  63811. /** defines the name of the probe */
  63812. name: string;
  63813. private _scene;
  63814. private _renderTargetTexture;
  63815. private _projectionMatrix;
  63816. private _viewMatrix;
  63817. private _target;
  63818. private _add;
  63819. private _attachedMesh;
  63820. private _invertYAxis;
  63821. /** Gets or sets probe position (center of the cube map) */
  63822. position: Vector3;
  63823. /**
  63824. * Creates a new reflection probe
  63825. * @param name defines the name of the probe
  63826. * @param size defines the texture resolution (for each face)
  63827. * @param scene defines the hosting scene
  63828. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  63829. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  63830. */
  63831. constructor(
  63832. /** defines the name of the probe */
  63833. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  63834. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  63835. get samples(): number;
  63836. set samples(value: number);
  63837. /** Gets or sets the refresh rate to use (on every frame by default) */
  63838. get refreshRate(): number;
  63839. set refreshRate(value: number);
  63840. /**
  63841. * Gets the hosting scene
  63842. * @returns a Scene
  63843. */
  63844. getScene(): Scene;
  63845. /** Gets the internal CubeTexture used to render to */
  63846. get cubeTexture(): RenderTargetTexture;
  63847. /** Gets the list of meshes to render */
  63848. get renderList(): Nullable<AbstractMesh[]>;
  63849. /**
  63850. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  63851. * @param mesh defines the mesh to attach to
  63852. */
  63853. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  63854. /**
  63855. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  63856. * @param renderingGroupId The rendering group id corresponding to its index
  63857. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  63858. */
  63859. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  63860. /**
  63861. * Clean all associated resources
  63862. */
  63863. dispose(): void;
  63864. /**
  63865. * Converts the reflection probe information to a readable string for debug purpose.
  63866. * @param fullDetails Supports for multiple levels of logging within scene loading
  63867. * @returns the human readable reflection probe info
  63868. */
  63869. toString(fullDetails?: boolean): string;
  63870. /**
  63871. * Get the class name of the relfection probe.
  63872. * @returns "ReflectionProbe"
  63873. */
  63874. getClassName(): string;
  63875. /**
  63876. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  63877. * @returns The JSON representation of the texture
  63878. */
  63879. serialize(): any;
  63880. /**
  63881. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  63882. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  63883. * @param scene Define the scene the parsed reflection probe should be instantiated in
  63884. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  63885. * @returns The parsed reflection probe if successful
  63886. */
  63887. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  63888. }
  63889. }
  63890. declare module "babylonjs/Loading/Plugins/babylonFileLoader" {
  63891. /** @hidden */
  63892. export var _BabylonLoaderRegistered: boolean;
  63893. /**
  63894. * Helps setting up some configuration for the babylon file loader.
  63895. */
  63896. export class BabylonFileLoaderConfiguration {
  63897. /**
  63898. * The loader does not allow injecting custom physix engine into the plugins.
  63899. * Unfortunately in ES6, we need to manually inject them into the plugin.
  63900. * So you could set this variable to your engine import to make it work.
  63901. */
  63902. static LoaderInjectedPhysicsEngine: any;
  63903. }
  63904. }
  63905. declare module "babylonjs/Loading/Plugins/index" {
  63906. export * from "babylonjs/Loading/Plugins/babylonFileLoader";
  63907. }
  63908. declare module "babylonjs/Loading/index" {
  63909. export * from "babylonjs/Loading/loadingScreen";
  63910. export * from "babylonjs/Loading/Plugins/index";
  63911. export * from "babylonjs/Loading/sceneLoader";
  63912. export * from "babylonjs/Loading/sceneLoaderFlags";
  63913. }
  63914. declare module "babylonjs/Materials/Background/index" {
  63915. export * from "babylonjs/Materials/Background/backgroundMaterial";
  63916. }
  63917. declare module "babylonjs/Materials/PBR/pbrBaseSimpleMaterial" {
  63918. import { Scene } from "babylonjs/scene";
  63919. import { Color3 } from "babylonjs/Maths/math.color";
  63920. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  63921. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63922. /**
  63923. * The Physically based simple base material of BJS.
  63924. *
  63925. * This enables better naming and convention enforcements on top of the pbrMaterial.
  63926. * It is used as the base class for both the specGloss and metalRough conventions.
  63927. */
  63928. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  63929. /**
  63930. * Number of Simultaneous lights allowed on the material.
  63931. */
  63932. maxSimultaneousLights: number;
  63933. /**
  63934. * If sets to true, disables all the lights affecting the material.
  63935. */
  63936. disableLighting: boolean;
  63937. /**
  63938. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  63939. */
  63940. environmentTexture: BaseTexture;
  63941. /**
  63942. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  63943. */
  63944. invertNormalMapX: boolean;
  63945. /**
  63946. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  63947. */
  63948. invertNormalMapY: boolean;
  63949. /**
  63950. * Normal map used in the model.
  63951. */
  63952. normalTexture: BaseTexture;
  63953. /**
  63954. * Emissivie color used to self-illuminate the model.
  63955. */
  63956. emissiveColor: Color3;
  63957. /**
  63958. * Emissivie texture used to self-illuminate the model.
  63959. */
  63960. emissiveTexture: BaseTexture;
  63961. /**
  63962. * Occlusion Channel Strenght.
  63963. */
  63964. occlusionStrength: number;
  63965. /**
  63966. * Occlusion Texture of the material (adding extra occlusion effects).
  63967. */
  63968. occlusionTexture: BaseTexture;
  63969. /**
  63970. * Defines the alpha limits in alpha test mode.
  63971. */
  63972. alphaCutOff: number;
  63973. /**
  63974. * Gets the current double sided mode.
  63975. */
  63976. get doubleSided(): boolean;
  63977. /**
  63978. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  63979. */
  63980. set doubleSided(value: boolean);
  63981. /**
  63982. * Stores the pre-calculated light information of a mesh in a texture.
  63983. */
  63984. lightmapTexture: BaseTexture;
  63985. /**
  63986. * If true, the light map contains occlusion information instead of lighting info.
  63987. */
  63988. useLightmapAsShadowmap: boolean;
  63989. /**
  63990. * Instantiates a new PBRMaterial instance.
  63991. *
  63992. * @param name The material name
  63993. * @param scene The scene the material will be use in.
  63994. */
  63995. constructor(name: string, scene: Scene);
  63996. getClassName(): string;
  63997. }
  63998. }
  63999. declare module "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial" {
  64000. import { Scene } from "babylonjs/scene";
  64001. import { Color3 } from "babylonjs/Maths/math.color";
  64002. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64003. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64004. /**
  64005. * The PBR material of BJS following the metal roughness convention.
  64006. *
  64007. * This fits to the PBR convention in the GLTF definition:
  64008. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  64009. */
  64010. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  64011. /**
  64012. * The base color has two different interpretations depending on the value of metalness.
  64013. * When the material is a metal, the base color is the specific measured reflectance value
  64014. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  64015. * of the material.
  64016. */
  64017. baseColor: Color3;
  64018. /**
  64019. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  64020. * well as opacity information in the alpha channel.
  64021. */
  64022. baseTexture: BaseTexture;
  64023. /**
  64024. * Specifies the metallic scalar value of the material.
  64025. * Can also be used to scale the metalness values of the metallic texture.
  64026. */
  64027. metallic: number;
  64028. /**
  64029. * Specifies the roughness scalar value of the material.
  64030. * Can also be used to scale the roughness values of the metallic texture.
  64031. */
  64032. roughness: number;
  64033. /**
  64034. * Texture containing both the metallic value in the B channel and the
  64035. * roughness value in the G channel to keep better precision.
  64036. */
  64037. metallicRoughnessTexture: BaseTexture;
  64038. /**
  64039. * Instantiates a new PBRMetalRoughnessMaterial instance.
  64040. *
  64041. * @param name The material name
  64042. * @param scene The scene the material will be use in.
  64043. */
  64044. constructor(name: string, scene: Scene);
  64045. /**
  64046. * Return the currrent class name of the material.
  64047. */
  64048. getClassName(): string;
  64049. /**
  64050. * Makes a duplicate of the current material.
  64051. * @param name - name to use for the new material.
  64052. */
  64053. clone(name: string): PBRMetallicRoughnessMaterial;
  64054. /**
  64055. * Serialize the material to a parsable JSON object.
  64056. */
  64057. serialize(): any;
  64058. /**
  64059. * Parses a JSON object correponding to the serialize function.
  64060. */
  64061. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  64062. }
  64063. }
  64064. declare module "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial" {
  64065. import { Scene } from "babylonjs/scene";
  64066. import { Color3 } from "babylonjs/Maths/math.color";
  64067. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64068. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64069. /**
  64070. * The PBR material of BJS following the specular glossiness convention.
  64071. *
  64072. * This fits to the PBR convention in the GLTF definition:
  64073. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  64074. */
  64075. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  64076. /**
  64077. * Specifies the diffuse color of the material.
  64078. */
  64079. diffuseColor: Color3;
  64080. /**
  64081. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  64082. * channel.
  64083. */
  64084. diffuseTexture: BaseTexture;
  64085. /**
  64086. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  64087. */
  64088. specularColor: Color3;
  64089. /**
  64090. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  64091. */
  64092. glossiness: number;
  64093. /**
  64094. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  64095. */
  64096. specularGlossinessTexture: BaseTexture;
  64097. /**
  64098. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  64099. *
  64100. * @param name The material name
  64101. * @param scene The scene the material will be use in.
  64102. */
  64103. constructor(name: string, scene: Scene);
  64104. /**
  64105. * Return the currrent class name of the material.
  64106. */
  64107. getClassName(): string;
  64108. /**
  64109. * Makes a duplicate of the current material.
  64110. * @param name - name to use for the new material.
  64111. */
  64112. clone(name: string): PBRSpecularGlossinessMaterial;
  64113. /**
  64114. * Serialize the material to a parsable JSON object.
  64115. */
  64116. serialize(): any;
  64117. /**
  64118. * Parses a JSON object correponding to the serialize function.
  64119. */
  64120. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  64121. }
  64122. }
  64123. declare module "babylonjs/Materials/PBR/index" {
  64124. export * from "babylonjs/Materials/PBR/pbrBaseMaterial";
  64125. export * from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64126. export * from "babylonjs/Materials/PBR/pbrMaterial";
  64127. export * from "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial";
  64128. export * from "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial";
  64129. }
  64130. declare module "babylonjs/Materials/Textures/colorGradingTexture" {
  64131. import { Nullable } from "babylonjs/types";
  64132. import { Scene } from "babylonjs/scene";
  64133. import { Matrix } from "babylonjs/Maths/math.vector";
  64134. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64135. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  64136. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64137. /**
  64138. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  64139. * It can help converting any input color in a desired output one. This can then be used to create effects
  64140. * from sepia, black and white to sixties or futuristic rendering...
  64141. *
  64142. * The only supported format is currently 3dl.
  64143. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  64144. */
  64145. export class ColorGradingTexture extends BaseTexture {
  64146. /**
  64147. * The texture URL.
  64148. */
  64149. url: string;
  64150. /**
  64151. * Empty line regex stored for GC.
  64152. */
  64153. private static _noneEmptyLineRegex;
  64154. private _textureMatrix;
  64155. private _onLoad;
  64156. /**
  64157. * Instantiates a ColorGradingTexture from the following parameters.
  64158. *
  64159. * @param url The location of the color gradind data (currently only supporting 3dl)
  64160. * @param sceneOrEngine The scene or engine the texture will be used in
  64161. * @param onLoad defines a callback triggered when the texture has been loaded
  64162. */
  64163. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  64164. /**
  64165. * Fires the onload event from the constructor if requested.
  64166. */
  64167. private _triggerOnLoad;
  64168. /**
  64169. * Returns the texture matrix used in most of the material.
  64170. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  64171. */
  64172. getTextureMatrix(): Matrix;
  64173. /**
  64174. * Occurs when the file being loaded is a .3dl LUT file.
  64175. */
  64176. private load3dlTexture;
  64177. /**
  64178. * Starts the loading process of the texture.
  64179. */
  64180. private loadTexture;
  64181. /**
  64182. * Clones the color gradind texture.
  64183. */
  64184. clone(): ColorGradingTexture;
  64185. /**
  64186. * Called during delayed load for textures.
  64187. */
  64188. delayLoad(): void;
  64189. /**
  64190. * Parses a color grading texture serialized by Babylon.
  64191. * @param parsedTexture The texture information being parsedTexture
  64192. * @param scene The scene to load the texture in
  64193. * @param rootUrl The root url of the data assets to load
  64194. * @return A color gradind texture
  64195. */
  64196. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  64197. /**
  64198. * Serializes the LUT texture to json format.
  64199. */
  64200. serialize(): any;
  64201. }
  64202. }
  64203. declare module "babylonjs/Materials/Textures/equiRectangularCubeTexture" {
  64204. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64205. import { Scene } from "babylonjs/scene";
  64206. import { Nullable } from "babylonjs/types";
  64207. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64208. /**
  64209. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  64210. */
  64211. export class EquiRectangularCubeTexture extends BaseTexture {
  64212. /** The six faces of the cube. */
  64213. private static _FacesMapping;
  64214. private _noMipmap;
  64215. private _onLoad;
  64216. private _onError;
  64217. /** The size of the cubemap. */
  64218. private _size;
  64219. /** The buffer of the image. */
  64220. private _buffer;
  64221. /** The width of the input image. */
  64222. private _width;
  64223. /** The height of the input image. */
  64224. private _height;
  64225. /** The URL to the image. */
  64226. url: string;
  64227. /**
  64228. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  64229. * @param url The location of the image
  64230. * @param scene The scene the texture will be used in
  64231. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  64232. * @param noMipmap Forces to not generate the mipmap if true
  64233. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  64234. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  64235. * @param onLoad — defines a callback called when texture is loaded
  64236. * @param onError — defines a callback called if there is an error
  64237. */
  64238. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  64239. /**
  64240. * Load the image data, by putting the image on a canvas and extracting its buffer.
  64241. */
  64242. private loadImage;
  64243. /**
  64244. * Convert the image buffer into a cubemap and create a CubeTexture.
  64245. */
  64246. private loadTexture;
  64247. /**
  64248. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  64249. * @param buffer The ArrayBuffer that should be converted.
  64250. * @returns The buffer as Float32Array.
  64251. */
  64252. private getFloat32ArrayFromArrayBuffer;
  64253. /**
  64254. * Get the current class name of the texture useful for serialization or dynamic coding.
  64255. * @returns "EquiRectangularCubeTexture"
  64256. */
  64257. getClassName(): string;
  64258. /**
  64259. * Create a clone of the current EquiRectangularCubeTexture and return it.
  64260. * @returns A clone of the current EquiRectangularCubeTexture.
  64261. */
  64262. clone(): EquiRectangularCubeTexture;
  64263. }
  64264. }
  64265. declare module "babylonjs/Materials/Textures/htmlElementTexture" {
  64266. import { Nullable } from "babylonjs/types";
  64267. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64268. import { Matrix } from "babylonjs/Maths/math.vector";
  64269. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  64270. import "babylonjs/Engines/Extensions/engine.videoTexture";
  64271. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  64272. import { Scene } from "babylonjs/scene";
  64273. /**
  64274. * Defines the options related to the creation of an HtmlElementTexture
  64275. */
  64276. export interface IHtmlElementTextureOptions {
  64277. /**
  64278. * Defines wether mip maps should be created or not.
  64279. */
  64280. generateMipMaps?: boolean;
  64281. /**
  64282. * Defines the sampling mode of the texture.
  64283. */
  64284. samplingMode?: number;
  64285. /**
  64286. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  64287. */
  64288. engine: Nullable<ThinEngine>;
  64289. /**
  64290. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  64291. */
  64292. scene: Nullable<Scene>;
  64293. }
  64294. /**
  64295. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  64296. * To be as efficient as possible depending on your constraints nothing aside the first upload
  64297. * is automatically managed.
  64298. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  64299. * in your application.
  64300. *
  64301. * As the update is not automatic, you need to call them manually.
  64302. */
  64303. export class HtmlElementTexture extends BaseTexture {
  64304. /**
  64305. * The texture URL.
  64306. */
  64307. element: HTMLVideoElement | HTMLCanvasElement;
  64308. private static readonly DefaultOptions;
  64309. private _textureMatrix;
  64310. private _isVideo;
  64311. private _generateMipMaps;
  64312. private _samplingMode;
  64313. /**
  64314. * Instantiates a HtmlElementTexture from the following parameters.
  64315. *
  64316. * @param name Defines the name of the texture
  64317. * @param element Defines the video or canvas the texture is filled with
  64318. * @param options Defines the other none mandatory texture creation options
  64319. */
  64320. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  64321. private _createInternalTexture;
  64322. /**
  64323. * Returns the texture matrix used in most of the material.
  64324. */
  64325. getTextureMatrix(): Matrix;
  64326. /**
  64327. * Updates the content of the texture.
  64328. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  64329. */
  64330. update(invertY?: Nullable<boolean>): void;
  64331. }
  64332. }
  64333. declare module "babylonjs/Misc/tga" {
  64334. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64335. /**
  64336. * Based on jsTGALoader - Javascript loader for TGA file
  64337. * By Vincent Thibault
  64338. * @see http://blog.robrowser.com/javascript-tga-loader.html
  64339. */
  64340. export class TGATools {
  64341. private static _TYPE_INDEXED;
  64342. private static _TYPE_RGB;
  64343. private static _TYPE_GREY;
  64344. private static _TYPE_RLE_INDEXED;
  64345. private static _TYPE_RLE_RGB;
  64346. private static _TYPE_RLE_GREY;
  64347. private static _ORIGIN_MASK;
  64348. private static _ORIGIN_SHIFT;
  64349. private static _ORIGIN_BL;
  64350. private static _ORIGIN_BR;
  64351. private static _ORIGIN_UL;
  64352. private static _ORIGIN_UR;
  64353. /**
  64354. * Gets the header of a TGA file
  64355. * @param data defines the TGA data
  64356. * @returns the header
  64357. */
  64358. static GetTGAHeader(data: Uint8Array): any;
  64359. /**
  64360. * Uploads TGA content to a Babylon Texture
  64361. * @hidden
  64362. */
  64363. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  64364. /** @hidden */
  64365. 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;
  64366. /** @hidden */
  64367. 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;
  64368. /** @hidden */
  64369. 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;
  64370. /** @hidden */
  64371. 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;
  64372. /** @hidden */
  64373. 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;
  64374. /** @hidden */
  64375. 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;
  64376. }
  64377. }
  64378. declare module "babylonjs/Materials/Textures/Loaders/tgaTextureLoader" {
  64379. import { Nullable } from "babylonjs/types";
  64380. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64381. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  64382. /**
  64383. * Implementation of the TGA Texture Loader.
  64384. * @hidden
  64385. */
  64386. export class _TGATextureLoader implements IInternalTextureLoader {
  64387. /**
  64388. * Defines wether the loader supports cascade loading the different faces.
  64389. */
  64390. readonly supportCascades: boolean;
  64391. /**
  64392. * This returns if the loader support the current file information.
  64393. * @param extension defines the file extension of the file being loaded
  64394. * @returns true if the loader can load the specified file
  64395. */
  64396. canLoad(extension: string): boolean;
  64397. /**
  64398. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  64399. * @param data contains the texture data
  64400. * @param texture defines the BabylonJS internal texture
  64401. * @param createPolynomials will be true if polynomials have been requested
  64402. * @param onLoad defines the callback to trigger once the texture is ready
  64403. * @param onError defines the callback to trigger in case of error
  64404. */
  64405. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  64406. /**
  64407. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  64408. * @param data contains the texture data
  64409. * @param texture defines the BabylonJS internal texture
  64410. * @param callback defines the method to call once ready to upload
  64411. */
  64412. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  64413. }
  64414. }
  64415. declare module "babylonjs/Misc/basis" {
  64416. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64417. /**
  64418. * Info about the .basis files
  64419. */
  64420. class BasisFileInfo {
  64421. /**
  64422. * If the file has alpha
  64423. */
  64424. hasAlpha: boolean;
  64425. /**
  64426. * Info about each image of the basis file
  64427. */
  64428. images: Array<{
  64429. levels: Array<{
  64430. width: number;
  64431. height: number;
  64432. transcodedPixels: ArrayBufferView;
  64433. }>;
  64434. }>;
  64435. }
  64436. /**
  64437. * Result of transcoding a basis file
  64438. */
  64439. class TranscodeResult {
  64440. /**
  64441. * Info about the .basis file
  64442. */
  64443. fileInfo: BasisFileInfo;
  64444. /**
  64445. * Format to use when loading the file
  64446. */
  64447. format: number;
  64448. }
  64449. /**
  64450. * Configuration options for the Basis transcoder
  64451. */
  64452. export class BasisTranscodeConfiguration {
  64453. /**
  64454. * Supported compression formats used to determine the supported output format of the transcoder
  64455. */
  64456. supportedCompressionFormats?: {
  64457. /**
  64458. * etc1 compression format
  64459. */
  64460. etc1?: boolean;
  64461. /**
  64462. * s3tc compression format
  64463. */
  64464. s3tc?: boolean;
  64465. /**
  64466. * pvrtc compression format
  64467. */
  64468. pvrtc?: boolean;
  64469. /**
  64470. * etc2 compression format
  64471. */
  64472. etc2?: boolean;
  64473. };
  64474. /**
  64475. * If mipmap levels should be loaded for transcoded images (Default: true)
  64476. */
  64477. loadMipmapLevels?: boolean;
  64478. /**
  64479. * Index of a single image to load (Default: all images)
  64480. */
  64481. loadSingleImage?: number;
  64482. }
  64483. /**
  64484. * Used to load .Basis files
  64485. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  64486. */
  64487. export class BasisTools {
  64488. private static _IgnoreSupportedFormats;
  64489. /**
  64490. * URL to use when loading the basis transcoder
  64491. */
  64492. static JSModuleURL: string;
  64493. /**
  64494. * URL to use when loading the wasm module for the transcoder
  64495. */
  64496. static WasmModuleURL: string;
  64497. /**
  64498. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  64499. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  64500. * @returns internal format corresponding to the Basis format
  64501. */
  64502. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  64503. private static _WorkerPromise;
  64504. private static _Worker;
  64505. private static _actionId;
  64506. private static _CreateWorkerAsync;
  64507. /**
  64508. * Transcodes a loaded image file to compressed pixel data
  64509. * @param data image data to transcode
  64510. * @param config configuration options for the transcoding
  64511. * @returns a promise resulting in the transcoded image
  64512. */
  64513. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  64514. /**
  64515. * Loads a texture from the transcode result
  64516. * @param texture texture load to
  64517. * @param transcodeResult the result of transcoding the basis file to load from
  64518. */
  64519. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  64520. }
  64521. }
  64522. declare module "babylonjs/Materials/Textures/Loaders/basisTextureLoader" {
  64523. import { Nullable } from "babylonjs/types";
  64524. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64525. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  64526. /**
  64527. * Loader for .basis file format
  64528. */
  64529. export class _BasisTextureLoader implements IInternalTextureLoader {
  64530. /**
  64531. * Defines whether the loader supports cascade loading the different faces.
  64532. */
  64533. readonly supportCascades: boolean;
  64534. /**
  64535. * This returns if the loader support the current file information.
  64536. * @param extension defines the file extension of the file being loaded
  64537. * @returns true if the loader can load the specified file
  64538. */
  64539. canLoad(extension: string): boolean;
  64540. /**
  64541. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  64542. * @param data contains the texture data
  64543. * @param texture defines the BabylonJS internal texture
  64544. * @param createPolynomials will be true if polynomials have been requested
  64545. * @param onLoad defines the callback to trigger once the texture is ready
  64546. * @param onError defines the callback to trigger in case of error
  64547. */
  64548. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  64549. /**
  64550. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  64551. * @param data contains the texture data
  64552. * @param texture defines the BabylonJS internal texture
  64553. * @param callback defines the method to call once ready to upload
  64554. */
  64555. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  64556. }
  64557. }
  64558. declare module "babylonjs/Materials/Textures/Loaders/index" {
  64559. export * from "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  64560. export * from "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  64561. export * from "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  64562. export * from "babylonjs/Materials/Textures/Loaders/tgaTextureLoader";
  64563. export * from "babylonjs/Materials/Textures/Loaders/basisTextureLoader";
  64564. }
  64565. declare module "babylonjs/Materials/Textures/Packer/frame" {
  64566. import { Vector2 } from "babylonjs/Maths/math.vector";
  64567. /**
  64568. * Defines the basic options interface of a TexturePacker Frame
  64569. */
  64570. export interface ITexturePackerFrame {
  64571. /**
  64572. * The frame ID
  64573. */
  64574. id: number;
  64575. /**
  64576. * The frames Scale
  64577. */
  64578. scale: Vector2;
  64579. /**
  64580. * The Frames offset
  64581. */
  64582. offset: Vector2;
  64583. }
  64584. /**
  64585. * This is a support class for frame Data on texture packer sets.
  64586. */
  64587. export class TexturePackerFrame implements ITexturePackerFrame {
  64588. /**
  64589. * The frame ID
  64590. */
  64591. id: number;
  64592. /**
  64593. * The frames Scale
  64594. */
  64595. scale: Vector2;
  64596. /**
  64597. * The Frames offset
  64598. */
  64599. offset: Vector2;
  64600. /**
  64601. * Initializes a texture package frame.
  64602. * @param id The numerical frame identifier
  64603. * @param scale Scalar Vector2 for UV frame
  64604. * @param offset Vector2 for the frame position in UV units.
  64605. * @returns TexturePackerFrame
  64606. */
  64607. constructor(id: number, scale: Vector2, offset: Vector2);
  64608. }
  64609. }
  64610. declare module "babylonjs/Materials/Textures/Packer/packer" {
  64611. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64612. import { Scene } from "babylonjs/scene";
  64613. import { Nullable } from "babylonjs/types";
  64614. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  64615. import { TexturePackerFrame } from "babylonjs/Materials/Textures/Packer/frame";
  64616. /**
  64617. * Defines the basic options interface of a TexturePacker
  64618. */
  64619. export interface ITexturePackerOptions {
  64620. /**
  64621. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  64622. */
  64623. map?: string[];
  64624. /**
  64625. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  64626. */
  64627. uvsIn?: string;
  64628. /**
  64629. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  64630. */
  64631. uvsOut?: string;
  64632. /**
  64633. * number representing the layout style. Defaults to LAYOUT_STRIP
  64634. */
  64635. layout?: number;
  64636. /**
  64637. * number of columns if using custom column count layout(2). This defaults to 4.
  64638. */
  64639. colnum?: number;
  64640. /**
  64641. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  64642. */
  64643. updateInputMeshes?: boolean;
  64644. /**
  64645. * boolean flag to dispose all the source textures. Defaults to true.
  64646. */
  64647. disposeSources?: boolean;
  64648. /**
  64649. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  64650. */
  64651. fillBlanks?: boolean;
  64652. /**
  64653. * string value representing the context fill style color. Defaults to 'black'.
  64654. */
  64655. customFillColor?: string;
  64656. /**
  64657. * Width and Height Value of each Frame in the TexturePacker Sets
  64658. */
  64659. frameSize?: number;
  64660. /**
  64661. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  64662. */
  64663. paddingRatio?: number;
  64664. /**
  64665. * Number that declares the fill method for the padding gutter.
  64666. */
  64667. paddingMode?: number;
  64668. /**
  64669. * If in SUBUV_COLOR padding mode what color to use.
  64670. */
  64671. paddingColor?: Color3 | Color4;
  64672. }
  64673. /**
  64674. * Defines the basic interface of a TexturePacker JSON File
  64675. */
  64676. export interface ITexturePackerJSON {
  64677. /**
  64678. * The frame ID
  64679. */
  64680. name: string;
  64681. /**
  64682. * The base64 channel data
  64683. */
  64684. sets: any;
  64685. /**
  64686. * The options of the Packer
  64687. */
  64688. options: ITexturePackerOptions;
  64689. /**
  64690. * The frame data of the Packer
  64691. */
  64692. frames: Array<number>;
  64693. }
  64694. /**
  64695. * This is a support class that generates a series of packed texture sets.
  64696. * @see https://doc.babylonjs.com/babylon101/materials
  64697. */
  64698. export class TexturePacker {
  64699. /** Packer Layout Constant 0 */
  64700. static readonly LAYOUT_STRIP: number;
  64701. /** Packer Layout Constant 1 */
  64702. static readonly LAYOUT_POWER2: number;
  64703. /** Packer Layout Constant 2 */
  64704. static readonly LAYOUT_COLNUM: number;
  64705. /** Packer Layout Constant 0 */
  64706. static readonly SUBUV_WRAP: number;
  64707. /** Packer Layout Constant 1 */
  64708. static readonly SUBUV_EXTEND: number;
  64709. /** Packer Layout Constant 2 */
  64710. static readonly SUBUV_COLOR: number;
  64711. /** The Name of the Texture Package */
  64712. name: string;
  64713. /** The scene scope of the TexturePacker */
  64714. scene: Scene;
  64715. /** The Meshes to target */
  64716. meshes: AbstractMesh[];
  64717. /** Arguments passed with the Constructor */
  64718. options: ITexturePackerOptions;
  64719. /** The promise that is started upon initialization */
  64720. promise: Nullable<Promise<TexturePacker | string>>;
  64721. /** The Container object for the channel sets that are generated */
  64722. sets: object;
  64723. /** The Container array for the frames that are generated */
  64724. frames: TexturePackerFrame[];
  64725. /** The expected number of textures the system is parsing. */
  64726. private _expecting;
  64727. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  64728. private _paddingValue;
  64729. /**
  64730. * Initializes a texture package series from an array of meshes or a single mesh.
  64731. * @param name The name of the package
  64732. * @param meshes The target meshes to compose the package from
  64733. * @param options The arguments that texture packer should follow while building.
  64734. * @param scene The scene which the textures are scoped to.
  64735. * @returns TexturePacker
  64736. */
  64737. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  64738. /**
  64739. * Starts the package process
  64740. * @param resolve The promises resolution function
  64741. * @returns TexturePacker
  64742. */
  64743. private _createFrames;
  64744. /**
  64745. * Calculates the Size of the Channel Sets
  64746. * @returns Vector2
  64747. */
  64748. private _calculateSize;
  64749. /**
  64750. * Calculates the UV data for the frames.
  64751. * @param baseSize the base frameSize
  64752. * @param padding the base frame padding
  64753. * @param dtSize size of the Dynamic Texture for that channel
  64754. * @param dtUnits is 1/dtSize
  64755. * @param update flag to update the input meshes
  64756. */
  64757. private _calculateMeshUVFrames;
  64758. /**
  64759. * Calculates the frames Offset.
  64760. * @param index of the frame
  64761. * @returns Vector2
  64762. */
  64763. private _getFrameOffset;
  64764. /**
  64765. * Updates a Mesh to the frame data
  64766. * @param mesh that is the target
  64767. * @param frameID or the frame index
  64768. */
  64769. private _updateMeshUV;
  64770. /**
  64771. * Updates a Meshes materials to use the texture packer channels
  64772. * @param m is the mesh to target
  64773. * @param force all channels on the packer to be set.
  64774. */
  64775. private _updateTextureReferences;
  64776. /**
  64777. * Public method to set a Mesh to a frame
  64778. * @param m that is the target
  64779. * @param frameID or the frame index
  64780. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  64781. */
  64782. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  64783. /**
  64784. * Starts the async promise to compile the texture packer.
  64785. * @returns Promise<void>
  64786. */
  64787. processAsync(): Promise<void>;
  64788. /**
  64789. * Disposes all textures associated with this packer
  64790. */
  64791. dispose(): void;
  64792. /**
  64793. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  64794. * @param imageType is the image type to use.
  64795. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  64796. */
  64797. download(imageType?: string, quality?: number): void;
  64798. /**
  64799. * Public method to load a texturePacker JSON file.
  64800. * @param data of the JSON file in string format.
  64801. */
  64802. updateFromJSON(data: string): void;
  64803. }
  64804. }
  64805. declare module "babylonjs/Materials/Textures/Packer/index" {
  64806. export * from "babylonjs/Materials/Textures/Packer/packer";
  64807. export * from "babylonjs/Materials/Textures/Packer/frame";
  64808. }
  64809. declare module "babylonjs/Materials/Textures/Procedurals/customProceduralTexture" {
  64810. import { Scene } from "babylonjs/scene";
  64811. import { Texture } from "babylonjs/Materials/Textures/texture";
  64812. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64813. /**
  64814. * 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.
  64815. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  64816. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  64817. */
  64818. export class CustomProceduralTexture extends ProceduralTexture {
  64819. private _animate;
  64820. private _time;
  64821. private _config;
  64822. private _texturePath;
  64823. /**
  64824. * Instantiates a new Custom Procedural Texture.
  64825. * 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.
  64826. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  64827. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  64828. * @param name Define the name of the texture
  64829. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  64830. * @param size Define the size of the texture to create
  64831. * @param scene Define the scene the texture belongs to
  64832. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  64833. * @param generateMipMaps Define if the texture should creates mip maps or not
  64834. */
  64835. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  64836. private _loadJson;
  64837. /**
  64838. * Is the texture ready to be used ? (rendered at least once)
  64839. * @returns true if ready, otherwise, false.
  64840. */
  64841. isReady(): boolean;
  64842. /**
  64843. * Render the texture to its associated render target.
  64844. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  64845. */
  64846. render(useCameraPostProcess?: boolean): void;
  64847. /**
  64848. * Update the list of dependant textures samplers in the shader.
  64849. */
  64850. updateTextures(): void;
  64851. /**
  64852. * Update the uniform values of the procedural texture in the shader.
  64853. */
  64854. updateShaderUniforms(): void;
  64855. /**
  64856. * Define if the texture animates or not.
  64857. */
  64858. get animate(): boolean;
  64859. set animate(value: boolean);
  64860. }
  64861. }
  64862. declare module "babylonjs/Shaders/noise.fragment" {
  64863. /** @hidden */
  64864. export var noisePixelShader: {
  64865. name: string;
  64866. shader: string;
  64867. };
  64868. }
  64869. declare module "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture" {
  64870. import { Nullable } from "babylonjs/types";
  64871. import { Scene } from "babylonjs/scene";
  64872. import { Texture } from "babylonjs/Materials/Textures/texture";
  64873. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64874. import "babylonjs/Shaders/noise.fragment";
  64875. /**
  64876. * Class used to generate noise procedural textures
  64877. */
  64878. export class NoiseProceduralTexture extends ProceduralTexture {
  64879. private _time;
  64880. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  64881. brightness: number;
  64882. /** Defines the number of octaves to process */
  64883. octaves: number;
  64884. /** Defines the level of persistence (0.8 by default) */
  64885. persistence: number;
  64886. /** Gets or sets animation speed factor (default is 1) */
  64887. animationSpeedFactor: number;
  64888. /**
  64889. * Creates a new NoiseProceduralTexture
  64890. * @param name defines the name fo the texture
  64891. * @param size defines the size of the texture (default is 256)
  64892. * @param scene defines the hosting scene
  64893. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  64894. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  64895. */
  64896. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  64897. private _updateShaderUniforms;
  64898. protected _getDefines(): string;
  64899. /** Generate the current state of the procedural texture */
  64900. render(useCameraPostProcess?: boolean): void;
  64901. /**
  64902. * Serializes this noise procedural texture
  64903. * @returns a serialized noise procedural texture object
  64904. */
  64905. serialize(): any;
  64906. /**
  64907. * Clone the texture.
  64908. * @returns the cloned texture
  64909. */
  64910. clone(): NoiseProceduralTexture;
  64911. /**
  64912. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  64913. * @param parsedTexture defines parsed texture data
  64914. * @param scene defines the current scene
  64915. * @param rootUrl defines the root URL containing noise procedural texture information
  64916. * @returns a parsed NoiseProceduralTexture
  64917. */
  64918. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  64919. }
  64920. }
  64921. declare module "babylonjs/Materials/Textures/Procedurals/index" {
  64922. export * from "babylonjs/Materials/Textures/Procedurals/customProceduralTexture";
  64923. export * from "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture";
  64924. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64925. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent";
  64926. }
  64927. declare module "babylonjs/Materials/Textures/rawCubeTexture" {
  64928. import { Nullable } from "babylonjs/types";
  64929. import { Scene } from "babylonjs/scene";
  64930. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  64931. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64932. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  64933. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64934. /**
  64935. * Raw cube texture where the raw buffers are passed in
  64936. */
  64937. export class RawCubeTexture extends CubeTexture {
  64938. /**
  64939. * Creates a cube texture where the raw buffers are passed in.
  64940. * @param scene defines the scene the texture is attached to
  64941. * @param data defines the array of data to use to create each face
  64942. * @param size defines the size of the textures
  64943. * @param format defines the format of the data
  64944. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  64945. * @param generateMipMaps defines if the engine should generate the mip levels
  64946. * @param invertY defines if data must be stored with Y axis inverted
  64947. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  64948. * @param compression defines the compression used (null by default)
  64949. */
  64950. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  64951. /**
  64952. * Updates the raw cube texture.
  64953. * @param data defines the data to store
  64954. * @param format defines the data format
  64955. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  64956. * @param invertY defines if data must be stored with Y axis inverted
  64957. * @param compression defines the compression used (null by default)
  64958. * @param level defines which level of the texture to update
  64959. */
  64960. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  64961. /**
  64962. * Updates a raw cube texture with RGBD encoded data.
  64963. * @param data defines the array of data [mipmap][face] to use to create each face
  64964. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  64965. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  64966. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  64967. * @returns a promsie that resolves when the operation is complete
  64968. */
  64969. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  64970. /**
  64971. * Clones the raw cube texture.
  64972. * @return a new cube texture
  64973. */
  64974. clone(): CubeTexture;
  64975. /** @hidden */
  64976. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  64977. }
  64978. }
  64979. declare module "babylonjs/Materials/Textures/rawTexture2DArray" {
  64980. import { Scene } from "babylonjs/scene";
  64981. import { Texture } from "babylonjs/Materials/Textures/texture";
  64982. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64983. /**
  64984. * Class used to store 2D array textures containing user data
  64985. */
  64986. export class RawTexture2DArray extends Texture {
  64987. /** Gets or sets the texture format to use */
  64988. format: number;
  64989. /**
  64990. * Create a new RawTexture2DArray
  64991. * @param data defines the data of the texture
  64992. * @param width defines the width of the texture
  64993. * @param height defines the height of the texture
  64994. * @param depth defines the number of layers of the texture
  64995. * @param format defines the texture format to use
  64996. * @param scene defines the hosting scene
  64997. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  64998. * @param invertY defines if texture must be stored with Y axis inverted
  64999. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  65000. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  65001. */
  65002. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  65003. /** Gets or sets the texture format to use */
  65004. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  65005. /**
  65006. * Update the texture with new data
  65007. * @param data defines the data to store in the texture
  65008. */
  65009. update(data: ArrayBufferView): void;
  65010. }
  65011. }
  65012. declare module "babylonjs/Materials/Textures/rawTexture3D" {
  65013. import { Scene } from "babylonjs/scene";
  65014. import { Texture } from "babylonjs/Materials/Textures/texture";
  65015. import "babylonjs/Engines/Extensions/engine.rawTexture";
  65016. /**
  65017. * Class used to store 3D textures containing user data
  65018. */
  65019. export class RawTexture3D extends Texture {
  65020. /** Gets or sets the texture format to use */
  65021. format: number;
  65022. /**
  65023. * Create a new RawTexture3D
  65024. * @param data defines the data of the texture
  65025. * @param width defines the width of the texture
  65026. * @param height defines the height of the texture
  65027. * @param depth defines the depth of the texture
  65028. * @param format defines the texture format to use
  65029. * @param scene defines the hosting scene
  65030. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  65031. * @param invertY defines if texture must be stored with Y axis inverted
  65032. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  65033. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  65034. */
  65035. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  65036. /** Gets or sets the texture format to use */
  65037. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  65038. /**
  65039. * Update the texture with new data
  65040. * @param data defines the data to store in the texture
  65041. */
  65042. update(data: ArrayBufferView): void;
  65043. }
  65044. }
  65045. declare module "babylonjs/Materials/Textures/refractionTexture" {
  65046. import { Scene } from "babylonjs/scene";
  65047. import { Plane } from "babylonjs/Maths/math.plane";
  65048. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  65049. /**
  65050. * Creates a refraction texture used by refraction channel of the standard material.
  65051. * It is like a mirror but to see through a material.
  65052. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65053. */
  65054. export class RefractionTexture extends RenderTargetTexture {
  65055. /**
  65056. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  65057. * 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.
  65058. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65059. */
  65060. refractionPlane: Plane;
  65061. /**
  65062. * Define how deep under the surface we should see.
  65063. */
  65064. depth: number;
  65065. /**
  65066. * Creates a refraction texture used by refraction channel of the standard material.
  65067. * It is like a mirror but to see through a material.
  65068. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65069. * @param name Define the texture name
  65070. * @param size Define the size of the underlying texture
  65071. * @param scene Define the scene the refraction belongs to
  65072. * @param generateMipMaps Define if we need to generate mips level for the refraction
  65073. */
  65074. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  65075. /**
  65076. * Clone the refraction texture.
  65077. * @returns the cloned texture
  65078. */
  65079. clone(): RefractionTexture;
  65080. /**
  65081. * Serialize the texture to a JSON representation you could use in Parse later on
  65082. * @returns the serialized JSON representation
  65083. */
  65084. serialize(): any;
  65085. }
  65086. }
  65087. declare module "babylonjs/Materials/Textures/index" {
  65088. export * from "babylonjs/Materials/Textures/baseTexture";
  65089. export * from "babylonjs/Materials/Textures/baseTexture.polynomial";
  65090. export * from "babylonjs/Materials/Textures/colorGradingTexture";
  65091. export * from "babylonjs/Materials/Textures/cubeTexture";
  65092. export * from "babylonjs/Materials/Textures/dynamicTexture";
  65093. export * from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  65094. export * from "babylonjs/Materials/Textures/Filtering/hdrFiltering";
  65095. export * from "babylonjs/Materials/Textures/hdrCubeTexture";
  65096. export * from "babylonjs/Materials/Textures/htmlElementTexture";
  65097. export * from "babylonjs/Materials/Textures/internalTexture";
  65098. export * from "babylonjs/Materials/Textures/internalTextureLoader";
  65099. export * from "babylonjs/Materials/Textures/Loaders/index";
  65100. export * from "babylonjs/Materials/Textures/mirrorTexture";
  65101. export * from "babylonjs/Materials/Textures/multiRenderTarget";
  65102. export * from "babylonjs/Materials/Textures/Packer/index";
  65103. export * from "babylonjs/Materials/Textures/Procedurals/index";
  65104. export * from "babylonjs/Materials/Textures/rawCubeTexture";
  65105. export * from "babylonjs/Materials/Textures/rawTexture";
  65106. export * from "babylonjs/Materials/Textures/rawTexture2DArray";
  65107. export * from "babylonjs/Materials/Textures/rawTexture3D";
  65108. export * from "babylonjs/Materials/Textures/refractionTexture";
  65109. export * from "babylonjs/Materials/Textures/renderTargetTexture";
  65110. export * from "babylonjs/Materials/Textures/texture";
  65111. export * from "babylonjs/Materials/Textures/videoTexture";
  65112. }
  65113. declare module "babylonjs/Materials/Node/Enums/index" {
  65114. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  65115. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  65116. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode";
  65117. export * from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  65118. export * from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  65119. }
  65120. declare module "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock" {
  65121. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65122. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65123. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65124. import { Mesh } from "babylonjs/Meshes/mesh";
  65125. import { Effect } from "babylonjs/Materials/effect";
  65126. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65127. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65128. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  65129. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  65130. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  65131. /**
  65132. * Block used to add support for vertex skinning (bones)
  65133. */
  65134. export class BonesBlock extends NodeMaterialBlock {
  65135. /**
  65136. * Creates a new BonesBlock
  65137. * @param name defines the block name
  65138. */
  65139. constructor(name: string);
  65140. /**
  65141. * Initialize the block and prepare the context for build
  65142. * @param state defines the state that will be used for the build
  65143. */
  65144. initialize(state: NodeMaterialBuildState): void;
  65145. /**
  65146. * Gets the current class name
  65147. * @returns the class name
  65148. */
  65149. getClassName(): string;
  65150. /**
  65151. * Gets the matrix indices input component
  65152. */
  65153. get matricesIndices(): NodeMaterialConnectionPoint;
  65154. /**
  65155. * Gets the matrix weights input component
  65156. */
  65157. get matricesWeights(): NodeMaterialConnectionPoint;
  65158. /**
  65159. * Gets the extra matrix indices input component
  65160. */
  65161. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  65162. /**
  65163. * Gets the extra matrix weights input component
  65164. */
  65165. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  65166. /**
  65167. * Gets the world input component
  65168. */
  65169. get world(): NodeMaterialConnectionPoint;
  65170. /**
  65171. * Gets the output component
  65172. */
  65173. get output(): NodeMaterialConnectionPoint;
  65174. autoConfigure(material: NodeMaterial): void;
  65175. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  65176. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65177. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65178. protected _buildBlock(state: NodeMaterialBuildState): this;
  65179. }
  65180. }
  65181. declare module "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock" {
  65182. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65183. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65184. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65185. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65186. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65187. import { SubMesh } from "babylonjs/Meshes/subMesh";
  65188. /**
  65189. * Block used to add support for instances
  65190. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  65191. */
  65192. export class InstancesBlock extends NodeMaterialBlock {
  65193. /**
  65194. * Creates a new InstancesBlock
  65195. * @param name defines the block name
  65196. */
  65197. constructor(name: string);
  65198. /**
  65199. * Gets the current class name
  65200. * @returns the class name
  65201. */
  65202. getClassName(): string;
  65203. /**
  65204. * Gets the first world row input component
  65205. */
  65206. get world0(): NodeMaterialConnectionPoint;
  65207. /**
  65208. * Gets the second world row input component
  65209. */
  65210. get world1(): NodeMaterialConnectionPoint;
  65211. /**
  65212. * Gets the third world row input component
  65213. */
  65214. get world2(): NodeMaterialConnectionPoint;
  65215. /**
  65216. * Gets the forth world row input component
  65217. */
  65218. get world3(): NodeMaterialConnectionPoint;
  65219. /**
  65220. * Gets the world input component
  65221. */
  65222. get world(): NodeMaterialConnectionPoint;
  65223. /**
  65224. * Gets the output component
  65225. */
  65226. get output(): NodeMaterialConnectionPoint;
  65227. /**
  65228. * Gets the isntanceID component
  65229. */
  65230. get instanceID(): NodeMaterialConnectionPoint;
  65231. autoConfigure(material: NodeMaterial): void;
  65232. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  65233. protected _buildBlock(state: NodeMaterialBuildState): this;
  65234. }
  65235. }
  65236. declare module "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock" {
  65237. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65238. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65239. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65240. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65241. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65242. import { Effect } from "babylonjs/Materials/effect";
  65243. import { Mesh } from "babylonjs/Meshes/mesh";
  65244. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  65245. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  65246. /**
  65247. * Block used to add morph targets support to vertex shader
  65248. */
  65249. export class MorphTargetsBlock extends NodeMaterialBlock {
  65250. private _repeatableContentAnchor;
  65251. /**
  65252. * Create a new MorphTargetsBlock
  65253. * @param name defines the block name
  65254. */
  65255. constructor(name: string);
  65256. /**
  65257. * Gets the current class name
  65258. * @returns the class name
  65259. */
  65260. getClassName(): string;
  65261. /**
  65262. * Gets the position input component
  65263. */
  65264. get position(): NodeMaterialConnectionPoint;
  65265. /**
  65266. * Gets the normal input component
  65267. */
  65268. get normal(): NodeMaterialConnectionPoint;
  65269. /**
  65270. * Gets the tangent input component
  65271. */
  65272. get tangent(): NodeMaterialConnectionPoint;
  65273. /**
  65274. * Gets the tangent input component
  65275. */
  65276. get uv(): NodeMaterialConnectionPoint;
  65277. /**
  65278. * Gets the position output component
  65279. */
  65280. get positionOutput(): NodeMaterialConnectionPoint;
  65281. /**
  65282. * Gets the normal output component
  65283. */
  65284. get normalOutput(): NodeMaterialConnectionPoint;
  65285. /**
  65286. * Gets the tangent output component
  65287. */
  65288. get tangentOutput(): NodeMaterialConnectionPoint;
  65289. /**
  65290. * Gets the tangent output component
  65291. */
  65292. get uvOutput(): NodeMaterialConnectionPoint;
  65293. initialize(state: NodeMaterialBuildState): void;
  65294. autoConfigure(material: NodeMaterial): void;
  65295. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65296. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65297. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  65298. protected _buildBlock(state: NodeMaterialBuildState): this;
  65299. }
  65300. }
  65301. declare module "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock" {
  65302. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65303. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65304. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65305. import { Nullable } from "babylonjs/types";
  65306. import { Scene } from "babylonjs/scene";
  65307. import { Effect } from "babylonjs/Materials/effect";
  65308. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65309. import { Mesh } from "babylonjs/Meshes/mesh";
  65310. import { Light } from "babylonjs/Lights/light";
  65311. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65312. /**
  65313. * Block used to get data information from a light
  65314. */
  65315. export class LightInformationBlock extends NodeMaterialBlock {
  65316. private _lightDataUniformName;
  65317. private _lightColorUniformName;
  65318. private _lightTypeDefineName;
  65319. /**
  65320. * Gets or sets the light associated with this block
  65321. */
  65322. light: Nullable<Light>;
  65323. /**
  65324. * Creates a new LightInformationBlock
  65325. * @param name defines the block name
  65326. */
  65327. constructor(name: string);
  65328. /**
  65329. * Gets the current class name
  65330. * @returns the class name
  65331. */
  65332. getClassName(): string;
  65333. /**
  65334. * Gets the world position input component
  65335. */
  65336. get worldPosition(): NodeMaterialConnectionPoint;
  65337. /**
  65338. * Gets the direction output component
  65339. */
  65340. get direction(): NodeMaterialConnectionPoint;
  65341. /**
  65342. * Gets the direction output component
  65343. */
  65344. get color(): NodeMaterialConnectionPoint;
  65345. /**
  65346. * Gets the direction output component
  65347. */
  65348. get intensity(): NodeMaterialConnectionPoint;
  65349. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65350. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65351. protected _buildBlock(state: NodeMaterialBuildState): this;
  65352. serialize(): any;
  65353. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65354. }
  65355. }
  65356. declare module "babylonjs/Materials/Node/Blocks/Vertex/index" {
  65357. export * from "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock";
  65358. export * from "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock";
  65359. export * from "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock";
  65360. export * from "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock";
  65361. export * from "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock";
  65362. }
  65363. declare module "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock" {
  65364. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65365. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65366. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65367. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65368. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65369. import { Effect } from "babylonjs/Materials/effect";
  65370. import { Mesh } from "babylonjs/Meshes/mesh";
  65371. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  65372. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  65373. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  65374. /**
  65375. * Block used to add image processing support to fragment shader
  65376. */
  65377. export class ImageProcessingBlock extends NodeMaterialBlock {
  65378. /**
  65379. * Create a new ImageProcessingBlock
  65380. * @param name defines the block name
  65381. */
  65382. constructor(name: string);
  65383. /**
  65384. * Gets the current class name
  65385. * @returns the class name
  65386. */
  65387. getClassName(): string;
  65388. /**
  65389. * Gets the color input component
  65390. */
  65391. get color(): NodeMaterialConnectionPoint;
  65392. /**
  65393. * Gets the output component
  65394. */
  65395. get output(): NodeMaterialConnectionPoint;
  65396. /**
  65397. * Initialize the block and prepare the context for build
  65398. * @param state defines the state that will be used for the build
  65399. */
  65400. initialize(state: NodeMaterialBuildState): void;
  65401. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  65402. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65403. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65404. protected _buildBlock(state: NodeMaterialBuildState): this;
  65405. }
  65406. }
  65407. declare module "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock" {
  65408. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65409. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65410. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65411. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65412. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65413. import { Effect } from "babylonjs/Materials/effect";
  65414. import { Mesh } from "babylonjs/Meshes/mesh";
  65415. import { Scene } from "babylonjs/scene";
  65416. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  65417. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  65418. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  65419. /**
  65420. * Block used to pertub normals based on a normal map
  65421. */
  65422. export class PerturbNormalBlock extends NodeMaterialBlock {
  65423. private _tangentSpaceParameterName;
  65424. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  65425. invertX: boolean;
  65426. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  65427. invertY: boolean;
  65428. /**
  65429. * Create a new PerturbNormalBlock
  65430. * @param name defines the block name
  65431. */
  65432. constructor(name: string);
  65433. /**
  65434. * Gets the current class name
  65435. * @returns the class name
  65436. */
  65437. getClassName(): string;
  65438. /**
  65439. * Gets the world position input component
  65440. */
  65441. get worldPosition(): NodeMaterialConnectionPoint;
  65442. /**
  65443. * Gets the world normal input component
  65444. */
  65445. get worldNormal(): NodeMaterialConnectionPoint;
  65446. /**
  65447. * Gets the world tangent input component
  65448. */
  65449. get worldTangent(): NodeMaterialConnectionPoint;
  65450. /**
  65451. * Gets the uv input component
  65452. */
  65453. get uv(): NodeMaterialConnectionPoint;
  65454. /**
  65455. * Gets the normal map color input component
  65456. */
  65457. get normalMapColor(): NodeMaterialConnectionPoint;
  65458. /**
  65459. * Gets the strength input component
  65460. */
  65461. get strength(): NodeMaterialConnectionPoint;
  65462. /**
  65463. * Gets the output component
  65464. */
  65465. get output(): NodeMaterialConnectionPoint;
  65466. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65467. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65468. autoConfigure(material: NodeMaterial): void;
  65469. protected _buildBlock(state: NodeMaterialBuildState): this;
  65470. protected _dumpPropertiesCode(): string;
  65471. serialize(): any;
  65472. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65473. }
  65474. }
  65475. declare module "babylonjs/Materials/Node/Blocks/Fragment/discardBlock" {
  65476. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65477. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65478. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65479. /**
  65480. * Block used to discard a pixel if a value is smaller than a cutoff
  65481. */
  65482. export class DiscardBlock extends NodeMaterialBlock {
  65483. /**
  65484. * Create a new DiscardBlock
  65485. * @param name defines the block name
  65486. */
  65487. constructor(name: string);
  65488. /**
  65489. * Gets the current class name
  65490. * @returns the class name
  65491. */
  65492. getClassName(): string;
  65493. /**
  65494. * Gets the color input component
  65495. */
  65496. get value(): NodeMaterialConnectionPoint;
  65497. /**
  65498. * Gets the cutoff input component
  65499. */
  65500. get cutoff(): NodeMaterialConnectionPoint;
  65501. protected _buildBlock(state: NodeMaterialBuildState): this;
  65502. }
  65503. }
  65504. declare module "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock" {
  65505. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65506. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65507. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65508. /**
  65509. * Block used to test if the fragment shader is front facing
  65510. */
  65511. export class FrontFacingBlock extends NodeMaterialBlock {
  65512. /**
  65513. * Creates a new FrontFacingBlock
  65514. * @param name defines the block name
  65515. */
  65516. constructor(name: string);
  65517. /**
  65518. * Gets the current class name
  65519. * @returns the class name
  65520. */
  65521. getClassName(): string;
  65522. /**
  65523. * Gets the output component
  65524. */
  65525. get output(): NodeMaterialConnectionPoint;
  65526. protected _buildBlock(state: NodeMaterialBuildState): this;
  65527. }
  65528. }
  65529. declare module "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock" {
  65530. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65531. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65532. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65533. /**
  65534. * Block used to get the derivative value on x and y of a given input
  65535. */
  65536. export class DerivativeBlock extends NodeMaterialBlock {
  65537. /**
  65538. * Create a new DerivativeBlock
  65539. * @param name defines the block name
  65540. */
  65541. constructor(name: string);
  65542. /**
  65543. * Gets the current class name
  65544. * @returns the class name
  65545. */
  65546. getClassName(): string;
  65547. /**
  65548. * Gets the input component
  65549. */
  65550. get input(): NodeMaterialConnectionPoint;
  65551. /**
  65552. * Gets the derivative output on x
  65553. */
  65554. get dx(): NodeMaterialConnectionPoint;
  65555. /**
  65556. * Gets the derivative output on y
  65557. */
  65558. get dy(): NodeMaterialConnectionPoint;
  65559. protected _buildBlock(state: NodeMaterialBuildState): this;
  65560. }
  65561. }
  65562. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock" {
  65563. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65564. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65565. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65566. /**
  65567. * Block used to make gl_FragCoord available
  65568. */
  65569. export class FragCoordBlock extends NodeMaterialBlock {
  65570. /**
  65571. * Creates a new FragCoordBlock
  65572. * @param name defines the block name
  65573. */
  65574. constructor(name: string);
  65575. /**
  65576. * Gets the current class name
  65577. * @returns the class name
  65578. */
  65579. getClassName(): string;
  65580. /**
  65581. * Gets the xy component
  65582. */
  65583. get xy(): NodeMaterialConnectionPoint;
  65584. /**
  65585. * Gets the xyz component
  65586. */
  65587. get xyz(): NodeMaterialConnectionPoint;
  65588. /**
  65589. * Gets the xyzw component
  65590. */
  65591. get xyzw(): NodeMaterialConnectionPoint;
  65592. /**
  65593. * Gets the x component
  65594. */
  65595. get x(): NodeMaterialConnectionPoint;
  65596. /**
  65597. * Gets the y component
  65598. */
  65599. get y(): NodeMaterialConnectionPoint;
  65600. /**
  65601. * Gets the z component
  65602. */
  65603. get z(): NodeMaterialConnectionPoint;
  65604. /**
  65605. * Gets the w component
  65606. */
  65607. get output(): NodeMaterialConnectionPoint;
  65608. protected writeOutputs(state: NodeMaterialBuildState): string;
  65609. protected _buildBlock(state: NodeMaterialBuildState): this;
  65610. }
  65611. }
  65612. declare module "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock" {
  65613. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65614. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65615. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65616. import { Effect } from "babylonjs/Materials/effect";
  65617. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65618. import { Mesh } from "babylonjs/Meshes/mesh";
  65619. /**
  65620. * Block used to get the screen sizes
  65621. */
  65622. export class ScreenSizeBlock extends NodeMaterialBlock {
  65623. private _varName;
  65624. private _scene;
  65625. /**
  65626. * Creates a new ScreenSizeBlock
  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 xy component
  65637. */
  65638. get xy(): NodeMaterialConnectionPoint;
  65639. /**
  65640. * Gets the x component
  65641. */
  65642. get x(): NodeMaterialConnectionPoint;
  65643. /**
  65644. * Gets the y component
  65645. */
  65646. get y(): NodeMaterialConnectionPoint;
  65647. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65648. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  65649. protected _buildBlock(state: NodeMaterialBuildState): this;
  65650. }
  65651. }
  65652. declare module "babylonjs/Materials/Node/Blocks/Fragment/index" {
  65653. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock";
  65654. export * from "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock";
  65655. export * from "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock";
  65656. export * from "babylonjs/Materials/Node/Blocks/Fragment/discardBlock";
  65657. export * from "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock";
  65658. export * from "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock";
  65659. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock";
  65660. export * from "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock";
  65661. }
  65662. declare module "babylonjs/Materials/Node/Blocks/Dual/fogBlock" {
  65663. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65664. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65665. import { Mesh } from "babylonjs/Meshes/mesh";
  65666. import { Effect } from "babylonjs/Materials/effect";
  65667. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65668. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65669. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65670. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  65671. /**
  65672. * Block used to add support for scene fog
  65673. */
  65674. export class FogBlock extends NodeMaterialBlock {
  65675. private _fogDistanceName;
  65676. private _fogParameters;
  65677. /**
  65678. * Create a new FogBlock
  65679. * @param name defines the block name
  65680. */
  65681. constructor(name: string);
  65682. /**
  65683. * Gets the current class name
  65684. * @returns the class name
  65685. */
  65686. getClassName(): string;
  65687. /**
  65688. * Gets the world position input component
  65689. */
  65690. get worldPosition(): NodeMaterialConnectionPoint;
  65691. /**
  65692. * Gets the view input component
  65693. */
  65694. get view(): NodeMaterialConnectionPoint;
  65695. /**
  65696. * Gets the color input component
  65697. */
  65698. get input(): NodeMaterialConnectionPoint;
  65699. /**
  65700. * Gets the fog color input component
  65701. */
  65702. get fogColor(): NodeMaterialConnectionPoint;
  65703. /**
  65704. * Gets the output component
  65705. */
  65706. get output(): NodeMaterialConnectionPoint;
  65707. autoConfigure(material: NodeMaterial): void;
  65708. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65709. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65710. protected _buildBlock(state: NodeMaterialBuildState): this;
  65711. }
  65712. }
  65713. declare module "babylonjs/Materials/Node/Blocks/Dual/lightBlock" {
  65714. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65715. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65716. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65717. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65718. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65719. import { Effect } from "babylonjs/Materials/effect";
  65720. import { Mesh } from "babylonjs/Meshes/mesh";
  65721. import { Light } from "babylonjs/Lights/light";
  65722. import { Nullable } from "babylonjs/types";
  65723. import { Scene } from "babylonjs/scene";
  65724. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  65725. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  65726. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  65727. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  65728. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  65729. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  65730. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  65731. /**
  65732. * Block used to add light in the fragment shader
  65733. */
  65734. export class LightBlock extends NodeMaterialBlock {
  65735. private _lightId;
  65736. /**
  65737. * Gets or sets the light associated with this block
  65738. */
  65739. light: Nullable<Light>;
  65740. /**
  65741. * Create a new LightBlock
  65742. * @param name defines the block name
  65743. */
  65744. constructor(name: string);
  65745. /**
  65746. * Gets the current class name
  65747. * @returns the class name
  65748. */
  65749. getClassName(): string;
  65750. /**
  65751. * Gets the world position input component
  65752. */
  65753. get worldPosition(): NodeMaterialConnectionPoint;
  65754. /**
  65755. * Gets the world normal input component
  65756. */
  65757. get worldNormal(): NodeMaterialConnectionPoint;
  65758. /**
  65759. * Gets the camera (or eye) position component
  65760. */
  65761. get cameraPosition(): NodeMaterialConnectionPoint;
  65762. /**
  65763. * Gets the glossiness component
  65764. */
  65765. get glossiness(): NodeMaterialConnectionPoint;
  65766. /**
  65767. * Gets the glossinness power component
  65768. */
  65769. get glossPower(): NodeMaterialConnectionPoint;
  65770. /**
  65771. * Gets the diffuse color component
  65772. */
  65773. get diffuseColor(): NodeMaterialConnectionPoint;
  65774. /**
  65775. * Gets the specular color component
  65776. */
  65777. get specularColor(): NodeMaterialConnectionPoint;
  65778. /**
  65779. * Gets the diffuse output component
  65780. */
  65781. get diffuseOutput(): NodeMaterialConnectionPoint;
  65782. /**
  65783. * Gets the specular output component
  65784. */
  65785. get specularOutput(): NodeMaterialConnectionPoint;
  65786. /**
  65787. * Gets the shadow output component
  65788. */
  65789. get shadow(): NodeMaterialConnectionPoint;
  65790. autoConfigure(material: NodeMaterial): void;
  65791. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65792. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  65793. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65794. private _injectVertexCode;
  65795. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  65796. serialize(): any;
  65797. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65798. }
  65799. }
  65800. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock" {
  65801. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65802. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65803. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65804. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  65805. /**
  65806. * Block used to read a reflection texture from a sampler
  65807. */
  65808. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  65809. /**
  65810. * Create a new ReflectionTextureBlock
  65811. * @param name defines the block name
  65812. */
  65813. constructor(name: string);
  65814. /**
  65815. * Gets the current class name
  65816. * @returns the class name
  65817. */
  65818. getClassName(): string;
  65819. /**
  65820. * Gets the world position input component
  65821. */
  65822. get position(): NodeMaterialConnectionPoint;
  65823. /**
  65824. * Gets the world position input component
  65825. */
  65826. get worldPosition(): NodeMaterialConnectionPoint;
  65827. /**
  65828. * Gets the world normal input component
  65829. */
  65830. get worldNormal(): NodeMaterialConnectionPoint;
  65831. /**
  65832. * Gets the world input component
  65833. */
  65834. get world(): NodeMaterialConnectionPoint;
  65835. /**
  65836. * Gets the camera (or eye) position component
  65837. */
  65838. get cameraPosition(): NodeMaterialConnectionPoint;
  65839. /**
  65840. * Gets the view input component
  65841. */
  65842. get view(): NodeMaterialConnectionPoint;
  65843. /**
  65844. * Gets the rgb output component
  65845. */
  65846. get rgb(): NodeMaterialConnectionPoint;
  65847. /**
  65848. * Gets the rgba output component
  65849. */
  65850. get rgba(): NodeMaterialConnectionPoint;
  65851. /**
  65852. * Gets the r output component
  65853. */
  65854. get r(): NodeMaterialConnectionPoint;
  65855. /**
  65856. * Gets the g output component
  65857. */
  65858. get g(): NodeMaterialConnectionPoint;
  65859. /**
  65860. * Gets the b output component
  65861. */
  65862. get b(): NodeMaterialConnectionPoint;
  65863. /**
  65864. * Gets the a output component
  65865. */
  65866. get a(): NodeMaterialConnectionPoint;
  65867. autoConfigure(material: NodeMaterial): void;
  65868. protected _buildBlock(state: NodeMaterialBuildState): this;
  65869. }
  65870. }
  65871. declare module "babylonjs/Materials/Node/Blocks/Dual/index" {
  65872. export * from "babylonjs/Materials/Node/Blocks/Dual/fogBlock";
  65873. export * from "babylonjs/Materials/Node/Blocks/Dual/lightBlock";
  65874. export * from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  65875. export * from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  65876. export * from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  65877. }
  65878. declare module "babylonjs/Materials/Node/Blocks/Input/index" {
  65879. export * from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  65880. export * from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  65881. }
  65882. declare module "babylonjs/Materials/Node/Blocks/addBlock" {
  65883. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65884. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65885. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65886. /**
  65887. * Block used to add 2 vectors
  65888. */
  65889. export class AddBlock extends NodeMaterialBlock {
  65890. /**
  65891. * Creates a new AddBlock
  65892. * @param name defines the block name
  65893. */
  65894. constructor(name: string);
  65895. /**
  65896. * Gets the current class name
  65897. * @returns the class name
  65898. */
  65899. getClassName(): string;
  65900. /**
  65901. * Gets the left operand input component
  65902. */
  65903. get left(): NodeMaterialConnectionPoint;
  65904. /**
  65905. * Gets the right operand input component
  65906. */
  65907. get right(): NodeMaterialConnectionPoint;
  65908. /**
  65909. * Gets the output component
  65910. */
  65911. get output(): NodeMaterialConnectionPoint;
  65912. protected _buildBlock(state: NodeMaterialBuildState): this;
  65913. }
  65914. }
  65915. declare module "babylonjs/Materials/Node/Blocks/scaleBlock" {
  65916. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65917. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65918. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65919. /**
  65920. * Block used to scale a vector by a float
  65921. */
  65922. export class ScaleBlock extends NodeMaterialBlock {
  65923. /**
  65924. * Creates a new ScaleBlock
  65925. * @param name defines the block name
  65926. */
  65927. constructor(name: string);
  65928. /**
  65929. * Gets the current class name
  65930. * @returns the class name
  65931. */
  65932. getClassName(): string;
  65933. /**
  65934. * Gets the input component
  65935. */
  65936. get input(): NodeMaterialConnectionPoint;
  65937. /**
  65938. * Gets the factor input component
  65939. */
  65940. get factor(): NodeMaterialConnectionPoint;
  65941. /**
  65942. * Gets the output component
  65943. */
  65944. get output(): NodeMaterialConnectionPoint;
  65945. protected _buildBlock(state: NodeMaterialBuildState): this;
  65946. }
  65947. }
  65948. declare module "babylonjs/Materials/Node/Blocks/clampBlock" {
  65949. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65950. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65951. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65952. import { Scene } from "babylonjs/scene";
  65953. /**
  65954. * Block used to clamp a float
  65955. */
  65956. export class ClampBlock extends NodeMaterialBlock {
  65957. /** Gets or sets the minimum range */
  65958. minimum: number;
  65959. /** Gets or sets the maximum range */
  65960. maximum: number;
  65961. /**
  65962. * Creates a new ClampBlock
  65963. * @param name defines the block name
  65964. */
  65965. constructor(name: string);
  65966. /**
  65967. * Gets the current class name
  65968. * @returns the class name
  65969. */
  65970. getClassName(): string;
  65971. /**
  65972. * Gets the value input component
  65973. */
  65974. get value(): NodeMaterialConnectionPoint;
  65975. /**
  65976. * Gets the output component
  65977. */
  65978. get output(): NodeMaterialConnectionPoint;
  65979. protected _buildBlock(state: NodeMaterialBuildState): this;
  65980. protected _dumpPropertiesCode(): string;
  65981. serialize(): any;
  65982. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65983. }
  65984. }
  65985. declare module "babylonjs/Materials/Node/Blocks/crossBlock" {
  65986. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65987. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65988. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65989. /**
  65990. * Block used to apply a cross product between 2 vectors
  65991. */
  65992. export class CrossBlock extends NodeMaterialBlock {
  65993. /**
  65994. * Creates a new CrossBlock
  65995. * @param name defines the block name
  65996. */
  65997. constructor(name: string);
  65998. /**
  65999. * Gets the current class name
  66000. * @returns the class name
  66001. */
  66002. getClassName(): string;
  66003. /**
  66004. * Gets the left operand input component
  66005. */
  66006. get left(): NodeMaterialConnectionPoint;
  66007. /**
  66008. * Gets the right operand input component
  66009. */
  66010. get right(): NodeMaterialConnectionPoint;
  66011. /**
  66012. * Gets the output component
  66013. */
  66014. get output(): NodeMaterialConnectionPoint;
  66015. protected _buildBlock(state: NodeMaterialBuildState): this;
  66016. }
  66017. }
  66018. declare module "babylonjs/Materials/Node/Blocks/dotBlock" {
  66019. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66020. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66021. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66022. /**
  66023. * Block used to apply a dot product between 2 vectors
  66024. */
  66025. export class DotBlock extends NodeMaterialBlock {
  66026. /**
  66027. * Creates a new DotBlock
  66028. * @param name defines the block name
  66029. */
  66030. constructor(name: string);
  66031. /**
  66032. * Gets the current class name
  66033. * @returns the class name
  66034. */
  66035. getClassName(): string;
  66036. /**
  66037. * Gets the left operand input component
  66038. */
  66039. get left(): NodeMaterialConnectionPoint;
  66040. /**
  66041. * Gets the right operand input component
  66042. */
  66043. get right(): NodeMaterialConnectionPoint;
  66044. /**
  66045. * Gets the output component
  66046. */
  66047. get output(): NodeMaterialConnectionPoint;
  66048. protected _buildBlock(state: NodeMaterialBuildState): this;
  66049. }
  66050. }
  66051. declare module "babylonjs/Materials/Node/Blocks/normalizeBlock" {
  66052. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66053. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66054. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66055. /**
  66056. * Block used to normalize a vector
  66057. */
  66058. export class NormalizeBlock extends NodeMaterialBlock {
  66059. /**
  66060. * Creates a new NormalizeBlock
  66061. * @param name defines the block name
  66062. */
  66063. constructor(name: string);
  66064. /**
  66065. * Gets the current class name
  66066. * @returns the class name
  66067. */
  66068. getClassName(): string;
  66069. /**
  66070. * Gets the input component
  66071. */
  66072. get input(): NodeMaterialConnectionPoint;
  66073. /**
  66074. * Gets the output component
  66075. */
  66076. get output(): NodeMaterialConnectionPoint;
  66077. protected _buildBlock(state: NodeMaterialBuildState): this;
  66078. }
  66079. }
  66080. declare module "babylonjs/Materials/Node/Blocks/trigonometryBlock" {
  66081. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66082. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66083. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66084. import { Scene } from "babylonjs/scene";
  66085. /**
  66086. * Operations supported by the Trigonometry block
  66087. */
  66088. export enum TrigonometryBlockOperations {
  66089. /** Cos */
  66090. Cos = 0,
  66091. /** Sin */
  66092. Sin = 1,
  66093. /** Abs */
  66094. Abs = 2,
  66095. /** Exp */
  66096. Exp = 3,
  66097. /** Exp2 */
  66098. Exp2 = 4,
  66099. /** Round */
  66100. Round = 5,
  66101. /** Floor */
  66102. Floor = 6,
  66103. /** Ceiling */
  66104. Ceiling = 7,
  66105. /** Square root */
  66106. Sqrt = 8,
  66107. /** Log */
  66108. Log = 9,
  66109. /** Tangent */
  66110. Tan = 10,
  66111. /** Arc tangent */
  66112. ArcTan = 11,
  66113. /** Arc cosinus */
  66114. ArcCos = 12,
  66115. /** Arc sinus */
  66116. ArcSin = 13,
  66117. /** Fraction */
  66118. Fract = 14,
  66119. /** Sign */
  66120. Sign = 15,
  66121. /** To radians (from degrees) */
  66122. Radians = 16,
  66123. /** To degrees (from radians) */
  66124. Degrees = 17
  66125. }
  66126. /**
  66127. * Block used to apply trigonometry operation to floats
  66128. */
  66129. export class TrigonometryBlock extends NodeMaterialBlock {
  66130. /**
  66131. * Gets or sets the operation applied by the block
  66132. */
  66133. operation: TrigonometryBlockOperations;
  66134. /**
  66135. * Creates a new TrigonometryBlock
  66136. * @param name defines the block name
  66137. */
  66138. constructor(name: string);
  66139. /**
  66140. * Gets the current class name
  66141. * @returns the class name
  66142. */
  66143. getClassName(): string;
  66144. /**
  66145. * Gets the input component
  66146. */
  66147. get input(): NodeMaterialConnectionPoint;
  66148. /**
  66149. * Gets the output component
  66150. */
  66151. get output(): NodeMaterialConnectionPoint;
  66152. protected _buildBlock(state: NodeMaterialBuildState): this;
  66153. serialize(): any;
  66154. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66155. protected _dumpPropertiesCode(): string;
  66156. }
  66157. }
  66158. declare module "babylonjs/Materials/Node/Blocks/colorMergerBlock" {
  66159. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66160. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66161. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66162. /**
  66163. * Block used to create a Color3/4 out of individual inputs (one for each component)
  66164. */
  66165. export class ColorMergerBlock extends NodeMaterialBlock {
  66166. /**
  66167. * Create a new ColorMergerBlock
  66168. * @param name defines the block name
  66169. */
  66170. constructor(name: string);
  66171. /**
  66172. * Gets the current class name
  66173. * @returns the class name
  66174. */
  66175. getClassName(): string;
  66176. /**
  66177. * Gets the rgb component (input)
  66178. */
  66179. get rgbIn(): NodeMaterialConnectionPoint;
  66180. /**
  66181. * Gets the r component (input)
  66182. */
  66183. get r(): NodeMaterialConnectionPoint;
  66184. /**
  66185. * Gets the g component (input)
  66186. */
  66187. get g(): NodeMaterialConnectionPoint;
  66188. /**
  66189. * Gets the b component (input)
  66190. */
  66191. get b(): NodeMaterialConnectionPoint;
  66192. /**
  66193. * Gets the a component (input)
  66194. */
  66195. get a(): NodeMaterialConnectionPoint;
  66196. /**
  66197. * Gets the rgba component (output)
  66198. */
  66199. get rgba(): NodeMaterialConnectionPoint;
  66200. /**
  66201. * Gets the rgb component (output)
  66202. */
  66203. get rgbOut(): NodeMaterialConnectionPoint;
  66204. /**
  66205. * Gets the rgb component (output)
  66206. * @deprecated Please use rgbOut instead.
  66207. */
  66208. get rgb(): NodeMaterialConnectionPoint;
  66209. protected _buildBlock(state: NodeMaterialBuildState): this;
  66210. }
  66211. }
  66212. declare module "babylonjs/Materials/Node/Blocks/vectorSplitterBlock" {
  66213. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66214. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66215. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66216. /**
  66217. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  66218. */
  66219. export class VectorSplitterBlock extends NodeMaterialBlock {
  66220. /**
  66221. * Create a new VectorSplitterBlock
  66222. * @param name defines the block name
  66223. */
  66224. constructor(name: string);
  66225. /**
  66226. * Gets the current class name
  66227. * @returns the class name
  66228. */
  66229. getClassName(): string;
  66230. /**
  66231. * Gets the xyzw component (input)
  66232. */
  66233. get xyzw(): NodeMaterialConnectionPoint;
  66234. /**
  66235. * Gets the xyz component (input)
  66236. */
  66237. get xyzIn(): NodeMaterialConnectionPoint;
  66238. /**
  66239. * Gets the xy component (input)
  66240. */
  66241. get xyIn(): NodeMaterialConnectionPoint;
  66242. /**
  66243. * Gets the xyz component (output)
  66244. */
  66245. get xyzOut(): NodeMaterialConnectionPoint;
  66246. /**
  66247. * Gets the xy component (output)
  66248. */
  66249. get xyOut(): NodeMaterialConnectionPoint;
  66250. /**
  66251. * Gets the x component (output)
  66252. */
  66253. get x(): NodeMaterialConnectionPoint;
  66254. /**
  66255. * Gets the y component (output)
  66256. */
  66257. get y(): NodeMaterialConnectionPoint;
  66258. /**
  66259. * Gets the z component (output)
  66260. */
  66261. get z(): NodeMaterialConnectionPoint;
  66262. /**
  66263. * Gets the w component (output)
  66264. */
  66265. get w(): NodeMaterialConnectionPoint;
  66266. protected _inputRename(name: string): string;
  66267. protected _outputRename(name: string): string;
  66268. protected _buildBlock(state: NodeMaterialBuildState): this;
  66269. }
  66270. }
  66271. declare module "babylonjs/Materials/Node/Blocks/lerpBlock" {
  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 lerp between 2 values
  66277. */
  66278. export class LerpBlock extends NodeMaterialBlock {
  66279. /**
  66280. * Creates a new LerpBlock
  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 left operand input component
  66291. */
  66292. get left(): NodeMaterialConnectionPoint;
  66293. /**
  66294. * Gets the right operand input component
  66295. */
  66296. get right(): NodeMaterialConnectionPoint;
  66297. /**
  66298. * Gets the gradient operand input component
  66299. */
  66300. get gradient(): NodeMaterialConnectionPoint;
  66301. /**
  66302. * Gets the output component
  66303. */
  66304. get output(): NodeMaterialConnectionPoint;
  66305. protected _buildBlock(state: NodeMaterialBuildState): this;
  66306. }
  66307. }
  66308. declare module "babylonjs/Materials/Node/Blocks/divideBlock" {
  66309. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66310. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66311. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66312. /**
  66313. * Block used to divide 2 vectors
  66314. */
  66315. export class DivideBlock extends NodeMaterialBlock {
  66316. /**
  66317. * Creates a new DivideBlock
  66318. * @param name defines the block name
  66319. */
  66320. constructor(name: string);
  66321. /**
  66322. * Gets the current class name
  66323. * @returns the class name
  66324. */
  66325. getClassName(): string;
  66326. /**
  66327. * Gets the left operand input component
  66328. */
  66329. get left(): NodeMaterialConnectionPoint;
  66330. /**
  66331. * Gets the right operand input component
  66332. */
  66333. get right(): NodeMaterialConnectionPoint;
  66334. /**
  66335. * Gets the output component
  66336. */
  66337. get output(): NodeMaterialConnectionPoint;
  66338. protected _buildBlock(state: NodeMaterialBuildState): this;
  66339. }
  66340. }
  66341. declare module "babylonjs/Materials/Node/Blocks/subtractBlock" {
  66342. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66343. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66344. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66345. /**
  66346. * Block used to subtract 2 vectors
  66347. */
  66348. export class SubtractBlock extends NodeMaterialBlock {
  66349. /**
  66350. * Creates a new SubtractBlock
  66351. * @param name defines the block name
  66352. */
  66353. constructor(name: string);
  66354. /**
  66355. * Gets the current class name
  66356. * @returns the class name
  66357. */
  66358. getClassName(): string;
  66359. /**
  66360. * Gets the left operand input component
  66361. */
  66362. get left(): NodeMaterialConnectionPoint;
  66363. /**
  66364. * Gets the right operand input component
  66365. */
  66366. get right(): NodeMaterialConnectionPoint;
  66367. /**
  66368. * Gets the output component
  66369. */
  66370. get output(): NodeMaterialConnectionPoint;
  66371. protected _buildBlock(state: NodeMaterialBuildState): this;
  66372. }
  66373. }
  66374. declare module "babylonjs/Materials/Node/Blocks/stepBlock" {
  66375. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66376. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66377. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66378. /**
  66379. * Block used to step a value
  66380. */
  66381. export class StepBlock extends NodeMaterialBlock {
  66382. /**
  66383. * Creates a new StepBlock
  66384. * @param name defines the block name
  66385. */
  66386. constructor(name: string);
  66387. /**
  66388. * Gets the current class name
  66389. * @returns the class name
  66390. */
  66391. getClassName(): string;
  66392. /**
  66393. * Gets the value operand input component
  66394. */
  66395. get value(): NodeMaterialConnectionPoint;
  66396. /**
  66397. * Gets the edge operand input component
  66398. */
  66399. get edge(): NodeMaterialConnectionPoint;
  66400. /**
  66401. * Gets the output component
  66402. */
  66403. get output(): NodeMaterialConnectionPoint;
  66404. protected _buildBlock(state: NodeMaterialBuildState): this;
  66405. }
  66406. }
  66407. declare module "babylonjs/Materials/Node/Blocks/oneMinusBlock" {
  66408. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66409. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66410. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66411. /**
  66412. * Block used to get the opposite (1 - x) of a value
  66413. */
  66414. export class OneMinusBlock extends NodeMaterialBlock {
  66415. /**
  66416. * Creates a new OneMinusBlock
  66417. * @param name defines the block name
  66418. */
  66419. constructor(name: string);
  66420. /**
  66421. * Gets the current class name
  66422. * @returns the class name
  66423. */
  66424. getClassName(): string;
  66425. /**
  66426. * Gets the input component
  66427. */
  66428. get input(): NodeMaterialConnectionPoint;
  66429. /**
  66430. * Gets the output component
  66431. */
  66432. get output(): NodeMaterialConnectionPoint;
  66433. protected _buildBlock(state: NodeMaterialBuildState): this;
  66434. }
  66435. }
  66436. declare module "babylonjs/Materials/Node/Blocks/viewDirectionBlock" {
  66437. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66438. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66439. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66440. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66441. /**
  66442. * Block used to get the view direction
  66443. */
  66444. export class ViewDirectionBlock extends NodeMaterialBlock {
  66445. /**
  66446. * Creates a new ViewDirectionBlock
  66447. * @param name defines the block name
  66448. */
  66449. constructor(name: string);
  66450. /**
  66451. * Gets the current class name
  66452. * @returns the class name
  66453. */
  66454. getClassName(): string;
  66455. /**
  66456. * Gets the world position component
  66457. */
  66458. get worldPosition(): NodeMaterialConnectionPoint;
  66459. /**
  66460. * Gets the camera position component
  66461. */
  66462. get cameraPosition(): NodeMaterialConnectionPoint;
  66463. /**
  66464. * Gets the output component
  66465. */
  66466. get output(): NodeMaterialConnectionPoint;
  66467. autoConfigure(material: NodeMaterial): void;
  66468. protected _buildBlock(state: NodeMaterialBuildState): this;
  66469. }
  66470. }
  66471. declare module "babylonjs/Materials/Node/Blocks/fresnelBlock" {
  66472. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66473. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66474. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66475. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66476. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  66477. /**
  66478. * Block used to compute fresnel value
  66479. */
  66480. export class FresnelBlock extends NodeMaterialBlock {
  66481. /**
  66482. * Create a new FresnelBlock
  66483. * @param name defines the block name
  66484. */
  66485. constructor(name: string);
  66486. /**
  66487. * Gets the current class name
  66488. * @returns the class name
  66489. */
  66490. getClassName(): string;
  66491. /**
  66492. * Gets the world normal input component
  66493. */
  66494. get worldNormal(): NodeMaterialConnectionPoint;
  66495. /**
  66496. * Gets the view direction input component
  66497. */
  66498. get viewDirection(): NodeMaterialConnectionPoint;
  66499. /**
  66500. * Gets the bias input component
  66501. */
  66502. get bias(): NodeMaterialConnectionPoint;
  66503. /**
  66504. * Gets the camera (or eye) position component
  66505. */
  66506. get power(): NodeMaterialConnectionPoint;
  66507. /**
  66508. * Gets the fresnel output component
  66509. */
  66510. get fresnel(): NodeMaterialConnectionPoint;
  66511. autoConfigure(material: NodeMaterial): void;
  66512. protected _buildBlock(state: NodeMaterialBuildState): this;
  66513. }
  66514. }
  66515. declare module "babylonjs/Materials/Node/Blocks/maxBlock" {
  66516. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66517. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66518. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66519. /**
  66520. * Block used to get the max of 2 values
  66521. */
  66522. export class MaxBlock extends NodeMaterialBlock {
  66523. /**
  66524. * Creates a new MaxBlock
  66525. * @param name defines the block name
  66526. */
  66527. constructor(name: string);
  66528. /**
  66529. * Gets the current class name
  66530. * @returns the class name
  66531. */
  66532. getClassName(): string;
  66533. /**
  66534. * Gets the left operand input component
  66535. */
  66536. get left(): NodeMaterialConnectionPoint;
  66537. /**
  66538. * Gets the right operand input component
  66539. */
  66540. get right(): NodeMaterialConnectionPoint;
  66541. /**
  66542. * Gets the output component
  66543. */
  66544. get output(): NodeMaterialConnectionPoint;
  66545. protected _buildBlock(state: NodeMaterialBuildState): this;
  66546. }
  66547. }
  66548. declare module "babylonjs/Materials/Node/Blocks/minBlock" {
  66549. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66550. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66551. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66552. /**
  66553. * Block used to get the min of 2 values
  66554. */
  66555. export class MinBlock extends NodeMaterialBlock {
  66556. /**
  66557. * Creates a new MinBlock
  66558. * @param name defines the block name
  66559. */
  66560. constructor(name: string);
  66561. /**
  66562. * Gets the current class name
  66563. * @returns the class name
  66564. */
  66565. getClassName(): string;
  66566. /**
  66567. * Gets the left operand input component
  66568. */
  66569. get left(): NodeMaterialConnectionPoint;
  66570. /**
  66571. * Gets the right operand input component
  66572. */
  66573. get right(): NodeMaterialConnectionPoint;
  66574. /**
  66575. * Gets the output component
  66576. */
  66577. get output(): NodeMaterialConnectionPoint;
  66578. protected _buildBlock(state: NodeMaterialBuildState): this;
  66579. }
  66580. }
  66581. declare module "babylonjs/Materials/Node/Blocks/distanceBlock" {
  66582. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66583. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66584. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66585. /**
  66586. * Block used to get the distance between 2 values
  66587. */
  66588. export class DistanceBlock extends NodeMaterialBlock {
  66589. /**
  66590. * Creates a new DistanceBlock
  66591. * @param name defines the block name
  66592. */
  66593. constructor(name: string);
  66594. /**
  66595. * Gets the current class name
  66596. * @returns the class name
  66597. */
  66598. getClassName(): string;
  66599. /**
  66600. * Gets the left operand input component
  66601. */
  66602. get left(): NodeMaterialConnectionPoint;
  66603. /**
  66604. * Gets the right operand input component
  66605. */
  66606. get right(): NodeMaterialConnectionPoint;
  66607. /**
  66608. * Gets the output component
  66609. */
  66610. get output(): NodeMaterialConnectionPoint;
  66611. protected _buildBlock(state: NodeMaterialBuildState): this;
  66612. }
  66613. }
  66614. declare module "babylonjs/Materials/Node/Blocks/lengthBlock" {
  66615. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66616. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66617. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66618. /**
  66619. * Block used to get the length of a vector
  66620. */
  66621. export class LengthBlock extends NodeMaterialBlock {
  66622. /**
  66623. * Creates a new LengthBlock
  66624. * @param name defines the block name
  66625. */
  66626. constructor(name: string);
  66627. /**
  66628. * Gets the current class name
  66629. * @returns the class name
  66630. */
  66631. getClassName(): string;
  66632. /**
  66633. * Gets the value input component
  66634. */
  66635. get value(): NodeMaterialConnectionPoint;
  66636. /**
  66637. * Gets the output component
  66638. */
  66639. get output(): NodeMaterialConnectionPoint;
  66640. protected _buildBlock(state: NodeMaterialBuildState): this;
  66641. }
  66642. }
  66643. declare module "babylonjs/Materials/Node/Blocks/negateBlock" {
  66644. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66645. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66646. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66647. /**
  66648. * Block used to get negative version of a value (i.e. x * -1)
  66649. */
  66650. export class NegateBlock extends NodeMaterialBlock {
  66651. /**
  66652. * Creates a new NegateBlock
  66653. * @param name defines the block name
  66654. */
  66655. constructor(name: string);
  66656. /**
  66657. * Gets the current class name
  66658. * @returns the class name
  66659. */
  66660. getClassName(): string;
  66661. /**
  66662. * Gets the value input component
  66663. */
  66664. get value(): NodeMaterialConnectionPoint;
  66665. /**
  66666. * Gets the output component
  66667. */
  66668. get output(): NodeMaterialConnectionPoint;
  66669. protected _buildBlock(state: NodeMaterialBuildState): this;
  66670. }
  66671. }
  66672. declare module "babylonjs/Materials/Node/Blocks/powBlock" {
  66673. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66674. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66675. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66676. /**
  66677. * Block used to get the value of the first parameter raised to the power of the second
  66678. */
  66679. export class PowBlock extends NodeMaterialBlock {
  66680. /**
  66681. * Creates a new PowBlock
  66682. * @param name defines the block name
  66683. */
  66684. constructor(name: string);
  66685. /**
  66686. * Gets the current class name
  66687. * @returns the class name
  66688. */
  66689. getClassName(): string;
  66690. /**
  66691. * Gets the value operand input component
  66692. */
  66693. get value(): NodeMaterialConnectionPoint;
  66694. /**
  66695. * Gets the power operand input component
  66696. */
  66697. get power(): NodeMaterialConnectionPoint;
  66698. /**
  66699. * Gets the output component
  66700. */
  66701. get output(): NodeMaterialConnectionPoint;
  66702. protected _buildBlock(state: NodeMaterialBuildState): this;
  66703. }
  66704. }
  66705. declare module "babylonjs/Materials/Node/Blocks/randomNumberBlock" {
  66706. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66707. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66708. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66709. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  66710. /**
  66711. * Block used to get a random number
  66712. */
  66713. export class RandomNumberBlock extends NodeMaterialBlock {
  66714. /**
  66715. * Creates a new RandomNumberBlock
  66716. * @param name defines the block name
  66717. */
  66718. constructor(name: string);
  66719. /**
  66720. * Gets the current class name
  66721. * @returns the class name
  66722. */
  66723. getClassName(): string;
  66724. /**
  66725. * Gets the seed input component
  66726. */
  66727. get seed(): NodeMaterialConnectionPoint;
  66728. /**
  66729. * Gets the output component
  66730. */
  66731. get output(): NodeMaterialConnectionPoint;
  66732. protected _buildBlock(state: NodeMaterialBuildState): this;
  66733. }
  66734. }
  66735. declare module "babylonjs/Materials/Node/Blocks/arcTan2Block" {
  66736. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66737. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66738. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66739. /**
  66740. * Block used to compute arc tangent of 2 values
  66741. */
  66742. export class ArcTan2Block extends NodeMaterialBlock {
  66743. /**
  66744. * Creates a new ArcTan2Block
  66745. * @param name defines the block name
  66746. */
  66747. constructor(name: string);
  66748. /**
  66749. * Gets the current class name
  66750. * @returns the class name
  66751. */
  66752. getClassName(): string;
  66753. /**
  66754. * Gets the x operand input component
  66755. */
  66756. get x(): NodeMaterialConnectionPoint;
  66757. /**
  66758. * Gets the y operand input component
  66759. */
  66760. get y(): NodeMaterialConnectionPoint;
  66761. /**
  66762. * Gets the output component
  66763. */
  66764. get output(): NodeMaterialConnectionPoint;
  66765. protected _buildBlock(state: NodeMaterialBuildState): this;
  66766. }
  66767. }
  66768. declare module "babylonjs/Materials/Node/Blocks/smoothStepBlock" {
  66769. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66770. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66771. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66772. /**
  66773. * Block used to smooth step a value
  66774. */
  66775. export class SmoothStepBlock extends NodeMaterialBlock {
  66776. /**
  66777. * Creates a new SmoothStepBlock
  66778. * @param name defines the block name
  66779. */
  66780. constructor(name: string);
  66781. /**
  66782. * Gets the current class name
  66783. * @returns the class name
  66784. */
  66785. getClassName(): string;
  66786. /**
  66787. * Gets the value operand input component
  66788. */
  66789. get value(): NodeMaterialConnectionPoint;
  66790. /**
  66791. * Gets the first edge operand input component
  66792. */
  66793. get edge0(): NodeMaterialConnectionPoint;
  66794. /**
  66795. * Gets the second edge operand input component
  66796. */
  66797. get edge1(): NodeMaterialConnectionPoint;
  66798. /**
  66799. * Gets the output component
  66800. */
  66801. get output(): NodeMaterialConnectionPoint;
  66802. protected _buildBlock(state: NodeMaterialBuildState): this;
  66803. }
  66804. }
  66805. declare module "babylonjs/Materials/Node/Blocks/reciprocalBlock" {
  66806. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66807. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66808. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66809. /**
  66810. * Block used to get the reciprocal (1 / x) of a value
  66811. */
  66812. export class ReciprocalBlock extends NodeMaterialBlock {
  66813. /**
  66814. * Creates a new ReciprocalBlock
  66815. * @param name defines the block name
  66816. */
  66817. constructor(name: string);
  66818. /**
  66819. * Gets the current class name
  66820. * @returns the class name
  66821. */
  66822. getClassName(): string;
  66823. /**
  66824. * Gets the input component
  66825. */
  66826. get input(): NodeMaterialConnectionPoint;
  66827. /**
  66828. * Gets the output component
  66829. */
  66830. get output(): NodeMaterialConnectionPoint;
  66831. protected _buildBlock(state: NodeMaterialBuildState): this;
  66832. }
  66833. }
  66834. declare module "babylonjs/Materials/Node/Blocks/replaceColorBlock" {
  66835. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66836. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66837. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66838. /**
  66839. * Block used to replace a color by another one
  66840. */
  66841. export class ReplaceColorBlock extends NodeMaterialBlock {
  66842. /**
  66843. * Creates a new ReplaceColorBlock
  66844. * @param name defines the block name
  66845. */
  66846. constructor(name: string);
  66847. /**
  66848. * Gets the current class name
  66849. * @returns the class name
  66850. */
  66851. getClassName(): string;
  66852. /**
  66853. * Gets the value input component
  66854. */
  66855. get value(): NodeMaterialConnectionPoint;
  66856. /**
  66857. * Gets the reference input component
  66858. */
  66859. get reference(): NodeMaterialConnectionPoint;
  66860. /**
  66861. * Gets the distance input component
  66862. */
  66863. get distance(): NodeMaterialConnectionPoint;
  66864. /**
  66865. * Gets the replacement input component
  66866. */
  66867. get replacement(): NodeMaterialConnectionPoint;
  66868. /**
  66869. * Gets the output component
  66870. */
  66871. get output(): NodeMaterialConnectionPoint;
  66872. protected _buildBlock(state: NodeMaterialBuildState): this;
  66873. }
  66874. }
  66875. declare module "babylonjs/Materials/Node/Blocks/posterizeBlock" {
  66876. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66877. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66878. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66879. /**
  66880. * Block used to posterize a value
  66881. * @see https://en.wikipedia.org/wiki/Posterization
  66882. */
  66883. export class PosterizeBlock extends NodeMaterialBlock {
  66884. /**
  66885. * Creates a new PosterizeBlock
  66886. * @param name defines the block name
  66887. */
  66888. constructor(name: string);
  66889. /**
  66890. * Gets the current class name
  66891. * @returns the class name
  66892. */
  66893. getClassName(): string;
  66894. /**
  66895. * Gets the value input component
  66896. */
  66897. get value(): NodeMaterialConnectionPoint;
  66898. /**
  66899. * Gets the steps input component
  66900. */
  66901. get steps(): NodeMaterialConnectionPoint;
  66902. /**
  66903. * Gets the output component
  66904. */
  66905. get output(): NodeMaterialConnectionPoint;
  66906. protected _buildBlock(state: NodeMaterialBuildState): this;
  66907. }
  66908. }
  66909. declare module "babylonjs/Materials/Node/Blocks/waveBlock" {
  66910. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66911. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66912. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66913. import { Scene } from "babylonjs/scene";
  66914. /**
  66915. * Operations supported by the Wave block
  66916. */
  66917. export enum WaveBlockKind {
  66918. /** SawTooth */
  66919. SawTooth = 0,
  66920. /** Square */
  66921. Square = 1,
  66922. /** Triangle */
  66923. Triangle = 2
  66924. }
  66925. /**
  66926. * Block used to apply wave operation to floats
  66927. */
  66928. export class WaveBlock extends NodeMaterialBlock {
  66929. /**
  66930. * Gets or sets the kibnd of wave to be applied by the block
  66931. */
  66932. kind: WaveBlockKind;
  66933. /**
  66934. * Creates a new WaveBlock
  66935. * @param name defines the block name
  66936. */
  66937. constructor(name: string);
  66938. /**
  66939. * Gets the current class name
  66940. * @returns the class name
  66941. */
  66942. getClassName(): string;
  66943. /**
  66944. * Gets the input component
  66945. */
  66946. get input(): NodeMaterialConnectionPoint;
  66947. /**
  66948. * Gets the output component
  66949. */
  66950. get output(): NodeMaterialConnectionPoint;
  66951. protected _buildBlock(state: NodeMaterialBuildState): this;
  66952. serialize(): any;
  66953. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66954. }
  66955. }
  66956. declare module "babylonjs/Materials/Node/Blocks/gradientBlock" {
  66957. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66958. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66959. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66960. import { Color3 } from "babylonjs/Maths/math.color";
  66961. import { Scene } from "babylonjs/scene";
  66962. /**
  66963. * Class used to store a color step for the GradientBlock
  66964. */
  66965. export class GradientBlockColorStep {
  66966. /**
  66967. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  66968. */
  66969. step: number;
  66970. /**
  66971. * Gets or sets the color associated with this step
  66972. */
  66973. color: Color3;
  66974. /**
  66975. * Creates a new GradientBlockColorStep
  66976. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  66977. * @param color defines the color associated with this step
  66978. */
  66979. constructor(
  66980. /**
  66981. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  66982. */
  66983. step: number,
  66984. /**
  66985. * Gets or sets the color associated with this step
  66986. */
  66987. color: Color3);
  66988. }
  66989. /**
  66990. * Block used to return a color from a gradient based on an input value between 0 and 1
  66991. */
  66992. export class GradientBlock extends NodeMaterialBlock {
  66993. /**
  66994. * Gets or sets the list of color steps
  66995. */
  66996. colorSteps: GradientBlockColorStep[];
  66997. /**
  66998. * Creates a new GradientBlock
  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 gradient input component
  67009. */
  67010. get gradient(): NodeMaterialConnectionPoint;
  67011. /**
  67012. * Gets the output component
  67013. */
  67014. get output(): NodeMaterialConnectionPoint;
  67015. private _writeColorConstant;
  67016. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67017. serialize(): any;
  67018. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67019. protected _dumpPropertiesCode(): string;
  67020. }
  67021. }
  67022. declare module "babylonjs/Materials/Node/Blocks/nLerpBlock" {
  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. /**
  67027. * Block used to normalize lerp between 2 values
  67028. */
  67029. export class NLerpBlock extends NodeMaterialBlock {
  67030. /**
  67031. * Creates a new NLerpBlock
  67032. * @param name defines the block name
  67033. */
  67034. constructor(name: string);
  67035. /**
  67036. * Gets the current class name
  67037. * @returns the class name
  67038. */
  67039. getClassName(): string;
  67040. /**
  67041. * Gets the left operand input component
  67042. */
  67043. get left(): NodeMaterialConnectionPoint;
  67044. /**
  67045. * Gets the right operand input component
  67046. */
  67047. get right(): NodeMaterialConnectionPoint;
  67048. /**
  67049. * Gets the gradient operand input component
  67050. */
  67051. get gradient(): NodeMaterialConnectionPoint;
  67052. /**
  67053. * Gets the output component
  67054. */
  67055. get output(): NodeMaterialConnectionPoint;
  67056. protected _buildBlock(state: NodeMaterialBuildState): this;
  67057. }
  67058. }
  67059. declare module "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock" {
  67060. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67061. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67062. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67063. import { Scene } from "babylonjs/scene";
  67064. /**
  67065. * block used to Generate a Worley Noise 3D Noise Pattern
  67066. */
  67067. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  67068. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  67069. manhattanDistance: boolean;
  67070. /**
  67071. * Creates a new WorleyNoise3DBlock
  67072. * @param name defines the block name
  67073. */
  67074. constructor(name: string);
  67075. /**
  67076. * Gets the current class name
  67077. * @returns the class name
  67078. */
  67079. getClassName(): string;
  67080. /**
  67081. * Gets the seed input component
  67082. */
  67083. get seed(): NodeMaterialConnectionPoint;
  67084. /**
  67085. * Gets the jitter input component
  67086. */
  67087. get jitter(): NodeMaterialConnectionPoint;
  67088. /**
  67089. * Gets the output component
  67090. */
  67091. get output(): NodeMaterialConnectionPoint;
  67092. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67093. /**
  67094. * Exposes the properties to the UI?
  67095. */
  67096. protected _dumpPropertiesCode(): string;
  67097. /**
  67098. * Exposes the properties to the Seralize?
  67099. */
  67100. serialize(): any;
  67101. /**
  67102. * Exposes the properties to the deseralize?
  67103. */
  67104. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67105. }
  67106. }
  67107. declare module "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock" {
  67108. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67109. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67110. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67111. /**
  67112. * block used to Generate a Simplex Perlin 3d Noise Pattern
  67113. */
  67114. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  67115. /**
  67116. * Creates a new SimplexPerlin3DBlock
  67117. * @param name defines the block name
  67118. */
  67119. constructor(name: string);
  67120. /**
  67121. * Gets the current class name
  67122. * @returns the class name
  67123. */
  67124. getClassName(): string;
  67125. /**
  67126. * Gets the seed operand input component
  67127. */
  67128. get seed(): NodeMaterialConnectionPoint;
  67129. /**
  67130. * Gets the output component
  67131. */
  67132. get output(): NodeMaterialConnectionPoint;
  67133. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67134. }
  67135. }
  67136. declare module "babylonjs/Materials/Node/Blocks/normalBlendBlock" {
  67137. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67138. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67139. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67140. /**
  67141. * Block used to blend normals
  67142. */
  67143. export class NormalBlendBlock extends NodeMaterialBlock {
  67144. /**
  67145. * Creates a new NormalBlendBlock
  67146. * @param name defines the block name
  67147. */
  67148. constructor(name: string);
  67149. /**
  67150. * Gets the current class name
  67151. * @returns the class name
  67152. */
  67153. getClassName(): string;
  67154. /**
  67155. * Gets the first input component
  67156. */
  67157. get normalMap0(): NodeMaterialConnectionPoint;
  67158. /**
  67159. * Gets the second input component
  67160. */
  67161. get normalMap1(): NodeMaterialConnectionPoint;
  67162. /**
  67163. * Gets the output component
  67164. */
  67165. get output(): NodeMaterialConnectionPoint;
  67166. protected _buildBlock(state: NodeMaterialBuildState): this;
  67167. }
  67168. }
  67169. declare module "babylonjs/Materials/Node/Blocks/rotate2dBlock" {
  67170. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67171. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67172. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67173. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  67174. /**
  67175. * Block used to rotate a 2d vector by a given angle
  67176. */
  67177. export class Rotate2dBlock extends NodeMaterialBlock {
  67178. /**
  67179. * Creates a new Rotate2dBlock
  67180. * @param name defines the block name
  67181. */
  67182. constructor(name: string);
  67183. /**
  67184. * Gets the current class name
  67185. * @returns the class name
  67186. */
  67187. getClassName(): string;
  67188. /**
  67189. * Gets the input vector
  67190. */
  67191. get input(): NodeMaterialConnectionPoint;
  67192. /**
  67193. * Gets the input angle
  67194. */
  67195. get angle(): NodeMaterialConnectionPoint;
  67196. /**
  67197. * Gets the output component
  67198. */
  67199. get output(): NodeMaterialConnectionPoint;
  67200. autoConfigure(material: NodeMaterial): void;
  67201. protected _buildBlock(state: NodeMaterialBuildState): this;
  67202. }
  67203. }
  67204. declare module "babylonjs/Materials/Node/Blocks/reflectBlock" {
  67205. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67206. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67207. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67208. /**
  67209. * Block used to get the reflected vector from a direction and a normal
  67210. */
  67211. export class ReflectBlock extends NodeMaterialBlock {
  67212. /**
  67213. * Creates a new ReflectBlock
  67214. * @param name defines the block name
  67215. */
  67216. constructor(name: string);
  67217. /**
  67218. * Gets the current class name
  67219. * @returns the class name
  67220. */
  67221. getClassName(): string;
  67222. /**
  67223. * Gets the incident component
  67224. */
  67225. get incident(): NodeMaterialConnectionPoint;
  67226. /**
  67227. * Gets the normal component
  67228. */
  67229. get normal(): NodeMaterialConnectionPoint;
  67230. /**
  67231. * Gets the output component
  67232. */
  67233. get output(): NodeMaterialConnectionPoint;
  67234. protected _buildBlock(state: NodeMaterialBuildState): this;
  67235. }
  67236. }
  67237. declare module "babylonjs/Materials/Node/Blocks/refractBlock" {
  67238. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67239. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67240. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67241. /**
  67242. * Block used to get the refracted vector from a direction and a normal
  67243. */
  67244. export class RefractBlock extends NodeMaterialBlock {
  67245. /**
  67246. * Creates a new RefractBlock
  67247. * @param name defines the block name
  67248. */
  67249. constructor(name: string);
  67250. /**
  67251. * Gets the current class name
  67252. * @returns the class name
  67253. */
  67254. getClassName(): string;
  67255. /**
  67256. * Gets the incident component
  67257. */
  67258. get incident(): NodeMaterialConnectionPoint;
  67259. /**
  67260. * Gets the normal component
  67261. */
  67262. get normal(): NodeMaterialConnectionPoint;
  67263. /**
  67264. * Gets the index of refraction component
  67265. */
  67266. get ior(): NodeMaterialConnectionPoint;
  67267. /**
  67268. * Gets the output component
  67269. */
  67270. get output(): NodeMaterialConnectionPoint;
  67271. protected _buildBlock(state: NodeMaterialBuildState): this;
  67272. }
  67273. }
  67274. declare module "babylonjs/Materials/Node/Blocks/desaturateBlock" {
  67275. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67276. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67277. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67278. /**
  67279. * Block used to desaturate a color
  67280. */
  67281. export class DesaturateBlock extends NodeMaterialBlock {
  67282. /**
  67283. * Creates a new DesaturateBlock
  67284. * @param name defines the block name
  67285. */
  67286. constructor(name: string);
  67287. /**
  67288. * Gets the current class name
  67289. * @returns the class name
  67290. */
  67291. getClassName(): string;
  67292. /**
  67293. * Gets the color operand input component
  67294. */
  67295. get color(): NodeMaterialConnectionPoint;
  67296. /**
  67297. * Gets the level operand input component
  67298. */
  67299. get level(): NodeMaterialConnectionPoint;
  67300. /**
  67301. * Gets the output component
  67302. */
  67303. get output(): NodeMaterialConnectionPoint;
  67304. protected _buildBlock(state: NodeMaterialBuildState): this;
  67305. }
  67306. }
  67307. declare module "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock" {
  67308. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67309. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67310. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67311. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67312. import { Nullable } from "babylonjs/types";
  67313. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67314. import { Scene } from "babylonjs/scene";
  67315. /**
  67316. * Block used to implement the ambient occlusion module of the PBR material
  67317. */
  67318. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  67319. /**
  67320. * Create a new AmbientOcclusionBlock
  67321. * @param name defines the block name
  67322. */
  67323. constructor(name: string);
  67324. /**
  67325. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  67326. */
  67327. useAmbientInGrayScale: boolean;
  67328. /**
  67329. * Initialize the block and prepare the context for build
  67330. * @param state defines the state that will be used for the build
  67331. */
  67332. initialize(state: NodeMaterialBuildState): void;
  67333. /**
  67334. * Gets the current class name
  67335. * @returns the class name
  67336. */
  67337. getClassName(): string;
  67338. /**
  67339. * Gets the texture input component
  67340. */
  67341. get texture(): NodeMaterialConnectionPoint;
  67342. /**
  67343. * Gets the texture intensity component
  67344. */
  67345. get intensity(): NodeMaterialConnectionPoint;
  67346. /**
  67347. * Gets the direct light intensity input component
  67348. */
  67349. get directLightIntensity(): NodeMaterialConnectionPoint;
  67350. /**
  67351. * Gets the ambient occlusion object output component
  67352. */
  67353. get ambientOcclusion(): NodeMaterialConnectionPoint;
  67354. /**
  67355. * Gets the main code of the block (fragment side)
  67356. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  67357. * @returns the shader code
  67358. */
  67359. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  67360. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67361. protected _buildBlock(state: NodeMaterialBuildState): this;
  67362. protected _dumpPropertiesCode(): string;
  67363. serialize(): any;
  67364. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67365. }
  67366. }
  67367. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock" {
  67368. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67369. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67370. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67371. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  67372. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67373. import { Nullable } from "babylonjs/types";
  67374. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  67375. import { Mesh } from "babylonjs/Meshes/mesh";
  67376. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67377. import { Effect } from "babylonjs/Materials/effect";
  67378. import { Scene } from "babylonjs/scene";
  67379. /**
  67380. * Block used to implement the reflection module of the PBR material
  67381. */
  67382. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  67383. /** @hidden */
  67384. _defineLODReflectionAlpha: string;
  67385. /** @hidden */
  67386. _defineLinearSpecularReflection: string;
  67387. private _vEnvironmentIrradianceName;
  67388. /** @hidden */
  67389. _vReflectionMicrosurfaceInfosName: string;
  67390. /** @hidden */
  67391. _vReflectionInfosName: string;
  67392. /** @hidden */
  67393. _vReflectionFilteringInfoName: string;
  67394. private _scene;
  67395. /**
  67396. * The three properties below are set by the main PBR block prior to calling methods of this class.
  67397. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  67398. * It's less burden on the user side in the editor part.
  67399. */
  67400. /** @hidden */
  67401. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  67402. /** @hidden */
  67403. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  67404. /** @hidden */
  67405. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  67406. /**
  67407. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  67408. * diffuse part of the IBL.
  67409. */
  67410. useSphericalHarmonics: boolean;
  67411. /**
  67412. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  67413. */
  67414. forceIrradianceInFragment: boolean;
  67415. /**
  67416. * Create a new ReflectionBlock
  67417. * @param name defines the block name
  67418. */
  67419. constructor(name: string);
  67420. /**
  67421. * Gets the current class name
  67422. * @returns the class name
  67423. */
  67424. getClassName(): string;
  67425. /**
  67426. * Gets the position input component
  67427. */
  67428. get position(): NodeMaterialConnectionPoint;
  67429. /**
  67430. * Gets the world position input component
  67431. */
  67432. get worldPosition(): NodeMaterialConnectionPoint;
  67433. /**
  67434. * Gets the world normal input component
  67435. */
  67436. get worldNormal(): NodeMaterialConnectionPoint;
  67437. /**
  67438. * Gets the world input component
  67439. */
  67440. get world(): NodeMaterialConnectionPoint;
  67441. /**
  67442. * Gets the camera (or eye) position component
  67443. */
  67444. get cameraPosition(): NodeMaterialConnectionPoint;
  67445. /**
  67446. * Gets the view input component
  67447. */
  67448. get view(): NodeMaterialConnectionPoint;
  67449. /**
  67450. * Gets the color input component
  67451. */
  67452. get color(): NodeMaterialConnectionPoint;
  67453. /**
  67454. * Gets the reflection object output component
  67455. */
  67456. get reflection(): NodeMaterialConnectionPoint;
  67457. /**
  67458. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  67459. */
  67460. get hasTexture(): boolean;
  67461. /**
  67462. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  67463. */
  67464. get reflectionColor(): string;
  67465. protected _getTexture(): Nullable<BaseTexture>;
  67466. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67467. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67468. /**
  67469. * Gets the code to inject in the vertex shader
  67470. * @param state current state of the node material building
  67471. * @returns the shader code
  67472. */
  67473. handleVertexSide(state: NodeMaterialBuildState): string;
  67474. /**
  67475. * Gets the main code of the block (fragment side)
  67476. * @param state current state of the node material building
  67477. * @param normalVarName name of the existing variable corresponding to the normal
  67478. * @returns the shader code
  67479. */
  67480. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  67481. protected _buildBlock(state: NodeMaterialBuildState): this;
  67482. protected _dumpPropertiesCode(): string;
  67483. serialize(): any;
  67484. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67485. }
  67486. }
  67487. declare module "babylonjs/Materials/Node/Blocks/PBR/sheenBlock" {
  67488. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67489. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67490. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67491. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67492. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67493. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67494. import { Scene } from "babylonjs/scene";
  67495. import { Nullable } from "babylonjs/types";
  67496. /**
  67497. * Block used to implement the sheen module of the PBR material
  67498. */
  67499. export class SheenBlock extends NodeMaterialBlock {
  67500. /**
  67501. * Create a new SheenBlock
  67502. * @param name defines the block name
  67503. */
  67504. constructor(name: string);
  67505. /**
  67506. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  67507. * It allows the strength of the sheen effect to not depend on the base color of the material,
  67508. * making it easier to setup and tweak the effect
  67509. */
  67510. albedoScaling: boolean;
  67511. /**
  67512. * Defines if the sheen is linked to the sheen color.
  67513. */
  67514. linkSheenWithAlbedo: boolean;
  67515. /**
  67516. * Initialize the block and prepare the context for build
  67517. * @param state defines the state that will be used for the build
  67518. */
  67519. initialize(state: NodeMaterialBuildState): void;
  67520. /**
  67521. * Gets the current class name
  67522. * @returns the class name
  67523. */
  67524. getClassName(): string;
  67525. /**
  67526. * Gets the intensity input component
  67527. */
  67528. get intensity(): NodeMaterialConnectionPoint;
  67529. /**
  67530. * Gets the color input component
  67531. */
  67532. get color(): NodeMaterialConnectionPoint;
  67533. /**
  67534. * Gets the roughness input component
  67535. */
  67536. get roughness(): NodeMaterialConnectionPoint;
  67537. /**
  67538. * Gets the sheen object output component
  67539. */
  67540. get sheen(): NodeMaterialConnectionPoint;
  67541. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67542. /**
  67543. * Gets the main code of the block (fragment side)
  67544. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67545. * @returns the shader code
  67546. */
  67547. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  67548. protected _buildBlock(state: NodeMaterialBuildState): this;
  67549. protected _dumpPropertiesCode(): string;
  67550. serialize(): any;
  67551. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67552. }
  67553. }
  67554. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock" {
  67555. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67556. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67557. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67558. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67559. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67560. import { Scene } from "babylonjs/scene";
  67561. import { Nullable } from "babylonjs/types";
  67562. import { Mesh } from "babylonjs/Meshes/mesh";
  67563. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67564. import { Effect } from "babylonjs/Materials/effect";
  67565. /**
  67566. * Block used to implement the reflectivity module of the PBR material
  67567. */
  67568. export class ReflectivityBlock extends NodeMaterialBlock {
  67569. private _metallicReflectanceColor;
  67570. private _metallicF0Factor;
  67571. /** @hidden */
  67572. _vMetallicReflectanceFactorsName: string;
  67573. /**
  67574. * The property below is set by the main PBR block prior to calling methods of this class.
  67575. */
  67576. /** @hidden */
  67577. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  67578. /**
  67579. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  67580. */
  67581. useAmbientOcclusionFromMetallicTextureRed: boolean;
  67582. /**
  67583. * Specifies if the metallic texture contains the metallness information in its blue channel.
  67584. */
  67585. useMetallnessFromMetallicTextureBlue: boolean;
  67586. /**
  67587. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  67588. */
  67589. useRoughnessFromMetallicTextureAlpha: boolean;
  67590. /**
  67591. * Specifies if the metallic texture contains the roughness information in its green channel.
  67592. */
  67593. useRoughnessFromMetallicTextureGreen: boolean;
  67594. /**
  67595. * Create a new ReflectivityBlock
  67596. * @param name defines the block name
  67597. */
  67598. constructor(name: string);
  67599. /**
  67600. * Initialize the block and prepare the context for build
  67601. * @param state defines the state that will be used for the build
  67602. */
  67603. initialize(state: NodeMaterialBuildState): void;
  67604. /**
  67605. * Gets the current class name
  67606. * @returns the class name
  67607. */
  67608. getClassName(): string;
  67609. /**
  67610. * Gets the metallic input component
  67611. */
  67612. get metallic(): NodeMaterialConnectionPoint;
  67613. /**
  67614. * Gets the roughness input component
  67615. */
  67616. get roughness(): NodeMaterialConnectionPoint;
  67617. /**
  67618. * Gets the texture input component
  67619. */
  67620. get texture(): NodeMaterialConnectionPoint;
  67621. /**
  67622. * Gets the reflectivity object output component
  67623. */
  67624. get reflectivity(): NodeMaterialConnectionPoint;
  67625. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67626. /**
  67627. * Gets the main code of the block (fragment side)
  67628. * @param state current state of the node material building
  67629. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  67630. * @returns the shader code
  67631. */
  67632. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  67633. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67634. protected _buildBlock(state: NodeMaterialBuildState): this;
  67635. protected _dumpPropertiesCode(): string;
  67636. serialize(): any;
  67637. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67638. }
  67639. }
  67640. declare module "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock" {
  67641. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67642. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67643. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67644. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67645. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67646. /**
  67647. * Block used to implement the anisotropy module of the PBR material
  67648. */
  67649. export class AnisotropyBlock extends NodeMaterialBlock {
  67650. /**
  67651. * The two properties below are set by the main PBR block prior to calling methods of this class.
  67652. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  67653. * It's less burden on the user side in the editor part.
  67654. */
  67655. /** @hidden */
  67656. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  67657. /** @hidden */
  67658. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  67659. /**
  67660. * Create a new AnisotropyBlock
  67661. * @param name defines the block name
  67662. */
  67663. constructor(name: string);
  67664. /**
  67665. * Initialize the block and prepare the context for build
  67666. * @param state defines the state that will be used for the build
  67667. */
  67668. initialize(state: NodeMaterialBuildState): void;
  67669. /**
  67670. * Gets the current class name
  67671. * @returns the class name
  67672. */
  67673. getClassName(): string;
  67674. /**
  67675. * Gets the intensity input component
  67676. */
  67677. get intensity(): NodeMaterialConnectionPoint;
  67678. /**
  67679. * Gets the direction input component
  67680. */
  67681. get direction(): NodeMaterialConnectionPoint;
  67682. /**
  67683. * Gets the texture input component
  67684. */
  67685. get texture(): NodeMaterialConnectionPoint;
  67686. /**
  67687. * Gets the uv input component
  67688. */
  67689. get uv(): NodeMaterialConnectionPoint;
  67690. /**
  67691. * Gets the worldTangent input component
  67692. */
  67693. get worldTangent(): NodeMaterialConnectionPoint;
  67694. /**
  67695. * Gets the anisotropy object output component
  67696. */
  67697. get anisotropy(): NodeMaterialConnectionPoint;
  67698. private _generateTBNSpace;
  67699. /**
  67700. * Gets the main code of the block (fragment side)
  67701. * @param state current state of the node material building
  67702. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  67703. * @returns the shader code
  67704. */
  67705. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  67706. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67707. protected _buildBlock(state: NodeMaterialBuildState): this;
  67708. }
  67709. }
  67710. declare module "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock" {
  67711. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67712. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67713. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67714. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67715. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67716. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67717. import { Nullable } from "babylonjs/types";
  67718. import { Mesh } from "babylonjs/Meshes/mesh";
  67719. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67720. import { Effect } from "babylonjs/Materials/effect";
  67721. /**
  67722. * Block used to implement the clear coat module of the PBR material
  67723. */
  67724. export class ClearCoatBlock extends NodeMaterialBlock {
  67725. private _scene;
  67726. /**
  67727. * Create a new ClearCoatBlock
  67728. * @param name defines the block name
  67729. */
  67730. constructor(name: string);
  67731. /**
  67732. * Initialize the block and prepare the context for build
  67733. * @param state defines the state that will be used for the build
  67734. */
  67735. initialize(state: NodeMaterialBuildState): void;
  67736. /**
  67737. * Gets the current class name
  67738. * @returns the class name
  67739. */
  67740. getClassName(): string;
  67741. /**
  67742. * Gets the intensity input component
  67743. */
  67744. get intensity(): NodeMaterialConnectionPoint;
  67745. /**
  67746. * Gets the roughness input component
  67747. */
  67748. get roughness(): NodeMaterialConnectionPoint;
  67749. /**
  67750. * Gets the ior input component
  67751. */
  67752. get ior(): NodeMaterialConnectionPoint;
  67753. /**
  67754. * Gets the texture input component
  67755. */
  67756. get texture(): NodeMaterialConnectionPoint;
  67757. /**
  67758. * Gets the bump texture input component
  67759. */
  67760. get bumpTexture(): NodeMaterialConnectionPoint;
  67761. /**
  67762. * Gets the uv input component
  67763. */
  67764. get uv(): NodeMaterialConnectionPoint;
  67765. /**
  67766. * Gets the tint color input component
  67767. */
  67768. get tintColor(): NodeMaterialConnectionPoint;
  67769. /**
  67770. * Gets the tint "at distance" input component
  67771. */
  67772. get tintAtDistance(): NodeMaterialConnectionPoint;
  67773. /**
  67774. * Gets the tint thickness input component
  67775. */
  67776. get tintThickness(): NodeMaterialConnectionPoint;
  67777. /**
  67778. * Gets the world tangent input component
  67779. */
  67780. get worldTangent(): NodeMaterialConnectionPoint;
  67781. /**
  67782. * Gets the clear coat object output component
  67783. */
  67784. get clearcoat(): NodeMaterialConnectionPoint;
  67785. autoConfigure(material: NodeMaterial): void;
  67786. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67787. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67788. private _generateTBNSpace;
  67789. /**
  67790. * Gets the main code of the block (fragment side)
  67791. * @param state current state of the node material building
  67792. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  67793. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67794. * @param worldPosVarName name of the variable holding the world position
  67795. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  67796. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  67797. * @param worldNormalVarName name of the variable holding the world normal
  67798. * @returns the shader code
  67799. */
  67800. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  67801. protected _buildBlock(state: NodeMaterialBuildState): this;
  67802. }
  67803. }
  67804. declare module "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock" {
  67805. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67806. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67807. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67808. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67809. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67810. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67811. import { Nullable } from "babylonjs/types";
  67812. /**
  67813. * Block used to implement the sub surface module of the PBR material
  67814. */
  67815. export class SubSurfaceBlock extends NodeMaterialBlock {
  67816. /**
  67817. * Create a new SubSurfaceBlock
  67818. * @param name defines the block name
  67819. */
  67820. constructor(name: string);
  67821. /**
  67822. * Stores the intensity of the different subsurface effects in the thickness texture.
  67823. * * the green channel is the translucency intensity.
  67824. * * the blue channel is the scattering intensity.
  67825. * * the alpha channel is the refraction intensity.
  67826. */
  67827. useMaskFromThicknessTexture: boolean;
  67828. /**
  67829. * Initialize the block and prepare the context for build
  67830. * @param state defines the state that will be used for the build
  67831. */
  67832. initialize(state: NodeMaterialBuildState): void;
  67833. /**
  67834. * Gets the current class name
  67835. * @returns the class name
  67836. */
  67837. getClassName(): string;
  67838. /**
  67839. * Gets the min thickness input component
  67840. */
  67841. get minThickness(): NodeMaterialConnectionPoint;
  67842. /**
  67843. * Gets the max thickness input component
  67844. */
  67845. get maxThickness(): NodeMaterialConnectionPoint;
  67846. /**
  67847. * Gets the thickness texture component
  67848. */
  67849. get thicknessTexture(): NodeMaterialConnectionPoint;
  67850. /**
  67851. * Gets the tint color input component
  67852. */
  67853. get tintColor(): NodeMaterialConnectionPoint;
  67854. /**
  67855. * Gets the translucency intensity input component
  67856. */
  67857. get translucencyIntensity(): NodeMaterialConnectionPoint;
  67858. /**
  67859. * Gets the translucency diffusion distance input component
  67860. */
  67861. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  67862. /**
  67863. * Gets the refraction object parameters
  67864. */
  67865. get refraction(): NodeMaterialConnectionPoint;
  67866. /**
  67867. * Gets the sub surface object output component
  67868. */
  67869. get subsurface(): NodeMaterialConnectionPoint;
  67870. autoConfigure(material: NodeMaterial): void;
  67871. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67872. /**
  67873. * Gets the main code of the block (fragment side)
  67874. * @param state current state of the node material building
  67875. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  67876. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67877. * @param worldPosVarName name of the variable holding the world position
  67878. * @returns the shader code
  67879. */
  67880. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  67881. protected _buildBlock(state: NodeMaterialBuildState): this;
  67882. }
  67883. }
  67884. declare module "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock" {
  67885. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67886. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67887. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67888. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67889. import { Light } from "babylonjs/Lights/light";
  67890. import { Nullable } from "babylonjs/types";
  67891. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67892. import { Effect } from "babylonjs/Materials/effect";
  67893. import { Mesh } from "babylonjs/Meshes/mesh";
  67894. import { Scene } from "babylonjs/scene";
  67895. /**
  67896. * Block used to implement the PBR metallic/roughness model
  67897. */
  67898. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  67899. /**
  67900. * Gets or sets the light associated with this block
  67901. */
  67902. light: Nullable<Light>;
  67903. private _lightId;
  67904. private _scene;
  67905. private _environmentBRDFTexture;
  67906. private _environmentBrdfSamplerName;
  67907. private _vNormalWName;
  67908. private _invertNormalName;
  67909. /**
  67910. * Create a new ReflectionBlock
  67911. * @param name defines the block name
  67912. */
  67913. constructor(name: string);
  67914. /**
  67915. * Intensity of the direct lights e.g. the four lights available in your scene.
  67916. * This impacts both the direct diffuse and specular highlights.
  67917. */
  67918. directIntensity: number;
  67919. /**
  67920. * Intensity of the environment e.g. how much the environment will light the object
  67921. * either through harmonics for rough material or through the refelction for shiny ones.
  67922. */
  67923. environmentIntensity: number;
  67924. /**
  67925. * This is a special control allowing the reduction of the specular highlights coming from the
  67926. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  67927. */
  67928. specularIntensity: number;
  67929. /**
  67930. * Defines the falloff type used in this material.
  67931. * It by default is Physical.
  67932. */
  67933. lightFalloff: number;
  67934. /**
  67935. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  67936. */
  67937. useAlphaFromAlbedoTexture: boolean;
  67938. /**
  67939. * Specifies that alpha test should be used
  67940. */
  67941. useAlphaTest: boolean;
  67942. /**
  67943. * Defines the alpha limits in alpha test mode.
  67944. */
  67945. alphaTestCutoff: number;
  67946. /**
  67947. * Specifies that alpha blending should be used
  67948. */
  67949. useAlphaBlending: boolean;
  67950. /**
  67951. * Defines if the alpha value should be determined via the rgb values.
  67952. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  67953. */
  67954. opacityRGB: boolean;
  67955. /**
  67956. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  67957. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  67958. */
  67959. useRadianceOverAlpha: boolean;
  67960. /**
  67961. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  67962. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  67963. */
  67964. useSpecularOverAlpha: boolean;
  67965. /**
  67966. * Enables specular anti aliasing in the PBR shader.
  67967. * It will both interacts on the Geometry for analytical and IBL lighting.
  67968. * It also prefilter the roughness map based on the bump values.
  67969. */
  67970. enableSpecularAntiAliasing: boolean;
  67971. /**
  67972. * Enables realtime filtering on the texture.
  67973. */
  67974. realTimeFiltering: boolean;
  67975. /**
  67976. * Quality switch for realtime filtering
  67977. */
  67978. realTimeFilteringQuality: number;
  67979. /**
  67980. * Defines if the material uses energy conservation.
  67981. */
  67982. useEnergyConservation: boolean;
  67983. /**
  67984. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  67985. * too much the area relying on ambient texture to define their ambient occlusion.
  67986. */
  67987. useRadianceOcclusion: boolean;
  67988. /**
  67989. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  67990. * makes the reflect vector face the model (under horizon).
  67991. */
  67992. useHorizonOcclusion: boolean;
  67993. /**
  67994. * If set to true, no lighting calculations will be applied.
  67995. */
  67996. unlit: boolean;
  67997. /**
  67998. * Force normal to face away from face.
  67999. */
  68000. forceNormalForward: boolean;
  68001. /**
  68002. * Defines the material debug mode.
  68003. * It helps seeing only some components of the material while troubleshooting.
  68004. */
  68005. debugMode: number;
  68006. /**
  68007. * Specify from where on screen the debug mode should start.
  68008. * The value goes from -1 (full screen) to 1 (not visible)
  68009. * It helps with side by side comparison against the final render
  68010. * This defaults to 0
  68011. */
  68012. debugLimit: number;
  68013. /**
  68014. * As the default viewing range might not be enough (if the ambient is really small for instance)
  68015. * You can use the factor to better multiply the final value.
  68016. */
  68017. debugFactor: number;
  68018. /**
  68019. * Initialize the block and prepare the context for build
  68020. * @param state defines the state that will be used for the build
  68021. */
  68022. initialize(state: NodeMaterialBuildState): void;
  68023. /**
  68024. * Gets the current class name
  68025. * @returns the class name
  68026. */
  68027. getClassName(): string;
  68028. /**
  68029. * Gets the world position input component
  68030. */
  68031. get worldPosition(): NodeMaterialConnectionPoint;
  68032. /**
  68033. * Gets the world normal input component
  68034. */
  68035. get worldNormal(): NodeMaterialConnectionPoint;
  68036. /**
  68037. * Gets the perturbed normal input component
  68038. */
  68039. get perturbedNormal(): NodeMaterialConnectionPoint;
  68040. /**
  68041. * Gets the camera position input component
  68042. */
  68043. get cameraPosition(): NodeMaterialConnectionPoint;
  68044. /**
  68045. * Gets the base color input component
  68046. */
  68047. get baseColor(): NodeMaterialConnectionPoint;
  68048. /**
  68049. * Gets the opacity texture input component
  68050. */
  68051. get opacityTexture(): NodeMaterialConnectionPoint;
  68052. /**
  68053. * Gets the ambient color input component
  68054. */
  68055. get ambientColor(): NodeMaterialConnectionPoint;
  68056. /**
  68057. * Gets the reflectivity object parameters
  68058. */
  68059. get reflectivity(): NodeMaterialConnectionPoint;
  68060. /**
  68061. * Gets the ambient occlusion object parameters
  68062. */
  68063. get ambientOcclusion(): NodeMaterialConnectionPoint;
  68064. /**
  68065. * Gets the reflection object parameters
  68066. */
  68067. get reflection(): NodeMaterialConnectionPoint;
  68068. /**
  68069. * Gets the sheen object parameters
  68070. */
  68071. get sheen(): NodeMaterialConnectionPoint;
  68072. /**
  68073. * Gets the clear coat object parameters
  68074. */
  68075. get clearcoat(): NodeMaterialConnectionPoint;
  68076. /**
  68077. * Gets the sub surface object parameters
  68078. */
  68079. get subsurface(): NodeMaterialConnectionPoint;
  68080. /**
  68081. * Gets the anisotropy object parameters
  68082. */
  68083. get anisotropy(): NodeMaterialConnectionPoint;
  68084. /**
  68085. * Gets the ambient output component
  68086. */
  68087. get ambient(): NodeMaterialConnectionPoint;
  68088. /**
  68089. * Gets the diffuse output component
  68090. */
  68091. get diffuse(): NodeMaterialConnectionPoint;
  68092. /**
  68093. * Gets the specular output component
  68094. */
  68095. get specular(): NodeMaterialConnectionPoint;
  68096. /**
  68097. * Gets the sheen output component
  68098. */
  68099. get sheenDir(): NodeMaterialConnectionPoint;
  68100. /**
  68101. * Gets the clear coat output component
  68102. */
  68103. get clearcoatDir(): NodeMaterialConnectionPoint;
  68104. /**
  68105. * Gets the indirect diffuse output component
  68106. */
  68107. get diffuseIndirect(): NodeMaterialConnectionPoint;
  68108. /**
  68109. * Gets the indirect specular output component
  68110. */
  68111. get specularIndirect(): NodeMaterialConnectionPoint;
  68112. /**
  68113. * Gets the indirect sheen output component
  68114. */
  68115. get sheenIndirect(): NodeMaterialConnectionPoint;
  68116. /**
  68117. * Gets the indirect clear coat output component
  68118. */
  68119. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  68120. /**
  68121. * Gets the refraction output component
  68122. */
  68123. get refraction(): NodeMaterialConnectionPoint;
  68124. /**
  68125. * Gets the global lighting output component
  68126. */
  68127. get lighting(): NodeMaterialConnectionPoint;
  68128. /**
  68129. * Gets the shadow output component
  68130. */
  68131. get shadow(): NodeMaterialConnectionPoint;
  68132. /**
  68133. * Gets the alpha output component
  68134. */
  68135. get alpha(): NodeMaterialConnectionPoint;
  68136. autoConfigure(material: NodeMaterial): void;
  68137. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  68138. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  68139. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  68140. private _injectVertexCode;
  68141. /**
  68142. * Gets the code corresponding to the albedo/opacity module
  68143. * @returns the shader code
  68144. */
  68145. getAlbedoOpacityCode(): string;
  68146. protected _buildBlock(state: NodeMaterialBuildState): this;
  68147. protected _dumpPropertiesCode(): string;
  68148. serialize(): any;
  68149. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  68150. }
  68151. }
  68152. declare module "babylonjs/Materials/Node/Blocks/PBR/index" {
  68153. export * from "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock";
  68154. export * from "babylonjs/Materials/Node/Blocks/PBR/sheenBlock";
  68155. export * from "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock";
  68156. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock";
  68157. export * from "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock";
  68158. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  68159. export * from "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock";
  68160. export * from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  68161. export * from "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock";
  68162. }
  68163. declare module "babylonjs/Materials/Node/Blocks/Particle/index" {
  68164. export * from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  68165. export * from "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock";
  68166. export * from "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock";
  68167. }
  68168. declare module "babylonjs/Materials/Node/Blocks/modBlock" {
  68169. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68170. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68171. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68172. /**
  68173. * Block used to compute value of one parameter modulo another
  68174. */
  68175. export class ModBlock extends NodeMaterialBlock {
  68176. /**
  68177. * Creates a new ModBlock
  68178. * @param name defines the block name
  68179. */
  68180. constructor(name: string);
  68181. /**
  68182. * Gets the current class name
  68183. * @returns the class name
  68184. */
  68185. getClassName(): string;
  68186. /**
  68187. * Gets the left operand input component
  68188. */
  68189. get left(): NodeMaterialConnectionPoint;
  68190. /**
  68191. * Gets the right operand input component
  68192. */
  68193. get right(): NodeMaterialConnectionPoint;
  68194. /**
  68195. * Gets the output component
  68196. */
  68197. get output(): NodeMaterialConnectionPoint;
  68198. protected _buildBlock(state: NodeMaterialBuildState): this;
  68199. }
  68200. }
  68201. declare module "babylonjs/Materials/Node/Blocks/index" {
  68202. export * from "babylonjs/Materials/Node/Blocks/Vertex/index";
  68203. export * from "babylonjs/Materials/Node/Blocks/Fragment/index";
  68204. export * from "babylonjs/Materials/Node/Blocks/Dual/index";
  68205. export * from "babylonjs/Materials/Node/Blocks/Input/index";
  68206. export * from "babylonjs/Materials/Node/Blocks/multiplyBlock";
  68207. export * from "babylonjs/Materials/Node/Blocks/addBlock";
  68208. export * from "babylonjs/Materials/Node/Blocks/scaleBlock";
  68209. export * from "babylonjs/Materials/Node/Blocks/clampBlock";
  68210. export * from "babylonjs/Materials/Node/Blocks/crossBlock";
  68211. export * from "babylonjs/Materials/Node/Blocks/dotBlock";
  68212. export * from "babylonjs/Materials/Node/Blocks/transformBlock";
  68213. export * from "babylonjs/Materials/Node/Blocks/remapBlock";
  68214. export * from "babylonjs/Materials/Node/Blocks/normalizeBlock";
  68215. export * from "babylonjs/Materials/Node/Blocks/trigonometryBlock";
  68216. export * from "babylonjs/Materials/Node/Blocks/colorMergerBlock";
  68217. export * from "babylonjs/Materials/Node/Blocks/vectorMergerBlock";
  68218. export * from "babylonjs/Materials/Node/Blocks/colorSplitterBlock";
  68219. export * from "babylonjs/Materials/Node/Blocks/vectorSplitterBlock";
  68220. export * from "babylonjs/Materials/Node/Blocks/lerpBlock";
  68221. export * from "babylonjs/Materials/Node/Blocks/divideBlock";
  68222. export * from "babylonjs/Materials/Node/Blocks/subtractBlock";
  68223. export * from "babylonjs/Materials/Node/Blocks/stepBlock";
  68224. export * from "babylonjs/Materials/Node/Blocks/oneMinusBlock";
  68225. export * from "babylonjs/Materials/Node/Blocks/viewDirectionBlock";
  68226. export * from "babylonjs/Materials/Node/Blocks/fresnelBlock";
  68227. export * from "babylonjs/Materials/Node/Blocks/maxBlock";
  68228. export * from "babylonjs/Materials/Node/Blocks/minBlock";
  68229. export * from "babylonjs/Materials/Node/Blocks/distanceBlock";
  68230. export * from "babylonjs/Materials/Node/Blocks/lengthBlock";
  68231. export * from "babylonjs/Materials/Node/Blocks/negateBlock";
  68232. export * from "babylonjs/Materials/Node/Blocks/powBlock";
  68233. export * from "babylonjs/Materials/Node/Blocks/randomNumberBlock";
  68234. export * from "babylonjs/Materials/Node/Blocks/arcTan2Block";
  68235. export * from "babylonjs/Materials/Node/Blocks/smoothStepBlock";
  68236. export * from "babylonjs/Materials/Node/Blocks/reciprocalBlock";
  68237. export * from "babylonjs/Materials/Node/Blocks/replaceColorBlock";
  68238. export * from "babylonjs/Materials/Node/Blocks/posterizeBlock";
  68239. export * from "babylonjs/Materials/Node/Blocks/waveBlock";
  68240. export * from "babylonjs/Materials/Node/Blocks/gradientBlock";
  68241. export * from "babylonjs/Materials/Node/Blocks/nLerpBlock";
  68242. export * from "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock";
  68243. export * from "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock";
  68244. export * from "babylonjs/Materials/Node/Blocks/normalBlendBlock";
  68245. export * from "babylonjs/Materials/Node/Blocks/rotate2dBlock";
  68246. export * from "babylonjs/Materials/Node/Blocks/reflectBlock";
  68247. export * from "babylonjs/Materials/Node/Blocks/refractBlock";
  68248. export * from "babylonjs/Materials/Node/Blocks/desaturateBlock";
  68249. export * from "babylonjs/Materials/Node/Blocks/PBR/index";
  68250. export * from "babylonjs/Materials/Node/Blocks/Particle/index";
  68251. export * from "babylonjs/Materials/Node/Blocks/modBlock";
  68252. }
  68253. declare module "babylonjs/Materials/Node/Optimizers/index" {
  68254. export * from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  68255. }
  68256. declare module "babylonjs/Materials/Node/index" {
  68257. export * from "babylonjs/Materials/Node/Enums/index";
  68258. export * from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68259. export * from "babylonjs/Materials/Node/nodeMaterialBlock";
  68260. export * from "babylonjs/Materials/Node/nodeMaterial";
  68261. export * from "babylonjs/Materials/Node/Blocks/index";
  68262. export * from "babylonjs/Materials/Node/Optimizers/index";
  68263. export * from "babylonjs/Materials/Node/nodeMaterialDecorator";
  68264. }
  68265. declare module "babylonjs/Materials/index" {
  68266. export * from "babylonjs/Materials/Background/index";
  68267. export * from "babylonjs/Materials/colorCurves";
  68268. export * from "babylonjs/Materials/iEffectFallbacks";
  68269. export * from "babylonjs/Materials/effectFallbacks";
  68270. export * from "babylonjs/Materials/effect";
  68271. export * from "babylonjs/Materials/fresnelParameters";
  68272. export * from "babylonjs/Materials/imageProcessingConfiguration";
  68273. export * from "babylonjs/Materials/material";
  68274. export * from "babylonjs/Materials/materialDefines";
  68275. export * from "babylonjs/Materials/thinMaterialHelper";
  68276. export * from "babylonjs/Materials/materialHelper";
  68277. export * from "babylonjs/Materials/multiMaterial";
  68278. export * from "babylonjs/Materials/PBR/index";
  68279. export * from "babylonjs/Materials/pushMaterial";
  68280. export * from "babylonjs/Materials/shaderMaterial";
  68281. export * from "babylonjs/Materials/standardMaterial";
  68282. export * from "babylonjs/Materials/Textures/index";
  68283. export * from "babylonjs/Materials/uniformBuffer";
  68284. export * from "babylonjs/Materials/materialFlags";
  68285. export * from "babylonjs/Materials/Node/index";
  68286. export * from "babylonjs/Materials/effectRenderer";
  68287. export * from "babylonjs/Materials/shadowDepthWrapper";
  68288. }
  68289. declare module "babylonjs/Maths/index" {
  68290. export * from "babylonjs/Maths/math.scalar";
  68291. export * from "babylonjs/Maths/math";
  68292. export * from "babylonjs/Maths/sphericalPolynomial";
  68293. }
  68294. declare module "babylonjs/Misc/workerPool" {
  68295. import { IDisposable } from "babylonjs/scene";
  68296. /**
  68297. * Helper class to push actions to a pool of workers.
  68298. */
  68299. export class WorkerPool implements IDisposable {
  68300. private _workerInfos;
  68301. private _pendingActions;
  68302. /**
  68303. * Constructor
  68304. * @param workers Array of workers to use for actions
  68305. */
  68306. constructor(workers: Array<Worker>);
  68307. /**
  68308. * Terminates all workers and clears any pending actions.
  68309. */
  68310. dispose(): void;
  68311. /**
  68312. * Pushes an action to the worker pool. If all the workers are active, the action will be
  68313. * pended until a worker has completed its action.
  68314. * @param action The action to perform. Call onComplete when the action is complete.
  68315. */
  68316. push(action: (worker: Worker, onComplete: () => void) => void): void;
  68317. private _execute;
  68318. }
  68319. }
  68320. declare module "babylonjs/Meshes/Compression/dracoCompression" {
  68321. import { IDisposable } from "babylonjs/scene";
  68322. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  68323. /**
  68324. * Configuration for Draco compression
  68325. */
  68326. export interface IDracoCompressionConfiguration {
  68327. /**
  68328. * Configuration for the decoder.
  68329. */
  68330. decoder: {
  68331. /**
  68332. * The url to the WebAssembly module.
  68333. */
  68334. wasmUrl?: string;
  68335. /**
  68336. * The url to the WebAssembly binary.
  68337. */
  68338. wasmBinaryUrl?: string;
  68339. /**
  68340. * The url to the fallback JavaScript module.
  68341. */
  68342. fallbackUrl?: string;
  68343. };
  68344. }
  68345. /**
  68346. * Draco compression (https://google.github.io/draco/)
  68347. *
  68348. * This class wraps the Draco module.
  68349. *
  68350. * **Encoder**
  68351. *
  68352. * The encoder is not currently implemented.
  68353. *
  68354. * **Decoder**
  68355. *
  68356. * 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.
  68357. *
  68358. * To update the configuration, use the following code:
  68359. * ```javascript
  68360. * DracoCompression.Configuration = {
  68361. * decoder: {
  68362. * wasmUrl: "<url to the WebAssembly library>",
  68363. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  68364. * fallbackUrl: "<url to the fallback JavaScript library>",
  68365. * }
  68366. * };
  68367. * ```
  68368. *
  68369. * 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.
  68370. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  68371. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  68372. *
  68373. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  68374. * ```javascript
  68375. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  68376. * ```
  68377. *
  68378. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  68379. */
  68380. export class DracoCompression implements IDisposable {
  68381. private _workerPoolPromise?;
  68382. private _decoderModulePromise?;
  68383. /**
  68384. * The configuration. Defaults to the following urls:
  68385. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  68386. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  68387. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  68388. */
  68389. static Configuration: IDracoCompressionConfiguration;
  68390. /**
  68391. * Returns true if the decoder configuration is available.
  68392. */
  68393. static get DecoderAvailable(): boolean;
  68394. /**
  68395. * Default number of workers to create when creating the draco compression object.
  68396. */
  68397. static DefaultNumWorkers: number;
  68398. private static GetDefaultNumWorkers;
  68399. private static _Default;
  68400. /**
  68401. * Default instance for the draco compression object.
  68402. */
  68403. static get Default(): DracoCompression;
  68404. /**
  68405. * Constructor
  68406. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  68407. */
  68408. constructor(numWorkers?: number);
  68409. /**
  68410. * Stop all async operations and release resources.
  68411. */
  68412. dispose(): void;
  68413. /**
  68414. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  68415. * @returns a promise that resolves when ready
  68416. */
  68417. whenReadyAsync(): Promise<void>;
  68418. /**
  68419. * Decode Draco compressed mesh data to vertex data.
  68420. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  68421. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  68422. * @returns A promise that resolves with the decoded vertex data
  68423. */
  68424. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  68425. [kind: string]: number;
  68426. }): Promise<VertexData>;
  68427. }
  68428. }
  68429. declare module "babylonjs/Meshes/Compression/index" {
  68430. export * from "babylonjs/Meshes/Compression/dracoCompression";
  68431. }
  68432. declare module "babylonjs/Meshes/csg" {
  68433. import { Nullable } from "babylonjs/types";
  68434. import { Scene } from "babylonjs/scene";
  68435. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  68436. import { Mesh } from "babylonjs/Meshes/mesh";
  68437. import { Material } from "babylonjs/Materials/material";
  68438. /**
  68439. * Class for building Constructive Solid Geometry
  68440. */
  68441. export class CSG {
  68442. private polygons;
  68443. /**
  68444. * The world matrix
  68445. */
  68446. matrix: Matrix;
  68447. /**
  68448. * Stores the position
  68449. */
  68450. position: Vector3;
  68451. /**
  68452. * Stores the rotation
  68453. */
  68454. rotation: Vector3;
  68455. /**
  68456. * Stores the rotation quaternion
  68457. */
  68458. rotationQuaternion: Nullable<Quaternion>;
  68459. /**
  68460. * Stores the scaling vector
  68461. */
  68462. scaling: Vector3;
  68463. /**
  68464. * Convert the Mesh to CSG
  68465. * @param mesh The Mesh to convert to CSG
  68466. * @returns A new CSG from the Mesh
  68467. */
  68468. static FromMesh(mesh: Mesh): CSG;
  68469. /**
  68470. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  68471. * @param polygons Polygons used to construct a CSG solid
  68472. */
  68473. private static FromPolygons;
  68474. /**
  68475. * Clones, or makes a deep copy, of the CSG
  68476. * @returns A new CSG
  68477. */
  68478. clone(): CSG;
  68479. /**
  68480. * Unions this CSG with another CSG
  68481. * @param csg The CSG to union against this CSG
  68482. * @returns The unioned CSG
  68483. */
  68484. union(csg: CSG): CSG;
  68485. /**
  68486. * Unions this CSG with another CSG in place
  68487. * @param csg The CSG to union against this CSG
  68488. */
  68489. unionInPlace(csg: CSG): void;
  68490. /**
  68491. * Subtracts this CSG with another CSG
  68492. * @param csg The CSG to subtract against this CSG
  68493. * @returns A new CSG
  68494. */
  68495. subtract(csg: CSG): CSG;
  68496. /**
  68497. * Subtracts this CSG with another CSG in place
  68498. * @param csg The CSG to subtact against this CSG
  68499. */
  68500. subtractInPlace(csg: CSG): void;
  68501. /**
  68502. * Intersect this CSG with another CSG
  68503. * @param csg The CSG to intersect against this CSG
  68504. * @returns A new CSG
  68505. */
  68506. intersect(csg: CSG): CSG;
  68507. /**
  68508. * Intersects this CSG with another CSG in place
  68509. * @param csg The CSG to intersect against this CSG
  68510. */
  68511. intersectInPlace(csg: CSG): void;
  68512. /**
  68513. * Return a new CSG solid with solid and empty space switched. This solid is
  68514. * not modified.
  68515. * @returns A new CSG solid with solid and empty space switched
  68516. */
  68517. inverse(): CSG;
  68518. /**
  68519. * Inverses the CSG in place
  68520. */
  68521. inverseInPlace(): void;
  68522. /**
  68523. * This is used to keep meshes transformations so they can be restored
  68524. * when we build back a Babylon Mesh
  68525. * NB : All CSG operations are performed in world coordinates
  68526. * @param csg The CSG to copy the transform attributes from
  68527. * @returns This CSG
  68528. */
  68529. copyTransformAttributes(csg: CSG): CSG;
  68530. /**
  68531. * Build Raw mesh from CSG
  68532. * Coordinates here are in world space
  68533. * @param name The name of the mesh geometry
  68534. * @param scene The Scene
  68535. * @param keepSubMeshes Specifies if the submeshes should be kept
  68536. * @returns A new Mesh
  68537. */
  68538. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68539. /**
  68540. * Build Mesh from CSG taking material and transforms into account
  68541. * @param name The name of the Mesh
  68542. * @param material The material of the Mesh
  68543. * @param scene The Scene
  68544. * @param keepSubMeshes Specifies if submeshes should be kept
  68545. * @returns The new Mesh
  68546. */
  68547. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68548. }
  68549. }
  68550. declare module "babylonjs/Meshes/trailMesh" {
  68551. import { Mesh } from "babylonjs/Meshes/mesh";
  68552. import { Scene } from "babylonjs/scene";
  68553. import { TransformNode } from "babylonjs/Meshes/transformNode";
  68554. /**
  68555. * Class used to create a trail following a mesh
  68556. */
  68557. export class TrailMesh extends Mesh {
  68558. private _generator;
  68559. private _autoStart;
  68560. private _running;
  68561. private _diameter;
  68562. private _length;
  68563. private _sectionPolygonPointsCount;
  68564. private _sectionVectors;
  68565. private _sectionNormalVectors;
  68566. private _beforeRenderObserver;
  68567. /**
  68568. * @constructor
  68569. * @param name The value used by scene.getMeshByName() to do a lookup.
  68570. * @param generator The mesh or transform node to generate a trail.
  68571. * @param scene The scene to add this mesh to.
  68572. * @param diameter Diameter of trailing mesh. Default is 1.
  68573. * @param length Length of trailing mesh. Default is 60.
  68574. * @param autoStart Automatically start trailing mesh. Default true.
  68575. */
  68576. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  68577. /**
  68578. * "TrailMesh"
  68579. * @returns "TrailMesh"
  68580. */
  68581. getClassName(): string;
  68582. private _createMesh;
  68583. /**
  68584. * Start trailing mesh.
  68585. */
  68586. start(): void;
  68587. /**
  68588. * Stop trailing mesh.
  68589. */
  68590. stop(): void;
  68591. /**
  68592. * Update trailing mesh geometry.
  68593. */
  68594. update(): void;
  68595. /**
  68596. * Returns a new TrailMesh object.
  68597. * @param name is a string, the name given to the new mesh
  68598. * @param newGenerator use new generator object for cloned trail mesh
  68599. * @returns a new mesh
  68600. */
  68601. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  68602. /**
  68603. * Serializes this trail mesh
  68604. * @param serializationObject object to write serialization to
  68605. */
  68606. serialize(serializationObject: any): void;
  68607. /**
  68608. * Parses a serialized trail mesh
  68609. * @param parsedMesh the serialized mesh
  68610. * @param scene the scene to create the trail mesh in
  68611. * @returns the created trail mesh
  68612. */
  68613. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  68614. }
  68615. }
  68616. declare module "babylonjs/Meshes/Builders/tiledBoxBuilder" {
  68617. import { Nullable } from "babylonjs/types";
  68618. import { Scene } from "babylonjs/scene";
  68619. import { Vector4 } from "babylonjs/Maths/math.vector";
  68620. import { Color4 } from "babylonjs/Maths/math.color";
  68621. import { Mesh } from "babylonjs/Meshes/mesh";
  68622. /**
  68623. * Class containing static functions to help procedurally build meshes
  68624. */
  68625. export class TiledBoxBuilder {
  68626. /**
  68627. * Creates a box mesh
  68628. * 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)
  68629. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68630. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68631. * * 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
  68632. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68633. * @param name defines the name of the mesh
  68634. * @param options defines the options used to create the mesh
  68635. * @param scene defines the hosting scene
  68636. * @returns the box mesh
  68637. */
  68638. static CreateTiledBox(name: string, options: {
  68639. pattern?: number;
  68640. width?: number;
  68641. height?: number;
  68642. depth?: number;
  68643. tileSize?: number;
  68644. tileWidth?: number;
  68645. tileHeight?: number;
  68646. alignHorizontal?: number;
  68647. alignVertical?: number;
  68648. faceUV?: Vector4[];
  68649. faceColors?: Color4[];
  68650. sideOrientation?: number;
  68651. updatable?: boolean;
  68652. }, scene?: Nullable<Scene>): Mesh;
  68653. }
  68654. }
  68655. declare module "babylonjs/Meshes/Builders/torusKnotBuilder" {
  68656. import { Vector4 } from "babylonjs/Maths/math.vector";
  68657. import { Mesh } from "babylonjs/Meshes/mesh";
  68658. /**
  68659. * Class containing static functions to help procedurally build meshes
  68660. */
  68661. export class TorusKnotBuilder {
  68662. /**
  68663. * Creates a torus knot mesh
  68664. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  68665. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  68666. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  68667. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  68668. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68669. * * 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
  68670. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  68671. * @param name defines the name of the mesh
  68672. * @param options defines the options used to create the mesh
  68673. * @param scene defines the hosting scene
  68674. * @returns the torus knot mesh
  68675. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  68676. */
  68677. static CreateTorusKnot(name: string, options: {
  68678. radius?: number;
  68679. tube?: number;
  68680. radialSegments?: number;
  68681. tubularSegments?: number;
  68682. p?: number;
  68683. q?: number;
  68684. updatable?: boolean;
  68685. sideOrientation?: number;
  68686. frontUVs?: Vector4;
  68687. backUVs?: Vector4;
  68688. }, scene: any): Mesh;
  68689. }
  68690. }
  68691. declare module "babylonjs/Meshes/polygonMesh" {
  68692. import { Scene } from "babylonjs/scene";
  68693. import { Vector2 } from "babylonjs/Maths/math.vector";
  68694. import { Mesh } from "babylonjs/Meshes/mesh";
  68695. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  68696. import { Path2 } from "babylonjs/Maths/math.path";
  68697. /**
  68698. * Polygon
  68699. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  68700. */
  68701. export class Polygon {
  68702. /**
  68703. * Creates a rectangle
  68704. * @param xmin bottom X coord
  68705. * @param ymin bottom Y coord
  68706. * @param xmax top X coord
  68707. * @param ymax top Y coord
  68708. * @returns points that make the resulting rectation
  68709. */
  68710. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  68711. /**
  68712. * Creates a circle
  68713. * @param radius radius of circle
  68714. * @param cx scale in x
  68715. * @param cy scale in y
  68716. * @param numberOfSides number of sides that make up the circle
  68717. * @returns points that make the resulting circle
  68718. */
  68719. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  68720. /**
  68721. * Creates a polygon from input string
  68722. * @param input Input polygon data
  68723. * @returns the parsed points
  68724. */
  68725. static Parse(input: string): Vector2[];
  68726. /**
  68727. * Starts building a polygon from x and y coordinates
  68728. * @param x x coordinate
  68729. * @param y y coordinate
  68730. * @returns the started path2
  68731. */
  68732. static StartingAt(x: number, y: number): Path2;
  68733. }
  68734. /**
  68735. * Builds a polygon
  68736. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  68737. */
  68738. export class PolygonMeshBuilder {
  68739. private _points;
  68740. private _outlinepoints;
  68741. private _holes;
  68742. private _name;
  68743. private _scene;
  68744. private _epoints;
  68745. private _eholes;
  68746. private _addToepoint;
  68747. /**
  68748. * Babylon reference to the earcut plugin.
  68749. */
  68750. bjsEarcut: any;
  68751. /**
  68752. * Creates a PolygonMeshBuilder
  68753. * @param name name of the builder
  68754. * @param contours Path of the polygon
  68755. * @param scene scene to add to when creating the mesh
  68756. * @param earcutInjection can be used to inject your own earcut reference
  68757. */
  68758. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  68759. /**
  68760. * Adds a whole within the polygon
  68761. * @param hole Array of points defining the hole
  68762. * @returns this
  68763. */
  68764. addHole(hole: Vector2[]): PolygonMeshBuilder;
  68765. /**
  68766. * Creates the polygon
  68767. * @param updatable If the mesh should be updatable
  68768. * @param depth The depth of the mesh created
  68769. * @returns the created mesh
  68770. */
  68771. build(updatable?: boolean, depth?: number): Mesh;
  68772. /**
  68773. * Creates the polygon
  68774. * @param depth The depth of the mesh created
  68775. * @returns the created VertexData
  68776. */
  68777. buildVertexData(depth?: number): VertexData;
  68778. /**
  68779. * Adds a side to the polygon
  68780. * @param positions points that make the polygon
  68781. * @param normals normals of the polygon
  68782. * @param uvs uvs of the polygon
  68783. * @param indices indices of the polygon
  68784. * @param bounds bounds of the polygon
  68785. * @param points points of the polygon
  68786. * @param depth depth of the polygon
  68787. * @param flip flip of the polygon
  68788. */
  68789. private addSide;
  68790. }
  68791. }
  68792. declare module "babylonjs/Meshes/Builders/polygonBuilder" {
  68793. import { Scene } from "babylonjs/scene";
  68794. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68795. import { Color4 } from "babylonjs/Maths/math.color";
  68796. import { Mesh } from "babylonjs/Meshes/mesh";
  68797. import { Nullable } from "babylonjs/types";
  68798. /**
  68799. * Class containing static functions to help procedurally build meshes
  68800. */
  68801. export class PolygonBuilder {
  68802. /**
  68803. * Creates a polygon mesh
  68804. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  68805. * * 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
  68806. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  68807. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68808. * * 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)
  68809. * * Remember you can only change the shape positions, not their number when updating a polygon
  68810. * @param name defines the name of the mesh
  68811. * @param options defines the options used to create the mesh
  68812. * @param scene defines the hosting scene
  68813. * @param earcutInjection can be used to inject your own earcut reference
  68814. * @returns the polygon mesh
  68815. */
  68816. static CreatePolygon(name: string, options: {
  68817. shape: Vector3[];
  68818. holes?: Vector3[][];
  68819. depth?: number;
  68820. faceUV?: Vector4[];
  68821. faceColors?: Color4[];
  68822. updatable?: boolean;
  68823. sideOrientation?: number;
  68824. frontUVs?: Vector4;
  68825. backUVs?: Vector4;
  68826. wrap?: boolean;
  68827. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  68828. /**
  68829. * Creates an extruded polygon mesh, with depth in the Y direction.
  68830. * * 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)
  68831. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68832. * @param name defines the name of the mesh
  68833. * @param options defines the options used to create the mesh
  68834. * @param scene defines the hosting scene
  68835. * @param earcutInjection can be used to inject your own earcut reference
  68836. * @returns the polygon mesh
  68837. */
  68838. static ExtrudePolygon(name: string, options: {
  68839. shape: Vector3[];
  68840. holes?: Vector3[][];
  68841. depth?: number;
  68842. faceUV?: Vector4[];
  68843. faceColors?: Color4[];
  68844. updatable?: boolean;
  68845. sideOrientation?: number;
  68846. frontUVs?: Vector4;
  68847. backUVs?: Vector4;
  68848. wrap?: boolean;
  68849. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  68850. }
  68851. }
  68852. declare module "babylonjs/Meshes/Builders/latheBuilder" {
  68853. import { Scene } from "babylonjs/scene";
  68854. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68855. import { Mesh } from "babylonjs/Meshes/mesh";
  68856. import { Nullable } from "babylonjs/types";
  68857. /**
  68858. * Class containing static functions to help procedurally build meshes
  68859. */
  68860. export class LatheBuilder {
  68861. /**
  68862. * Creates lathe mesh.
  68863. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  68864. * * 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
  68865. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  68866. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  68867. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  68868. * * 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
  68869. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  68870. * * 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
  68871. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68872. * * 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
  68873. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68874. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68875. * @param name defines the name of the mesh
  68876. * @param options defines the options used to create the mesh
  68877. * @param scene defines the hosting scene
  68878. * @returns the lathe mesh
  68879. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  68880. */
  68881. static CreateLathe(name: string, options: {
  68882. shape: Vector3[];
  68883. radius?: number;
  68884. tessellation?: number;
  68885. clip?: number;
  68886. arc?: number;
  68887. closed?: boolean;
  68888. updatable?: boolean;
  68889. sideOrientation?: number;
  68890. frontUVs?: Vector4;
  68891. backUVs?: Vector4;
  68892. cap?: number;
  68893. invertUV?: boolean;
  68894. }, scene?: Nullable<Scene>): Mesh;
  68895. }
  68896. }
  68897. declare module "babylonjs/Meshes/Builders/tiledPlaneBuilder" {
  68898. import { Nullable } from "babylonjs/types";
  68899. import { Scene } from "babylonjs/scene";
  68900. import { Vector4 } from "babylonjs/Maths/math.vector";
  68901. import { Mesh } from "babylonjs/Meshes/mesh";
  68902. /**
  68903. * Class containing static functions to help procedurally build meshes
  68904. */
  68905. export class TiledPlaneBuilder {
  68906. /**
  68907. * Creates a tiled plane mesh
  68908. * * The parameter `pattern` will, depending on value, do nothing or
  68909. * * * flip (reflect about central vertical) alternate tiles across and up
  68910. * * * flip every tile on alternate rows
  68911. * * * rotate (180 degs) alternate tiles across and up
  68912. * * * rotate every tile on alternate rows
  68913. * * * flip and rotate alternate tiles across and up
  68914. * * * flip and rotate every tile on alternate rows
  68915. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  68916. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  68917. * * 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
  68918. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  68919. * * 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)
  68920. * * 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)
  68921. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  68922. * @param name defines the name of the mesh
  68923. * @param options defines the options used to create the mesh
  68924. * @param scene defines the hosting scene
  68925. * @returns the box mesh
  68926. */
  68927. static CreateTiledPlane(name: string, options: {
  68928. pattern?: number;
  68929. tileSize?: number;
  68930. tileWidth?: number;
  68931. tileHeight?: number;
  68932. size?: number;
  68933. width?: number;
  68934. height?: number;
  68935. alignHorizontal?: number;
  68936. alignVertical?: number;
  68937. sideOrientation?: number;
  68938. frontUVs?: Vector4;
  68939. backUVs?: Vector4;
  68940. updatable?: boolean;
  68941. }, scene?: Nullable<Scene>): Mesh;
  68942. }
  68943. }
  68944. declare module "babylonjs/Meshes/Builders/tubeBuilder" {
  68945. import { Nullable } from "babylonjs/types";
  68946. import { Scene } from "babylonjs/scene";
  68947. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68948. import { Mesh } from "babylonjs/Meshes/mesh";
  68949. /**
  68950. * Class containing static functions to help procedurally build meshes
  68951. */
  68952. export class TubeBuilder {
  68953. /**
  68954. * Creates a tube mesh.
  68955. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  68956. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  68957. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  68958. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  68959. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  68960. * * 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)
  68961. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  68962. * * 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
  68963. * * 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
  68964. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68965. * * 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
  68966. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68967. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68968. * @param name defines the name of the mesh
  68969. * @param options defines the options used to create the mesh
  68970. * @param scene defines the hosting scene
  68971. * @returns the tube mesh
  68972. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  68973. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  68974. */
  68975. static CreateTube(name: string, options: {
  68976. path: Vector3[];
  68977. radius?: number;
  68978. tessellation?: number;
  68979. radiusFunction?: {
  68980. (i: number, distance: number): number;
  68981. };
  68982. cap?: number;
  68983. arc?: number;
  68984. updatable?: boolean;
  68985. sideOrientation?: number;
  68986. frontUVs?: Vector4;
  68987. backUVs?: Vector4;
  68988. instance?: Mesh;
  68989. invertUV?: boolean;
  68990. }, scene?: Nullable<Scene>): Mesh;
  68991. }
  68992. }
  68993. declare module "babylonjs/Meshes/Builders/icoSphereBuilder" {
  68994. import { Scene } from "babylonjs/scene";
  68995. import { Vector4 } from "babylonjs/Maths/math.vector";
  68996. import { Mesh } from "babylonjs/Meshes/mesh";
  68997. import { Nullable } from "babylonjs/types";
  68998. /**
  68999. * Class containing static functions to help procedurally build meshes
  69000. */
  69001. export class IcoSphereBuilder {
  69002. /**
  69003. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  69004. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  69005. * * 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`)
  69006. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  69007. * * 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
  69008. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69009. * * 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
  69010. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69011. * @param name defines the name of the mesh
  69012. * @param options defines the options used to create the mesh
  69013. * @param scene defines the hosting scene
  69014. * @returns the icosahedron mesh
  69015. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  69016. */
  69017. static CreateIcoSphere(name: string, options: {
  69018. radius?: number;
  69019. radiusX?: number;
  69020. radiusY?: number;
  69021. radiusZ?: number;
  69022. flat?: boolean;
  69023. subdivisions?: number;
  69024. sideOrientation?: number;
  69025. frontUVs?: Vector4;
  69026. backUVs?: Vector4;
  69027. updatable?: boolean;
  69028. }, scene?: Nullable<Scene>): Mesh;
  69029. }
  69030. }
  69031. declare module "babylonjs/Meshes/Builders/decalBuilder" {
  69032. import { Vector3 } from "babylonjs/Maths/math.vector";
  69033. import { Mesh } from "babylonjs/Meshes/mesh";
  69034. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  69035. /**
  69036. * Class containing static functions to help procedurally build meshes
  69037. */
  69038. export class DecalBuilder {
  69039. /**
  69040. * Creates a decal mesh.
  69041. * 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
  69042. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  69043. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  69044. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  69045. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  69046. * @param name defines the name of the mesh
  69047. * @param sourceMesh defines the mesh where the decal must be applied
  69048. * @param options defines the options used to create the mesh
  69049. * @param scene defines the hosting scene
  69050. * @returns the decal mesh
  69051. * @see https://doc.babylonjs.com/how_to/decals
  69052. */
  69053. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  69054. position?: Vector3;
  69055. normal?: Vector3;
  69056. size?: Vector3;
  69057. angle?: number;
  69058. }): Mesh;
  69059. }
  69060. }
  69061. declare module "babylonjs/Meshes/meshBuilder" {
  69062. import { Vector4, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  69063. import { Nullable } from "babylonjs/types";
  69064. import { Scene } from "babylonjs/scene";
  69065. import { Mesh } from "babylonjs/Meshes/mesh";
  69066. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  69067. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  69068. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  69069. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  69070. import { Plane } from "babylonjs/Maths/math.plane";
  69071. /**
  69072. * Class containing static functions to help procedurally build meshes
  69073. */
  69074. export class MeshBuilder {
  69075. /**
  69076. * Creates a box mesh
  69077. * * The parameter `size` sets the size (float) of each box side (default 1)
  69078. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  69079. * * 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)
  69080. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69081. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69082. * * 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
  69083. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69084. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  69085. * @param name defines the name of the mesh
  69086. * @param options defines the options used to create the mesh
  69087. * @param scene defines the hosting scene
  69088. * @returns the box mesh
  69089. */
  69090. static CreateBox(name: string, options: {
  69091. size?: number;
  69092. width?: number;
  69093. height?: number;
  69094. depth?: number;
  69095. faceUV?: Vector4[];
  69096. faceColors?: Color4[];
  69097. sideOrientation?: number;
  69098. frontUVs?: Vector4;
  69099. backUVs?: Vector4;
  69100. wrap?: boolean;
  69101. topBaseAt?: number;
  69102. bottomBaseAt?: number;
  69103. updatable?: boolean;
  69104. }, scene?: Nullable<Scene>): Mesh;
  69105. /**
  69106. * Creates a tiled box mesh
  69107. * * faceTiles sets the pattern, tile size and number of tiles for a face
  69108. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69109. * @param name defines the name of the mesh
  69110. * @param options defines the options used to create the mesh
  69111. * @param scene defines the hosting scene
  69112. * @returns the tiled box mesh
  69113. */
  69114. static CreateTiledBox(name: string, options: {
  69115. pattern?: number;
  69116. size?: number;
  69117. width?: number;
  69118. height?: number;
  69119. depth: number;
  69120. tileSize?: number;
  69121. tileWidth?: number;
  69122. tileHeight?: number;
  69123. faceUV?: Vector4[];
  69124. faceColors?: Color4[];
  69125. alignHorizontal?: number;
  69126. alignVertical?: number;
  69127. sideOrientation?: number;
  69128. updatable?: boolean;
  69129. }, scene?: Nullable<Scene>): Mesh;
  69130. /**
  69131. * Creates a sphere mesh
  69132. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  69133. * * 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`)
  69134. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  69135. * * 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
  69136. * * 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)
  69137. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69138. * * 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
  69139. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69140. * @param name defines the name of the mesh
  69141. * @param options defines the options used to create the mesh
  69142. * @param scene defines the hosting scene
  69143. * @returns the sphere mesh
  69144. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  69145. */
  69146. static CreateSphere(name: string, options: {
  69147. segments?: number;
  69148. diameter?: number;
  69149. diameterX?: number;
  69150. diameterY?: number;
  69151. diameterZ?: number;
  69152. arc?: number;
  69153. slice?: number;
  69154. sideOrientation?: number;
  69155. frontUVs?: Vector4;
  69156. backUVs?: Vector4;
  69157. updatable?: boolean;
  69158. }, scene?: Nullable<Scene>): Mesh;
  69159. /**
  69160. * Creates a plane polygonal mesh. By default, this is a disc
  69161. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  69162. * * 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
  69163. * * 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
  69164. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69165. * * 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
  69166. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69167. * @param name defines the name of the mesh
  69168. * @param options defines the options used to create the mesh
  69169. * @param scene defines the hosting scene
  69170. * @returns the plane polygonal mesh
  69171. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  69172. */
  69173. static CreateDisc(name: string, options: {
  69174. radius?: number;
  69175. tessellation?: number;
  69176. arc?: number;
  69177. updatable?: boolean;
  69178. sideOrientation?: number;
  69179. frontUVs?: Vector4;
  69180. backUVs?: Vector4;
  69181. }, scene?: Nullable<Scene>): Mesh;
  69182. /**
  69183. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  69184. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  69185. * * 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`)
  69186. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  69187. * * 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
  69188. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69189. * * 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
  69190. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69191. * @param name defines the name of the mesh
  69192. * @param options defines the options used to create the mesh
  69193. * @param scene defines the hosting scene
  69194. * @returns the icosahedron mesh
  69195. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  69196. */
  69197. static CreateIcoSphere(name: string, options: {
  69198. radius?: number;
  69199. radiusX?: number;
  69200. radiusY?: number;
  69201. radiusZ?: number;
  69202. flat?: boolean;
  69203. subdivisions?: number;
  69204. sideOrientation?: number;
  69205. frontUVs?: Vector4;
  69206. backUVs?: Vector4;
  69207. updatable?: boolean;
  69208. }, scene?: Nullable<Scene>): Mesh;
  69209. /**
  69210. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69211. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  69212. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  69213. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  69214. * * 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
  69215. * * 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
  69216. * * 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
  69217. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69218. * * 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
  69219. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69220. * * 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
  69221. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  69222. * * 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
  69223. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  69224. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69225. * @param name defines the name of the mesh
  69226. * @param options defines the options used to create the mesh
  69227. * @param scene defines the hosting scene
  69228. * @returns the ribbon mesh
  69229. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  69230. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69231. */
  69232. static CreateRibbon(name: string, options: {
  69233. pathArray: Vector3[][];
  69234. closeArray?: boolean;
  69235. closePath?: boolean;
  69236. offset?: number;
  69237. updatable?: boolean;
  69238. sideOrientation?: number;
  69239. frontUVs?: Vector4;
  69240. backUVs?: Vector4;
  69241. instance?: Mesh;
  69242. invertUV?: boolean;
  69243. uvs?: Vector2[];
  69244. colors?: Color4[];
  69245. }, scene?: Nullable<Scene>): Mesh;
  69246. /**
  69247. * Creates a cylinder or a cone mesh
  69248. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  69249. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  69250. * * 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.
  69251. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  69252. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  69253. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  69254. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  69255. * * 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).
  69256. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  69257. * * 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).
  69258. * * 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
  69259. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  69260. * * 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
  69261. * * 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.
  69262. * * If `enclose` is false, a ring surface is one element.
  69263. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  69264. * * 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
  69265. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69266. * * 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
  69267. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69268. * @param name defines the name of the mesh
  69269. * @param options defines the options used to create the mesh
  69270. * @param scene defines the hosting scene
  69271. * @returns the cylinder mesh
  69272. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  69273. */
  69274. static CreateCylinder(name: string, options: {
  69275. height?: number;
  69276. diameterTop?: number;
  69277. diameterBottom?: number;
  69278. diameter?: number;
  69279. tessellation?: number;
  69280. subdivisions?: number;
  69281. arc?: number;
  69282. faceColors?: Color4[];
  69283. faceUV?: Vector4[];
  69284. updatable?: boolean;
  69285. hasRings?: boolean;
  69286. enclose?: boolean;
  69287. cap?: number;
  69288. sideOrientation?: number;
  69289. frontUVs?: Vector4;
  69290. backUVs?: Vector4;
  69291. }, scene?: Nullable<Scene>): Mesh;
  69292. /**
  69293. * Creates a torus mesh
  69294. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  69295. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  69296. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  69297. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69298. * * 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
  69299. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69300. * @param name defines the name of the mesh
  69301. * @param options defines the options used to create the mesh
  69302. * @param scene defines the hosting scene
  69303. * @returns the torus mesh
  69304. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  69305. */
  69306. static CreateTorus(name: string, options: {
  69307. diameter?: number;
  69308. thickness?: number;
  69309. tessellation?: number;
  69310. updatable?: boolean;
  69311. sideOrientation?: number;
  69312. frontUVs?: Vector4;
  69313. backUVs?: Vector4;
  69314. }, scene?: Nullable<Scene>): Mesh;
  69315. /**
  69316. * Creates a torus knot mesh
  69317. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  69318. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  69319. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  69320. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  69321. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69322. * * 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
  69323. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69324. * @param name defines the name of the mesh
  69325. * @param options defines the options used to create the mesh
  69326. * @param scene defines the hosting scene
  69327. * @returns the torus knot mesh
  69328. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  69329. */
  69330. static CreateTorusKnot(name: string, options: {
  69331. radius?: number;
  69332. tube?: number;
  69333. radialSegments?: number;
  69334. tubularSegments?: number;
  69335. p?: number;
  69336. q?: number;
  69337. updatable?: boolean;
  69338. sideOrientation?: number;
  69339. frontUVs?: Vector4;
  69340. backUVs?: Vector4;
  69341. }, scene?: Nullable<Scene>): Mesh;
  69342. /**
  69343. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  69344. * * 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
  69345. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  69346. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  69347. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  69348. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  69349. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  69350. * * 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
  69351. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  69352. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69353. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  69354. * @param name defines the name of the new line system
  69355. * @param options defines the options used to create the line system
  69356. * @param scene defines the hosting scene
  69357. * @returns a new line system mesh
  69358. */
  69359. static CreateLineSystem(name: string, options: {
  69360. lines: Vector3[][];
  69361. updatable?: boolean;
  69362. instance?: Nullable<LinesMesh>;
  69363. colors?: Nullable<Color4[][]>;
  69364. useVertexAlpha?: boolean;
  69365. }, scene: Nullable<Scene>): LinesMesh;
  69366. /**
  69367. * Creates a line mesh
  69368. * 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
  69369. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  69370. * * The parameter `points` is an array successive Vector3
  69371. * * 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
  69372. * * The optional parameter `colors` is an array of successive Color4, one per line point
  69373. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  69374. * * When updating an instance, remember that only point positions can change, not the number of points
  69375. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69376. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  69377. * @param name defines the name of the new line system
  69378. * @param options defines the options used to create the line system
  69379. * @param scene defines the hosting scene
  69380. * @returns a new line mesh
  69381. */
  69382. static CreateLines(name: string, options: {
  69383. points: Vector3[];
  69384. updatable?: boolean;
  69385. instance?: Nullable<LinesMesh>;
  69386. colors?: Color4[];
  69387. useVertexAlpha?: boolean;
  69388. }, scene?: Nullable<Scene>): LinesMesh;
  69389. /**
  69390. * Creates a dashed line mesh
  69391. * * 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
  69392. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  69393. * * The parameter `points` is an array successive Vector3
  69394. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  69395. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  69396. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  69397. * * 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
  69398. * * When updating an instance, remember that only point positions can change, not the number of points
  69399. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69400. * @param name defines the name of the mesh
  69401. * @param options defines the options used to create the mesh
  69402. * @param scene defines the hosting scene
  69403. * @returns the dashed line mesh
  69404. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  69405. */
  69406. static CreateDashedLines(name: string, options: {
  69407. points: Vector3[];
  69408. dashSize?: number;
  69409. gapSize?: number;
  69410. dashNb?: number;
  69411. updatable?: boolean;
  69412. instance?: LinesMesh;
  69413. }, scene?: Nullable<Scene>): LinesMesh;
  69414. /**
  69415. * 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.
  69416. * * 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.
  69417. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  69418. * * 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.
  69419. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  69420. * * 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
  69421. * * 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
  69422. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  69423. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69424. * * 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
  69425. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  69426. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69427. * @param name defines the name of the mesh
  69428. * @param options defines the options used to create the mesh
  69429. * @param scene defines the hosting scene
  69430. * @returns the extruded shape mesh
  69431. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69432. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  69433. */
  69434. static ExtrudeShape(name: string, options: {
  69435. shape: Vector3[];
  69436. path: Vector3[];
  69437. scale?: number;
  69438. rotation?: number;
  69439. cap?: number;
  69440. updatable?: boolean;
  69441. sideOrientation?: number;
  69442. frontUVs?: Vector4;
  69443. backUVs?: Vector4;
  69444. instance?: Mesh;
  69445. invertUV?: boolean;
  69446. }, scene?: Nullable<Scene>): Mesh;
  69447. /**
  69448. * Creates an custom extruded shape mesh.
  69449. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  69450. * * 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.
  69451. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  69452. * * 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
  69453. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  69454. * * 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
  69455. * * It must returns a float value that will be the scale value applied to the shape on each path point
  69456. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  69457. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  69458. * * 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
  69459. * * 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
  69460. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  69461. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69462. * * 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
  69463. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69464. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69465. * @param name defines the name of the mesh
  69466. * @param options defines the options used to create the mesh
  69467. * @param scene defines the hosting scene
  69468. * @returns the custom extruded shape mesh
  69469. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  69470. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69471. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  69472. */
  69473. static ExtrudeShapeCustom(name: string, options: {
  69474. shape: Vector3[];
  69475. path: Vector3[];
  69476. scaleFunction?: any;
  69477. rotationFunction?: any;
  69478. ribbonCloseArray?: boolean;
  69479. ribbonClosePath?: boolean;
  69480. cap?: number;
  69481. updatable?: boolean;
  69482. sideOrientation?: number;
  69483. frontUVs?: Vector4;
  69484. backUVs?: Vector4;
  69485. instance?: Mesh;
  69486. invertUV?: boolean;
  69487. }, scene?: Nullable<Scene>): Mesh;
  69488. /**
  69489. * Creates lathe mesh.
  69490. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  69491. * * 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
  69492. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  69493. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  69494. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  69495. * * 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
  69496. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  69497. * * 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
  69498. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69499. * * 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
  69500. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69501. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69502. * @param name defines the name of the mesh
  69503. * @param options defines the options used to create the mesh
  69504. * @param scene defines the hosting scene
  69505. * @returns the lathe mesh
  69506. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  69507. */
  69508. static CreateLathe(name: string, options: {
  69509. shape: Vector3[];
  69510. radius?: number;
  69511. tessellation?: number;
  69512. clip?: number;
  69513. arc?: number;
  69514. closed?: boolean;
  69515. updatable?: boolean;
  69516. sideOrientation?: number;
  69517. frontUVs?: Vector4;
  69518. backUVs?: Vector4;
  69519. cap?: number;
  69520. invertUV?: boolean;
  69521. }, scene?: Nullable<Scene>): Mesh;
  69522. /**
  69523. * Creates a tiled plane mesh
  69524. * * You can set a limited pattern arrangement with the tiles
  69525. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69526. * * 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
  69527. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69528. * @param name defines the name of the mesh
  69529. * @param options defines the options used to create the mesh
  69530. * @param scene defines the hosting scene
  69531. * @returns the plane mesh
  69532. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69533. */
  69534. static CreateTiledPlane(name: string, options: {
  69535. pattern?: number;
  69536. tileSize?: number;
  69537. tileWidth?: number;
  69538. tileHeight?: number;
  69539. size?: number;
  69540. width?: number;
  69541. height?: number;
  69542. alignHorizontal?: number;
  69543. alignVertical?: number;
  69544. sideOrientation?: number;
  69545. frontUVs?: Vector4;
  69546. backUVs?: Vector4;
  69547. updatable?: boolean;
  69548. }, scene?: Nullable<Scene>): Mesh;
  69549. /**
  69550. * Creates a plane mesh
  69551. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  69552. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  69553. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  69554. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69555. * * 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
  69556. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69557. * @param name defines the name of the mesh
  69558. * @param options defines the options used to create the mesh
  69559. * @param scene defines the hosting scene
  69560. * @returns the plane mesh
  69561. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69562. */
  69563. static CreatePlane(name: string, options: {
  69564. size?: number;
  69565. width?: number;
  69566. height?: number;
  69567. sideOrientation?: number;
  69568. frontUVs?: Vector4;
  69569. backUVs?: Vector4;
  69570. updatable?: boolean;
  69571. sourcePlane?: Plane;
  69572. }, scene?: Nullable<Scene>): Mesh;
  69573. /**
  69574. * Creates a ground mesh
  69575. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  69576. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  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 ground mesh
  69582. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  69583. */
  69584. static CreateGround(name: string, options: {
  69585. width?: number;
  69586. height?: number;
  69587. subdivisions?: number;
  69588. subdivisionsX?: number;
  69589. subdivisionsY?: number;
  69590. updatable?: boolean;
  69591. }, scene?: Nullable<Scene>): Mesh;
  69592. /**
  69593. * Creates a tiled ground mesh
  69594. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  69595. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  69596. * * 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
  69597. * * 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
  69598. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69599. * @param name defines the name of the mesh
  69600. * @param options defines the options used to create the mesh
  69601. * @param scene defines the hosting scene
  69602. * @returns the tiled ground mesh
  69603. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  69604. */
  69605. static CreateTiledGround(name: string, options: {
  69606. xmin: number;
  69607. zmin: number;
  69608. xmax: number;
  69609. zmax: number;
  69610. subdivisions?: {
  69611. w: number;
  69612. h: number;
  69613. };
  69614. precision?: {
  69615. w: number;
  69616. h: number;
  69617. };
  69618. updatable?: boolean;
  69619. }, scene?: Nullable<Scene>): Mesh;
  69620. /**
  69621. * Creates a ground mesh from a height map
  69622. * * The parameter `url` sets the URL of the height map image resource.
  69623. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  69624. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  69625. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  69626. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  69627. * * 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.
  69628. * * 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).
  69629. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  69630. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69631. * @param name defines the name of the mesh
  69632. * @param url defines the url to the height map
  69633. * @param options defines the options used to create the mesh
  69634. * @param scene defines the hosting scene
  69635. * @returns the ground mesh
  69636. * @see https://doc.babylonjs.com/babylon101/height_map
  69637. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  69638. */
  69639. static CreateGroundFromHeightMap(name: string, url: string, options: {
  69640. width?: number;
  69641. height?: number;
  69642. subdivisions?: number;
  69643. minHeight?: number;
  69644. maxHeight?: number;
  69645. colorFilter?: Color3;
  69646. alphaFilter?: number;
  69647. updatable?: boolean;
  69648. onReady?: (mesh: GroundMesh) => void;
  69649. }, scene?: Nullable<Scene>): GroundMesh;
  69650. /**
  69651. * Creates a polygon mesh
  69652. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  69653. * * 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
  69654. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  69655. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69656. * * 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)
  69657. * * Remember you can only change the shape positions, not their number when updating a polygon
  69658. * @param name defines the name of the mesh
  69659. * @param options defines the options used to create the mesh
  69660. * @param scene defines the hosting scene
  69661. * @param earcutInjection can be used to inject your own earcut reference
  69662. * @returns the polygon mesh
  69663. */
  69664. static CreatePolygon(name: string, options: {
  69665. shape: Vector3[];
  69666. holes?: Vector3[][];
  69667. depth?: number;
  69668. faceUV?: Vector4[];
  69669. faceColors?: Color4[];
  69670. updatable?: boolean;
  69671. sideOrientation?: number;
  69672. frontUVs?: Vector4;
  69673. backUVs?: Vector4;
  69674. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69675. /**
  69676. * Creates an extruded polygon mesh, with depth in the Y direction.
  69677. * * 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)
  69678. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69679. * @param name defines the name of the mesh
  69680. * @param options defines the options used to create the mesh
  69681. * @param scene defines the hosting scene
  69682. * @param earcutInjection can be used to inject your own earcut reference
  69683. * @returns the polygon mesh
  69684. */
  69685. static ExtrudePolygon(name: string, options: {
  69686. shape: Vector3[];
  69687. holes?: Vector3[][];
  69688. depth?: number;
  69689. faceUV?: Vector4[];
  69690. faceColors?: Color4[];
  69691. updatable?: boolean;
  69692. sideOrientation?: number;
  69693. frontUVs?: Vector4;
  69694. backUVs?: Vector4;
  69695. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69696. /**
  69697. * Creates a tube mesh.
  69698. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69699. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  69700. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  69701. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  69702. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  69703. * * 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)
  69704. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  69705. * * 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
  69706. * * 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
  69707. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69708. * * 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
  69709. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69710. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69711. * @param name defines the name of the mesh
  69712. * @param options defines the options used to create the mesh
  69713. * @param scene defines the hosting scene
  69714. * @returns the tube mesh
  69715. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69716. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  69717. */
  69718. static CreateTube(name: string, options: {
  69719. path: Vector3[];
  69720. radius?: number;
  69721. tessellation?: number;
  69722. radiusFunction?: {
  69723. (i: number, distance: number): number;
  69724. };
  69725. cap?: number;
  69726. arc?: number;
  69727. updatable?: boolean;
  69728. sideOrientation?: number;
  69729. frontUVs?: Vector4;
  69730. backUVs?: Vector4;
  69731. instance?: Mesh;
  69732. invertUV?: boolean;
  69733. }, scene?: Nullable<Scene>): Mesh;
  69734. /**
  69735. * Creates a polyhedron mesh
  69736. * * 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
  69737. * * The parameter `size` (positive float, default 1) sets the polygon size
  69738. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  69739. * * 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`
  69740. * * 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
  69741. * * 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)`)
  69742. * * 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
  69743. * * 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
  69744. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69745. * * 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
  69746. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69747. * @param name defines the name of the mesh
  69748. * @param options defines the options used to create the mesh
  69749. * @param scene defines the hosting scene
  69750. * @returns the polyhedron mesh
  69751. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  69752. */
  69753. static CreatePolyhedron(name: string, options: {
  69754. type?: number;
  69755. size?: number;
  69756. sizeX?: number;
  69757. sizeY?: number;
  69758. sizeZ?: number;
  69759. custom?: any;
  69760. faceUV?: Vector4[];
  69761. faceColors?: Color4[];
  69762. flat?: boolean;
  69763. updatable?: boolean;
  69764. sideOrientation?: number;
  69765. frontUVs?: Vector4;
  69766. backUVs?: Vector4;
  69767. }, scene?: Nullable<Scene>): Mesh;
  69768. /**
  69769. * Creates a decal mesh.
  69770. * 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
  69771. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  69772. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  69773. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  69774. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  69775. * @param name defines the name of the mesh
  69776. * @param sourceMesh defines the mesh where the decal must be applied
  69777. * @param options defines the options used to create the mesh
  69778. * @param scene defines the hosting scene
  69779. * @returns the decal mesh
  69780. * @see https://doc.babylonjs.com/how_to/decals
  69781. */
  69782. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  69783. position?: Vector3;
  69784. normal?: Vector3;
  69785. size?: Vector3;
  69786. angle?: number;
  69787. }): Mesh;
  69788. }
  69789. }
  69790. declare module "babylonjs/Meshes/meshSimplification" {
  69791. import { Mesh } from "babylonjs/Meshes/mesh";
  69792. /**
  69793. * A simplifier interface for future simplification implementations
  69794. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69795. */
  69796. export interface ISimplifier {
  69797. /**
  69798. * Simplification of a given mesh according to the given settings.
  69799. * Since this requires computation, it is assumed that the function runs async.
  69800. * @param settings The settings of the simplification, including quality and distance
  69801. * @param successCallback A callback that will be called after the mesh was simplified.
  69802. * @param errorCallback in case of an error, this callback will be called. optional.
  69803. */
  69804. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  69805. }
  69806. /**
  69807. * Expected simplification settings.
  69808. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  69809. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69810. */
  69811. export interface ISimplificationSettings {
  69812. /**
  69813. * Gets or sets the expected quality
  69814. */
  69815. quality: number;
  69816. /**
  69817. * Gets or sets the distance when this optimized version should be used
  69818. */
  69819. distance: number;
  69820. /**
  69821. * Gets an already optimized mesh
  69822. */
  69823. optimizeMesh?: boolean;
  69824. }
  69825. /**
  69826. * Class used to specify simplification options
  69827. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69828. */
  69829. export class SimplificationSettings implements ISimplificationSettings {
  69830. /** expected quality */
  69831. quality: number;
  69832. /** distance when this optimized version should be used */
  69833. distance: number;
  69834. /** already optimized mesh */
  69835. optimizeMesh?: boolean | undefined;
  69836. /**
  69837. * Creates a SimplificationSettings
  69838. * @param quality expected quality
  69839. * @param distance distance when this optimized version should be used
  69840. * @param optimizeMesh already optimized mesh
  69841. */
  69842. constructor(
  69843. /** expected quality */
  69844. quality: number,
  69845. /** distance when this optimized version should be used */
  69846. distance: number,
  69847. /** already optimized mesh */
  69848. optimizeMesh?: boolean | undefined);
  69849. }
  69850. /**
  69851. * Interface used to define a simplification task
  69852. */
  69853. export interface ISimplificationTask {
  69854. /**
  69855. * Array of settings
  69856. */
  69857. settings: Array<ISimplificationSettings>;
  69858. /**
  69859. * Simplification type
  69860. */
  69861. simplificationType: SimplificationType;
  69862. /**
  69863. * Mesh to simplify
  69864. */
  69865. mesh: Mesh;
  69866. /**
  69867. * Callback called on success
  69868. */
  69869. successCallback?: () => void;
  69870. /**
  69871. * Defines if parallel processing can be used
  69872. */
  69873. parallelProcessing: boolean;
  69874. }
  69875. /**
  69876. * Queue used to order the simplification tasks
  69877. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69878. */
  69879. export class SimplificationQueue {
  69880. private _simplificationArray;
  69881. /**
  69882. * Gets a boolean indicating that the process is still running
  69883. */
  69884. running: boolean;
  69885. /**
  69886. * Creates a new queue
  69887. */
  69888. constructor();
  69889. /**
  69890. * Adds a new simplification task
  69891. * @param task defines a task to add
  69892. */
  69893. addTask(task: ISimplificationTask): void;
  69894. /**
  69895. * Execute next task
  69896. */
  69897. executeNext(): void;
  69898. /**
  69899. * Execute a simplification task
  69900. * @param task defines the task to run
  69901. */
  69902. runSimplification(task: ISimplificationTask): void;
  69903. private getSimplifier;
  69904. }
  69905. /**
  69906. * The implemented types of simplification
  69907. * At the moment only Quadratic Error Decimation is implemented
  69908. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69909. */
  69910. export enum SimplificationType {
  69911. /** Quadratic error decimation */
  69912. QUADRATIC = 0
  69913. }
  69914. /**
  69915. * An implementation of the Quadratic Error simplification algorithm.
  69916. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  69917. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  69918. * @author RaananW
  69919. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69920. */
  69921. export class QuadraticErrorSimplification implements ISimplifier {
  69922. private _mesh;
  69923. private triangles;
  69924. private vertices;
  69925. private references;
  69926. private _reconstructedMesh;
  69927. /** Gets or sets the number pf sync interations */
  69928. syncIterations: number;
  69929. /** Gets or sets the aggressiveness of the simplifier */
  69930. aggressiveness: number;
  69931. /** Gets or sets the number of allowed iterations for decimation */
  69932. decimationIterations: number;
  69933. /** Gets or sets the espilon to use for bounding box computation */
  69934. boundingBoxEpsilon: number;
  69935. /**
  69936. * Creates a new QuadraticErrorSimplification
  69937. * @param _mesh defines the target mesh
  69938. */
  69939. constructor(_mesh: Mesh);
  69940. /**
  69941. * Simplification of a given mesh according to the given settings.
  69942. * Since this requires computation, it is assumed that the function runs async.
  69943. * @param settings The settings of the simplification, including quality and distance
  69944. * @param successCallback A callback that will be called after the mesh was simplified.
  69945. */
  69946. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  69947. private runDecimation;
  69948. private initWithMesh;
  69949. private init;
  69950. private reconstructMesh;
  69951. private initDecimatedMesh;
  69952. private isFlipped;
  69953. private updateTriangles;
  69954. private identifyBorder;
  69955. private updateMesh;
  69956. private vertexError;
  69957. private calculateError;
  69958. }
  69959. }
  69960. declare module "babylonjs/Meshes/meshSimplificationSceneComponent" {
  69961. import { Scene } from "babylonjs/scene";
  69962. import { SimplificationQueue, ISimplificationSettings, SimplificationType } from "babylonjs/Meshes/meshSimplification";
  69963. import { ISceneComponent } from "babylonjs/sceneComponent";
  69964. module "babylonjs/scene" {
  69965. interface Scene {
  69966. /** @hidden (Backing field) */
  69967. _simplificationQueue: SimplificationQueue;
  69968. /**
  69969. * Gets or sets the simplification queue attached to the scene
  69970. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69971. */
  69972. simplificationQueue: SimplificationQueue;
  69973. }
  69974. }
  69975. module "babylonjs/Meshes/mesh" {
  69976. interface Mesh {
  69977. /**
  69978. * Simplify the mesh according to the given array of settings.
  69979. * Function will return immediately and will simplify async
  69980. * @param settings a collection of simplification settings
  69981. * @param parallelProcessing should all levels calculate parallel or one after the other
  69982. * @param simplificationType the type of simplification to run
  69983. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  69984. * @returns the current mesh
  69985. */
  69986. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  69987. }
  69988. }
  69989. /**
  69990. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  69991. * created in a scene
  69992. */
  69993. export class SimplicationQueueSceneComponent implements ISceneComponent {
  69994. /**
  69995. * The component name helpfull to identify the component in the list of scene components.
  69996. */
  69997. readonly name: string;
  69998. /**
  69999. * The scene the component belongs to.
  70000. */
  70001. scene: Scene;
  70002. /**
  70003. * Creates a new instance of the component for the given scene
  70004. * @param scene Defines the scene to register the component in
  70005. */
  70006. constructor(scene: Scene);
  70007. /**
  70008. * Registers the component in a given scene
  70009. */
  70010. register(): void;
  70011. /**
  70012. * Rebuilds the elements related to this component in case of
  70013. * context lost for instance.
  70014. */
  70015. rebuild(): void;
  70016. /**
  70017. * Disposes the component and the associated ressources
  70018. */
  70019. dispose(): void;
  70020. private _beforeCameraUpdate;
  70021. }
  70022. }
  70023. declare module "babylonjs/Meshes/Builders/index" {
  70024. export * from "babylonjs/Meshes/Builders/boxBuilder";
  70025. export * from "babylonjs/Meshes/Builders/tiledBoxBuilder";
  70026. export * from "babylonjs/Meshes/Builders/discBuilder";
  70027. export * from "babylonjs/Meshes/Builders/ribbonBuilder";
  70028. export * from "babylonjs/Meshes/Builders/sphereBuilder";
  70029. export * from "babylonjs/Meshes/Builders/hemisphereBuilder";
  70030. export * from "babylonjs/Meshes/Builders/cylinderBuilder";
  70031. export * from "babylonjs/Meshes/Builders/torusBuilder";
  70032. export * from "babylonjs/Meshes/Builders/torusKnotBuilder";
  70033. export * from "babylonjs/Meshes/Builders/linesBuilder";
  70034. export * from "babylonjs/Meshes/Builders/polygonBuilder";
  70035. export * from "babylonjs/Meshes/Builders/shapeBuilder";
  70036. export * from "babylonjs/Meshes/Builders/latheBuilder";
  70037. export * from "babylonjs/Meshes/Builders/planeBuilder";
  70038. export * from "babylonjs/Meshes/Builders/tiledPlaneBuilder";
  70039. export * from "babylonjs/Meshes/Builders/groundBuilder";
  70040. export * from "babylonjs/Meshes/Builders/tubeBuilder";
  70041. export * from "babylonjs/Meshes/Builders/polyhedronBuilder";
  70042. export * from "babylonjs/Meshes/Builders/icoSphereBuilder";
  70043. export * from "babylonjs/Meshes/Builders/decalBuilder";
  70044. }
  70045. declare module "babylonjs/Meshes/thinInstanceMesh" {
  70046. import { Nullable, DeepImmutableObject } from "babylonjs/types";
  70047. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  70048. import { Matrix } from "babylonjs/Maths/math.vector";
  70049. module "babylonjs/Meshes/mesh" {
  70050. interface Mesh {
  70051. /**
  70052. * Gets or sets a boolean defining if we want picking to pick thin instances as well
  70053. */
  70054. thinInstanceEnablePicking: boolean;
  70055. /**
  70056. * Creates a new thin instance
  70057. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  70058. * @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
  70059. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  70060. */
  70061. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  70062. /**
  70063. * Adds the transformation (matrix) of the current mesh as a thin instance
  70064. * @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
  70065. * @returns the thin instance index number
  70066. */
  70067. thinInstanceAddSelf(refresh: boolean): number;
  70068. /**
  70069. * Registers a custom attribute to be used with thin instances
  70070. * @param kind name of the attribute
  70071. * @param stride size in floats of the attribute
  70072. */
  70073. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  70074. /**
  70075. * Sets the matrix of a thin instance
  70076. * @param index index of the thin instance
  70077. * @param matrix matrix to set
  70078. * @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
  70079. */
  70080. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  70081. /**
  70082. * Sets the value of a custom attribute for a thin instance
  70083. * @param kind name of the attribute
  70084. * @param index index of the thin instance
  70085. * @param value value to set
  70086. * @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
  70087. */
  70088. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  70089. /**
  70090. * 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.
  70091. */
  70092. thinInstanceCount: number;
  70093. /**
  70094. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  70095. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  70096. * @param buffer buffer to set
  70097. * @param stride size in floats of each value of the buffer
  70098. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  70099. */
  70100. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  70101. /**
  70102. * Gets the list of world matrices
  70103. * @return an array containing all the world matrices from the thin instances
  70104. */
  70105. thinInstanceGetWorldMatrices(): Matrix[];
  70106. /**
  70107. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  70108. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  70109. */
  70110. thinInstanceBufferUpdated(kind: string): void;
  70111. /**
  70112. * Refreshes the bounding info, taking into account all the thin instances defined
  70113. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  70114. */
  70115. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  70116. /** @hidden */
  70117. _thinInstanceInitializeUserStorage(): void;
  70118. /** @hidden */
  70119. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  70120. /** @hidden */
  70121. _userThinInstanceBuffersStorage: {
  70122. data: {
  70123. [key: string]: Float32Array;
  70124. };
  70125. sizes: {
  70126. [key: string]: number;
  70127. };
  70128. vertexBuffers: {
  70129. [key: string]: Nullable<VertexBuffer>;
  70130. };
  70131. strides: {
  70132. [key: string]: number;
  70133. };
  70134. };
  70135. }
  70136. }
  70137. }
  70138. declare module "babylonjs/Meshes/index" {
  70139. export * from "babylonjs/Meshes/abstractMesh";
  70140. export * from "babylonjs/Meshes/buffer";
  70141. export * from "babylonjs/Meshes/Compression/index";
  70142. export * from "babylonjs/Meshes/csg";
  70143. export * from "babylonjs/Meshes/geometry";
  70144. export * from "babylonjs/Meshes/groundMesh";
  70145. export * from "babylonjs/Meshes/trailMesh";
  70146. export * from "babylonjs/Meshes/instancedMesh";
  70147. export * from "babylonjs/Meshes/linesMesh";
  70148. export * from "babylonjs/Meshes/mesh";
  70149. export * from "babylonjs/Meshes/mesh.vertexData";
  70150. export * from "babylonjs/Meshes/meshBuilder";
  70151. export * from "babylonjs/Meshes/meshSimplification";
  70152. export * from "babylonjs/Meshes/meshSimplificationSceneComponent";
  70153. export * from "babylonjs/Meshes/polygonMesh";
  70154. export * from "babylonjs/Meshes/subMesh";
  70155. export * from "babylonjs/Meshes/meshLODLevel";
  70156. export * from "babylonjs/Meshes/transformNode";
  70157. export * from "babylonjs/Meshes/Builders/index";
  70158. export * from "babylonjs/Meshes/dataBuffer";
  70159. export * from "babylonjs/Meshes/WebGL/webGLDataBuffer";
  70160. import "babylonjs/Meshes/thinInstanceMesh";
  70161. export * from "babylonjs/Meshes/thinInstanceMesh";
  70162. }
  70163. declare module "babylonjs/Morph/index" {
  70164. export * from "babylonjs/Morph/morphTarget";
  70165. export * from "babylonjs/Morph/morphTargetManager";
  70166. }
  70167. declare module "babylonjs/Navigation/INavigationEngine" {
  70168. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70169. import { Vector3 } from "babylonjs/Maths/math";
  70170. import { Mesh } from "babylonjs/Meshes/mesh";
  70171. import { Scene } from "babylonjs/scene";
  70172. /**
  70173. * Navigation plugin interface to add navigation constrained by a navigation mesh
  70174. */
  70175. export interface INavigationEnginePlugin {
  70176. /**
  70177. * plugin name
  70178. */
  70179. name: string;
  70180. /**
  70181. * Creates a navigation mesh
  70182. * @param meshes array of all the geometry used to compute the navigatio mesh
  70183. * @param parameters bunch of parameters used to filter geometry
  70184. */
  70185. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  70186. /**
  70187. * Create a navigation mesh debug mesh
  70188. * @param scene is where the mesh will be added
  70189. * @returns debug display mesh
  70190. */
  70191. createDebugNavMesh(scene: Scene): Mesh;
  70192. /**
  70193. * Get a navigation mesh constrained position, closest to the parameter position
  70194. * @param position world position
  70195. * @returns the closest point to position constrained by the navigation mesh
  70196. */
  70197. getClosestPoint(position: Vector3): Vector3;
  70198. /**
  70199. * Get a navigation mesh constrained position, closest to the parameter position
  70200. * @param position world position
  70201. * @param result output the closest point to position constrained by the navigation mesh
  70202. */
  70203. getClosestPointToRef(position: Vector3, result: Vector3): void;
  70204. /**
  70205. * Get a navigation mesh constrained position, within a particular radius
  70206. * @param position world position
  70207. * @param maxRadius the maximum distance to the constrained world position
  70208. * @returns the closest point to position constrained by the navigation mesh
  70209. */
  70210. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  70211. /**
  70212. * Get a navigation mesh constrained position, within a particular radius
  70213. * @param position world position
  70214. * @param maxRadius the maximum distance to the constrained world position
  70215. * @param result output the closest point to position constrained by the navigation mesh
  70216. */
  70217. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  70218. /**
  70219. * Compute the final position from a segment made of destination-position
  70220. * @param position world position
  70221. * @param destination world position
  70222. * @returns the resulting point along the navmesh
  70223. */
  70224. moveAlong(position: Vector3, destination: Vector3): Vector3;
  70225. /**
  70226. * Compute the final position from a segment made of destination-position
  70227. * @param position world position
  70228. * @param destination world position
  70229. * @param result output the resulting point along the navmesh
  70230. */
  70231. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  70232. /**
  70233. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  70234. * @param start world position
  70235. * @param end world position
  70236. * @returns array containing world position composing the path
  70237. */
  70238. computePath(start: Vector3, end: Vector3): Vector3[];
  70239. /**
  70240. * If this plugin is supported
  70241. * @returns true if plugin is supported
  70242. */
  70243. isSupported(): boolean;
  70244. /**
  70245. * Create a new Crowd so you can add agents
  70246. * @param maxAgents the maximum agent count in the crowd
  70247. * @param maxAgentRadius the maximum radius an agent can have
  70248. * @param scene to attach the crowd to
  70249. * @returns the crowd you can add agents to
  70250. */
  70251. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  70252. /**
  70253. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70254. * The queries will try to find a solution within those bounds
  70255. * default is (1,1,1)
  70256. * @param extent x,y,z value that define the extent around the queries point of reference
  70257. */
  70258. setDefaultQueryExtent(extent: Vector3): void;
  70259. /**
  70260. * Get the Bounding box extent specified by setDefaultQueryExtent
  70261. * @returns the box extent values
  70262. */
  70263. getDefaultQueryExtent(): Vector3;
  70264. /**
  70265. * build the navmesh from a previously saved state using getNavmeshData
  70266. * @param data the Uint8Array returned by getNavmeshData
  70267. */
  70268. buildFromNavmeshData(data: Uint8Array): void;
  70269. /**
  70270. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  70271. * @returns data the Uint8Array that can be saved and reused
  70272. */
  70273. getNavmeshData(): Uint8Array;
  70274. /**
  70275. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70276. * @param result output the box extent values
  70277. */
  70278. getDefaultQueryExtentToRef(result: Vector3): void;
  70279. /**
  70280. * Release all resources
  70281. */
  70282. dispose(): void;
  70283. }
  70284. /**
  70285. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  70286. */
  70287. export interface ICrowd {
  70288. /**
  70289. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  70290. * You can attach anything to that node. The node position is updated in the scene update tick.
  70291. * @param pos world position that will be constrained by the navigation mesh
  70292. * @param parameters agent parameters
  70293. * @param transform hooked to the agent that will be update by the scene
  70294. * @returns agent index
  70295. */
  70296. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  70297. /**
  70298. * Returns the agent position in world space
  70299. * @param index agent index returned by addAgent
  70300. * @returns world space position
  70301. */
  70302. getAgentPosition(index: number): Vector3;
  70303. /**
  70304. * Gets the agent position result in world space
  70305. * @param index agent index returned by addAgent
  70306. * @param result output world space position
  70307. */
  70308. getAgentPositionToRef(index: number, result: Vector3): void;
  70309. /**
  70310. * Gets the agent velocity in world space
  70311. * @param index agent index returned by addAgent
  70312. * @returns world space velocity
  70313. */
  70314. getAgentVelocity(index: number): Vector3;
  70315. /**
  70316. * Gets the agent velocity result in world space
  70317. * @param index agent index returned by addAgent
  70318. * @param result output world space velocity
  70319. */
  70320. getAgentVelocityToRef(index: number, result: Vector3): void;
  70321. /**
  70322. * remove a particular agent previously created
  70323. * @param index agent index returned by addAgent
  70324. */
  70325. removeAgent(index: number): void;
  70326. /**
  70327. * get the list of all agents attached to this crowd
  70328. * @returns list of agent indices
  70329. */
  70330. getAgents(): number[];
  70331. /**
  70332. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  70333. * @param deltaTime in seconds
  70334. */
  70335. update(deltaTime: number): void;
  70336. /**
  70337. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  70338. * @param index agent index returned by addAgent
  70339. * @param destination targeted world position
  70340. */
  70341. agentGoto(index: number, destination: Vector3): void;
  70342. /**
  70343. * Teleport the agent to a new position
  70344. * @param index agent index returned by addAgent
  70345. * @param destination targeted world position
  70346. */
  70347. agentTeleport(index: number, destination: Vector3): void;
  70348. /**
  70349. * Update agent parameters
  70350. * @param index agent index returned by addAgent
  70351. * @param parameters agent parameters
  70352. */
  70353. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  70354. /**
  70355. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70356. * The queries will try to find a solution within those bounds
  70357. * default is (1,1,1)
  70358. * @param extent x,y,z value that define the extent around the queries point of reference
  70359. */
  70360. setDefaultQueryExtent(extent: Vector3): void;
  70361. /**
  70362. * Get the Bounding box extent specified by setDefaultQueryExtent
  70363. * @returns the box extent values
  70364. */
  70365. getDefaultQueryExtent(): Vector3;
  70366. /**
  70367. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70368. * @param result output the box extent values
  70369. */
  70370. getDefaultQueryExtentToRef(result: Vector3): void;
  70371. /**
  70372. * Release all resources
  70373. */
  70374. dispose(): void;
  70375. }
  70376. /**
  70377. * Configures an agent
  70378. */
  70379. export interface IAgentParameters {
  70380. /**
  70381. * Agent radius. [Limit: >= 0]
  70382. */
  70383. radius: number;
  70384. /**
  70385. * Agent height. [Limit: > 0]
  70386. */
  70387. height: number;
  70388. /**
  70389. * Maximum allowed acceleration. [Limit: >= 0]
  70390. */
  70391. maxAcceleration: number;
  70392. /**
  70393. * Maximum allowed speed. [Limit: >= 0]
  70394. */
  70395. maxSpeed: number;
  70396. /**
  70397. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  70398. */
  70399. collisionQueryRange: number;
  70400. /**
  70401. * The path visibility optimization range. [Limit: > 0]
  70402. */
  70403. pathOptimizationRange: number;
  70404. /**
  70405. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  70406. */
  70407. separationWeight: number;
  70408. }
  70409. /**
  70410. * Configures the navigation mesh creation
  70411. */
  70412. export interface INavMeshParameters {
  70413. /**
  70414. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  70415. */
  70416. cs: number;
  70417. /**
  70418. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  70419. */
  70420. ch: number;
  70421. /**
  70422. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  70423. */
  70424. walkableSlopeAngle: number;
  70425. /**
  70426. * Minimum floor to 'ceiling' height that will still allow the floor area to
  70427. * be considered walkable. [Limit: >= 3] [Units: vx]
  70428. */
  70429. walkableHeight: number;
  70430. /**
  70431. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  70432. */
  70433. walkableClimb: number;
  70434. /**
  70435. * The distance to erode/shrink the walkable area of the heightfield away from
  70436. * obstructions. [Limit: >=0] [Units: vx]
  70437. */
  70438. walkableRadius: number;
  70439. /**
  70440. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  70441. */
  70442. maxEdgeLen: number;
  70443. /**
  70444. * The maximum distance a simplfied contour's border edges should deviate
  70445. * the original raw contour. [Limit: >=0] [Units: vx]
  70446. */
  70447. maxSimplificationError: number;
  70448. /**
  70449. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  70450. */
  70451. minRegionArea: number;
  70452. /**
  70453. * Any regions with a span count smaller than this value will, if possible,
  70454. * be merged with larger regions. [Limit: >=0] [Units: vx]
  70455. */
  70456. mergeRegionArea: number;
  70457. /**
  70458. * The maximum number of vertices allowed for polygons generated during the
  70459. * contour to polygon conversion process. [Limit: >= 3]
  70460. */
  70461. maxVertsPerPoly: number;
  70462. /**
  70463. * Sets the sampling distance to use when generating the detail mesh.
  70464. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  70465. */
  70466. detailSampleDist: number;
  70467. /**
  70468. * The maximum distance the detail mesh surface should deviate from heightfield
  70469. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  70470. */
  70471. detailSampleMaxError: number;
  70472. }
  70473. }
  70474. declare module "babylonjs/Navigation/Plugins/recastJSPlugin" {
  70475. import { INavigationEnginePlugin, ICrowd, IAgentParameters, INavMeshParameters } from "babylonjs/Navigation/INavigationEngine";
  70476. import { Mesh } from "babylonjs/Meshes/mesh";
  70477. import { Scene } from "babylonjs/scene";
  70478. import { Vector3 } from "babylonjs/Maths/math";
  70479. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70480. /**
  70481. * RecastJS navigation plugin
  70482. */
  70483. export class RecastJSPlugin implements INavigationEnginePlugin {
  70484. /**
  70485. * Reference to the Recast library
  70486. */
  70487. bjsRECAST: any;
  70488. /**
  70489. * plugin name
  70490. */
  70491. name: string;
  70492. /**
  70493. * the first navmesh created. We might extend this to support multiple navmeshes
  70494. */
  70495. navMesh: any;
  70496. /**
  70497. * Initializes the recastJS plugin
  70498. * @param recastInjection can be used to inject your own recast reference
  70499. */
  70500. constructor(recastInjection?: any);
  70501. /**
  70502. * Creates a navigation mesh
  70503. * @param meshes array of all the geometry used to compute the navigatio mesh
  70504. * @param parameters bunch of parameters used to filter geometry
  70505. */
  70506. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  70507. /**
  70508. * Create a navigation mesh debug mesh
  70509. * @param scene is where the mesh will be added
  70510. * @returns debug display mesh
  70511. */
  70512. createDebugNavMesh(scene: Scene): Mesh;
  70513. /**
  70514. * Get a navigation mesh constrained position, closest to the parameter position
  70515. * @param position world position
  70516. * @returns the closest point to position constrained by the navigation mesh
  70517. */
  70518. getClosestPoint(position: Vector3): Vector3;
  70519. /**
  70520. * Get a navigation mesh constrained position, closest to the parameter position
  70521. * @param position world position
  70522. * @param result output the closest point to position constrained by the navigation mesh
  70523. */
  70524. getClosestPointToRef(position: Vector3, result: Vector3): void;
  70525. /**
  70526. * Get a navigation mesh constrained position, within a particular radius
  70527. * @param position world position
  70528. * @param maxRadius the maximum distance to the constrained world position
  70529. * @returns the closest point to position constrained by the navigation mesh
  70530. */
  70531. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  70532. /**
  70533. * Get a navigation mesh constrained position, within a particular radius
  70534. * @param position world position
  70535. * @param maxRadius the maximum distance to the constrained world position
  70536. * @param result output the closest point to position constrained by the navigation mesh
  70537. */
  70538. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  70539. /**
  70540. * Compute the final position from a segment made of destination-position
  70541. * @param position world position
  70542. * @param destination world position
  70543. * @returns the resulting point along the navmesh
  70544. */
  70545. moveAlong(position: Vector3, destination: Vector3): Vector3;
  70546. /**
  70547. * Compute the final position from a segment made of destination-position
  70548. * @param position world position
  70549. * @param destination world position
  70550. * @param result output the resulting point along the navmesh
  70551. */
  70552. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  70553. /**
  70554. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  70555. * @param start world position
  70556. * @param end world position
  70557. * @returns array containing world position composing the path
  70558. */
  70559. computePath(start: Vector3, end: Vector3): Vector3[];
  70560. /**
  70561. * Create a new Crowd so you can add agents
  70562. * @param maxAgents the maximum agent count in the crowd
  70563. * @param maxAgentRadius the maximum radius an agent can have
  70564. * @param scene to attach the crowd to
  70565. * @returns the crowd you can add agents to
  70566. */
  70567. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  70568. /**
  70569. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70570. * The queries will try to find a solution within those bounds
  70571. * default is (1,1,1)
  70572. * @param extent x,y,z value that define the extent around the queries point of reference
  70573. */
  70574. setDefaultQueryExtent(extent: Vector3): void;
  70575. /**
  70576. * Get the Bounding box extent specified by setDefaultQueryExtent
  70577. * @returns the box extent values
  70578. */
  70579. getDefaultQueryExtent(): Vector3;
  70580. /**
  70581. * build the navmesh from a previously saved state using getNavmeshData
  70582. * @param data the Uint8Array returned by getNavmeshData
  70583. */
  70584. buildFromNavmeshData(data: Uint8Array): void;
  70585. /**
  70586. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  70587. * @returns data the Uint8Array that can be saved and reused
  70588. */
  70589. getNavmeshData(): Uint8Array;
  70590. /**
  70591. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70592. * @param result output the box extent values
  70593. */
  70594. getDefaultQueryExtentToRef(result: Vector3): void;
  70595. /**
  70596. * Disposes
  70597. */
  70598. dispose(): void;
  70599. /**
  70600. * If this plugin is supported
  70601. * @returns true if plugin is supported
  70602. */
  70603. isSupported(): boolean;
  70604. }
  70605. /**
  70606. * Recast detour crowd implementation
  70607. */
  70608. export class RecastJSCrowd implements ICrowd {
  70609. /**
  70610. * Recast/detour plugin
  70611. */
  70612. bjsRECASTPlugin: RecastJSPlugin;
  70613. /**
  70614. * Link to the detour crowd
  70615. */
  70616. recastCrowd: any;
  70617. /**
  70618. * One transform per agent
  70619. */
  70620. transforms: TransformNode[];
  70621. /**
  70622. * All agents created
  70623. */
  70624. agents: number[];
  70625. /**
  70626. * Link to the scene is kept to unregister the crowd from the scene
  70627. */
  70628. private _scene;
  70629. /**
  70630. * Observer for crowd updates
  70631. */
  70632. private _onBeforeAnimationsObserver;
  70633. /**
  70634. * Constructor
  70635. * @param plugin recastJS plugin
  70636. * @param maxAgents the maximum agent count in the crowd
  70637. * @param maxAgentRadius the maximum radius an agent can have
  70638. * @param scene to attach the crowd to
  70639. * @returns the crowd you can add agents to
  70640. */
  70641. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  70642. /**
  70643. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  70644. * You can attach anything to that node. The node position is updated in the scene update tick.
  70645. * @param pos world position that will be constrained by the navigation mesh
  70646. * @param parameters agent parameters
  70647. * @param transform hooked to the agent that will be update by the scene
  70648. * @returns agent index
  70649. */
  70650. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  70651. /**
  70652. * Returns the agent position in world space
  70653. * @param index agent index returned by addAgent
  70654. * @returns world space position
  70655. */
  70656. getAgentPosition(index: number): Vector3;
  70657. /**
  70658. * Returns the agent position result in world space
  70659. * @param index agent index returned by addAgent
  70660. * @param result output world space position
  70661. */
  70662. getAgentPositionToRef(index: number, result: Vector3): void;
  70663. /**
  70664. * Returns the agent velocity in world space
  70665. * @param index agent index returned by addAgent
  70666. * @returns world space velocity
  70667. */
  70668. getAgentVelocity(index: number): Vector3;
  70669. /**
  70670. * Returns the agent velocity result in world space
  70671. * @param index agent index returned by addAgent
  70672. * @param result output world space velocity
  70673. */
  70674. getAgentVelocityToRef(index: number, result: Vector3): void;
  70675. /**
  70676. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  70677. * @param index agent index returned by addAgent
  70678. * @param destination targeted world position
  70679. */
  70680. agentGoto(index: number, destination: Vector3): void;
  70681. /**
  70682. * Teleport the agent to a new position
  70683. * @param index agent index returned by addAgent
  70684. * @param destination targeted world position
  70685. */
  70686. agentTeleport(index: number, destination: Vector3): void;
  70687. /**
  70688. * Update agent parameters
  70689. * @param index agent index returned by addAgent
  70690. * @param parameters agent parameters
  70691. */
  70692. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  70693. /**
  70694. * remove a particular agent previously created
  70695. * @param index agent index returned by addAgent
  70696. */
  70697. removeAgent(index: number): void;
  70698. /**
  70699. * get the list of all agents attached to this crowd
  70700. * @returns list of agent indices
  70701. */
  70702. getAgents(): number[];
  70703. /**
  70704. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  70705. * @param deltaTime in seconds
  70706. */
  70707. update(deltaTime: number): void;
  70708. /**
  70709. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70710. * The queries will try to find a solution within those bounds
  70711. * default is (1,1,1)
  70712. * @param extent x,y,z value that define the extent around the queries point of reference
  70713. */
  70714. setDefaultQueryExtent(extent: Vector3): void;
  70715. /**
  70716. * Get the Bounding box extent specified by setDefaultQueryExtent
  70717. * @returns the box extent values
  70718. */
  70719. getDefaultQueryExtent(): Vector3;
  70720. /**
  70721. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70722. * @param result output the box extent values
  70723. */
  70724. getDefaultQueryExtentToRef(result: Vector3): void;
  70725. /**
  70726. * Release all resources
  70727. */
  70728. dispose(): void;
  70729. }
  70730. }
  70731. declare module "babylonjs/Navigation/Plugins/index" {
  70732. export * from "babylonjs/Navigation/Plugins/recastJSPlugin";
  70733. }
  70734. declare module "babylonjs/Navigation/index" {
  70735. export * from "babylonjs/Navigation/INavigationEngine";
  70736. export * from "babylonjs/Navigation/Plugins/index";
  70737. }
  70738. declare module "babylonjs/Offline/database" {
  70739. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  70740. /**
  70741. * Class used to enable access to IndexedDB
  70742. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  70743. */
  70744. export class Database implements IOfflineProvider {
  70745. private _callbackManifestChecked;
  70746. private _currentSceneUrl;
  70747. private _db;
  70748. private _enableSceneOffline;
  70749. private _enableTexturesOffline;
  70750. private _manifestVersionFound;
  70751. private _mustUpdateRessources;
  70752. private _hasReachedQuota;
  70753. private _isSupported;
  70754. private _idbFactory;
  70755. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  70756. private static IsUASupportingBlobStorage;
  70757. /**
  70758. * Gets a boolean indicating if Database storate is enabled (off by default)
  70759. */
  70760. static IDBStorageEnabled: boolean;
  70761. /**
  70762. * Gets a boolean indicating if scene must be saved in the database
  70763. */
  70764. get enableSceneOffline(): boolean;
  70765. /**
  70766. * Gets a boolean indicating if textures must be saved in the database
  70767. */
  70768. get enableTexturesOffline(): boolean;
  70769. /**
  70770. * Creates a new Database
  70771. * @param urlToScene defines the url to load the scene
  70772. * @param callbackManifestChecked defines the callback to use when manifest is checked
  70773. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  70774. */
  70775. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  70776. private static _ParseURL;
  70777. private static _ReturnFullUrlLocation;
  70778. private _checkManifestFile;
  70779. /**
  70780. * Open the database and make it available
  70781. * @param successCallback defines the callback to call on success
  70782. * @param errorCallback defines the callback to call on error
  70783. */
  70784. open(successCallback: () => void, errorCallback: () => void): void;
  70785. /**
  70786. * Loads an image from the database
  70787. * @param url defines the url to load from
  70788. * @param image defines the target DOM image
  70789. */
  70790. loadImage(url: string, image: HTMLImageElement): void;
  70791. private _loadImageFromDBAsync;
  70792. private _saveImageIntoDBAsync;
  70793. private _checkVersionFromDB;
  70794. private _loadVersionFromDBAsync;
  70795. private _saveVersionIntoDBAsync;
  70796. /**
  70797. * Loads a file from database
  70798. * @param url defines the URL to load from
  70799. * @param sceneLoaded defines a callback to call on success
  70800. * @param progressCallBack defines a callback to call when progress changed
  70801. * @param errorCallback defines a callback to call on error
  70802. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  70803. */
  70804. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  70805. private _loadFileAsync;
  70806. private _saveFileAsync;
  70807. /**
  70808. * Validates if xhr data is correct
  70809. * @param xhr defines the request to validate
  70810. * @param dataType defines the expected data type
  70811. * @returns true if data is correct
  70812. */
  70813. private static _ValidateXHRData;
  70814. }
  70815. }
  70816. declare module "babylonjs/Offline/index" {
  70817. export * from "babylonjs/Offline/database";
  70818. export * from "babylonjs/Offline/IOfflineProvider";
  70819. }
  70820. declare module "babylonjs/Shaders/gpuUpdateParticles.fragment" {
  70821. /** @hidden */
  70822. export var gpuUpdateParticlesPixelShader: {
  70823. name: string;
  70824. shader: string;
  70825. };
  70826. }
  70827. declare module "babylonjs/Shaders/gpuUpdateParticles.vertex" {
  70828. /** @hidden */
  70829. export var gpuUpdateParticlesVertexShader: {
  70830. name: string;
  70831. shader: string;
  70832. };
  70833. }
  70834. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2" {
  70835. /** @hidden */
  70836. export var clipPlaneFragmentDeclaration2: {
  70837. name: string;
  70838. shader: string;
  70839. };
  70840. }
  70841. declare module "babylonjs/Shaders/gpuRenderParticles.fragment" {
  70842. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2";
  70843. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  70844. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  70845. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  70846. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  70847. /** @hidden */
  70848. export var gpuRenderParticlesPixelShader: {
  70849. name: string;
  70850. shader: string;
  70851. };
  70852. }
  70853. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2" {
  70854. /** @hidden */
  70855. export var clipPlaneVertexDeclaration2: {
  70856. name: string;
  70857. shader: string;
  70858. };
  70859. }
  70860. declare module "babylonjs/Shaders/gpuRenderParticles.vertex" {
  70861. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2";
  70862. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  70863. /** @hidden */
  70864. export var gpuRenderParticlesVertexShader: {
  70865. name: string;
  70866. shader: string;
  70867. };
  70868. }
  70869. declare module "babylonjs/Particles/gpuParticleSystem" {
  70870. import { Nullable } from "babylonjs/types";
  70871. import { Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  70872. import { Observable } from "babylonjs/Misc/observable";
  70873. import { Matrix } from "babylonjs/Maths/math.vector";
  70874. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  70875. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  70876. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  70877. import { IDisposable } from "babylonjs/scene";
  70878. import { Effect } from "babylonjs/Materials/effect";
  70879. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  70880. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  70881. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  70882. import { Scene } from "babylonjs/scene";
  70883. import "babylonjs/Shaders/gpuUpdateParticles.fragment";
  70884. import "babylonjs/Shaders/gpuUpdateParticles.vertex";
  70885. import "babylonjs/Shaders/gpuRenderParticles.fragment";
  70886. import "babylonjs/Shaders/gpuRenderParticles.vertex";
  70887. /**
  70888. * This represents a GPU particle system in Babylon
  70889. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  70890. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  70891. */
  70892. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  70893. /**
  70894. * The layer mask we are rendering the particles through.
  70895. */
  70896. layerMask: number;
  70897. private _capacity;
  70898. private _activeCount;
  70899. private _currentActiveCount;
  70900. private _accumulatedCount;
  70901. private _renderEffect;
  70902. private _updateEffect;
  70903. private _buffer0;
  70904. private _buffer1;
  70905. private _spriteBuffer;
  70906. private _updateVAO;
  70907. private _renderVAO;
  70908. private _targetIndex;
  70909. private _sourceBuffer;
  70910. private _targetBuffer;
  70911. private _currentRenderId;
  70912. private _started;
  70913. private _stopped;
  70914. private _timeDelta;
  70915. private _randomTexture;
  70916. private _randomTexture2;
  70917. private _attributesStrideSize;
  70918. private _updateEffectOptions;
  70919. private _randomTextureSize;
  70920. private _actualFrame;
  70921. private _customEffect;
  70922. private readonly _rawTextureWidth;
  70923. /**
  70924. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  70925. */
  70926. static get IsSupported(): boolean;
  70927. /**
  70928. * An event triggered when the system is disposed.
  70929. */
  70930. onDisposeObservable: Observable<IParticleSystem>;
  70931. /**
  70932. * Gets the maximum number of particles active at the same time.
  70933. * @returns The max number of active particles.
  70934. */
  70935. getCapacity(): number;
  70936. /**
  70937. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  70938. * to override the particles.
  70939. */
  70940. forceDepthWrite: boolean;
  70941. /**
  70942. * Gets or set the number of active particles
  70943. */
  70944. get activeParticleCount(): number;
  70945. set activeParticleCount(value: number);
  70946. private _preWarmDone;
  70947. /**
  70948. * Specifies if the particles are updated in emitter local space or world space.
  70949. */
  70950. isLocal: boolean;
  70951. /** Gets or sets a matrix to use to compute projection */
  70952. defaultProjectionMatrix: Matrix;
  70953. /**
  70954. * Is this system ready to be used/rendered
  70955. * @return true if the system is ready
  70956. */
  70957. isReady(): boolean;
  70958. /**
  70959. * Gets if the system has been started. (Note: this will still be true after stop is called)
  70960. * @returns True if it has been started, otherwise false.
  70961. */
  70962. isStarted(): boolean;
  70963. /**
  70964. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  70965. * @returns True if it has been stopped, otherwise false.
  70966. */
  70967. isStopped(): boolean;
  70968. /**
  70969. * Gets a boolean indicating that the system is stopping
  70970. * @returns true if the system is currently stopping
  70971. */
  70972. isStopping(): boolean;
  70973. /**
  70974. * Gets the number of particles active at the same time.
  70975. * @returns The number of active particles.
  70976. */
  70977. getActiveCount(): number;
  70978. /**
  70979. * Starts the particle system and begins to emit
  70980. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  70981. */
  70982. start(delay?: number): void;
  70983. /**
  70984. * Stops the particle system.
  70985. */
  70986. stop(): void;
  70987. /**
  70988. * Remove all active particles
  70989. */
  70990. reset(): void;
  70991. /**
  70992. * Returns the string "GPUParticleSystem"
  70993. * @returns a string containing the class name
  70994. */
  70995. getClassName(): string;
  70996. /**
  70997. * Gets the custom effect used to render the particles
  70998. * @param blendMode Blend mode for which the effect should be retrieved
  70999. * @returns The effect
  71000. */
  71001. getCustomEffect(blendMode?: number): Nullable<Effect>;
  71002. /**
  71003. * Sets the custom effect used to render the particles
  71004. * @param effect The effect to set
  71005. * @param blendMode Blend mode for which the effect should be set
  71006. */
  71007. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  71008. /** @hidden */
  71009. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  71010. /**
  71011. * Observable that will be called just before the particles are drawn
  71012. */
  71013. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  71014. /**
  71015. * Gets the name of the particle vertex shader
  71016. */
  71017. get vertexShaderName(): string;
  71018. private _colorGradientsTexture;
  71019. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  71020. /**
  71021. * Adds a new color gradient
  71022. * @param gradient defines the gradient to use (between 0 and 1)
  71023. * @param color1 defines the color to affect to the specified gradient
  71024. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  71025. * @returns the current particle system
  71026. */
  71027. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  71028. private _refreshColorGradient;
  71029. /** Force the system to rebuild all gradients that need to be resync */
  71030. forceRefreshGradients(): void;
  71031. /**
  71032. * Remove a specific color gradient
  71033. * @param gradient defines the gradient to remove
  71034. * @returns the current particle system
  71035. */
  71036. removeColorGradient(gradient: number): GPUParticleSystem;
  71037. private _angularSpeedGradientsTexture;
  71038. private _sizeGradientsTexture;
  71039. private _velocityGradientsTexture;
  71040. private _limitVelocityGradientsTexture;
  71041. private _dragGradientsTexture;
  71042. private _addFactorGradient;
  71043. /**
  71044. * Adds a new size gradient
  71045. * @param gradient defines the gradient to use (between 0 and 1)
  71046. * @param factor defines the size factor to affect to the specified gradient
  71047. * @returns the current particle system
  71048. */
  71049. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  71050. /**
  71051. * Remove a specific size gradient
  71052. * @param gradient defines the gradient to remove
  71053. * @returns the current particle system
  71054. */
  71055. removeSizeGradient(gradient: number): GPUParticleSystem;
  71056. private _refreshFactorGradient;
  71057. /**
  71058. * Adds a new angular speed gradient
  71059. * @param gradient defines the gradient to use (between 0 and 1)
  71060. * @param factor defines the angular speed to affect to the specified gradient
  71061. * @returns the current particle system
  71062. */
  71063. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  71064. /**
  71065. * Remove a specific angular speed gradient
  71066. * @param gradient defines the gradient to remove
  71067. * @returns the current particle system
  71068. */
  71069. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  71070. /**
  71071. * Adds a new velocity gradient
  71072. * @param gradient defines the gradient to use (between 0 and 1)
  71073. * @param factor defines the velocity to affect to the specified gradient
  71074. * @returns the current particle system
  71075. */
  71076. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  71077. /**
  71078. * Remove a specific velocity gradient
  71079. * @param gradient defines the gradient to remove
  71080. * @returns the current particle system
  71081. */
  71082. removeVelocityGradient(gradient: number): GPUParticleSystem;
  71083. /**
  71084. * Adds a new limit velocity gradient
  71085. * @param gradient defines the gradient to use (between 0 and 1)
  71086. * @param factor defines the limit velocity value to affect to the specified gradient
  71087. * @returns the current particle system
  71088. */
  71089. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  71090. /**
  71091. * Remove a specific limit velocity gradient
  71092. * @param gradient defines the gradient to remove
  71093. * @returns the current particle system
  71094. */
  71095. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  71096. /**
  71097. * Adds a new drag gradient
  71098. * @param gradient defines the gradient to use (between 0 and 1)
  71099. * @param factor defines the drag value to affect to the specified gradient
  71100. * @returns the current particle system
  71101. */
  71102. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  71103. /**
  71104. * Remove a specific drag gradient
  71105. * @param gradient defines the gradient to remove
  71106. * @returns the current particle system
  71107. */
  71108. removeDragGradient(gradient: number): GPUParticleSystem;
  71109. /**
  71110. * Not supported by GPUParticleSystem
  71111. * @param gradient defines the gradient to use (between 0 and 1)
  71112. * @param factor defines the emit rate value to affect to the specified gradient
  71113. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71114. * @returns the current particle system
  71115. */
  71116. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71117. /**
  71118. * Not supported by GPUParticleSystem
  71119. * @param gradient defines the gradient to remove
  71120. * @returns the current particle system
  71121. */
  71122. removeEmitRateGradient(gradient: number): IParticleSystem;
  71123. /**
  71124. * Not supported by GPUParticleSystem
  71125. * @param gradient defines the gradient to use (between 0 and 1)
  71126. * @param factor defines the start size value to affect to the specified gradient
  71127. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71128. * @returns the current particle system
  71129. */
  71130. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71131. /**
  71132. * Not supported by GPUParticleSystem
  71133. * @param gradient defines the gradient to remove
  71134. * @returns the current particle system
  71135. */
  71136. removeStartSizeGradient(gradient: number): IParticleSystem;
  71137. /**
  71138. * Not supported by GPUParticleSystem
  71139. * @param gradient defines the gradient to use (between 0 and 1)
  71140. * @param min defines the color remap minimal range
  71141. * @param max defines the color remap maximal range
  71142. * @returns the current particle system
  71143. */
  71144. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  71145. /**
  71146. * Not supported by GPUParticleSystem
  71147. * @param gradient defines the gradient to remove
  71148. * @returns the current particle system
  71149. */
  71150. removeColorRemapGradient(): IParticleSystem;
  71151. /**
  71152. * Not supported by GPUParticleSystem
  71153. * @param gradient defines the gradient to use (between 0 and 1)
  71154. * @param min defines the alpha remap minimal range
  71155. * @param max defines the alpha remap maximal range
  71156. * @returns the current particle system
  71157. */
  71158. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  71159. /**
  71160. * Not supported by GPUParticleSystem
  71161. * @param gradient defines the gradient to remove
  71162. * @returns the current particle system
  71163. */
  71164. removeAlphaRemapGradient(): IParticleSystem;
  71165. /**
  71166. * Not supported by GPUParticleSystem
  71167. * @param gradient defines the gradient to use (between 0 and 1)
  71168. * @param color defines the color to affect to the specified gradient
  71169. * @returns the current particle system
  71170. */
  71171. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  71172. /**
  71173. * Not supported by GPUParticleSystem
  71174. * @param gradient defines the gradient to remove
  71175. * @returns the current particle system
  71176. */
  71177. removeRampGradient(): IParticleSystem;
  71178. /**
  71179. * Not supported by GPUParticleSystem
  71180. * @returns the list of ramp gradients
  71181. */
  71182. getRampGradients(): Nullable<Array<Color3Gradient>>;
  71183. /**
  71184. * Not supported by GPUParticleSystem
  71185. * Gets or sets a boolean indicating that ramp gradients must be used
  71186. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  71187. */
  71188. get useRampGradients(): boolean;
  71189. set useRampGradients(value: boolean);
  71190. /**
  71191. * Not supported by GPUParticleSystem
  71192. * @param gradient defines the gradient to use (between 0 and 1)
  71193. * @param factor defines the life time factor to affect to the specified gradient
  71194. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71195. * @returns the current particle system
  71196. */
  71197. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71198. /**
  71199. * Not supported by GPUParticleSystem
  71200. * @param gradient defines the gradient to remove
  71201. * @returns the current particle system
  71202. */
  71203. removeLifeTimeGradient(gradient: number): IParticleSystem;
  71204. /**
  71205. * Instantiates a GPU particle system.
  71206. * 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.
  71207. * @param name The name of the particle system
  71208. * @param options The options used to create the system
  71209. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  71210. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  71211. * @param customEffect a custom effect used to change the way particles are rendered by default
  71212. */
  71213. constructor(name: string, options: Partial<{
  71214. capacity: number;
  71215. randomTextureSize: number;
  71216. }>, sceneOrEngine: Scene | ThinEngine, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  71217. protected _reset(): void;
  71218. private _createUpdateVAO;
  71219. private _createRenderVAO;
  71220. private _initialize;
  71221. /** @hidden */
  71222. _recreateUpdateEffect(): void;
  71223. private _getEffect;
  71224. /**
  71225. * Fill the defines array according to the current settings of the particle system
  71226. * @param defines Array to be updated
  71227. * @param blendMode blend mode to take into account when updating the array
  71228. */
  71229. fillDefines(defines: Array<string>, blendMode?: number): void;
  71230. /**
  71231. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  71232. * @param uniforms Uniforms array to fill
  71233. * @param attributes Attributes array to fill
  71234. * @param samplers Samplers array to fill
  71235. */
  71236. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  71237. /** @hidden */
  71238. _recreateRenderEffect(): Effect;
  71239. /**
  71240. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  71241. * @param preWarm defines if we are in the pre-warmimg phase
  71242. */
  71243. animate(preWarm?: boolean): void;
  71244. private _createFactorGradientTexture;
  71245. private _createSizeGradientTexture;
  71246. private _createAngularSpeedGradientTexture;
  71247. private _createVelocityGradientTexture;
  71248. private _createLimitVelocityGradientTexture;
  71249. private _createDragGradientTexture;
  71250. private _createColorGradientTexture;
  71251. /**
  71252. * Renders the particle system in its current state
  71253. * @param preWarm defines if the system should only update the particles but not render them
  71254. * @returns the current number of particles
  71255. */
  71256. render(preWarm?: boolean): number;
  71257. /**
  71258. * Rebuilds the particle system
  71259. */
  71260. rebuild(): void;
  71261. private _releaseBuffers;
  71262. private _releaseVAOs;
  71263. /**
  71264. * Disposes the particle system and free the associated resources
  71265. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  71266. */
  71267. dispose(disposeTexture?: boolean): void;
  71268. /**
  71269. * Clones the particle system.
  71270. * @param name The name of the cloned object
  71271. * @param newEmitter The new emitter to use
  71272. * @returns the cloned particle system
  71273. */
  71274. clone(name: string, newEmitter: any): GPUParticleSystem;
  71275. /**
  71276. * Serializes the particle system to a JSON object
  71277. * @param serializeTexture defines if the texture must be serialized as well
  71278. * @returns the JSON object
  71279. */
  71280. serialize(serializeTexture?: boolean): any;
  71281. /**
  71282. * Parses a JSON object to create a GPU particle system.
  71283. * @param parsedParticleSystem The JSON object to parse
  71284. * @param sceneOrEngine The scene or the engine to create the particle system in
  71285. * @param rootUrl The root url to use to load external dependencies like texture
  71286. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  71287. * @returns the parsed GPU particle system
  71288. */
  71289. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  71290. }
  71291. }
  71292. declare module "babylonjs/Particles/particleSystemSet" {
  71293. import { Nullable } from "babylonjs/types";
  71294. import { Color3 } from "babylonjs/Maths/math.color";
  71295. import { TransformNode } from "babylonjs/Meshes/transformNode";
  71296. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  71297. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71298. import { Scene, IDisposable } from "babylonjs/scene";
  71299. /**
  71300. * Represents a set of particle systems working together to create a specific effect
  71301. */
  71302. export class ParticleSystemSet implements IDisposable {
  71303. /**
  71304. * Gets or sets base Assets URL
  71305. */
  71306. static BaseAssetsUrl: string;
  71307. private _emitterCreationOptions;
  71308. private _emitterNode;
  71309. /**
  71310. * Gets the particle system list
  71311. */
  71312. systems: IParticleSystem[];
  71313. /**
  71314. * Gets the emitter node used with this set
  71315. */
  71316. get emitterNode(): Nullable<TransformNode>;
  71317. /**
  71318. * Creates a new emitter mesh as a sphere
  71319. * @param options defines the options used to create the sphere
  71320. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  71321. * @param scene defines the hosting scene
  71322. */
  71323. setEmitterAsSphere(options: {
  71324. diameter: number;
  71325. segments: number;
  71326. color: Color3;
  71327. }, renderingGroupId: number, scene: Scene): void;
  71328. /**
  71329. * Starts all particle systems of the set
  71330. * @param emitter defines an optional mesh to use as emitter for the particle systems
  71331. */
  71332. start(emitter?: AbstractMesh): void;
  71333. /**
  71334. * Release all associated resources
  71335. */
  71336. dispose(): void;
  71337. /**
  71338. * Serialize the set into a JSON compatible object
  71339. * @param serializeTexture defines if the texture must be serialized as well
  71340. * @returns a JSON compatible representation of the set
  71341. */
  71342. serialize(serializeTexture?: boolean): any;
  71343. /**
  71344. * Parse a new ParticleSystemSet from a serialized source
  71345. * @param data defines a JSON compatible representation of the set
  71346. * @param scene defines the hosting scene
  71347. * @param gpu defines if we want GPU particles or CPU particles
  71348. * @returns a new ParticleSystemSet
  71349. */
  71350. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  71351. }
  71352. }
  71353. declare module "babylonjs/Particles/particleHelper" {
  71354. import { Nullable } from "babylonjs/types";
  71355. import { Scene } from "babylonjs/scene";
  71356. import { Vector3 } from "babylonjs/Maths/math.vector";
  71357. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  71358. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71359. import { ParticleSystemSet } from "babylonjs/Particles/particleSystemSet";
  71360. /**
  71361. * This class is made for on one-liner static method to help creating particle system set.
  71362. */
  71363. export class ParticleHelper {
  71364. /**
  71365. * Gets or sets base Assets URL
  71366. */
  71367. static BaseAssetsUrl: string;
  71368. /** Define the Url to load snippets */
  71369. static SnippetUrl: string;
  71370. /**
  71371. * Create a default particle system that you can tweak
  71372. * @param emitter defines the emitter to use
  71373. * @param capacity defines the system capacity (default is 500 particles)
  71374. * @param scene defines the hosting scene
  71375. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  71376. * @returns the new Particle system
  71377. */
  71378. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  71379. /**
  71380. * This is the main static method (one-liner) of this helper to create different particle systems
  71381. * @param type This string represents the type to the particle system to create
  71382. * @param scene The scene where the particle system should live
  71383. * @param gpu If the system will use gpu
  71384. * @returns the ParticleSystemSet created
  71385. */
  71386. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  71387. /**
  71388. * Static function used to export a particle system to a ParticleSystemSet variable.
  71389. * Please note that the emitter shape is not exported
  71390. * @param systems defines the particle systems to export
  71391. * @returns the created particle system set
  71392. */
  71393. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  71394. /**
  71395. * Creates a particle system from a snippet saved in a remote file
  71396. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  71397. * @param url defines the url to load from
  71398. * @param scene defines the hosting scene
  71399. * @param gpu If the system will use gpu
  71400. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  71401. * @returns a promise that will resolve to the new particle system
  71402. */
  71403. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  71404. /**
  71405. * Creates a particle system from a snippet saved by the particle system editor
  71406. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  71407. * @param scene defines the hosting scene
  71408. * @param gpu If the system will use gpu
  71409. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  71410. * @returns a promise that will resolve to the new particle system
  71411. */
  71412. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  71413. }
  71414. }
  71415. declare module "babylonjs/Particles/particleSystemComponent" {
  71416. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71417. import { Effect } from "babylonjs/Materials/effect";
  71418. import "babylonjs/Shaders/particles.vertex";
  71419. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  71420. module "babylonjs/Engines/engine" {
  71421. interface Engine {
  71422. /**
  71423. * Create an effect to use with particle systems.
  71424. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  71425. * the particle system for which you want to create a custom effect in the last parameter
  71426. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  71427. * @param uniformsNames defines a list of attribute names
  71428. * @param samplers defines an array of string used to represent textures
  71429. * @param defines defines the string containing the defines to use to compile the shaders
  71430. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  71431. * @param onCompiled defines a function to call when the effect creation is successful
  71432. * @param onError defines a function to call when the effect creation has failed
  71433. * @param particleSystem the particle system you want to create the effect for
  71434. * @returns the new Effect
  71435. */
  71436. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  71437. }
  71438. }
  71439. module "babylonjs/Meshes/mesh" {
  71440. interface Mesh {
  71441. /**
  71442. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  71443. * @returns an array of IParticleSystem
  71444. */
  71445. getEmittedParticleSystems(): IParticleSystem[];
  71446. /**
  71447. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  71448. * @returns an array of IParticleSystem
  71449. */
  71450. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  71451. }
  71452. }
  71453. }
  71454. declare module "babylonjs/Particles/pointsCloudSystem" {
  71455. import { Color4 } from "babylonjs/Maths/math";
  71456. import { Mesh } from "babylonjs/Meshes/mesh";
  71457. import { Scene, IDisposable } from "babylonjs/scene";
  71458. import { CloudPoint } from "babylonjs/Particles/cloudPoint";
  71459. /** Defines the 4 color options */
  71460. export enum PointColor {
  71461. /** color value */
  71462. Color = 2,
  71463. /** uv value */
  71464. UV = 1,
  71465. /** random value */
  71466. Random = 0,
  71467. /** stated value */
  71468. Stated = 3
  71469. }
  71470. /**
  71471. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  71472. * 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.
  71473. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  71474. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  71475. *
  71476. * Full documentation here : TO BE ENTERED
  71477. */
  71478. export class PointsCloudSystem implements IDisposable {
  71479. /**
  71480. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  71481. * Example : var p = SPS.particles[i];
  71482. */
  71483. particles: CloudPoint[];
  71484. /**
  71485. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  71486. */
  71487. nbParticles: number;
  71488. /**
  71489. * This a counter for your own usage. It's not set by any SPS functions.
  71490. */
  71491. counter: number;
  71492. /**
  71493. * The PCS name. This name is also given to the underlying mesh.
  71494. */
  71495. name: string;
  71496. /**
  71497. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  71498. */
  71499. mesh: Mesh;
  71500. /**
  71501. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  71502. * Please read :
  71503. */
  71504. vars: any;
  71505. /**
  71506. * @hidden
  71507. */
  71508. _size: number;
  71509. private _scene;
  71510. private _promises;
  71511. private _positions;
  71512. private _indices;
  71513. private _normals;
  71514. private _colors;
  71515. private _uvs;
  71516. private _indices32;
  71517. private _positions32;
  71518. private _colors32;
  71519. private _uvs32;
  71520. private _updatable;
  71521. private _isVisibilityBoxLocked;
  71522. private _alwaysVisible;
  71523. private _groups;
  71524. private _groupCounter;
  71525. private _computeParticleColor;
  71526. private _computeParticleTexture;
  71527. private _computeParticleRotation;
  71528. private _computeBoundingBox;
  71529. private _isReady;
  71530. /**
  71531. * Creates a PCS (Points Cloud System) object
  71532. * @param name (String) is the PCS name, this will be the underlying mesh name
  71533. * @param pointSize (number) is the size for each point
  71534. * @param scene (Scene) is the scene in which the PCS is added
  71535. * @param options defines the options of the PCS e.g.
  71536. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  71537. */
  71538. constructor(name: string, pointSize: number, scene: Scene, options?: {
  71539. updatable?: boolean;
  71540. });
  71541. /**
  71542. * Builds the PCS underlying mesh. Returns a standard Mesh.
  71543. * If no points were added to the PCS, the returned mesh is just a single point.
  71544. * @returns a promise for the created mesh
  71545. */
  71546. buildMeshAsync(): Promise<Mesh>;
  71547. /**
  71548. * @hidden
  71549. */
  71550. private _buildMesh;
  71551. private _addParticle;
  71552. private _randomUnitVector;
  71553. private _getColorIndicesForCoord;
  71554. private _setPointsColorOrUV;
  71555. private _colorFromTexture;
  71556. private _calculateDensity;
  71557. /**
  71558. * Adds points to the PCS in random positions within a unit sphere
  71559. * @param nb (positive integer) the number of particles to be created from this model
  71560. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  71561. * @returns the number of groups in the system
  71562. */
  71563. addPoints(nb: number, pointFunction?: any): number;
  71564. /**
  71565. * Adds points to the PCS from the surface of the model shape
  71566. * @param mesh is any Mesh object that will be used as a surface model for the points
  71567. * @param nb (positive integer) the number of particles to be created from this model
  71568. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71569. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71570. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71571. * @returns the number of groups in the system
  71572. */
  71573. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71574. /**
  71575. * Adds points to the PCS inside the model shape
  71576. * @param mesh is any Mesh object that will be used as a surface model for the points
  71577. * @param nb (positive integer) the number of particles to be created from this model
  71578. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71579. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71580. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71581. * @returns the number of groups in the system
  71582. */
  71583. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71584. /**
  71585. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  71586. * This method calls `updateParticle()` for each particle of the SPS.
  71587. * For an animated SPS, it is usually called within the render loop.
  71588. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  71589. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  71590. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  71591. * @returns the PCS.
  71592. */
  71593. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  71594. /**
  71595. * Disposes the PCS.
  71596. */
  71597. dispose(): void;
  71598. /**
  71599. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  71600. * doc :
  71601. * @returns the PCS.
  71602. */
  71603. refreshVisibleSize(): PointsCloudSystem;
  71604. /**
  71605. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  71606. * @param size the size (float) of the visibility box
  71607. * note : this doesn't lock the PCS mesh bounding box.
  71608. * doc :
  71609. */
  71610. setVisibilityBox(size: number): void;
  71611. /**
  71612. * Gets whether the PCS is always visible or not
  71613. * doc :
  71614. */
  71615. get isAlwaysVisible(): boolean;
  71616. /**
  71617. * Sets the PCS as always visible or not
  71618. * doc :
  71619. */
  71620. set isAlwaysVisible(val: boolean);
  71621. /**
  71622. * Tells to `setParticles()` to compute the particle rotations or not
  71623. * Default value : false. The PCS is faster when it's set to false
  71624. * Note : particle rotations are only applied to parent particles
  71625. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  71626. */
  71627. set computeParticleRotation(val: boolean);
  71628. /**
  71629. * Tells to `setParticles()` to compute the particle colors or not.
  71630. * Default value : true. The PCS is faster when it's set to false.
  71631. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71632. */
  71633. set computeParticleColor(val: boolean);
  71634. set computeParticleTexture(val: boolean);
  71635. /**
  71636. * Gets if `setParticles()` computes the particle colors or not.
  71637. * Default value : false. The PCS is faster when it's set to false.
  71638. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71639. */
  71640. get computeParticleColor(): boolean;
  71641. /**
  71642. * Gets if `setParticles()` computes the particle textures or not.
  71643. * Default value : false. The PCS is faster when it's set to false.
  71644. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  71645. */
  71646. get computeParticleTexture(): boolean;
  71647. /**
  71648. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  71649. */
  71650. set computeBoundingBox(val: boolean);
  71651. /**
  71652. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  71653. */
  71654. get computeBoundingBox(): boolean;
  71655. /**
  71656. * This function does nothing. It may be overwritten to set all the particle first values.
  71657. * The PCS doesn't call this function, you may have to call it by your own.
  71658. * doc :
  71659. */
  71660. initParticles(): void;
  71661. /**
  71662. * This function does nothing. It may be overwritten to recycle a particle
  71663. * The PCS doesn't call this function, you can to call it
  71664. * doc :
  71665. * @param particle The particle to recycle
  71666. * @returns the recycled particle
  71667. */
  71668. recycleParticle(particle: CloudPoint): CloudPoint;
  71669. /**
  71670. * Updates a particle : this function should be overwritten by the user.
  71671. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  71672. * doc :
  71673. * @example : just set a particle position or velocity and recycle conditions
  71674. * @param particle The particle to update
  71675. * @returns the updated particle
  71676. */
  71677. updateParticle(particle: CloudPoint): CloudPoint;
  71678. /**
  71679. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  71680. * This does nothing and may be overwritten by the user.
  71681. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  71682. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  71683. * @param update the boolean update value actually passed to setParticles()
  71684. */
  71685. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71686. /**
  71687. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  71688. * This will be passed three parameters.
  71689. * This does nothing and may be overwritten by the user.
  71690. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  71691. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  71692. * @param update the boolean update value actually passed to setParticles()
  71693. */
  71694. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71695. }
  71696. }
  71697. declare module "babylonjs/Particles/cloudPoint" {
  71698. import { Nullable } from "babylonjs/types";
  71699. import { Color4, Vector2, Vector3, Matrix, Quaternion } from "babylonjs/Maths/math";
  71700. import { Mesh } from "babylonjs/Meshes/mesh";
  71701. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  71702. import { PointsCloudSystem } from "babylonjs/Particles/pointsCloudSystem";
  71703. /**
  71704. * Represents one particle of a points cloud system.
  71705. */
  71706. export class CloudPoint {
  71707. /**
  71708. * particle global index
  71709. */
  71710. idx: number;
  71711. /**
  71712. * The color of the particle
  71713. */
  71714. color: Nullable<Color4>;
  71715. /**
  71716. * The world space position of the particle.
  71717. */
  71718. position: Vector3;
  71719. /**
  71720. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  71721. */
  71722. rotation: Vector3;
  71723. /**
  71724. * The world space rotation quaternion of the particle.
  71725. */
  71726. rotationQuaternion: Nullable<Quaternion>;
  71727. /**
  71728. * The uv of the particle.
  71729. */
  71730. uv: Nullable<Vector2>;
  71731. /**
  71732. * The current speed of the particle.
  71733. */
  71734. velocity: Vector3;
  71735. /**
  71736. * The pivot point in the particle local space.
  71737. */
  71738. pivot: Vector3;
  71739. /**
  71740. * Must the particle be translated from its pivot point in its local space ?
  71741. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  71742. * Default : false
  71743. */
  71744. translateFromPivot: boolean;
  71745. /**
  71746. * Index of this particle in the global "positions" array (Internal use)
  71747. * @hidden
  71748. */
  71749. _pos: number;
  71750. /**
  71751. * @hidden Index of this particle in the global "indices" array (Internal use)
  71752. */
  71753. _ind: number;
  71754. /**
  71755. * Group this particle belongs to
  71756. */
  71757. _group: PointsGroup;
  71758. /**
  71759. * Group id of this particle
  71760. */
  71761. groupId: number;
  71762. /**
  71763. * Index of the particle in its group id (Internal use)
  71764. */
  71765. idxInGroup: number;
  71766. /**
  71767. * @hidden Particle BoundingInfo object (Internal use)
  71768. */
  71769. _boundingInfo: BoundingInfo;
  71770. /**
  71771. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  71772. */
  71773. _pcs: PointsCloudSystem;
  71774. /**
  71775. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  71776. */
  71777. _stillInvisible: boolean;
  71778. /**
  71779. * @hidden Last computed particle rotation matrix
  71780. */
  71781. _rotationMatrix: number[];
  71782. /**
  71783. * Parent particle Id, if any.
  71784. * Default null.
  71785. */
  71786. parentId: Nullable<number>;
  71787. /**
  71788. * @hidden Internal global position in the PCS.
  71789. */
  71790. _globalPosition: Vector3;
  71791. /**
  71792. * Creates a Point Cloud object.
  71793. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  71794. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  71795. * @param group (PointsGroup) is the group the particle belongs to
  71796. * @param groupId (integer) is the group identifier in the PCS.
  71797. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  71798. * @param pcs defines the PCS it is associated to
  71799. */
  71800. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  71801. /**
  71802. * get point size
  71803. */
  71804. get size(): Vector3;
  71805. /**
  71806. * Set point size
  71807. */
  71808. set size(scale: Vector3);
  71809. /**
  71810. * Legacy support, changed quaternion to rotationQuaternion
  71811. */
  71812. get quaternion(): Nullable<Quaternion>;
  71813. /**
  71814. * Legacy support, changed quaternion to rotationQuaternion
  71815. */
  71816. set quaternion(q: Nullable<Quaternion>);
  71817. /**
  71818. * Returns a boolean. True if the particle intersects a mesh, else false
  71819. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  71820. * @param target is the object (point or mesh) what the intersection is computed against
  71821. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  71822. * @returns true if it intersects
  71823. */
  71824. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  71825. /**
  71826. * get the rotation matrix of the particle
  71827. * @hidden
  71828. */
  71829. getRotationMatrix(m: Matrix): void;
  71830. }
  71831. /**
  71832. * Represents a group of points in a points cloud system
  71833. * * PCS internal tool, don't use it manually.
  71834. */
  71835. export class PointsGroup {
  71836. /**
  71837. * The group id
  71838. * @hidden
  71839. */
  71840. groupID: number;
  71841. /**
  71842. * image data for group (internal use)
  71843. * @hidden
  71844. */
  71845. _groupImageData: Nullable<ArrayBufferView>;
  71846. /**
  71847. * Image Width (internal use)
  71848. * @hidden
  71849. */
  71850. _groupImgWidth: number;
  71851. /**
  71852. * Image Height (internal use)
  71853. * @hidden
  71854. */
  71855. _groupImgHeight: number;
  71856. /**
  71857. * Custom position function (internal use)
  71858. * @hidden
  71859. */
  71860. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  71861. /**
  71862. * density per facet for surface points
  71863. * @hidden
  71864. */
  71865. _groupDensity: number[];
  71866. /**
  71867. * Only when points are colored by texture carries pointer to texture list array
  71868. * @hidden
  71869. */
  71870. _textureNb: number;
  71871. /**
  71872. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  71873. * PCS internal tool, don't use it manually.
  71874. * @hidden
  71875. */
  71876. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  71877. }
  71878. }
  71879. declare module "babylonjs/Particles/index" {
  71880. export * from "babylonjs/Particles/baseParticleSystem";
  71881. export * from "babylonjs/Particles/EmitterTypes/index";
  71882. export * from "babylonjs/Particles/gpuParticleSystem";
  71883. export * from "babylonjs/Particles/IParticleSystem";
  71884. export * from "babylonjs/Particles/particle";
  71885. export * from "babylonjs/Particles/particleHelper";
  71886. export * from "babylonjs/Particles/particleSystem";
  71887. import "babylonjs/Particles/particleSystemComponent";
  71888. export * from "babylonjs/Particles/particleSystemComponent";
  71889. export * from "babylonjs/Particles/particleSystemSet";
  71890. export * from "babylonjs/Particles/solidParticle";
  71891. export * from "babylonjs/Particles/solidParticleSystem";
  71892. export * from "babylonjs/Particles/cloudPoint";
  71893. export * from "babylonjs/Particles/pointsCloudSystem";
  71894. export * from "babylonjs/Particles/subEmitter";
  71895. }
  71896. declare module "babylonjs/Physics/physicsEngineComponent" {
  71897. import { Nullable } from "babylonjs/types";
  71898. import { Observable, Observer } from "babylonjs/Misc/observable";
  71899. import { Vector3 } from "babylonjs/Maths/math.vector";
  71900. import { Mesh } from "babylonjs/Meshes/mesh";
  71901. import { ISceneComponent } from "babylonjs/sceneComponent";
  71902. import { Scene } from "babylonjs/scene";
  71903. import { Node } from "babylonjs/node";
  71904. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  71905. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  71906. module "babylonjs/scene" {
  71907. interface Scene {
  71908. /** @hidden (Backing field) */
  71909. _physicsEngine: Nullable<IPhysicsEngine>;
  71910. /** @hidden */
  71911. _physicsTimeAccumulator: number;
  71912. /**
  71913. * Gets the current physics engine
  71914. * @returns a IPhysicsEngine or null if none attached
  71915. */
  71916. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  71917. /**
  71918. * Enables physics to the current scene
  71919. * @param gravity defines the scene's gravity for the physics engine
  71920. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  71921. * @return a boolean indicating if the physics engine was initialized
  71922. */
  71923. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  71924. /**
  71925. * Disables and disposes the physics engine associated with the scene
  71926. */
  71927. disablePhysicsEngine(): void;
  71928. /**
  71929. * Gets a boolean indicating if there is an active physics engine
  71930. * @returns a boolean indicating if there is an active physics engine
  71931. */
  71932. isPhysicsEnabled(): boolean;
  71933. /**
  71934. * Deletes a physics compound impostor
  71935. * @param compound defines the compound to delete
  71936. */
  71937. deleteCompoundImpostor(compound: any): void;
  71938. /**
  71939. * An event triggered when physic simulation is about to be run
  71940. */
  71941. onBeforePhysicsObservable: Observable<Scene>;
  71942. /**
  71943. * An event triggered when physic simulation has been done
  71944. */
  71945. onAfterPhysicsObservable: Observable<Scene>;
  71946. }
  71947. }
  71948. module "babylonjs/Meshes/abstractMesh" {
  71949. interface AbstractMesh {
  71950. /** @hidden */
  71951. _physicsImpostor: Nullable<PhysicsImpostor>;
  71952. /**
  71953. * Gets or sets impostor used for physic simulation
  71954. * @see https://doc.babylonjs.com/features/physics_engine
  71955. */
  71956. physicsImpostor: Nullable<PhysicsImpostor>;
  71957. /**
  71958. * Gets the current physics impostor
  71959. * @see https://doc.babylonjs.com/features/physics_engine
  71960. * @returns a physics impostor or null
  71961. */
  71962. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  71963. /** Apply a physic impulse to the mesh
  71964. * @param force defines the force to apply
  71965. * @param contactPoint defines where to apply the force
  71966. * @returns the current mesh
  71967. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  71968. */
  71969. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  71970. /**
  71971. * Creates a physic joint between two meshes
  71972. * @param otherMesh defines the other mesh to use
  71973. * @param pivot1 defines the pivot to use on this mesh
  71974. * @param pivot2 defines the pivot to use on the other mesh
  71975. * @param options defines additional options (can be plugin dependent)
  71976. * @returns the current mesh
  71977. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  71978. */
  71979. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  71980. /** @hidden */
  71981. _disposePhysicsObserver: Nullable<Observer<Node>>;
  71982. }
  71983. }
  71984. /**
  71985. * Defines the physics engine scene component responsible to manage a physics engine
  71986. */
  71987. export class PhysicsEngineSceneComponent implements ISceneComponent {
  71988. /**
  71989. * The component name helpful to identify the component in the list of scene components.
  71990. */
  71991. readonly name: string;
  71992. /**
  71993. * The scene the component belongs to.
  71994. */
  71995. scene: Scene;
  71996. /**
  71997. * Creates a new instance of the component for the given scene
  71998. * @param scene Defines the scene to register the component in
  71999. */
  72000. constructor(scene: Scene);
  72001. /**
  72002. * Registers the component in a given scene
  72003. */
  72004. register(): void;
  72005. /**
  72006. * Rebuilds the elements related to this component in case of
  72007. * context lost for instance.
  72008. */
  72009. rebuild(): void;
  72010. /**
  72011. * Disposes the component and the associated ressources
  72012. */
  72013. dispose(): void;
  72014. }
  72015. }
  72016. declare module "babylonjs/Physics/physicsHelper" {
  72017. import { Nullable } from "babylonjs/types";
  72018. import { Vector3 } from "babylonjs/Maths/math.vector";
  72019. import { Mesh } from "babylonjs/Meshes/mesh";
  72020. import { Scene } from "babylonjs/scene";
  72021. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  72022. /**
  72023. * A helper for physics simulations
  72024. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72025. */
  72026. export class PhysicsHelper {
  72027. private _scene;
  72028. private _physicsEngine;
  72029. /**
  72030. * Initializes the Physics helper
  72031. * @param scene Babylon.js scene
  72032. */
  72033. constructor(scene: Scene);
  72034. /**
  72035. * Applies a radial explosion impulse
  72036. * @param origin the origin of the explosion
  72037. * @param radiusOrEventOptions the radius or the options of radial explosion
  72038. * @param strength the explosion strength
  72039. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72040. * @returns A physics radial explosion event, or null
  72041. */
  72042. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  72043. /**
  72044. * Applies a radial explosion force
  72045. * @param origin the origin of the explosion
  72046. * @param radiusOrEventOptions the radius or the options of radial explosion
  72047. * @param strength the explosion strength
  72048. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72049. * @returns A physics radial explosion event, or null
  72050. */
  72051. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  72052. /**
  72053. * Creates a gravitational field
  72054. * @param origin the origin of the explosion
  72055. * @param radiusOrEventOptions the radius or the options of radial explosion
  72056. * @param strength the explosion strength
  72057. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72058. * @returns A physics gravitational field event, or null
  72059. */
  72060. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  72061. /**
  72062. * Creates a physics updraft event
  72063. * @param origin the origin of the updraft
  72064. * @param radiusOrEventOptions the radius or the options of the updraft
  72065. * @param strength the strength of the updraft
  72066. * @param height the height of the updraft
  72067. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  72068. * @returns A physics updraft event, or null
  72069. */
  72070. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  72071. /**
  72072. * Creates a physics vortex event
  72073. * @param origin the of the vortex
  72074. * @param radiusOrEventOptions the radius or the options of the vortex
  72075. * @param strength the strength of the vortex
  72076. * @param height the height of the vortex
  72077. * @returns a Physics vortex event, or null
  72078. * A physics vortex event or null
  72079. */
  72080. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  72081. }
  72082. /**
  72083. * Represents a physics radial explosion event
  72084. */
  72085. class PhysicsRadialExplosionEvent {
  72086. private _scene;
  72087. private _options;
  72088. private _sphere;
  72089. private _dataFetched;
  72090. /**
  72091. * Initializes a radial explosioin event
  72092. * @param _scene BabylonJS scene
  72093. * @param _options The options for the vortex event
  72094. */
  72095. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  72096. /**
  72097. * Returns the data related to the radial explosion event (sphere).
  72098. * @returns The radial explosion event data
  72099. */
  72100. getData(): PhysicsRadialExplosionEventData;
  72101. /**
  72102. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  72103. * @param impostor A physics imposter
  72104. * @param origin the origin of the explosion
  72105. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  72106. */
  72107. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  72108. /**
  72109. * Triggers affecterd impostors callbacks
  72110. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  72111. */
  72112. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  72113. /**
  72114. * Disposes the sphere.
  72115. * @param force Specifies if the sphere should be disposed by force
  72116. */
  72117. dispose(force?: boolean): void;
  72118. /*** Helpers ***/
  72119. private _prepareSphere;
  72120. private _intersectsWithSphere;
  72121. }
  72122. /**
  72123. * Represents a gravitational field event
  72124. */
  72125. class PhysicsGravitationalFieldEvent {
  72126. private _physicsHelper;
  72127. private _scene;
  72128. private _origin;
  72129. private _options;
  72130. private _tickCallback;
  72131. private _sphere;
  72132. private _dataFetched;
  72133. /**
  72134. * Initializes the physics gravitational field event
  72135. * @param _physicsHelper A physics helper
  72136. * @param _scene BabylonJS scene
  72137. * @param _origin The origin position of the gravitational field event
  72138. * @param _options The options for the vortex event
  72139. */
  72140. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  72141. /**
  72142. * Returns the data related to the gravitational field event (sphere).
  72143. * @returns A gravitational field event
  72144. */
  72145. getData(): PhysicsGravitationalFieldEventData;
  72146. /**
  72147. * Enables the gravitational field.
  72148. */
  72149. enable(): void;
  72150. /**
  72151. * Disables the gravitational field.
  72152. */
  72153. disable(): void;
  72154. /**
  72155. * Disposes the sphere.
  72156. * @param force The force to dispose from the gravitational field event
  72157. */
  72158. dispose(force?: boolean): void;
  72159. private _tick;
  72160. }
  72161. /**
  72162. * Represents a physics updraft event
  72163. */
  72164. class PhysicsUpdraftEvent {
  72165. private _scene;
  72166. private _origin;
  72167. private _options;
  72168. private _physicsEngine;
  72169. private _originTop;
  72170. private _originDirection;
  72171. private _tickCallback;
  72172. private _cylinder;
  72173. private _cylinderPosition;
  72174. private _dataFetched;
  72175. /**
  72176. * Initializes the physics updraft event
  72177. * @param _scene BabylonJS scene
  72178. * @param _origin The origin position of the updraft
  72179. * @param _options The options for the updraft event
  72180. */
  72181. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  72182. /**
  72183. * Returns the data related to the updraft event (cylinder).
  72184. * @returns A physics updraft event
  72185. */
  72186. getData(): PhysicsUpdraftEventData;
  72187. /**
  72188. * Enables the updraft.
  72189. */
  72190. enable(): void;
  72191. /**
  72192. * Disables the updraft.
  72193. */
  72194. disable(): void;
  72195. /**
  72196. * Disposes the cylinder.
  72197. * @param force Specifies if the updraft should be disposed by force
  72198. */
  72199. dispose(force?: boolean): void;
  72200. private getImpostorHitData;
  72201. private _tick;
  72202. /*** Helpers ***/
  72203. private _prepareCylinder;
  72204. private _intersectsWithCylinder;
  72205. }
  72206. /**
  72207. * Represents a physics vortex event
  72208. */
  72209. class PhysicsVortexEvent {
  72210. private _scene;
  72211. private _origin;
  72212. private _options;
  72213. private _physicsEngine;
  72214. private _originTop;
  72215. private _tickCallback;
  72216. private _cylinder;
  72217. private _cylinderPosition;
  72218. private _dataFetched;
  72219. /**
  72220. * Initializes the physics vortex event
  72221. * @param _scene The BabylonJS scene
  72222. * @param _origin The origin position of the vortex
  72223. * @param _options The options for the vortex event
  72224. */
  72225. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  72226. /**
  72227. * Returns the data related to the vortex event (cylinder).
  72228. * @returns The physics vortex event data
  72229. */
  72230. getData(): PhysicsVortexEventData;
  72231. /**
  72232. * Enables the vortex.
  72233. */
  72234. enable(): void;
  72235. /**
  72236. * Disables the cortex.
  72237. */
  72238. disable(): void;
  72239. /**
  72240. * Disposes the sphere.
  72241. * @param force
  72242. */
  72243. dispose(force?: boolean): void;
  72244. private getImpostorHitData;
  72245. private _tick;
  72246. /*** Helpers ***/
  72247. private _prepareCylinder;
  72248. private _intersectsWithCylinder;
  72249. }
  72250. /**
  72251. * Options fot the radial explosion event
  72252. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72253. */
  72254. export class PhysicsRadialExplosionEventOptions {
  72255. /**
  72256. * The radius of the sphere for the radial explosion.
  72257. */
  72258. radius: number;
  72259. /**
  72260. * The strenth of the explosion.
  72261. */
  72262. strength: number;
  72263. /**
  72264. * The strenght of the force in correspondence to the distance of the affected object
  72265. */
  72266. falloff: PhysicsRadialImpulseFalloff;
  72267. /**
  72268. * Sphere options for the radial explosion.
  72269. */
  72270. sphere: {
  72271. segments: number;
  72272. diameter: number;
  72273. };
  72274. /**
  72275. * Sphere options for the radial explosion.
  72276. */
  72277. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  72278. }
  72279. /**
  72280. * Options fot the updraft event
  72281. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72282. */
  72283. export class PhysicsUpdraftEventOptions {
  72284. /**
  72285. * The radius of the cylinder for the vortex
  72286. */
  72287. radius: number;
  72288. /**
  72289. * The strenth of the updraft.
  72290. */
  72291. strength: number;
  72292. /**
  72293. * The height of the cylinder for the updraft.
  72294. */
  72295. height: number;
  72296. /**
  72297. * The mode for the the updraft.
  72298. */
  72299. updraftMode: PhysicsUpdraftMode;
  72300. }
  72301. /**
  72302. * Options fot the vortex event
  72303. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72304. */
  72305. export class PhysicsVortexEventOptions {
  72306. /**
  72307. * The radius of the cylinder for the vortex
  72308. */
  72309. radius: number;
  72310. /**
  72311. * The strenth of the vortex.
  72312. */
  72313. strength: number;
  72314. /**
  72315. * The height of the cylinder for the vortex.
  72316. */
  72317. height: number;
  72318. /**
  72319. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  72320. */
  72321. centripetalForceThreshold: number;
  72322. /**
  72323. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  72324. */
  72325. centripetalForceMultiplier: number;
  72326. /**
  72327. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  72328. */
  72329. centrifugalForceMultiplier: number;
  72330. /**
  72331. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  72332. */
  72333. updraftForceMultiplier: number;
  72334. }
  72335. /**
  72336. * The strenght of the force in correspondence to the distance of the affected object
  72337. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72338. */
  72339. export enum PhysicsRadialImpulseFalloff {
  72340. /** Defines that impulse is constant in strength across it's whole radius */
  72341. Constant = 0,
  72342. /** Defines that impulse gets weaker if it's further from the origin */
  72343. Linear = 1
  72344. }
  72345. /**
  72346. * The strength of the force in correspondence to the distance of the affected object
  72347. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72348. */
  72349. export enum PhysicsUpdraftMode {
  72350. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  72351. Center = 0,
  72352. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  72353. Perpendicular = 1
  72354. }
  72355. /**
  72356. * Interface for a physics hit data
  72357. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72358. */
  72359. export interface PhysicsHitData {
  72360. /**
  72361. * The force applied at the contact point
  72362. */
  72363. force: Vector3;
  72364. /**
  72365. * The contact point
  72366. */
  72367. contactPoint: Vector3;
  72368. /**
  72369. * The distance from the origin to the contact point
  72370. */
  72371. distanceFromOrigin: number;
  72372. }
  72373. /**
  72374. * Interface for radial explosion event data
  72375. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72376. */
  72377. export interface PhysicsRadialExplosionEventData {
  72378. /**
  72379. * A sphere used for the radial explosion event
  72380. */
  72381. sphere: Mesh;
  72382. }
  72383. /**
  72384. * Interface for gravitational field event data
  72385. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72386. */
  72387. export interface PhysicsGravitationalFieldEventData {
  72388. /**
  72389. * A sphere mesh used for the gravitational field event
  72390. */
  72391. sphere: Mesh;
  72392. }
  72393. /**
  72394. * Interface for updraft event data
  72395. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72396. */
  72397. export interface PhysicsUpdraftEventData {
  72398. /**
  72399. * A cylinder used for the updraft event
  72400. */
  72401. cylinder: Mesh;
  72402. }
  72403. /**
  72404. * Interface for vortex event data
  72405. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72406. */
  72407. export interface PhysicsVortexEventData {
  72408. /**
  72409. * A cylinder used for the vortex event
  72410. */
  72411. cylinder: Mesh;
  72412. }
  72413. /**
  72414. * Interface for an affected physics impostor
  72415. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72416. */
  72417. export interface PhysicsAffectedImpostorWithData {
  72418. /**
  72419. * The impostor affected by the effect
  72420. */
  72421. impostor: PhysicsImpostor;
  72422. /**
  72423. * The data about the hit/horce from the explosion
  72424. */
  72425. hitData: PhysicsHitData;
  72426. }
  72427. }
  72428. declare module "babylonjs/Physics/Plugins/index" {
  72429. export * from "babylonjs/Physics/Plugins/cannonJSPlugin";
  72430. export * from "babylonjs/Physics/Plugins/ammoJSPlugin";
  72431. export * from "babylonjs/Physics/Plugins/oimoJSPlugin";
  72432. }
  72433. declare module "babylonjs/Physics/index" {
  72434. export * from "babylonjs/Physics/IPhysicsEngine";
  72435. export * from "babylonjs/Physics/physicsEngine";
  72436. export * from "babylonjs/Physics/physicsEngineComponent";
  72437. export * from "babylonjs/Physics/physicsHelper";
  72438. export * from "babylonjs/Physics/physicsImpostor";
  72439. export * from "babylonjs/Physics/physicsJoint";
  72440. export * from "babylonjs/Physics/Plugins/index";
  72441. }
  72442. declare module "babylonjs/Shaders/blackAndWhite.fragment" {
  72443. /** @hidden */
  72444. export var blackAndWhitePixelShader: {
  72445. name: string;
  72446. shader: string;
  72447. };
  72448. }
  72449. declare module "babylonjs/PostProcesses/blackAndWhitePostProcess" {
  72450. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72451. import { Camera } from "babylonjs/Cameras/camera";
  72452. import { Engine } from "babylonjs/Engines/engine";
  72453. import "babylonjs/Shaders/blackAndWhite.fragment";
  72454. import { Nullable } from "babylonjs/types";
  72455. import { Scene } from "babylonjs/scene";
  72456. /**
  72457. * Post process used to render in black and white
  72458. */
  72459. export class BlackAndWhitePostProcess extends PostProcess {
  72460. /**
  72461. * Linear about to convert he result to black and white (default: 1)
  72462. */
  72463. degree: number;
  72464. /**
  72465. * Gets a string identifying the name of the class
  72466. * @returns "BlackAndWhitePostProcess" string
  72467. */
  72468. getClassName(): string;
  72469. /**
  72470. * Creates a black and white post process
  72471. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  72472. * @param name The name of the effect.
  72473. * @param options The required width/height ratio to downsize to before computing the render pass.
  72474. * @param camera The camera to apply the render pass to.
  72475. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72476. * @param engine The engine which the post process will be applied. (default: current engine)
  72477. * @param reusable If the post process can be reused on the same frame. (default: false)
  72478. */
  72479. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72480. /** @hidden */
  72481. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlackAndWhitePostProcess>;
  72482. }
  72483. }
  72484. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect" {
  72485. import { Nullable } from "babylonjs/types";
  72486. import { Camera } from "babylonjs/Cameras/camera";
  72487. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72488. import { Engine } from "babylonjs/Engines/engine";
  72489. /**
  72490. * This represents a set of one or more post processes in Babylon.
  72491. * A post process can be used to apply a shader to a texture after it is rendered.
  72492. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  72493. */
  72494. export class PostProcessRenderEffect {
  72495. private _postProcesses;
  72496. private _getPostProcesses;
  72497. private _singleInstance;
  72498. private _cameras;
  72499. private _indicesForCamera;
  72500. /**
  72501. * Name of the effect
  72502. * @hidden
  72503. */
  72504. _name: string;
  72505. /**
  72506. * Instantiates a post process render effect.
  72507. * A post process can be used to apply a shader to a texture after it is rendered.
  72508. * @param engine The engine the effect is tied to
  72509. * @param name The name of the effect
  72510. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  72511. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  72512. */
  72513. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  72514. /**
  72515. * Checks if all the post processes in the effect are supported.
  72516. */
  72517. get isSupported(): boolean;
  72518. /**
  72519. * Updates the current state of the effect
  72520. * @hidden
  72521. */
  72522. _update(): void;
  72523. /**
  72524. * Attaches the effect on cameras
  72525. * @param cameras The camera to attach to.
  72526. * @hidden
  72527. */
  72528. _attachCameras(cameras: Camera): void;
  72529. /**
  72530. * Attaches the effect on cameras
  72531. * @param cameras The camera to attach to.
  72532. * @hidden
  72533. */
  72534. _attachCameras(cameras: Camera[]): void;
  72535. /**
  72536. * Detaches the effect on cameras
  72537. * @param cameras The camera to detatch from.
  72538. * @hidden
  72539. */
  72540. _detachCameras(cameras: Camera): void;
  72541. /**
  72542. * Detatches the effect on cameras
  72543. * @param cameras The camera to detatch from.
  72544. * @hidden
  72545. */
  72546. _detachCameras(cameras: Camera[]): void;
  72547. /**
  72548. * Enables the effect on given cameras
  72549. * @param cameras The camera to enable.
  72550. * @hidden
  72551. */
  72552. _enable(cameras: Camera): void;
  72553. /**
  72554. * Enables the effect on given cameras
  72555. * @param cameras The camera to enable.
  72556. * @hidden
  72557. */
  72558. _enable(cameras: Nullable<Camera[]>): void;
  72559. /**
  72560. * Disables the effect on the given cameras
  72561. * @param cameras The camera to disable.
  72562. * @hidden
  72563. */
  72564. _disable(cameras: Camera): void;
  72565. /**
  72566. * Disables the effect on the given cameras
  72567. * @param cameras The camera to disable.
  72568. * @hidden
  72569. */
  72570. _disable(cameras: Nullable<Camera[]>): void;
  72571. /**
  72572. * Gets a list of the post processes contained in the effect.
  72573. * @param camera The camera to get the post processes on.
  72574. * @returns The list of the post processes in the effect.
  72575. */
  72576. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  72577. }
  72578. }
  72579. declare module "babylonjs/Shaders/extractHighlights.fragment" {
  72580. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  72581. /** @hidden */
  72582. export var extractHighlightsPixelShader: {
  72583. name: string;
  72584. shader: string;
  72585. };
  72586. }
  72587. declare module "babylonjs/PostProcesses/extractHighlightsPostProcess" {
  72588. import { Nullable } from "babylonjs/types";
  72589. import { Camera } from "babylonjs/Cameras/camera";
  72590. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72591. import { Engine } from "babylonjs/Engines/engine";
  72592. import "babylonjs/Shaders/extractHighlights.fragment";
  72593. /**
  72594. * 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.
  72595. */
  72596. export class ExtractHighlightsPostProcess extends PostProcess {
  72597. /**
  72598. * The luminance threshold, pixels below this value will be set to black.
  72599. */
  72600. threshold: number;
  72601. /** @hidden */
  72602. _exposure: number;
  72603. /**
  72604. * Post process which has the input texture to be used when performing highlight extraction
  72605. * @hidden
  72606. */
  72607. _inputPostProcess: Nullable<PostProcess>;
  72608. /**
  72609. * Gets a string identifying the name of the class
  72610. * @returns "ExtractHighlightsPostProcess" string
  72611. */
  72612. getClassName(): string;
  72613. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72614. }
  72615. }
  72616. declare module "babylonjs/Shaders/bloomMerge.fragment" {
  72617. /** @hidden */
  72618. export var bloomMergePixelShader: {
  72619. name: string;
  72620. shader: string;
  72621. };
  72622. }
  72623. declare module "babylonjs/PostProcesses/bloomMergePostProcess" {
  72624. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72625. import { Nullable } from "babylonjs/types";
  72626. import { Engine } from "babylonjs/Engines/engine";
  72627. import { Camera } from "babylonjs/Cameras/camera";
  72628. import "babylonjs/Shaders/bloomMerge.fragment";
  72629. /**
  72630. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  72631. */
  72632. export class BloomMergePostProcess extends PostProcess {
  72633. /** Weight of the bloom to be added to the original input. */
  72634. weight: number;
  72635. /**
  72636. * Gets a string identifying the name of the class
  72637. * @returns "BloomMergePostProcess" string
  72638. */
  72639. getClassName(): string;
  72640. /**
  72641. * Creates a new instance of @see BloomMergePostProcess
  72642. * @param name The name of the effect.
  72643. * @param originalFromInput Post process which's input will be used for the merge.
  72644. * @param blurred Blurred highlights post process which's output will be used.
  72645. * @param weight Weight of the bloom to be added to the original input.
  72646. * @param options The required width/height ratio to downsize to before computing the render pass.
  72647. * @param camera The camera to apply the render pass to.
  72648. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72649. * @param engine The engine which the post process will be applied. (default: current engine)
  72650. * @param reusable If the post process can be reused on the same frame. (default: false)
  72651. * @param textureType Type of textures used when performing the post process. (default: 0)
  72652. * @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)
  72653. */
  72654. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  72655. /** Weight of the bloom to be added to the original input. */
  72656. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72657. }
  72658. }
  72659. declare module "babylonjs/PostProcesses/bloomEffect" {
  72660. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  72661. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72662. import { ExtractHighlightsPostProcess } from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  72663. import { Camera } from "babylonjs/Cameras/camera";
  72664. import { Scene } from "babylonjs/scene";
  72665. /**
  72666. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  72667. */
  72668. export class BloomEffect extends PostProcessRenderEffect {
  72669. private bloomScale;
  72670. /**
  72671. * @hidden Internal
  72672. */
  72673. _effects: Array<PostProcess>;
  72674. /**
  72675. * @hidden Internal
  72676. */
  72677. _downscale: ExtractHighlightsPostProcess;
  72678. private _blurX;
  72679. private _blurY;
  72680. private _merge;
  72681. /**
  72682. * The luminance threshold to find bright areas of the image to bloom.
  72683. */
  72684. get threshold(): number;
  72685. set threshold(value: number);
  72686. /**
  72687. * The strength of the bloom.
  72688. */
  72689. get weight(): number;
  72690. set weight(value: number);
  72691. /**
  72692. * Specifies the size of the bloom blur kernel, relative to the final output size
  72693. */
  72694. get kernel(): number;
  72695. set kernel(value: number);
  72696. /**
  72697. * Creates a new instance of @see BloomEffect
  72698. * @param scene The scene the effect belongs to.
  72699. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  72700. * @param bloomKernel The size of the kernel to be used when applying the blur.
  72701. * @param bloomWeight The the strength of bloom.
  72702. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  72703. * @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)
  72704. */
  72705. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  72706. /**
  72707. * Disposes each of the internal effects for a given camera.
  72708. * @param camera The camera to dispose the effect on.
  72709. */
  72710. disposeEffects(camera: Camera): void;
  72711. /**
  72712. * @hidden Internal
  72713. */
  72714. _updateEffects(): void;
  72715. /**
  72716. * Internal
  72717. * @returns if all the contained post processes are ready.
  72718. * @hidden
  72719. */
  72720. _isReady(): boolean;
  72721. }
  72722. }
  72723. declare module "babylonjs/Shaders/chromaticAberration.fragment" {
  72724. /** @hidden */
  72725. export var chromaticAberrationPixelShader: {
  72726. name: string;
  72727. shader: string;
  72728. };
  72729. }
  72730. declare module "babylonjs/PostProcesses/chromaticAberrationPostProcess" {
  72731. import { Vector2 } from "babylonjs/Maths/math.vector";
  72732. import { Nullable } from "babylonjs/types";
  72733. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72734. import { Camera } from "babylonjs/Cameras/camera";
  72735. import { Engine } from "babylonjs/Engines/engine";
  72736. import "babylonjs/Shaders/chromaticAberration.fragment";
  72737. import { Scene } from "babylonjs/scene";
  72738. /**
  72739. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  72740. */
  72741. export class ChromaticAberrationPostProcess extends PostProcess {
  72742. /**
  72743. * The amount of seperation of rgb channels (default: 30)
  72744. */
  72745. aberrationAmount: number;
  72746. /**
  72747. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  72748. */
  72749. radialIntensity: number;
  72750. /**
  72751. * 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))
  72752. */
  72753. direction: Vector2;
  72754. /**
  72755. * 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))
  72756. */
  72757. centerPosition: Vector2;
  72758. /** The width of the screen to apply the effect on */
  72759. screenWidth: number;
  72760. /** The height of the screen to apply the effect on */
  72761. screenHeight: number;
  72762. /**
  72763. * Gets a string identifying the name of the class
  72764. * @returns "ChromaticAberrationPostProcess" string
  72765. */
  72766. getClassName(): string;
  72767. /**
  72768. * Creates a new instance ChromaticAberrationPostProcess
  72769. * @param name The name of the effect.
  72770. * @param screenWidth The width of the screen to apply the effect on.
  72771. * @param screenHeight The height of the screen to apply the effect on.
  72772. * @param options The required width/height ratio to downsize to before computing the render pass.
  72773. * @param camera The camera to apply the render pass to.
  72774. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72775. * @param engine The engine which the post process will be applied. (default: current engine)
  72776. * @param reusable If the post process can be reused on the same frame. (default: false)
  72777. * @param textureType Type of textures used when performing the post process. (default: 0)
  72778. * @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)
  72779. */
  72780. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72781. /** @hidden */
  72782. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ChromaticAberrationPostProcess>;
  72783. }
  72784. }
  72785. declare module "babylonjs/Shaders/circleOfConfusion.fragment" {
  72786. /** @hidden */
  72787. export var circleOfConfusionPixelShader: {
  72788. name: string;
  72789. shader: string;
  72790. };
  72791. }
  72792. declare module "babylonjs/PostProcesses/circleOfConfusionPostProcess" {
  72793. import { Nullable } from "babylonjs/types";
  72794. import { Engine } from "babylonjs/Engines/engine";
  72795. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72796. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  72797. import { Camera } from "babylonjs/Cameras/camera";
  72798. import "babylonjs/Shaders/circleOfConfusion.fragment";
  72799. /**
  72800. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  72801. */
  72802. export class CircleOfConfusionPostProcess extends PostProcess {
  72803. /**
  72804. * 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.
  72805. */
  72806. lensSize: number;
  72807. /**
  72808. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  72809. */
  72810. fStop: number;
  72811. /**
  72812. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  72813. */
  72814. focusDistance: number;
  72815. /**
  72816. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  72817. */
  72818. focalLength: number;
  72819. /**
  72820. * Gets a string identifying the name of the class
  72821. * @returns "CircleOfConfusionPostProcess" string
  72822. */
  72823. getClassName(): string;
  72824. private _depthTexture;
  72825. /**
  72826. * Creates a new instance CircleOfConfusionPostProcess
  72827. * @param name The name of the effect.
  72828. * @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.
  72829. * @param options The required width/height ratio to downsize to before computing the render pass.
  72830. * @param camera The camera to apply the render pass to.
  72831. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72832. * @param engine The engine which the post process will be applied. (default: current engine)
  72833. * @param reusable If the post process can be reused on the same frame. (default: false)
  72834. * @param textureType Type of textures used when performing the post process. (default: 0)
  72835. * @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)
  72836. */
  72837. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72838. /**
  72839. * 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.
  72840. */
  72841. set depthTexture(value: RenderTargetTexture);
  72842. }
  72843. }
  72844. declare module "babylonjs/Shaders/colorCorrection.fragment" {
  72845. /** @hidden */
  72846. export var colorCorrectionPixelShader: {
  72847. name: string;
  72848. shader: string;
  72849. };
  72850. }
  72851. declare module "babylonjs/PostProcesses/colorCorrectionPostProcess" {
  72852. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72853. import { Engine } from "babylonjs/Engines/engine";
  72854. import { Camera } from "babylonjs/Cameras/camera";
  72855. import "babylonjs/Shaders/colorCorrection.fragment";
  72856. import { Nullable } from "babylonjs/types";
  72857. import { Scene } from "babylonjs/scene";
  72858. /**
  72859. *
  72860. * This post-process allows the modification of rendered colors by using
  72861. * a 'look-up table' (LUT). This effect is also called Color Grading.
  72862. *
  72863. * The object needs to be provided an url to a texture containing the color
  72864. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  72865. * Use an image editing software to tweak the LUT to match your needs.
  72866. *
  72867. * For an example of a color LUT, see here:
  72868. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  72869. * For explanations on color grading, see here:
  72870. * @see http://udn.epicgames.com/Three/ColorGrading.html
  72871. *
  72872. */
  72873. export class ColorCorrectionPostProcess extends PostProcess {
  72874. private _colorTableTexture;
  72875. /**
  72876. * Gets the color table url used to create the LUT texture
  72877. */
  72878. colorTableUrl: string;
  72879. /**
  72880. * Gets a string identifying the name of the class
  72881. * @returns "ColorCorrectionPostProcess" string
  72882. */
  72883. getClassName(): string;
  72884. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72885. /** @hidden */
  72886. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ColorCorrectionPostProcess>;
  72887. }
  72888. }
  72889. declare module "babylonjs/Shaders/convolution.fragment" {
  72890. /** @hidden */
  72891. export var convolutionPixelShader: {
  72892. name: string;
  72893. shader: string;
  72894. };
  72895. }
  72896. declare module "babylonjs/PostProcesses/convolutionPostProcess" {
  72897. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72898. import { Nullable } from "babylonjs/types";
  72899. import { Camera } from "babylonjs/Cameras/camera";
  72900. import { Engine } from "babylonjs/Engines/engine";
  72901. import "babylonjs/Shaders/convolution.fragment";
  72902. import { Scene } from "babylonjs/scene";
  72903. /**
  72904. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  72905. * input texture to perform effects such as edge detection or sharpening
  72906. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  72907. */
  72908. export class ConvolutionPostProcess extends PostProcess {
  72909. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  72910. kernel: number[];
  72911. /**
  72912. * Gets a string identifying the name of the class
  72913. * @returns "ConvolutionPostProcess" string
  72914. */
  72915. getClassName(): string;
  72916. /**
  72917. * Creates a new instance ConvolutionPostProcess
  72918. * @param name The name of the effect.
  72919. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  72920. * @param options The required width/height ratio to downsize to before computing the render pass.
  72921. * @param camera The camera to apply the render pass to.
  72922. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72923. * @param engine The engine which the post process will be applied. (default: current engine)
  72924. * @param reusable If the post process can be reused on the same frame. (default: false)
  72925. * @param textureType Type of textures used when performing the post process. (default: 0)
  72926. */
  72927. constructor(name: string, kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  72928. /** @hidden */
  72929. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ConvolutionPostProcess>;
  72930. /**
  72931. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72932. */
  72933. static EdgeDetect0Kernel: number[];
  72934. /**
  72935. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72936. */
  72937. static EdgeDetect1Kernel: number[];
  72938. /**
  72939. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72940. */
  72941. static EdgeDetect2Kernel: number[];
  72942. /**
  72943. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72944. */
  72945. static SharpenKernel: number[];
  72946. /**
  72947. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72948. */
  72949. static EmbossKernel: number[];
  72950. /**
  72951. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72952. */
  72953. static GaussianKernel: number[];
  72954. }
  72955. }
  72956. declare module "babylonjs/PostProcesses/depthOfFieldBlurPostProcess" {
  72957. import { Nullable } from "babylonjs/types";
  72958. import { Vector2 } from "babylonjs/Maths/math.vector";
  72959. import { Camera } from "babylonjs/Cameras/camera";
  72960. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72961. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  72962. import { Engine } from "babylonjs/Engines/engine";
  72963. import { Scene } from "babylonjs/scene";
  72964. /**
  72965. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  72966. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  72967. * based on samples that have a large difference in distance than the center pixel.
  72968. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  72969. */
  72970. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  72971. /**
  72972. * The direction the blur should be applied
  72973. */
  72974. direction: Vector2;
  72975. /**
  72976. * Gets a string identifying the name of the class
  72977. * @returns "DepthOfFieldBlurPostProcess" string
  72978. */
  72979. getClassName(): string;
  72980. /**
  72981. * Creates a new instance CircleOfConfusionPostProcess
  72982. * @param name The name of the effect.
  72983. * @param scene The scene the effect belongs to.
  72984. * @param direction The direction the blur should be applied.
  72985. * @param kernel The size of the kernel used to blur.
  72986. * @param options The required width/height ratio to downsize to before computing the render pass.
  72987. * @param camera The camera to apply the render pass to.
  72988. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  72989. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  72990. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72991. * @param engine The engine which the post process will be applied. (default: current engine)
  72992. * @param reusable If the post process can be reused on the same frame. (default: false)
  72993. * @param textureType Type of textures used when performing the post process. (default: 0)
  72994. * @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)
  72995. */
  72996. 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);
  72997. }
  72998. }
  72999. declare module "babylonjs/Shaders/depthOfFieldMerge.fragment" {
  73000. /** @hidden */
  73001. export var depthOfFieldMergePixelShader: {
  73002. name: string;
  73003. shader: string;
  73004. };
  73005. }
  73006. declare module "babylonjs/PostProcesses/depthOfFieldMergePostProcess" {
  73007. import { Nullable } from "babylonjs/types";
  73008. import { Camera } from "babylonjs/Cameras/camera";
  73009. import { Effect } from "babylonjs/Materials/effect";
  73010. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73011. import { Engine } from "babylonjs/Engines/engine";
  73012. import "babylonjs/Shaders/depthOfFieldMerge.fragment";
  73013. /**
  73014. * Options to be set when merging outputs from the default pipeline.
  73015. */
  73016. export class DepthOfFieldMergePostProcessOptions {
  73017. /**
  73018. * The original image to merge on top of
  73019. */
  73020. originalFromInput: PostProcess;
  73021. /**
  73022. * Parameters to perform the merge of the depth of field effect
  73023. */
  73024. depthOfField?: {
  73025. circleOfConfusion: PostProcess;
  73026. blurSteps: Array<PostProcess>;
  73027. };
  73028. /**
  73029. * Parameters to perform the merge of bloom effect
  73030. */
  73031. bloom?: {
  73032. blurred: PostProcess;
  73033. weight: number;
  73034. };
  73035. }
  73036. /**
  73037. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  73038. */
  73039. export class DepthOfFieldMergePostProcess extends PostProcess {
  73040. private blurSteps;
  73041. /**
  73042. * Gets a string identifying the name of the class
  73043. * @returns "DepthOfFieldMergePostProcess" string
  73044. */
  73045. getClassName(): string;
  73046. /**
  73047. * Creates a new instance of DepthOfFieldMergePostProcess
  73048. * @param name The name of the effect.
  73049. * @param originalFromInput Post process which's input will be used for the merge.
  73050. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  73051. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  73052. * @param options The required width/height ratio to downsize to before computing the render pass.
  73053. * @param camera The camera to apply the render pass to.
  73054. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73055. * @param engine The engine which the post process will be applied. (default: current engine)
  73056. * @param reusable If the post process can be reused on the same frame. (default: false)
  73057. * @param textureType Type of textures used when performing the post process. (default: 0)
  73058. * @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)
  73059. */
  73060. 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);
  73061. /**
  73062. * Updates the effect with the current post process compile time values and recompiles the shader.
  73063. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  73064. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  73065. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  73066. * @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
  73067. * @param onCompiled Called when the shader has been compiled.
  73068. * @param onError Called if there is an error when compiling a shader.
  73069. */
  73070. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  73071. }
  73072. }
  73073. declare module "babylonjs/PostProcesses/depthOfFieldEffect" {
  73074. import { Nullable } from "babylonjs/types";
  73075. import { Camera } from "babylonjs/Cameras/camera";
  73076. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  73077. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  73078. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  73079. import { DepthOfFieldBlurPostProcess } from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  73080. import { Scene } from "babylonjs/scene";
  73081. /**
  73082. * Specifies the level of max blur that should be applied when using the depth of field effect
  73083. */
  73084. export enum DepthOfFieldEffectBlurLevel {
  73085. /**
  73086. * Subtle blur
  73087. */
  73088. Low = 0,
  73089. /**
  73090. * Medium blur
  73091. */
  73092. Medium = 1,
  73093. /**
  73094. * Large blur
  73095. */
  73096. High = 2
  73097. }
  73098. /**
  73099. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  73100. */
  73101. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  73102. private _circleOfConfusion;
  73103. /**
  73104. * @hidden Internal, blurs from high to low
  73105. */
  73106. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  73107. private _depthOfFieldBlurY;
  73108. private _dofMerge;
  73109. /**
  73110. * @hidden Internal post processes in depth of field effect
  73111. */
  73112. _effects: Array<PostProcess>;
  73113. /**
  73114. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  73115. */
  73116. set focalLength(value: number);
  73117. get focalLength(): number;
  73118. /**
  73119. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  73120. */
  73121. set fStop(value: number);
  73122. get fStop(): number;
  73123. /**
  73124. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  73125. */
  73126. set focusDistance(value: number);
  73127. get focusDistance(): number;
  73128. /**
  73129. * 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.
  73130. */
  73131. set lensSize(value: number);
  73132. get lensSize(): number;
  73133. /**
  73134. * Creates a new instance DepthOfFieldEffect
  73135. * @param scene The scene the effect belongs to.
  73136. * @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.
  73137. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  73138. * @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)
  73139. */
  73140. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  73141. /**
  73142. * Get the current class name of the current effet
  73143. * @returns "DepthOfFieldEffect"
  73144. */
  73145. getClassName(): string;
  73146. /**
  73147. * 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.
  73148. */
  73149. set depthTexture(value: RenderTargetTexture);
  73150. /**
  73151. * Disposes each of the internal effects for a given camera.
  73152. * @param camera The camera to dispose the effect on.
  73153. */
  73154. disposeEffects(camera: Camera): void;
  73155. /**
  73156. * @hidden Internal
  73157. */
  73158. _updateEffects(): void;
  73159. /**
  73160. * Internal
  73161. * @returns if all the contained post processes are ready.
  73162. * @hidden
  73163. */
  73164. _isReady(): boolean;
  73165. }
  73166. }
  73167. declare module "babylonjs/Shaders/displayPass.fragment" {
  73168. /** @hidden */
  73169. export var displayPassPixelShader: {
  73170. name: string;
  73171. shader: string;
  73172. };
  73173. }
  73174. declare module "babylonjs/PostProcesses/displayPassPostProcess" {
  73175. import { Nullable } from "babylonjs/types";
  73176. import { Camera } from "babylonjs/Cameras/camera";
  73177. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73178. import { Engine } from "babylonjs/Engines/engine";
  73179. import "babylonjs/Shaders/displayPass.fragment";
  73180. import { Scene } from "babylonjs/scene";
  73181. /**
  73182. * DisplayPassPostProcess which produces an output the same as it's input
  73183. */
  73184. export class DisplayPassPostProcess extends PostProcess {
  73185. /**
  73186. * Gets a string identifying the name of the class
  73187. * @returns "DisplayPassPostProcess" string
  73188. */
  73189. getClassName(): string;
  73190. /**
  73191. * Creates the DisplayPassPostProcess
  73192. * @param name The name of the effect.
  73193. * @param options The required width/height ratio to downsize to before computing the render pass.
  73194. * @param camera The camera to apply the render pass to.
  73195. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73196. * @param engine The engine which the post process will be applied. (default: current engine)
  73197. * @param reusable If the post process can be reused on the same frame. (default: false)
  73198. */
  73199. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73200. /** @hidden */
  73201. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<DisplayPassPostProcess>;
  73202. }
  73203. }
  73204. declare module "babylonjs/Shaders/filter.fragment" {
  73205. /** @hidden */
  73206. export var filterPixelShader: {
  73207. name: string;
  73208. shader: string;
  73209. };
  73210. }
  73211. declare module "babylonjs/PostProcesses/filterPostProcess" {
  73212. import { Nullable } from "babylonjs/types";
  73213. import { Matrix } from "babylonjs/Maths/math.vector";
  73214. import { Camera } from "babylonjs/Cameras/camera";
  73215. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73216. import { Engine } from "babylonjs/Engines/engine";
  73217. import "babylonjs/Shaders/filter.fragment";
  73218. import { Scene } from "babylonjs/scene";
  73219. /**
  73220. * Applies a kernel filter to the image
  73221. */
  73222. export class FilterPostProcess extends PostProcess {
  73223. /** The matrix to be applied to the image */
  73224. kernelMatrix: Matrix;
  73225. /**
  73226. * Gets a string identifying the name of the class
  73227. * @returns "FilterPostProcess" string
  73228. */
  73229. getClassName(): string;
  73230. /**
  73231. *
  73232. * @param name The name of the effect.
  73233. * @param kernelMatrix The matrix to be applied to the image
  73234. * @param options The required width/height ratio to downsize to before computing the render pass.
  73235. * @param camera The camera to apply the render pass to.
  73236. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73237. * @param engine The engine which the post process will be applied. (default: current engine)
  73238. * @param reusable If the post process can be reused on the same frame. (default: false)
  73239. */
  73240. constructor(name: string, kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73241. /** @hidden */
  73242. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<FilterPostProcess>;
  73243. }
  73244. }
  73245. declare module "babylonjs/Shaders/fxaa.fragment" {
  73246. /** @hidden */
  73247. export var fxaaPixelShader: {
  73248. name: string;
  73249. shader: string;
  73250. };
  73251. }
  73252. declare module "babylonjs/Shaders/fxaa.vertex" {
  73253. /** @hidden */
  73254. export var fxaaVertexShader: {
  73255. name: string;
  73256. shader: string;
  73257. };
  73258. }
  73259. declare module "babylonjs/PostProcesses/fxaaPostProcess" {
  73260. import { Nullable } from "babylonjs/types";
  73261. import { Camera } from "babylonjs/Cameras/camera";
  73262. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73263. import { Engine } from "babylonjs/Engines/engine";
  73264. import "babylonjs/Shaders/fxaa.fragment";
  73265. import "babylonjs/Shaders/fxaa.vertex";
  73266. import { Scene } from "babylonjs/scene";
  73267. /**
  73268. * Fxaa post process
  73269. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  73270. */
  73271. export class FxaaPostProcess extends PostProcess {
  73272. /**
  73273. * Gets a string identifying the name of the class
  73274. * @returns "FxaaPostProcess" string
  73275. */
  73276. getClassName(): string;
  73277. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73278. private _getDefines;
  73279. /** @hidden */
  73280. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): FxaaPostProcess;
  73281. }
  73282. }
  73283. declare module "babylonjs/Shaders/grain.fragment" {
  73284. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  73285. /** @hidden */
  73286. export var grainPixelShader: {
  73287. name: string;
  73288. shader: string;
  73289. };
  73290. }
  73291. declare module "babylonjs/PostProcesses/grainPostProcess" {
  73292. import { Nullable } from "babylonjs/types";
  73293. import { Camera } from "babylonjs/Cameras/camera";
  73294. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73295. import { Engine } from "babylonjs/Engines/engine";
  73296. import "babylonjs/Shaders/grain.fragment";
  73297. import { Scene } from "babylonjs/scene";
  73298. /**
  73299. * The GrainPostProcess adds noise to the image at mid luminance levels
  73300. */
  73301. export class GrainPostProcess extends PostProcess {
  73302. /**
  73303. * The intensity of the grain added (default: 30)
  73304. */
  73305. intensity: number;
  73306. /**
  73307. * If the grain should be randomized on every frame
  73308. */
  73309. animated: boolean;
  73310. /**
  73311. * Gets a string identifying the name of the class
  73312. * @returns "GrainPostProcess" string
  73313. */
  73314. getClassName(): string;
  73315. /**
  73316. * Creates a new instance of @see GrainPostProcess
  73317. * @param name The name of the effect.
  73318. * @param options The required width/height ratio to downsize to before computing the render pass.
  73319. * @param camera The camera to apply the render pass to.
  73320. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73321. * @param engine The engine which the post process will be applied. (default: current engine)
  73322. * @param reusable If the post process can be reused on the same frame. (default: false)
  73323. * @param textureType Type of textures used when performing the post process. (default: 0)
  73324. * @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)
  73325. */
  73326. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73327. /** @hidden */
  73328. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): GrainPostProcess;
  73329. }
  73330. }
  73331. declare module "babylonjs/Shaders/highlights.fragment" {
  73332. /** @hidden */
  73333. export var highlightsPixelShader: {
  73334. name: string;
  73335. shader: string;
  73336. };
  73337. }
  73338. declare module "babylonjs/PostProcesses/highlightsPostProcess" {
  73339. import { Nullable } from "babylonjs/types";
  73340. import { Camera } from "babylonjs/Cameras/camera";
  73341. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73342. import { Engine } from "babylonjs/Engines/engine";
  73343. import "babylonjs/Shaders/highlights.fragment";
  73344. /**
  73345. * Extracts highlights from the image
  73346. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  73347. */
  73348. export class HighlightsPostProcess extends PostProcess {
  73349. /**
  73350. * Gets a string identifying the name of the class
  73351. * @returns "HighlightsPostProcess" string
  73352. */
  73353. getClassName(): string;
  73354. /**
  73355. * Extracts highlights from the image
  73356. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  73357. * @param name The name of the effect.
  73358. * @param options The required width/height ratio to downsize to before computing the render pass.
  73359. * @param camera The camera to apply the render pass to.
  73360. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73361. * @param engine The engine which the post process will be applied. (default: current engine)
  73362. * @param reusable If the post process can be reused on the same frame. (default: false)
  73363. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  73364. */
  73365. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73366. }
  73367. }
  73368. declare module "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration" {
  73369. /** @hidden */
  73370. export var mrtFragmentDeclaration: {
  73371. name: string;
  73372. shader: string;
  73373. };
  73374. }
  73375. declare module "babylonjs/Shaders/geometry.fragment" {
  73376. import "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration";
  73377. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  73378. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  73379. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  73380. /** @hidden */
  73381. export var geometryPixelShader: {
  73382. name: string;
  73383. shader: string;
  73384. };
  73385. }
  73386. declare module "babylonjs/Shaders/geometry.vertex" {
  73387. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  73388. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  73389. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  73390. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  73391. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  73392. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  73393. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  73394. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  73395. /** @hidden */
  73396. export var geometryVertexShader: {
  73397. name: string;
  73398. shader: string;
  73399. };
  73400. }
  73401. declare module "babylonjs/Rendering/geometryBufferRenderer" {
  73402. import { Matrix } from "babylonjs/Maths/math.vector";
  73403. import { SubMesh } from "babylonjs/Meshes/subMesh";
  73404. import { Mesh } from "babylonjs/Meshes/mesh";
  73405. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  73406. import { Effect } from "babylonjs/Materials/effect";
  73407. import { Scene } from "babylonjs/scene";
  73408. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  73409. import "babylonjs/Shaders/geometry.fragment";
  73410. import "babylonjs/Shaders/geometry.vertex";
  73411. /** @hidden */
  73412. interface ISavedTransformationMatrix {
  73413. world: Matrix;
  73414. viewProjection: Matrix;
  73415. }
  73416. /**
  73417. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  73418. */
  73419. export class GeometryBufferRenderer {
  73420. /**
  73421. * Constant used to retrieve the position texture index in the G-Buffer textures array
  73422. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  73423. */
  73424. static readonly POSITION_TEXTURE_TYPE: number;
  73425. /**
  73426. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  73427. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  73428. */
  73429. static readonly VELOCITY_TEXTURE_TYPE: number;
  73430. /**
  73431. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  73432. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  73433. */
  73434. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  73435. /**
  73436. * Dictionary used to store the previous transformation matrices of each rendered mesh
  73437. * in order to compute objects velocities when enableVelocity is set to "true"
  73438. * @hidden
  73439. */
  73440. _previousTransformationMatrices: {
  73441. [index: number]: ISavedTransformationMatrix;
  73442. };
  73443. /**
  73444. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  73445. * in order to compute objects velocities when enableVelocity is set to "true"
  73446. * @hidden
  73447. */
  73448. _previousBonesTransformationMatrices: {
  73449. [index: number]: Float32Array;
  73450. };
  73451. /**
  73452. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  73453. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  73454. */
  73455. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  73456. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  73457. renderTransparentMeshes: boolean;
  73458. private _scene;
  73459. private _resizeObserver;
  73460. private _multiRenderTarget;
  73461. private _ratio;
  73462. private _enablePosition;
  73463. private _enableVelocity;
  73464. private _enableReflectivity;
  73465. private _positionIndex;
  73466. private _velocityIndex;
  73467. private _reflectivityIndex;
  73468. protected _effect: Effect;
  73469. protected _cachedDefines: string;
  73470. /**
  73471. * Set the render list (meshes to be rendered) used in the G buffer.
  73472. */
  73473. set renderList(meshes: Mesh[]);
  73474. /**
  73475. * Gets wether or not G buffer are supported by the running hardware.
  73476. * This requires draw buffer supports
  73477. */
  73478. get isSupported(): boolean;
  73479. /**
  73480. * Returns the index of the given texture type in the G-Buffer textures array
  73481. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  73482. * @returns the index of the given texture type in the G-Buffer textures array
  73483. */
  73484. getTextureIndex(textureType: number): number;
  73485. /**
  73486. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  73487. */
  73488. get enablePosition(): boolean;
  73489. /**
  73490. * Sets whether or not objects positions are enabled for the G buffer.
  73491. */
  73492. set enablePosition(enable: boolean);
  73493. /**
  73494. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  73495. */
  73496. get enableVelocity(): boolean;
  73497. /**
  73498. * Sets wether or not objects velocities are enabled for the G buffer.
  73499. */
  73500. set enableVelocity(enable: boolean);
  73501. /**
  73502. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  73503. */
  73504. get enableReflectivity(): boolean;
  73505. /**
  73506. * Sets wether or not objects roughness are enabled for the G buffer.
  73507. */
  73508. set enableReflectivity(enable: boolean);
  73509. /**
  73510. * Gets the scene associated with the buffer.
  73511. */
  73512. get scene(): Scene;
  73513. /**
  73514. * Gets the ratio used by the buffer during its creation.
  73515. * How big is the buffer related to the main canvas.
  73516. */
  73517. get ratio(): number;
  73518. /** @hidden */
  73519. static _SceneComponentInitialization: (scene: Scene) => void;
  73520. /**
  73521. * Creates a new G Buffer for the scene
  73522. * @param scene The scene the buffer belongs to
  73523. * @param ratio How big is the buffer related to the main canvas.
  73524. */
  73525. constructor(scene: Scene, ratio?: number);
  73526. /**
  73527. * Checks wether everything is ready to render a submesh to the G buffer.
  73528. * @param subMesh the submesh to check readiness for
  73529. * @param useInstances is the mesh drawn using instance or not
  73530. * @returns true if ready otherwise false
  73531. */
  73532. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  73533. /**
  73534. * Gets the current underlying G Buffer.
  73535. * @returns the buffer
  73536. */
  73537. getGBuffer(): MultiRenderTarget;
  73538. /**
  73539. * Gets the number of samples used to render the buffer (anti aliasing).
  73540. */
  73541. get samples(): number;
  73542. /**
  73543. * Sets the number of samples used to render the buffer (anti aliasing).
  73544. */
  73545. set samples(value: number);
  73546. /**
  73547. * Disposes the renderer and frees up associated resources.
  73548. */
  73549. dispose(): void;
  73550. protected _createRenderTargets(): void;
  73551. private _copyBonesTransformationMatrices;
  73552. }
  73553. }
  73554. declare module "babylonjs/Rendering/geometryBufferRendererSceneComponent" {
  73555. import { Nullable } from "babylonjs/types";
  73556. import { Scene } from "babylonjs/scene";
  73557. import { ISceneComponent } from "babylonjs/sceneComponent";
  73558. import { GeometryBufferRenderer } from "babylonjs/Rendering/geometryBufferRenderer";
  73559. module "babylonjs/scene" {
  73560. interface Scene {
  73561. /** @hidden (Backing field) */
  73562. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  73563. /**
  73564. * Gets or Sets the current geometry buffer associated to the scene.
  73565. */
  73566. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  73567. /**
  73568. * Enables a GeometryBufferRender and associates it with the scene
  73569. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  73570. * @returns the GeometryBufferRenderer
  73571. */
  73572. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  73573. /**
  73574. * Disables the GeometryBufferRender associated with the scene
  73575. */
  73576. disableGeometryBufferRenderer(): void;
  73577. }
  73578. }
  73579. /**
  73580. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  73581. * in several rendering techniques.
  73582. */
  73583. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  73584. /**
  73585. * The component name helpful to identify the component in the list of scene components.
  73586. */
  73587. readonly name: string;
  73588. /**
  73589. * The scene the component belongs to.
  73590. */
  73591. scene: Scene;
  73592. /**
  73593. * Creates a new instance of the component for the given scene
  73594. * @param scene Defines the scene to register the component in
  73595. */
  73596. constructor(scene: Scene);
  73597. /**
  73598. * Registers the component in a given scene
  73599. */
  73600. register(): void;
  73601. /**
  73602. * Rebuilds the elements related to this component in case of
  73603. * context lost for instance.
  73604. */
  73605. rebuild(): void;
  73606. /**
  73607. * Disposes the component and the associated ressources
  73608. */
  73609. dispose(): void;
  73610. private _gatherRenderTargets;
  73611. }
  73612. }
  73613. declare module "babylonjs/Shaders/motionBlur.fragment" {
  73614. /** @hidden */
  73615. export var motionBlurPixelShader: {
  73616. name: string;
  73617. shader: string;
  73618. };
  73619. }
  73620. declare module "babylonjs/PostProcesses/motionBlurPostProcess" {
  73621. import { Nullable } from "babylonjs/types";
  73622. import { Camera } from "babylonjs/Cameras/camera";
  73623. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73624. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  73625. import "babylonjs/Animations/animatable";
  73626. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  73627. import "babylonjs/Shaders/motionBlur.fragment";
  73628. import { Engine } from "babylonjs/Engines/engine";
  73629. import { Scene } from "babylonjs/scene";
  73630. /**
  73631. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  73632. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  73633. * As an example, all you have to do is to create the post-process:
  73634. * var mb = new BABYLON.MotionBlurPostProcess(
  73635. * 'mb', // The name of the effect.
  73636. * scene, // The scene containing the objects to blur according to their velocity.
  73637. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  73638. * camera // The camera to apply the render pass to.
  73639. * );
  73640. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  73641. */
  73642. export class MotionBlurPostProcess extends PostProcess {
  73643. /**
  73644. * Defines how much the image is blurred by the movement. Default value is equal to 1
  73645. */
  73646. motionStrength: number;
  73647. /**
  73648. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  73649. */
  73650. get motionBlurSamples(): number;
  73651. /**
  73652. * Sets the number of iterations to be used for motion blur quality
  73653. */
  73654. set motionBlurSamples(samples: number);
  73655. private _motionBlurSamples;
  73656. private _geometryBufferRenderer;
  73657. /**
  73658. * Gets a string identifying the name of the class
  73659. * @returns "MotionBlurPostProcess" string
  73660. */
  73661. getClassName(): string;
  73662. /**
  73663. * Creates a new instance MotionBlurPostProcess
  73664. * @param name The name of the effect.
  73665. * @param scene The scene containing the objects to blur according to their velocity.
  73666. * @param options The required width/height ratio to downsize to before computing the render pass.
  73667. * @param camera The camera to apply the render pass to.
  73668. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73669. * @param engine The engine which the post process will be applied. (default: current engine)
  73670. * @param reusable If the post process can be reused on the same frame. (default: false)
  73671. * @param textureType Type of textures used when performing the post process. (default: 0)
  73672. * @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)
  73673. */
  73674. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73675. /**
  73676. * Excludes the given skinned mesh from computing bones velocities.
  73677. * 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.
  73678. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  73679. */
  73680. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73681. /**
  73682. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  73683. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  73684. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  73685. */
  73686. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73687. /**
  73688. * Disposes the post process.
  73689. * @param camera The camera to dispose the post process on.
  73690. */
  73691. dispose(camera?: Camera): void;
  73692. /** @hidden */
  73693. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<MotionBlurPostProcess>;
  73694. }
  73695. }
  73696. declare module "babylonjs/Shaders/refraction.fragment" {
  73697. /** @hidden */
  73698. export var refractionPixelShader: {
  73699. name: string;
  73700. shader: string;
  73701. };
  73702. }
  73703. declare module "babylonjs/PostProcesses/refractionPostProcess" {
  73704. import { Color3 } from "babylonjs/Maths/math.color";
  73705. import { Camera } from "babylonjs/Cameras/camera";
  73706. import { Texture } from "babylonjs/Materials/Textures/texture";
  73707. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73708. import { Engine } from "babylonjs/Engines/engine";
  73709. import "babylonjs/Shaders/refraction.fragment";
  73710. import { Scene } from "babylonjs/scene";
  73711. /**
  73712. * Post process which applies a refractin texture
  73713. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  73714. */
  73715. export class RefractionPostProcess extends PostProcess {
  73716. private _refTexture;
  73717. private _ownRefractionTexture;
  73718. /** the base color of the refraction (used to taint the rendering) */
  73719. color: Color3;
  73720. /** simulated refraction depth */
  73721. depth: number;
  73722. /** the coefficient of the base color (0 to remove base color tainting) */
  73723. colorLevel: number;
  73724. /** Gets the url used to load the refraction texture */
  73725. refractionTextureUrl: string;
  73726. /**
  73727. * Gets or sets the refraction texture
  73728. * Please note that you are responsible for disposing the texture if you set it manually
  73729. */
  73730. get refractionTexture(): Texture;
  73731. set refractionTexture(value: Texture);
  73732. /**
  73733. * Gets a string identifying the name of the class
  73734. * @returns "RefractionPostProcess" string
  73735. */
  73736. getClassName(): string;
  73737. /**
  73738. * Initializes the RefractionPostProcess
  73739. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  73740. * @param name The name of the effect.
  73741. * @param refractionTextureUrl Url of the refraction texture to use
  73742. * @param color the base color of the refraction (used to taint the rendering)
  73743. * @param depth simulated refraction depth
  73744. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  73745. * @param camera The camera to apply the render pass to.
  73746. * @param options The required width/height ratio to downsize to before computing the render pass.
  73747. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73748. * @param engine The engine which the post process will be applied. (default: current engine)
  73749. * @param reusable If the post process can be reused on the same frame. (default: false)
  73750. */
  73751. constructor(name: string, refractionTextureUrl: string, color: Color3, depth: number, colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73752. /**
  73753. * Disposes of the post process
  73754. * @param camera Camera to dispose post process on
  73755. */
  73756. dispose(camera: Camera): void;
  73757. /** @hidden */
  73758. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): RefractionPostProcess;
  73759. }
  73760. }
  73761. declare module "babylonjs/Shaders/sharpen.fragment" {
  73762. /** @hidden */
  73763. export var sharpenPixelShader: {
  73764. name: string;
  73765. shader: string;
  73766. };
  73767. }
  73768. declare module "babylonjs/PostProcesses/sharpenPostProcess" {
  73769. import { Nullable } from "babylonjs/types";
  73770. import { Camera } from "babylonjs/Cameras/camera";
  73771. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73772. import "babylonjs/Shaders/sharpen.fragment";
  73773. import { Engine } from "babylonjs/Engines/engine";
  73774. import { Scene } from "babylonjs/scene";
  73775. /**
  73776. * The SharpenPostProcess applies a sharpen kernel to every pixel
  73777. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  73778. */
  73779. export class SharpenPostProcess extends PostProcess {
  73780. /**
  73781. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  73782. */
  73783. colorAmount: number;
  73784. /**
  73785. * How much sharpness should be applied (default: 0.3)
  73786. */
  73787. edgeAmount: number;
  73788. /**
  73789. * Gets a string identifying the name of the class
  73790. * @returns "SharpenPostProcess" string
  73791. */
  73792. getClassName(): string;
  73793. /**
  73794. * Creates a new instance ConvolutionPostProcess
  73795. * @param name The name of the effect.
  73796. * @param options The required width/height ratio to downsize to before computing the render pass.
  73797. * @param camera The camera to apply the render pass to.
  73798. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73799. * @param engine The engine which the post process will be applied. (default: current engine)
  73800. * @param reusable If the post process can be reused on the same frame. (default: false)
  73801. * @param textureType Type of textures used when performing the post process. (default: 0)
  73802. * @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)
  73803. */
  73804. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73805. /** @hidden */
  73806. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): SharpenPostProcess;
  73807. }
  73808. }
  73809. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline" {
  73810. import { Nullable } from "babylonjs/types";
  73811. import { Camera } from "babylonjs/Cameras/camera";
  73812. import { Engine } from "babylonjs/Engines/engine";
  73813. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  73814. import { IInspectable } from "babylonjs/Misc/iInspectable";
  73815. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  73816. /**
  73817. * PostProcessRenderPipeline
  73818. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73819. */
  73820. export class PostProcessRenderPipeline {
  73821. private engine;
  73822. private _renderEffects;
  73823. private _renderEffectsForIsolatedPass;
  73824. /**
  73825. * List of inspectable custom properties (used by the Inspector)
  73826. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  73827. */
  73828. inspectableCustomProperties: IInspectable[];
  73829. /**
  73830. * @hidden
  73831. */
  73832. protected _cameras: Camera[];
  73833. /** @hidden */
  73834. _name: string;
  73835. /**
  73836. * Gets pipeline name
  73837. */
  73838. get name(): string;
  73839. /** Gets the list of attached cameras */
  73840. get cameras(): Camera[];
  73841. /**
  73842. * Initializes a PostProcessRenderPipeline
  73843. * @param engine engine to add the pipeline to
  73844. * @param name name of the pipeline
  73845. */
  73846. constructor(engine: Engine, name: string);
  73847. /**
  73848. * Gets the class name
  73849. * @returns "PostProcessRenderPipeline"
  73850. */
  73851. getClassName(): string;
  73852. /**
  73853. * If all the render effects in the pipeline are supported
  73854. */
  73855. get isSupported(): boolean;
  73856. /**
  73857. * Adds an effect to the pipeline
  73858. * @param renderEffect the effect to add
  73859. */
  73860. addEffect(renderEffect: PostProcessRenderEffect): void;
  73861. /** @hidden */
  73862. _rebuild(): void;
  73863. /** @hidden */
  73864. _enableEffect(renderEffectName: string, cameras: Camera): void;
  73865. /** @hidden */
  73866. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  73867. /** @hidden */
  73868. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  73869. /** @hidden */
  73870. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  73871. /** @hidden */
  73872. _attachCameras(cameras: Camera, unique: boolean): void;
  73873. /** @hidden */
  73874. _attachCameras(cameras: Camera[], unique: boolean): void;
  73875. /** @hidden */
  73876. _detachCameras(cameras: Camera): void;
  73877. /** @hidden */
  73878. _detachCameras(cameras: Nullable<Camera[]>): void;
  73879. /** @hidden */
  73880. _update(): void;
  73881. /** @hidden */
  73882. _reset(): void;
  73883. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  73884. /**
  73885. * Sets the required values to the prepass renderer.
  73886. * @param prePassRenderer defines the prepass renderer to setup.
  73887. * @returns true if the pre pass is needed.
  73888. */
  73889. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  73890. /**
  73891. * Disposes of the pipeline
  73892. */
  73893. dispose(): void;
  73894. }
  73895. }
  73896. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager" {
  73897. import { Camera } from "babylonjs/Cameras/camera";
  73898. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  73899. /**
  73900. * PostProcessRenderPipelineManager class
  73901. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73902. */
  73903. export class PostProcessRenderPipelineManager {
  73904. private _renderPipelines;
  73905. /**
  73906. * Initializes a PostProcessRenderPipelineManager
  73907. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73908. */
  73909. constructor();
  73910. /**
  73911. * Gets the list of supported render pipelines
  73912. */
  73913. get supportedPipelines(): PostProcessRenderPipeline[];
  73914. /**
  73915. * Adds a pipeline to the manager
  73916. * @param renderPipeline The pipeline to add
  73917. */
  73918. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  73919. /**
  73920. * Attaches a camera to the pipeline
  73921. * @param renderPipelineName The name of the pipeline to attach to
  73922. * @param cameras the camera to attach
  73923. * @param unique if the camera can be attached multiple times to the pipeline
  73924. */
  73925. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  73926. /**
  73927. * Detaches a camera from the pipeline
  73928. * @param renderPipelineName The name of the pipeline to detach from
  73929. * @param cameras the camera to detach
  73930. */
  73931. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  73932. /**
  73933. * Enables an effect by name on a pipeline
  73934. * @param renderPipelineName the name of the pipeline to enable the effect in
  73935. * @param renderEffectName the name of the effect to enable
  73936. * @param cameras the cameras that the effect should be enabled on
  73937. */
  73938. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  73939. /**
  73940. * Disables an effect by name on a pipeline
  73941. * @param renderPipelineName the name of the pipeline to disable the effect in
  73942. * @param renderEffectName the name of the effect to disable
  73943. * @param cameras the cameras that the effect should be disabled on
  73944. */
  73945. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  73946. /**
  73947. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  73948. */
  73949. update(): void;
  73950. /** @hidden */
  73951. _rebuild(): void;
  73952. /**
  73953. * Disposes of the manager and pipelines
  73954. */
  73955. dispose(): void;
  73956. }
  73957. }
  73958. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent" {
  73959. import { ISceneComponent } from "babylonjs/sceneComponent";
  73960. import { PostProcessRenderPipelineManager } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  73961. import { Scene } from "babylonjs/scene";
  73962. module "babylonjs/scene" {
  73963. interface Scene {
  73964. /** @hidden (Backing field) */
  73965. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  73966. /**
  73967. * Gets the postprocess render pipeline manager
  73968. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73969. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  73970. */
  73971. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  73972. }
  73973. }
  73974. /**
  73975. * Defines the Render Pipeline scene component responsible to rendering pipelines
  73976. */
  73977. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  73978. /**
  73979. * The component name helpfull to identify the component in the list of scene components.
  73980. */
  73981. readonly name: string;
  73982. /**
  73983. * The scene the component belongs to.
  73984. */
  73985. scene: Scene;
  73986. /**
  73987. * Creates a new instance of the component for the given scene
  73988. * @param scene Defines the scene to register the component in
  73989. */
  73990. constructor(scene: Scene);
  73991. /**
  73992. * Registers the component in a given scene
  73993. */
  73994. register(): void;
  73995. /**
  73996. * Rebuilds the elements related to this component in case of
  73997. * context lost for instance.
  73998. */
  73999. rebuild(): void;
  74000. /**
  74001. * Disposes the component and the associated ressources
  74002. */
  74003. dispose(): void;
  74004. private _gatherRenderTargets;
  74005. }
  74006. }
  74007. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline" {
  74008. import { Nullable } from "babylonjs/types";
  74009. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  74010. import { Camera } from "babylonjs/Cameras/camera";
  74011. import { IDisposable } from "babylonjs/scene";
  74012. import { GlowLayer } from "babylonjs/Layers/glowLayer";
  74013. import { Scene } from "babylonjs/scene";
  74014. import { SharpenPostProcess } from "babylonjs/PostProcesses/sharpenPostProcess";
  74015. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  74016. import { ChromaticAberrationPostProcess } from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  74017. import { GrainPostProcess } from "babylonjs/PostProcesses/grainPostProcess";
  74018. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  74019. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74020. import { DepthOfFieldEffect, DepthOfFieldEffectBlurLevel } from "babylonjs/PostProcesses/depthOfFieldEffect";
  74021. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74022. import { Animation } from "babylonjs/Animations/animation";
  74023. /**
  74024. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  74025. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  74026. */
  74027. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  74028. private _scene;
  74029. private _camerasToBeAttached;
  74030. /**
  74031. * ID of the sharpen post process,
  74032. */
  74033. private readonly SharpenPostProcessId;
  74034. /**
  74035. * @ignore
  74036. * ID of the image processing post process;
  74037. */
  74038. readonly ImageProcessingPostProcessId: string;
  74039. /**
  74040. * @ignore
  74041. * ID of the Fast Approximate Anti-Aliasing post process;
  74042. */
  74043. readonly FxaaPostProcessId: string;
  74044. /**
  74045. * ID of the chromatic aberration post process,
  74046. */
  74047. private readonly ChromaticAberrationPostProcessId;
  74048. /**
  74049. * ID of the grain post process
  74050. */
  74051. private readonly GrainPostProcessId;
  74052. /**
  74053. * Sharpen post process which will apply a sharpen convolution to enhance edges
  74054. */
  74055. sharpen: SharpenPostProcess;
  74056. private _sharpenEffect;
  74057. private bloom;
  74058. /**
  74059. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  74060. */
  74061. depthOfField: DepthOfFieldEffect;
  74062. /**
  74063. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  74064. */
  74065. fxaa: FxaaPostProcess;
  74066. /**
  74067. * Image post processing pass used to perform operations such as tone mapping or color grading.
  74068. */
  74069. imageProcessing: ImageProcessingPostProcess;
  74070. /**
  74071. * Chromatic aberration post process which will shift rgb colors in the image
  74072. */
  74073. chromaticAberration: ChromaticAberrationPostProcess;
  74074. private _chromaticAberrationEffect;
  74075. /**
  74076. * Grain post process which add noise to the image
  74077. */
  74078. grain: GrainPostProcess;
  74079. private _grainEffect;
  74080. /**
  74081. * Glow post process which adds a glow to emissive areas of the image
  74082. */
  74083. private _glowLayer;
  74084. /**
  74085. * Animations which can be used to tweak settings over a period of time
  74086. */
  74087. animations: Animation[];
  74088. private _imageProcessingConfigurationObserver;
  74089. private _sharpenEnabled;
  74090. private _bloomEnabled;
  74091. private _depthOfFieldEnabled;
  74092. private _depthOfFieldBlurLevel;
  74093. private _fxaaEnabled;
  74094. private _imageProcessingEnabled;
  74095. private _defaultPipelineTextureType;
  74096. private _bloomScale;
  74097. private _chromaticAberrationEnabled;
  74098. private _grainEnabled;
  74099. private _buildAllowed;
  74100. /**
  74101. * Gets active scene
  74102. */
  74103. get scene(): Scene;
  74104. /**
  74105. * Enable or disable the sharpen process from the pipeline
  74106. */
  74107. set sharpenEnabled(enabled: boolean);
  74108. get sharpenEnabled(): boolean;
  74109. private _resizeObserver;
  74110. private _hardwareScaleLevel;
  74111. private _bloomKernel;
  74112. /**
  74113. * Specifies the size of the bloom blur kernel, relative to the final output size
  74114. */
  74115. get bloomKernel(): number;
  74116. set bloomKernel(value: number);
  74117. /**
  74118. * Specifies the weight of the bloom in the final rendering
  74119. */
  74120. private _bloomWeight;
  74121. /**
  74122. * Specifies the luma threshold for the area that will be blurred by the bloom
  74123. */
  74124. private _bloomThreshold;
  74125. private _hdr;
  74126. /**
  74127. * The strength of the bloom.
  74128. */
  74129. set bloomWeight(value: number);
  74130. get bloomWeight(): number;
  74131. /**
  74132. * The strength of the bloom.
  74133. */
  74134. set bloomThreshold(value: number);
  74135. get bloomThreshold(): number;
  74136. /**
  74137. * The scale of the bloom, lower value will provide better performance.
  74138. */
  74139. set bloomScale(value: number);
  74140. get bloomScale(): number;
  74141. /**
  74142. * Enable or disable the bloom from the pipeline
  74143. */
  74144. set bloomEnabled(enabled: boolean);
  74145. get bloomEnabled(): boolean;
  74146. private _rebuildBloom;
  74147. /**
  74148. * If the depth of field is enabled.
  74149. */
  74150. get depthOfFieldEnabled(): boolean;
  74151. set depthOfFieldEnabled(enabled: boolean);
  74152. /**
  74153. * Blur level of the depth of field effect. (Higher blur will effect performance)
  74154. */
  74155. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  74156. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  74157. /**
  74158. * If the anti aliasing is enabled.
  74159. */
  74160. set fxaaEnabled(enabled: boolean);
  74161. get fxaaEnabled(): boolean;
  74162. private _samples;
  74163. /**
  74164. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  74165. */
  74166. set samples(sampleCount: number);
  74167. get samples(): number;
  74168. /**
  74169. * If image processing is enabled.
  74170. */
  74171. set imageProcessingEnabled(enabled: boolean);
  74172. get imageProcessingEnabled(): boolean;
  74173. /**
  74174. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  74175. */
  74176. set glowLayerEnabled(enabled: boolean);
  74177. get glowLayerEnabled(): boolean;
  74178. /**
  74179. * Gets the glow layer (or null if not defined)
  74180. */
  74181. get glowLayer(): Nullable<GlowLayer>;
  74182. /**
  74183. * Enable or disable the chromaticAberration process from the pipeline
  74184. */
  74185. set chromaticAberrationEnabled(enabled: boolean);
  74186. get chromaticAberrationEnabled(): boolean;
  74187. /**
  74188. * Enable or disable the grain process from the pipeline
  74189. */
  74190. set grainEnabled(enabled: boolean);
  74191. get grainEnabled(): boolean;
  74192. /**
  74193. * @constructor
  74194. * @param name - The rendering pipeline name (default: "")
  74195. * @param hdr - If high dynamic range textures should be used (default: true)
  74196. * @param scene - The scene linked to this pipeline (default: the last created scene)
  74197. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  74198. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  74199. */
  74200. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  74201. /**
  74202. * Get the class name
  74203. * @returns "DefaultRenderingPipeline"
  74204. */
  74205. getClassName(): string;
  74206. /**
  74207. * Force the compilation of the entire pipeline.
  74208. */
  74209. prepare(): void;
  74210. private _hasCleared;
  74211. private _prevPostProcess;
  74212. private _prevPrevPostProcess;
  74213. private _setAutoClearAndTextureSharing;
  74214. private _depthOfFieldSceneObserver;
  74215. private _buildPipeline;
  74216. private _disposePostProcesses;
  74217. /**
  74218. * Adds a camera to the pipeline
  74219. * @param camera the camera to be added
  74220. */
  74221. addCamera(camera: Camera): void;
  74222. /**
  74223. * Removes a camera from the pipeline
  74224. * @param camera the camera to remove
  74225. */
  74226. removeCamera(camera: Camera): void;
  74227. /**
  74228. * Dispose of the pipeline and stop all post processes
  74229. */
  74230. dispose(): void;
  74231. /**
  74232. * Serialize the rendering pipeline (Used when exporting)
  74233. * @returns the serialized object
  74234. */
  74235. serialize(): any;
  74236. /**
  74237. * Parse the serialized pipeline
  74238. * @param source Source pipeline.
  74239. * @param scene The scene to load the pipeline to.
  74240. * @param rootUrl The URL of the serialized pipeline.
  74241. * @returns An instantiated pipeline from the serialized object.
  74242. */
  74243. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  74244. }
  74245. }
  74246. declare module "babylonjs/Shaders/lensHighlights.fragment" {
  74247. /** @hidden */
  74248. export var lensHighlightsPixelShader: {
  74249. name: string;
  74250. shader: string;
  74251. };
  74252. }
  74253. declare module "babylonjs/Shaders/depthOfField.fragment" {
  74254. /** @hidden */
  74255. export var depthOfFieldPixelShader: {
  74256. name: string;
  74257. shader: string;
  74258. };
  74259. }
  74260. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline" {
  74261. import { Camera } from "babylonjs/Cameras/camera";
  74262. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74263. import { Scene } from "babylonjs/scene";
  74264. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74265. import "babylonjs/Shaders/chromaticAberration.fragment";
  74266. import "babylonjs/Shaders/lensHighlights.fragment";
  74267. import "babylonjs/Shaders/depthOfField.fragment";
  74268. /**
  74269. * BABYLON.JS Chromatic Aberration GLSL Shader
  74270. * Author: Olivier Guyot
  74271. * Separates very slightly R, G and B colors on the edges of the screen
  74272. * Inspired by Francois Tarlier & Martins Upitis
  74273. */
  74274. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  74275. /**
  74276. * @ignore
  74277. * The chromatic aberration PostProcess id in the pipeline
  74278. */
  74279. LensChromaticAberrationEffect: string;
  74280. /**
  74281. * @ignore
  74282. * The highlights enhancing PostProcess id in the pipeline
  74283. */
  74284. HighlightsEnhancingEffect: string;
  74285. /**
  74286. * @ignore
  74287. * The depth-of-field PostProcess id in the pipeline
  74288. */
  74289. LensDepthOfFieldEffect: string;
  74290. private _scene;
  74291. private _depthTexture;
  74292. private _grainTexture;
  74293. private _chromaticAberrationPostProcess;
  74294. private _highlightsPostProcess;
  74295. private _depthOfFieldPostProcess;
  74296. private _edgeBlur;
  74297. private _grainAmount;
  74298. private _chromaticAberration;
  74299. private _distortion;
  74300. private _highlightsGain;
  74301. private _highlightsThreshold;
  74302. private _dofDistance;
  74303. private _dofAperture;
  74304. private _dofDarken;
  74305. private _dofPentagon;
  74306. private _blurNoise;
  74307. /**
  74308. * @constructor
  74309. *
  74310. * Effect parameters are as follow:
  74311. * {
  74312. * chromatic_aberration: number; // from 0 to x (1 for realism)
  74313. * edge_blur: number; // from 0 to x (1 for realism)
  74314. * distortion: number; // from 0 to x (1 for realism)
  74315. * grain_amount: number; // from 0 to 1
  74316. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  74317. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  74318. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  74319. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  74320. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  74321. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  74322. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  74323. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  74324. * }
  74325. * Note: if an effect parameter is unset, effect is disabled
  74326. *
  74327. * @param name The rendering pipeline name
  74328. * @param parameters - An object containing all parameters (see above)
  74329. * @param scene The scene linked to this pipeline
  74330. * @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)
  74331. * @param cameras The array of cameras that the rendering pipeline will be attached to
  74332. */
  74333. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  74334. /**
  74335. * Get the class name
  74336. * @returns "LensRenderingPipeline"
  74337. */
  74338. getClassName(): string;
  74339. /**
  74340. * Gets associated scene
  74341. */
  74342. get scene(): Scene;
  74343. /**
  74344. * Gets or sets the edge blur
  74345. */
  74346. get edgeBlur(): number;
  74347. set edgeBlur(value: number);
  74348. /**
  74349. * Gets or sets the grain amount
  74350. */
  74351. get grainAmount(): number;
  74352. set grainAmount(value: number);
  74353. /**
  74354. * Gets or sets the chromatic aberration amount
  74355. */
  74356. get chromaticAberration(): number;
  74357. set chromaticAberration(value: number);
  74358. /**
  74359. * Gets or sets the depth of field aperture
  74360. */
  74361. get dofAperture(): number;
  74362. set dofAperture(value: number);
  74363. /**
  74364. * Gets or sets the edge distortion
  74365. */
  74366. get edgeDistortion(): number;
  74367. set edgeDistortion(value: number);
  74368. /**
  74369. * Gets or sets the depth of field distortion
  74370. */
  74371. get dofDistortion(): number;
  74372. set dofDistortion(value: number);
  74373. /**
  74374. * Gets or sets the darken out of focus amount
  74375. */
  74376. get darkenOutOfFocus(): number;
  74377. set darkenOutOfFocus(value: number);
  74378. /**
  74379. * Gets or sets a boolean indicating if blur noise is enabled
  74380. */
  74381. get blurNoise(): boolean;
  74382. set blurNoise(value: boolean);
  74383. /**
  74384. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  74385. */
  74386. get pentagonBokeh(): boolean;
  74387. set pentagonBokeh(value: boolean);
  74388. /**
  74389. * Gets or sets the highlight grain amount
  74390. */
  74391. get highlightsGain(): number;
  74392. set highlightsGain(value: number);
  74393. /**
  74394. * Gets or sets the highlight threshold
  74395. */
  74396. get highlightsThreshold(): number;
  74397. set highlightsThreshold(value: number);
  74398. /**
  74399. * Sets the amount of blur at the edges
  74400. * @param amount blur amount
  74401. */
  74402. setEdgeBlur(amount: number): void;
  74403. /**
  74404. * Sets edge blur to 0
  74405. */
  74406. disableEdgeBlur(): void;
  74407. /**
  74408. * Sets the amout of grain
  74409. * @param amount Amount of grain
  74410. */
  74411. setGrainAmount(amount: number): void;
  74412. /**
  74413. * Set grain amount to 0
  74414. */
  74415. disableGrain(): void;
  74416. /**
  74417. * Sets the chromatic aberration amount
  74418. * @param amount amount of chromatic aberration
  74419. */
  74420. setChromaticAberration(amount: number): void;
  74421. /**
  74422. * Sets chromatic aberration amount to 0
  74423. */
  74424. disableChromaticAberration(): void;
  74425. /**
  74426. * Sets the EdgeDistortion amount
  74427. * @param amount amount of EdgeDistortion
  74428. */
  74429. setEdgeDistortion(amount: number): void;
  74430. /**
  74431. * Sets edge distortion to 0
  74432. */
  74433. disableEdgeDistortion(): void;
  74434. /**
  74435. * Sets the FocusDistance amount
  74436. * @param amount amount of FocusDistance
  74437. */
  74438. setFocusDistance(amount: number): void;
  74439. /**
  74440. * Disables depth of field
  74441. */
  74442. disableDepthOfField(): void;
  74443. /**
  74444. * Sets the Aperture amount
  74445. * @param amount amount of Aperture
  74446. */
  74447. setAperture(amount: number): void;
  74448. /**
  74449. * Sets the DarkenOutOfFocus amount
  74450. * @param amount amount of DarkenOutOfFocus
  74451. */
  74452. setDarkenOutOfFocus(amount: number): void;
  74453. private _pentagonBokehIsEnabled;
  74454. /**
  74455. * Creates a pentagon bokeh effect
  74456. */
  74457. enablePentagonBokeh(): void;
  74458. /**
  74459. * Disables the pentagon bokeh effect
  74460. */
  74461. disablePentagonBokeh(): void;
  74462. /**
  74463. * Enables noise blur
  74464. */
  74465. enableNoiseBlur(): void;
  74466. /**
  74467. * Disables noise blur
  74468. */
  74469. disableNoiseBlur(): void;
  74470. /**
  74471. * Sets the HighlightsGain amount
  74472. * @param amount amount of HighlightsGain
  74473. */
  74474. setHighlightsGain(amount: number): void;
  74475. /**
  74476. * Sets the HighlightsThreshold amount
  74477. * @param amount amount of HighlightsThreshold
  74478. */
  74479. setHighlightsThreshold(amount: number): void;
  74480. /**
  74481. * Disables highlights
  74482. */
  74483. disableHighlights(): void;
  74484. /**
  74485. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  74486. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  74487. */
  74488. dispose(disableDepthRender?: boolean): void;
  74489. private _createChromaticAberrationPostProcess;
  74490. private _createHighlightsPostProcess;
  74491. private _createDepthOfFieldPostProcess;
  74492. private _createGrainTexture;
  74493. }
  74494. }
  74495. declare module "babylonjs/Shaders/ssao2.fragment" {
  74496. /** @hidden */
  74497. export var ssao2PixelShader: {
  74498. name: string;
  74499. shader: string;
  74500. };
  74501. }
  74502. declare module "babylonjs/Shaders/ssaoCombine.fragment" {
  74503. /** @hidden */
  74504. export var ssaoCombinePixelShader: {
  74505. name: string;
  74506. shader: string;
  74507. };
  74508. }
  74509. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline" {
  74510. import { Camera } from "babylonjs/Cameras/camera";
  74511. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74512. import { Scene } from "babylonjs/scene";
  74513. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74514. import "babylonjs/Shaders/ssao2.fragment";
  74515. import "babylonjs/Shaders/ssaoCombine.fragment";
  74516. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  74517. /**
  74518. * Render pipeline to produce ssao effect
  74519. */
  74520. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  74521. /**
  74522. * @ignore
  74523. * The PassPostProcess id in the pipeline that contains the original scene color
  74524. */
  74525. SSAOOriginalSceneColorEffect: string;
  74526. /**
  74527. * @ignore
  74528. * The SSAO PostProcess id in the pipeline
  74529. */
  74530. SSAORenderEffect: string;
  74531. /**
  74532. * @ignore
  74533. * The horizontal blur PostProcess id in the pipeline
  74534. */
  74535. SSAOBlurHRenderEffect: string;
  74536. /**
  74537. * @ignore
  74538. * The vertical blur PostProcess id in the pipeline
  74539. */
  74540. SSAOBlurVRenderEffect: string;
  74541. /**
  74542. * @ignore
  74543. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  74544. */
  74545. SSAOCombineRenderEffect: string;
  74546. /**
  74547. * The output strength of the SSAO post-process. Default value is 1.0.
  74548. */
  74549. totalStrength: number;
  74550. /**
  74551. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  74552. */
  74553. maxZ: number;
  74554. /**
  74555. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  74556. */
  74557. minZAspect: number;
  74558. private _samples;
  74559. /**
  74560. * Number of samples used for the SSAO calculations. Default value is 8
  74561. */
  74562. set samples(n: number);
  74563. get samples(): number;
  74564. private _textureSamples;
  74565. /**
  74566. * Number of samples to use for antialiasing
  74567. */
  74568. set textureSamples(n: number);
  74569. get textureSamples(): number;
  74570. /**
  74571. * Force rendering the geometry through geometry buffer
  74572. */
  74573. private _forceGeometryBuffer;
  74574. /**
  74575. * Ratio object used for SSAO ratio and blur ratio
  74576. */
  74577. private _ratio;
  74578. /**
  74579. * Dynamically generated sphere sampler.
  74580. */
  74581. private _sampleSphere;
  74582. /**
  74583. * Blur filter offsets
  74584. */
  74585. private _samplerOffsets;
  74586. private _expensiveBlur;
  74587. /**
  74588. * If bilateral blur should be used
  74589. */
  74590. set expensiveBlur(b: boolean);
  74591. get expensiveBlur(): boolean;
  74592. /**
  74593. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  74594. */
  74595. radius: number;
  74596. /**
  74597. * The base color of the SSAO post-process
  74598. * The final result is "base + ssao" between [0, 1]
  74599. */
  74600. base: number;
  74601. /**
  74602. * Support test.
  74603. */
  74604. static get IsSupported(): boolean;
  74605. private _scene;
  74606. private _randomTexture;
  74607. private _originalColorPostProcess;
  74608. private _ssaoPostProcess;
  74609. private _blurHPostProcess;
  74610. private _blurVPostProcess;
  74611. private _ssaoCombinePostProcess;
  74612. private _prePassRenderer;
  74613. /**
  74614. * Gets active scene
  74615. */
  74616. get scene(): Scene;
  74617. /**
  74618. * @constructor
  74619. * @param name The rendering pipeline name
  74620. * @param scene The scene linked to this pipeline
  74621. * @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 }
  74622. * @param cameras The array of cameras that the rendering pipeline will be attached to
  74623. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  74624. */
  74625. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  74626. /**
  74627. * Get the class name
  74628. * @returns "SSAO2RenderingPipeline"
  74629. */
  74630. getClassName(): string;
  74631. /**
  74632. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  74633. */
  74634. dispose(disableGeometryBufferRenderer?: boolean): void;
  74635. private _createBlurPostProcess;
  74636. /** @hidden */
  74637. _rebuild(): void;
  74638. private _bits;
  74639. private _radicalInverse_VdC;
  74640. private _hammersley;
  74641. private _hemisphereSample_uniform;
  74642. private _generateHemisphere;
  74643. private _getDefinesForSSAO;
  74644. private _createSSAOPostProcess;
  74645. private _createSSAOCombinePostProcess;
  74646. private _createRandomTexture;
  74647. /**
  74648. * Serialize the rendering pipeline (Used when exporting)
  74649. * @returns the serialized object
  74650. */
  74651. serialize(): any;
  74652. /**
  74653. * Parse the serialized pipeline
  74654. * @param source Source pipeline.
  74655. * @param scene The scene to load the pipeline to.
  74656. * @param rootUrl The URL of the serialized pipeline.
  74657. * @returns An instantiated pipeline from the serialized object.
  74658. */
  74659. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  74660. /**
  74661. * Sets the required values to the prepass renderer.
  74662. * @param prePassRenderer defines the prepass renderer to setup
  74663. * @returns true if the pre pass is needed.
  74664. */
  74665. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  74666. }
  74667. }
  74668. declare module "babylonjs/Shaders/ssao.fragment" {
  74669. /** @hidden */
  74670. export var ssaoPixelShader: {
  74671. name: string;
  74672. shader: string;
  74673. };
  74674. }
  74675. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline" {
  74676. import { Camera } from "babylonjs/Cameras/camera";
  74677. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74678. import { Scene } from "babylonjs/scene";
  74679. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74680. import "babylonjs/Shaders/ssao.fragment";
  74681. import "babylonjs/Shaders/ssaoCombine.fragment";
  74682. /**
  74683. * Render pipeline to produce ssao effect
  74684. */
  74685. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  74686. /**
  74687. * @ignore
  74688. * The PassPostProcess id in the pipeline that contains the original scene color
  74689. */
  74690. SSAOOriginalSceneColorEffect: string;
  74691. /**
  74692. * @ignore
  74693. * The SSAO PostProcess id in the pipeline
  74694. */
  74695. SSAORenderEffect: string;
  74696. /**
  74697. * @ignore
  74698. * The horizontal blur PostProcess id in the pipeline
  74699. */
  74700. SSAOBlurHRenderEffect: string;
  74701. /**
  74702. * @ignore
  74703. * The vertical blur PostProcess id in the pipeline
  74704. */
  74705. SSAOBlurVRenderEffect: string;
  74706. /**
  74707. * @ignore
  74708. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  74709. */
  74710. SSAOCombineRenderEffect: string;
  74711. /**
  74712. * The output strength of the SSAO post-process. Default value is 1.0.
  74713. */
  74714. totalStrength: number;
  74715. /**
  74716. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  74717. */
  74718. radius: number;
  74719. /**
  74720. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  74721. * Must not be equal to fallOff and superior to fallOff.
  74722. * Default value is 0.0075
  74723. */
  74724. area: number;
  74725. /**
  74726. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  74727. * Must not be equal to area and inferior to area.
  74728. * Default value is 0.000001
  74729. */
  74730. fallOff: number;
  74731. /**
  74732. * The base color of the SSAO post-process
  74733. * The final result is "base + ssao" between [0, 1]
  74734. */
  74735. base: number;
  74736. private _scene;
  74737. private _depthTexture;
  74738. private _randomTexture;
  74739. private _originalColorPostProcess;
  74740. private _ssaoPostProcess;
  74741. private _blurHPostProcess;
  74742. private _blurVPostProcess;
  74743. private _ssaoCombinePostProcess;
  74744. private _firstUpdate;
  74745. /**
  74746. * Gets active scene
  74747. */
  74748. get scene(): Scene;
  74749. /**
  74750. * @constructor
  74751. * @param name - The rendering pipeline name
  74752. * @param scene - The scene linked to this pipeline
  74753. * @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 }
  74754. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  74755. */
  74756. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  74757. /**
  74758. * Get the class name
  74759. * @returns "SSAORenderingPipeline"
  74760. */
  74761. getClassName(): string;
  74762. /**
  74763. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  74764. */
  74765. dispose(disableDepthRender?: boolean): void;
  74766. private _createBlurPostProcess;
  74767. /** @hidden */
  74768. _rebuild(): void;
  74769. private _createSSAOPostProcess;
  74770. private _createSSAOCombinePostProcess;
  74771. private _createRandomTexture;
  74772. }
  74773. }
  74774. declare module "babylonjs/Shaders/screenSpaceReflection.fragment" {
  74775. /** @hidden */
  74776. export var screenSpaceReflectionPixelShader: {
  74777. name: string;
  74778. shader: string;
  74779. };
  74780. }
  74781. declare module "babylonjs/PostProcesses/screenSpaceReflectionPostProcess" {
  74782. import { Nullable } from "babylonjs/types";
  74783. import { Camera } from "babylonjs/Cameras/camera";
  74784. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  74785. import "babylonjs/Shaders/screenSpaceReflection.fragment";
  74786. import { Engine } from "babylonjs/Engines/engine";
  74787. import { Scene } from "babylonjs/scene";
  74788. /**
  74789. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  74790. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  74791. */
  74792. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  74793. /**
  74794. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  74795. */
  74796. threshold: number;
  74797. /**
  74798. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  74799. */
  74800. strength: number;
  74801. /**
  74802. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  74803. */
  74804. reflectionSpecularFalloffExponent: number;
  74805. /**
  74806. * 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]
  74807. */
  74808. step: number;
  74809. /**
  74810. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  74811. */
  74812. roughnessFactor: number;
  74813. private _geometryBufferRenderer;
  74814. private _enableSmoothReflections;
  74815. private _reflectionSamples;
  74816. private _smoothSteps;
  74817. /**
  74818. * Gets a string identifying the name of the class
  74819. * @returns "ScreenSpaceReflectionPostProcess" string
  74820. */
  74821. getClassName(): string;
  74822. /**
  74823. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  74824. * @param name The name of the effect.
  74825. * @param scene The scene containing the objects to calculate reflections.
  74826. * @param options The required width/height ratio to downsize to before computing the render pass.
  74827. * @param camera The camera to apply the render pass to.
  74828. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74829. * @param engine The engine which the post process will be applied. (default: current engine)
  74830. * @param reusable If the post process can be reused on the same frame. (default: false)
  74831. * @param textureType Type of textures used when performing the post process. (default: 0)
  74832. * @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)
  74833. */
  74834. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  74835. /**
  74836. * Gets wether or not smoothing reflections is enabled.
  74837. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  74838. */
  74839. get enableSmoothReflections(): boolean;
  74840. /**
  74841. * Sets wether or not smoothing reflections is enabled.
  74842. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  74843. */
  74844. set enableSmoothReflections(enabled: boolean);
  74845. /**
  74846. * Gets the number of samples taken while computing reflections. More samples count is high,
  74847. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  74848. */
  74849. get reflectionSamples(): number;
  74850. /**
  74851. * Sets the number of samples taken while computing reflections. More samples count is high,
  74852. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  74853. */
  74854. set reflectionSamples(samples: number);
  74855. /**
  74856. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  74857. * more the post-process will require GPU power and can generate a drop in FPS.
  74858. * Default value (5.0) work pretty well in all cases but can be adjusted.
  74859. */
  74860. get smoothSteps(): number;
  74861. set smoothSteps(steps: number);
  74862. private _updateEffectDefines;
  74863. /** @hidden */
  74864. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceReflectionPostProcess;
  74865. }
  74866. }
  74867. declare module "babylonjs/Shaders/standard.fragment" {
  74868. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  74869. /** @hidden */
  74870. export var standardPixelShader: {
  74871. name: string;
  74872. shader: string;
  74873. };
  74874. }
  74875. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline" {
  74876. import { Nullable } from "babylonjs/types";
  74877. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  74878. import { Camera } from "babylonjs/Cameras/camera";
  74879. import { Texture } from "babylonjs/Materials/Textures/texture";
  74880. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  74881. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74882. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  74883. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  74884. import { IDisposable } from "babylonjs/scene";
  74885. import { SpotLight } from "babylonjs/Lights/spotLight";
  74886. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  74887. import { Scene } from "babylonjs/scene";
  74888. import { ScreenSpaceReflectionPostProcess } from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  74889. import { Animation } from "babylonjs/Animations/animation";
  74890. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74891. import "babylonjs/Shaders/standard.fragment";
  74892. /**
  74893. * Standard rendering pipeline
  74894. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  74895. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  74896. */
  74897. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  74898. /**
  74899. * Public members
  74900. */
  74901. /**
  74902. * Post-process which contains the original scene color before the pipeline applies all the effects
  74903. */
  74904. originalPostProcess: Nullable<PostProcess>;
  74905. /**
  74906. * Post-process used to down scale an image x4
  74907. */
  74908. downSampleX4PostProcess: Nullable<PostProcess>;
  74909. /**
  74910. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  74911. */
  74912. brightPassPostProcess: Nullable<PostProcess>;
  74913. /**
  74914. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  74915. */
  74916. blurHPostProcesses: PostProcess[];
  74917. /**
  74918. * Post-process array storing all the vertical blur post-processes used by the pipeline
  74919. */
  74920. blurVPostProcesses: PostProcess[];
  74921. /**
  74922. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  74923. */
  74924. textureAdderPostProcess: Nullable<PostProcess>;
  74925. /**
  74926. * Post-process used to create volumetric lighting effect
  74927. */
  74928. volumetricLightPostProcess: Nullable<PostProcess>;
  74929. /**
  74930. * Post-process used to smooth the previous volumetric light post-process on the X axis
  74931. */
  74932. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  74933. /**
  74934. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  74935. */
  74936. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  74937. /**
  74938. * Post-process used to merge the volumetric light effect and the real scene color
  74939. */
  74940. volumetricLightMergePostProces: Nullable<PostProcess>;
  74941. /**
  74942. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  74943. */
  74944. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  74945. /**
  74946. * Base post-process used to calculate the average luminance of the final image for HDR
  74947. */
  74948. luminancePostProcess: Nullable<PostProcess>;
  74949. /**
  74950. * Post-processes used to create down sample post-processes in order to get
  74951. * the average luminance of the final image for HDR
  74952. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  74953. */
  74954. luminanceDownSamplePostProcesses: PostProcess[];
  74955. /**
  74956. * Post-process used to create a HDR effect (light adaptation)
  74957. */
  74958. hdrPostProcess: Nullable<PostProcess>;
  74959. /**
  74960. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  74961. */
  74962. textureAdderFinalPostProcess: Nullable<PostProcess>;
  74963. /**
  74964. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  74965. */
  74966. lensFlareFinalPostProcess: Nullable<PostProcess>;
  74967. /**
  74968. * Post-process used to merge the final HDR post-process and the real scene color
  74969. */
  74970. hdrFinalPostProcess: Nullable<PostProcess>;
  74971. /**
  74972. * Post-process used to create a lens flare effect
  74973. */
  74974. lensFlarePostProcess: Nullable<PostProcess>;
  74975. /**
  74976. * Post-process that merges the result of the lens flare post-process and the real scene color
  74977. */
  74978. lensFlareComposePostProcess: Nullable<PostProcess>;
  74979. /**
  74980. * Post-process used to create a motion blur effect
  74981. */
  74982. motionBlurPostProcess: Nullable<PostProcess>;
  74983. /**
  74984. * Post-process used to create a depth of field effect
  74985. */
  74986. depthOfFieldPostProcess: Nullable<PostProcess>;
  74987. /**
  74988. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  74989. */
  74990. fxaaPostProcess: Nullable<FxaaPostProcess>;
  74991. /**
  74992. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  74993. */
  74994. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  74995. /**
  74996. * Represents the brightness threshold in order to configure the illuminated surfaces
  74997. */
  74998. brightThreshold: number;
  74999. /**
  75000. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  75001. */
  75002. blurWidth: number;
  75003. /**
  75004. * Sets if the blur for highlighted surfaces must be only horizontal
  75005. */
  75006. horizontalBlur: boolean;
  75007. /**
  75008. * Gets the overall exposure used by the pipeline
  75009. */
  75010. get exposure(): number;
  75011. /**
  75012. * Sets the overall exposure used by the pipeline
  75013. */
  75014. set exposure(value: number);
  75015. /**
  75016. * Texture used typically to simulate "dirty" on camera lens
  75017. */
  75018. lensTexture: Nullable<Texture>;
  75019. /**
  75020. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  75021. */
  75022. volumetricLightCoefficient: number;
  75023. /**
  75024. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  75025. */
  75026. volumetricLightPower: number;
  75027. /**
  75028. * Used the set the blur intensity to smooth the volumetric lights
  75029. */
  75030. volumetricLightBlurScale: number;
  75031. /**
  75032. * Light (spot or directional) used to generate the volumetric lights rays
  75033. * The source light must have a shadow generate so the pipeline can get its
  75034. * depth map
  75035. */
  75036. sourceLight: Nullable<SpotLight | DirectionalLight>;
  75037. /**
  75038. * For eye adaptation, represents the minimum luminance the eye can see
  75039. */
  75040. hdrMinimumLuminance: number;
  75041. /**
  75042. * For eye adaptation, represents the decrease luminance speed
  75043. */
  75044. hdrDecreaseRate: number;
  75045. /**
  75046. * For eye adaptation, represents the increase luminance speed
  75047. */
  75048. hdrIncreaseRate: number;
  75049. /**
  75050. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  75051. */
  75052. get hdrAutoExposure(): boolean;
  75053. /**
  75054. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  75055. */
  75056. set hdrAutoExposure(value: boolean);
  75057. /**
  75058. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  75059. */
  75060. lensColorTexture: Nullable<Texture>;
  75061. /**
  75062. * The overall strengh for the lens flare effect
  75063. */
  75064. lensFlareStrength: number;
  75065. /**
  75066. * Dispersion coefficient for lens flare ghosts
  75067. */
  75068. lensFlareGhostDispersal: number;
  75069. /**
  75070. * Main lens flare halo width
  75071. */
  75072. lensFlareHaloWidth: number;
  75073. /**
  75074. * Based on the lens distortion effect, defines how much the lens flare result
  75075. * is distorted
  75076. */
  75077. lensFlareDistortionStrength: number;
  75078. /**
  75079. * Configures the blur intensity used for for lens flare (halo)
  75080. */
  75081. lensFlareBlurWidth: number;
  75082. /**
  75083. * Lens star texture must be used to simulate rays on the flares and is available
  75084. * in the documentation
  75085. */
  75086. lensStarTexture: Nullable<Texture>;
  75087. /**
  75088. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  75089. * flare effect by taking account of the dirt texture
  75090. */
  75091. lensFlareDirtTexture: Nullable<Texture>;
  75092. /**
  75093. * Represents the focal length for the depth of field effect
  75094. */
  75095. depthOfFieldDistance: number;
  75096. /**
  75097. * Represents the blur intensity for the blurred part of the depth of field effect
  75098. */
  75099. depthOfFieldBlurWidth: number;
  75100. /**
  75101. * Gets how much the image is blurred by the movement while using the motion blur post-process
  75102. */
  75103. get motionStrength(): number;
  75104. /**
  75105. * Sets how much the image is blurred by the movement while using the motion blur post-process
  75106. */
  75107. set motionStrength(strength: number);
  75108. /**
  75109. * Gets wether or not the motion blur post-process is object based or screen based.
  75110. */
  75111. get objectBasedMotionBlur(): boolean;
  75112. /**
  75113. * Sets wether or not the motion blur post-process should be object based or screen based
  75114. */
  75115. set objectBasedMotionBlur(value: boolean);
  75116. /**
  75117. * List of animations for the pipeline (IAnimatable implementation)
  75118. */
  75119. animations: Animation[];
  75120. /**
  75121. * Private members
  75122. */
  75123. private _scene;
  75124. private _currentDepthOfFieldSource;
  75125. private _basePostProcess;
  75126. private _fixedExposure;
  75127. private _currentExposure;
  75128. private _hdrAutoExposure;
  75129. private _hdrCurrentLuminance;
  75130. private _motionStrength;
  75131. private _isObjectBasedMotionBlur;
  75132. private _floatTextureType;
  75133. private _camerasToBeAttached;
  75134. private _ratio;
  75135. private _bloomEnabled;
  75136. private _depthOfFieldEnabled;
  75137. private _vlsEnabled;
  75138. private _lensFlareEnabled;
  75139. private _hdrEnabled;
  75140. private _motionBlurEnabled;
  75141. private _fxaaEnabled;
  75142. private _screenSpaceReflectionsEnabled;
  75143. private _motionBlurSamples;
  75144. private _volumetricLightStepsCount;
  75145. private _samples;
  75146. /**
  75147. * @ignore
  75148. * Specifies if the bloom pipeline is enabled
  75149. */
  75150. get BloomEnabled(): boolean;
  75151. set BloomEnabled(enabled: boolean);
  75152. /**
  75153. * @ignore
  75154. * Specifies if the depth of field pipeline is enabed
  75155. */
  75156. get DepthOfFieldEnabled(): boolean;
  75157. set DepthOfFieldEnabled(enabled: boolean);
  75158. /**
  75159. * @ignore
  75160. * Specifies if the lens flare pipeline is enabed
  75161. */
  75162. get LensFlareEnabled(): boolean;
  75163. set LensFlareEnabled(enabled: boolean);
  75164. /**
  75165. * @ignore
  75166. * Specifies if the HDR pipeline is enabled
  75167. */
  75168. get HDREnabled(): boolean;
  75169. set HDREnabled(enabled: boolean);
  75170. /**
  75171. * @ignore
  75172. * Specifies if the volumetric lights scattering effect is enabled
  75173. */
  75174. get VLSEnabled(): boolean;
  75175. set VLSEnabled(enabled: boolean);
  75176. /**
  75177. * @ignore
  75178. * Specifies if the motion blur effect is enabled
  75179. */
  75180. get MotionBlurEnabled(): boolean;
  75181. set MotionBlurEnabled(enabled: boolean);
  75182. /**
  75183. * Specifies if anti-aliasing is enabled
  75184. */
  75185. get fxaaEnabled(): boolean;
  75186. set fxaaEnabled(enabled: boolean);
  75187. /**
  75188. * Specifies if screen space reflections are enabled.
  75189. */
  75190. get screenSpaceReflectionsEnabled(): boolean;
  75191. set screenSpaceReflectionsEnabled(enabled: boolean);
  75192. /**
  75193. * Specifies the number of steps used to calculate the volumetric lights
  75194. * Typically in interval [50, 200]
  75195. */
  75196. get volumetricLightStepsCount(): number;
  75197. set volumetricLightStepsCount(count: number);
  75198. /**
  75199. * Specifies the number of samples used for the motion blur effect
  75200. * Typically in interval [16, 64]
  75201. */
  75202. get motionBlurSamples(): number;
  75203. set motionBlurSamples(samples: number);
  75204. /**
  75205. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  75206. */
  75207. get samples(): number;
  75208. set samples(sampleCount: number);
  75209. /**
  75210. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  75211. * @constructor
  75212. * @param name The rendering pipeline name
  75213. * @param scene The scene linked to this pipeline
  75214. * @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)
  75215. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  75216. * @param cameras The array of cameras that the rendering pipeline will be attached to
  75217. */
  75218. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  75219. private _buildPipeline;
  75220. private _createDownSampleX4PostProcess;
  75221. private _createBrightPassPostProcess;
  75222. private _createBlurPostProcesses;
  75223. private _createTextureAdderPostProcess;
  75224. private _createVolumetricLightPostProcess;
  75225. private _createLuminancePostProcesses;
  75226. private _createHdrPostProcess;
  75227. private _createLensFlarePostProcess;
  75228. private _createDepthOfFieldPostProcess;
  75229. private _createMotionBlurPostProcess;
  75230. private _getDepthTexture;
  75231. private _disposePostProcesses;
  75232. /**
  75233. * Dispose of the pipeline and stop all post processes
  75234. */
  75235. dispose(): void;
  75236. /**
  75237. * Serialize the rendering pipeline (Used when exporting)
  75238. * @returns the serialized object
  75239. */
  75240. serialize(): any;
  75241. /**
  75242. * Parse the serialized pipeline
  75243. * @param source Source pipeline.
  75244. * @param scene The scene to load the pipeline to.
  75245. * @param rootUrl The URL of the serialized pipeline.
  75246. * @returns An instantiated pipeline from the serialized object.
  75247. */
  75248. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  75249. /**
  75250. * Luminance steps
  75251. */
  75252. static LuminanceSteps: number;
  75253. }
  75254. }
  75255. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/index" {
  75256. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline";
  75257. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline";
  75258. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline";
  75259. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline";
  75260. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline";
  75261. }
  75262. declare module "babylonjs/PostProcesses/RenderPipeline/index" {
  75263. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/index";
  75264. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  75265. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  75266. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  75267. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  75268. }
  75269. declare module "babylonjs/Shaders/stereoscopicInterlace.fragment" {
  75270. /** @hidden */
  75271. export var stereoscopicInterlacePixelShader: {
  75272. name: string;
  75273. shader: string;
  75274. };
  75275. }
  75276. declare module "babylonjs/PostProcesses/stereoscopicInterlacePostProcess" {
  75277. import { Camera } from "babylonjs/Cameras/camera";
  75278. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75279. import { Engine } from "babylonjs/Engines/engine";
  75280. import "babylonjs/Shaders/stereoscopicInterlace.fragment";
  75281. /**
  75282. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  75283. */
  75284. export class StereoscopicInterlacePostProcessI extends PostProcess {
  75285. private _stepSize;
  75286. private _passedProcess;
  75287. /**
  75288. * Gets a string identifying the name of the class
  75289. * @returns "StereoscopicInterlacePostProcessI" string
  75290. */
  75291. getClassName(): string;
  75292. /**
  75293. * Initializes a StereoscopicInterlacePostProcessI
  75294. * @param name The name of the effect.
  75295. * @param rigCameras The rig cameras to be appled to the post process
  75296. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  75297. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  75298. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75299. * @param engine The engine which the post process will be applied. (default: current engine)
  75300. * @param reusable If the post process can be reused on the same frame. (default: false)
  75301. */
  75302. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  75303. }
  75304. /**
  75305. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  75306. */
  75307. export class StereoscopicInterlacePostProcess extends PostProcess {
  75308. private _stepSize;
  75309. private _passedProcess;
  75310. /**
  75311. * Gets a string identifying the name of the class
  75312. * @returns "StereoscopicInterlacePostProcess" string
  75313. */
  75314. getClassName(): string;
  75315. /**
  75316. * Initializes a StereoscopicInterlacePostProcess
  75317. * @param name The name of the effect.
  75318. * @param rigCameras The rig cameras to be appled to the post process
  75319. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  75320. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75321. * @param engine The engine which the post process will be applied. (default: current engine)
  75322. * @param reusable If the post process can be reused on the same frame. (default: false)
  75323. */
  75324. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  75325. }
  75326. }
  75327. declare module "babylonjs/Shaders/tonemap.fragment" {
  75328. /** @hidden */
  75329. export var tonemapPixelShader: {
  75330. name: string;
  75331. shader: string;
  75332. };
  75333. }
  75334. declare module "babylonjs/PostProcesses/tonemapPostProcess" {
  75335. import { Camera } from "babylonjs/Cameras/camera";
  75336. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75337. import "babylonjs/Shaders/tonemap.fragment";
  75338. import { Engine } from "babylonjs/Engines/engine";
  75339. /** Defines operator used for tonemapping */
  75340. export enum TonemappingOperator {
  75341. /** Hable */
  75342. Hable = 0,
  75343. /** Reinhard */
  75344. Reinhard = 1,
  75345. /** HejiDawson */
  75346. HejiDawson = 2,
  75347. /** Photographic */
  75348. Photographic = 3
  75349. }
  75350. /**
  75351. * Defines a post process to apply tone mapping
  75352. */
  75353. export class TonemapPostProcess extends PostProcess {
  75354. private _operator;
  75355. /** Defines the required exposure adjustement */
  75356. exposureAdjustment: number;
  75357. /**
  75358. * Gets a string identifying the name of the class
  75359. * @returns "TonemapPostProcess" string
  75360. */
  75361. getClassName(): string;
  75362. /**
  75363. * Creates a new TonemapPostProcess
  75364. * @param name defines the name of the postprocess
  75365. * @param _operator defines the operator to use
  75366. * @param exposureAdjustment defines the required exposure adjustement
  75367. * @param camera defines the camera to use (can be null)
  75368. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  75369. * @param engine defines the hosting engine (can be ignore if camera is set)
  75370. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  75371. */
  75372. constructor(name: string, _operator: TonemappingOperator,
  75373. /** Defines the required exposure adjustement */
  75374. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  75375. }
  75376. }
  75377. declare module "babylonjs/Shaders/volumetricLightScattering.fragment" {
  75378. /** @hidden */
  75379. export var volumetricLightScatteringPixelShader: {
  75380. name: string;
  75381. shader: string;
  75382. };
  75383. }
  75384. declare module "babylonjs/Shaders/volumetricLightScatteringPass.vertex" {
  75385. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  75386. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  75387. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  75388. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  75389. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  75390. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  75391. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  75392. /** @hidden */
  75393. export var volumetricLightScatteringPassVertexShader: {
  75394. name: string;
  75395. shader: string;
  75396. };
  75397. }
  75398. declare module "babylonjs/Shaders/volumetricLightScatteringPass.fragment" {
  75399. /** @hidden */
  75400. export var volumetricLightScatteringPassPixelShader: {
  75401. name: string;
  75402. shader: string;
  75403. };
  75404. }
  75405. declare module "babylonjs/PostProcesses/volumetricLightScatteringPostProcess" {
  75406. import { Vector3 } from "babylonjs/Maths/math.vector";
  75407. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  75408. import { Mesh } from "babylonjs/Meshes/mesh";
  75409. import { Camera } from "babylonjs/Cameras/camera";
  75410. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  75411. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75412. import { Scene } from "babylonjs/scene";
  75413. import "babylonjs/Meshes/Builders/planeBuilder";
  75414. import "babylonjs/Shaders/depth.vertex";
  75415. import "babylonjs/Shaders/volumetricLightScattering.fragment";
  75416. import "babylonjs/Shaders/volumetricLightScatteringPass.vertex";
  75417. import "babylonjs/Shaders/volumetricLightScatteringPass.fragment";
  75418. import { Engine } from "babylonjs/Engines/engine";
  75419. /**
  75420. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  75421. */
  75422. export class VolumetricLightScatteringPostProcess extends PostProcess {
  75423. private _volumetricLightScatteringPass;
  75424. private _volumetricLightScatteringRTT;
  75425. private _viewPort;
  75426. private _screenCoordinates;
  75427. private _cachedDefines;
  75428. /**
  75429. * If not undefined, the mesh position is computed from the attached node position
  75430. */
  75431. attachedNode: {
  75432. position: Vector3;
  75433. };
  75434. /**
  75435. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  75436. */
  75437. customMeshPosition: Vector3;
  75438. /**
  75439. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  75440. */
  75441. useCustomMeshPosition: boolean;
  75442. /**
  75443. * If the post-process should inverse the light scattering direction
  75444. */
  75445. invert: boolean;
  75446. /**
  75447. * The internal mesh used by the post-process
  75448. */
  75449. mesh: Mesh;
  75450. /**
  75451. * @hidden
  75452. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  75453. */
  75454. get useDiffuseColor(): boolean;
  75455. set useDiffuseColor(useDiffuseColor: boolean);
  75456. /**
  75457. * Array containing the excluded meshes not rendered in the internal pass
  75458. */
  75459. excludedMeshes: AbstractMesh[];
  75460. /**
  75461. * Controls the overall intensity of the post-process
  75462. */
  75463. exposure: number;
  75464. /**
  75465. * Dissipates each sample's contribution in range [0, 1]
  75466. */
  75467. decay: number;
  75468. /**
  75469. * Controls the overall intensity of each sample
  75470. */
  75471. weight: number;
  75472. /**
  75473. * Controls the density of each sample
  75474. */
  75475. density: number;
  75476. /**
  75477. * @constructor
  75478. * @param name The post-process name
  75479. * @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)
  75480. * @param camera The camera that the post-process will be attached to
  75481. * @param mesh The mesh used to create the light scattering
  75482. * @param samples The post-process quality, default 100
  75483. * @param samplingModeThe post-process filtering mode
  75484. * @param engine The babylon engine
  75485. * @param reusable If the post-process is reusable
  75486. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  75487. */
  75488. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  75489. /**
  75490. * Returns the string "VolumetricLightScatteringPostProcess"
  75491. * @returns "VolumetricLightScatteringPostProcess"
  75492. */
  75493. getClassName(): string;
  75494. private _isReady;
  75495. /**
  75496. * Sets the new light position for light scattering effect
  75497. * @param position The new custom light position
  75498. */
  75499. setCustomMeshPosition(position: Vector3): void;
  75500. /**
  75501. * Returns the light position for light scattering effect
  75502. * @return Vector3 The custom light position
  75503. */
  75504. getCustomMeshPosition(): Vector3;
  75505. /**
  75506. * Disposes the internal assets and detaches the post-process from the camera
  75507. */
  75508. dispose(camera: Camera): void;
  75509. /**
  75510. * Returns the render target texture used by the post-process
  75511. * @return the render target texture used by the post-process
  75512. */
  75513. getPass(): RenderTargetTexture;
  75514. private _meshExcluded;
  75515. private _createPass;
  75516. private _updateMeshScreenCoordinates;
  75517. /**
  75518. * Creates a default mesh for the Volumeric Light Scattering post-process
  75519. * @param name The mesh name
  75520. * @param scene The scene where to create the mesh
  75521. * @return the default mesh
  75522. */
  75523. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  75524. }
  75525. }
  75526. declare module "babylonjs/Shaders/screenSpaceCurvature.fragment" {
  75527. /** @hidden */
  75528. export var screenSpaceCurvaturePixelShader: {
  75529. name: string;
  75530. shader: string;
  75531. };
  75532. }
  75533. declare module "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess" {
  75534. import { Nullable } from "babylonjs/types";
  75535. import { Camera } from "babylonjs/Cameras/camera";
  75536. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  75537. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  75538. import "babylonjs/Shaders/screenSpaceCurvature.fragment";
  75539. import { Engine } from "babylonjs/Engines/engine";
  75540. import { Scene } from "babylonjs/scene";
  75541. /**
  75542. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  75543. */
  75544. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  75545. /**
  75546. * Defines how much ridge the curvature effect displays.
  75547. */
  75548. ridge: number;
  75549. /**
  75550. * Defines how much valley the curvature effect displays.
  75551. */
  75552. valley: number;
  75553. private _geometryBufferRenderer;
  75554. /**
  75555. * Gets a string identifying the name of the class
  75556. * @returns "ScreenSpaceCurvaturePostProcess" string
  75557. */
  75558. getClassName(): string;
  75559. /**
  75560. * Creates a new instance ScreenSpaceCurvaturePostProcess
  75561. * @param name The name of the effect.
  75562. * @param scene The scene containing the objects to blur according to their velocity.
  75563. * @param options The required width/height ratio to downsize to before computing the render pass.
  75564. * @param camera The camera to apply the render pass to.
  75565. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75566. * @param engine The engine which the post process will be applied. (default: current engine)
  75567. * @param reusable If the post process can be reused on the same frame. (default: false)
  75568. * @param textureType Type of textures used when performing the post process. (default: 0)
  75569. * @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)
  75570. */
  75571. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  75572. /**
  75573. * Support test.
  75574. */
  75575. static get IsSupported(): boolean;
  75576. /** @hidden */
  75577. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  75578. }
  75579. }
  75580. declare module "babylonjs/PostProcesses/index" {
  75581. export * from "babylonjs/PostProcesses/anaglyphPostProcess";
  75582. export * from "babylonjs/PostProcesses/blackAndWhitePostProcess";
  75583. export * from "babylonjs/PostProcesses/bloomEffect";
  75584. export * from "babylonjs/PostProcesses/bloomMergePostProcess";
  75585. export * from "babylonjs/PostProcesses/blurPostProcess";
  75586. export * from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  75587. export * from "babylonjs/PostProcesses/circleOfConfusionPostProcess";
  75588. export * from "babylonjs/PostProcesses/colorCorrectionPostProcess";
  75589. export * from "babylonjs/PostProcesses/convolutionPostProcess";
  75590. export * from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  75591. export * from "babylonjs/PostProcesses/depthOfFieldEffect";
  75592. export * from "babylonjs/PostProcesses/depthOfFieldMergePostProcess";
  75593. export * from "babylonjs/PostProcesses/displayPassPostProcess";
  75594. export * from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  75595. export * from "babylonjs/PostProcesses/filterPostProcess";
  75596. export * from "babylonjs/PostProcesses/fxaaPostProcess";
  75597. export * from "babylonjs/PostProcesses/grainPostProcess";
  75598. export * from "babylonjs/PostProcesses/highlightsPostProcess";
  75599. export * from "babylonjs/PostProcesses/imageProcessingPostProcess";
  75600. export * from "babylonjs/PostProcesses/motionBlurPostProcess";
  75601. export * from "babylonjs/PostProcesses/passPostProcess";
  75602. export * from "babylonjs/PostProcesses/postProcess";
  75603. export * from "babylonjs/PostProcesses/postProcessManager";
  75604. export * from "babylonjs/PostProcesses/refractionPostProcess";
  75605. export * from "babylonjs/PostProcesses/RenderPipeline/index";
  75606. export * from "babylonjs/PostProcesses/sharpenPostProcess";
  75607. export * from "babylonjs/PostProcesses/stereoscopicInterlacePostProcess";
  75608. export * from "babylonjs/PostProcesses/tonemapPostProcess";
  75609. export * from "babylonjs/PostProcesses/volumetricLightScatteringPostProcess";
  75610. export * from "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess";
  75611. export * from "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess";
  75612. export * from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  75613. export * from "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess";
  75614. }
  75615. declare module "babylonjs/Probes/index" {
  75616. export * from "babylonjs/Probes/reflectionProbe";
  75617. }
  75618. declare module "babylonjs/Rendering/boundingBoxRenderer" {
  75619. import { Scene } from "babylonjs/scene";
  75620. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  75621. import { SmartArray } from "babylonjs/Misc/smartArray";
  75622. import { ISceneComponent } from "babylonjs/sceneComponent";
  75623. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  75624. import "babylonjs/Meshes/Builders/boxBuilder";
  75625. import "babylonjs/Shaders/color.fragment";
  75626. import "babylonjs/Shaders/color.vertex";
  75627. import { Color3 } from "babylonjs/Maths/math.color";
  75628. import { Observable } from "babylonjs/Misc/observable";
  75629. module "babylonjs/scene" {
  75630. interface Scene {
  75631. /** @hidden (Backing field) */
  75632. _boundingBoxRenderer: BoundingBoxRenderer;
  75633. /** @hidden (Backing field) */
  75634. _forceShowBoundingBoxes: boolean;
  75635. /**
  75636. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  75637. */
  75638. forceShowBoundingBoxes: boolean;
  75639. /**
  75640. * Gets the bounding box renderer associated with the scene
  75641. * @returns a BoundingBoxRenderer
  75642. */
  75643. getBoundingBoxRenderer(): BoundingBoxRenderer;
  75644. }
  75645. }
  75646. module "babylonjs/Meshes/abstractMesh" {
  75647. interface AbstractMesh {
  75648. /** @hidden (Backing field) */
  75649. _showBoundingBox: boolean;
  75650. /**
  75651. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  75652. */
  75653. showBoundingBox: boolean;
  75654. }
  75655. }
  75656. /**
  75657. * Component responsible of rendering the bounding box of the meshes in a scene.
  75658. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  75659. */
  75660. export class BoundingBoxRenderer implements ISceneComponent {
  75661. /**
  75662. * The component name helpfull to identify the component in the list of scene components.
  75663. */
  75664. readonly name: string;
  75665. /**
  75666. * The scene the component belongs to.
  75667. */
  75668. scene: Scene;
  75669. /**
  75670. * Color of the bounding box lines placed in front of an object
  75671. */
  75672. frontColor: Color3;
  75673. /**
  75674. * Color of the bounding box lines placed behind an object
  75675. */
  75676. backColor: Color3;
  75677. /**
  75678. * Defines if the renderer should show the back lines or not
  75679. */
  75680. showBackLines: boolean;
  75681. /**
  75682. * Observable raised before rendering a bounding box
  75683. */
  75684. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  75685. /**
  75686. * Observable raised after rendering a bounding box
  75687. */
  75688. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  75689. /**
  75690. * @hidden
  75691. */
  75692. renderList: SmartArray<BoundingBox>;
  75693. private _colorShader;
  75694. private _vertexBuffers;
  75695. private _indexBuffer;
  75696. private _fillIndexBuffer;
  75697. private _fillIndexData;
  75698. /**
  75699. * Instantiates a new bounding box renderer in a scene.
  75700. * @param scene the scene the renderer renders in
  75701. */
  75702. constructor(scene: Scene);
  75703. /**
  75704. * Registers the component in a given scene
  75705. */
  75706. register(): void;
  75707. private _evaluateSubMesh;
  75708. private _activeMesh;
  75709. private _prepareRessources;
  75710. private _createIndexBuffer;
  75711. /**
  75712. * Rebuilds the elements related to this component in case of
  75713. * context lost for instance.
  75714. */
  75715. rebuild(): void;
  75716. /**
  75717. * @hidden
  75718. */
  75719. reset(): void;
  75720. /**
  75721. * Render the bounding boxes of a specific rendering group
  75722. * @param renderingGroupId defines the rendering group to render
  75723. */
  75724. render(renderingGroupId: number): void;
  75725. /**
  75726. * In case of occlusion queries, we can render the occlusion bounding box through this method
  75727. * @param mesh Define the mesh to render the occlusion bounding box for
  75728. */
  75729. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  75730. /**
  75731. * Dispose and release the resources attached to this renderer.
  75732. */
  75733. dispose(): void;
  75734. }
  75735. }
  75736. declare module "babylonjs/Rendering/depthRendererSceneComponent" {
  75737. import { Nullable } from "babylonjs/types";
  75738. import { Scene } from "babylonjs/scene";
  75739. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  75740. import { Camera } from "babylonjs/Cameras/camera";
  75741. import { ISceneComponent } from "babylonjs/sceneComponent";
  75742. module "babylonjs/scene" {
  75743. interface Scene {
  75744. /** @hidden (Backing field) */
  75745. _depthRenderer: {
  75746. [id: string]: DepthRenderer;
  75747. };
  75748. /**
  75749. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  75750. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  75751. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  75752. * @returns the created depth renderer
  75753. */
  75754. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  75755. /**
  75756. * Disables a depth renderer for a given camera
  75757. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  75758. */
  75759. disableDepthRenderer(camera?: Nullable<Camera>): void;
  75760. }
  75761. }
  75762. /**
  75763. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  75764. * in several rendering techniques.
  75765. */
  75766. export class DepthRendererSceneComponent implements ISceneComponent {
  75767. /**
  75768. * The component name helpfull to identify the component in the list of scene components.
  75769. */
  75770. readonly name: string;
  75771. /**
  75772. * The scene the component belongs to.
  75773. */
  75774. scene: Scene;
  75775. /**
  75776. * Creates a new instance of the component for the given scene
  75777. * @param scene Defines the scene to register the component in
  75778. */
  75779. constructor(scene: Scene);
  75780. /**
  75781. * Registers the component in a given scene
  75782. */
  75783. register(): void;
  75784. /**
  75785. * Rebuilds the elements related to this component in case of
  75786. * context lost for instance.
  75787. */
  75788. rebuild(): void;
  75789. /**
  75790. * Disposes the component and the associated ressources
  75791. */
  75792. dispose(): void;
  75793. private _gatherRenderTargets;
  75794. private _gatherActiveCameraRenderTargets;
  75795. }
  75796. }
  75797. declare module "babylonjs/Rendering/prePassRendererSceneComponent" {
  75798. import { Nullable } from "babylonjs/types";
  75799. import { Scene } from "babylonjs/scene";
  75800. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  75801. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  75802. import { AbstractScene } from "babylonjs/abstractScene";
  75803. module "babylonjs/abstractScene" {
  75804. interface AbstractScene {
  75805. /** @hidden (Backing field) */
  75806. _prePassRenderer: Nullable<PrePassRenderer>;
  75807. /**
  75808. * Gets or Sets the current prepass renderer associated to the scene.
  75809. */
  75810. prePassRenderer: Nullable<PrePassRenderer>;
  75811. /**
  75812. * Enables the prepass and associates it with the scene
  75813. * @returns the PrePassRenderer
  75814. */
  75815. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  75816. /**
  75817. * Disables the prepass associated with the scene
  75818. */
  75819. disablePrePassRenderer(): void;
  75820. }
  75821. }
  75822. /**
  75823. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  75824. * in several rendering techniques.
  75825. */
  75826. export class PrePassRendererSceneComponent implements ISceneSerializableComponent {
  75827. /**
  75828. * The component name helpful to identify the component in the list of scene components.
  75829. */
  75830. readonly name: string;
  75831. /**
  75832. * The scene the component belongs to.
  75833. */
  75834. scene: Scene;
  75835. /**
  75836. * Creates a new instance of the component for the given scene
  75837. * @param scene Defines the scene to register the component in
  75838. */
  75839. constructor(scene: Scene);
  75840. /**
  75841. * Registers the component in a given scene
  75842. */
  75843. register(): void;
  75844. private _beforeCameraDraw;
  75845. private _afterCameraDraw;
  75846. private _beforeClearStage;
  75847. /**
  75848. * Serializes the component data to the specified json object
  75849. * @param serializationObject The object to serialize to
  75850. */
  75851. serialize(serializationObject: any): void;
  75852. /**
  75853. * Adds all the elements from the container to the scene
  75854. * @param container the container holding the elements
  75855. */
  75856. addFromContainer(container: AbstractScene): void;
  75857. /**
  75858. * Removes all the elements in the container from the scene
  75859. * @param container contains the elements to remove
  75860. * @param dispose if the removed element should be disposed (default: false)
  75861. */
  75862. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  75863. /**
  75864. * Rebuilds the elements related to this component in case of
  75865. * context lost for instance.
  75866. */
  75867. rebuild(): void;
  75868. /**
  75869. * Disposes the component and the associated ressources
  75870. */
  75871. dispose(): void;
  75872. }
  75873. }
  75874. declare module "babylonjs/Shaders/outline.fragment" {
  75875. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  75876. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  75877. /** @hidden */
  75878. export var outlinePixelShader: {
  75879. name: string;
  75880. shader: string;
  75881. };
  75882. }
  75883. declare module "babylonjs/Shaders/outline.vertex" {
  75884. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  75885. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  75886. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  75887. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  75888. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  75889. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  75890. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  75891. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  75892. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  75893. /** @hidden */
  75894. export var outlineVertexShader: {
  75895. name: string;
  75896. shader: string;
  75897. };
  75898. }
  75899. declare module "babylonjs/Rendering/outlineRenderer" {
  75900. import { SubMesh } from "babylonjs/Meshes/subMesh";
  75901. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  75902. import { Scene } from "babylonjs/scene";
  75903. import { ISceneComponent } from "babylonjs/sceneComponent";
  75904. import "babylonjs/Shaders/outline.fragment";
  75905. import "babylonjs/Shaders/outline.vertex";
  75906. module "babylonjs/scene" {
  75907. interface Scene {
  75908. /** @hidden */
  75909. _outlineRenderer: OutlineRenderer;
  75910. /**
  75911. * Gets the outline renderer associated with the scene
  75912. * @returns a OutlineRenderer
  75913. */
  75914. getOutlineRenderer(): OutlineRenderer;
  75915. }
  75916. }
  75917. module "babylonjs/Meshes/abstractMesh" {
  75918. interface AbstractMesh {
  75919. /** @hidden (Backing field) */
  75920. _renderOutline: boolean;
  75921. /**
  75922. * Gets or sets a boolean indicating if the outline must be rendered as well
  75923. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  75924. */
  75925. renderOutline: boolean;
  75926. /** @hidden (Backing field) */
  75927. _renderOverlay: boolean;
  75928. /**
  75929. * Gets or sets a boolean indicating if the overlay must be rendered as well
  75930. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  75931. */
  75932. renderOverlay: boolean;
  75933. }
  75934. }
  75935. /**
  75936. * This class is responsible to draw bothe outline/overlay of meshes.
  75937. * It should not be used directly but through the available method on mesh.
  75938. */
  75939. export class OutlineRenderer implements ISceneComponent {
  75940. /**
  75941. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  75942. */
  75943. private static _StencilReference;
  75944. /**
  75945. * The name of the component. Each component must have a unique name.
  75946. */
  75947. name: string;
  75948. /**
  75949. * The scene the component belongs to.
  75950. */
  75951. scene: Scene;
  75952. /**
  75953. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  75954. */
  75955. zOffset: number;
  75956. private _engine;
  75957. private _effect;
  75958. private _cachedDefines;
  75959. private _savedDepthWrite;
  75960. /**
  75961. * Instantiates a new outline renderer. (There could be only one per scene).
  75962. * @param scene Defines the scene it belongs to
  75963. */
  75964. constructor(scene: Scene);
  75965. /**
  75966. * Register the component to one instance of a scene.
  75967. */
  75968. register(): void;
  75969. /**
  75970. * Rebuilds the elements related to this component in case of
  75971. * context lost for instance.
  75972. */
  75973. rebuild(): void;
  75974. /**
  75975. * Disposes the component and the associated ressources.
  75976. */
  75977. dispose(): void;
  75978. /**
  75979. * Renders the outline in the canvas.
  75980. * @param subMesh Defines the sumesh to render
  75981. * @param batch Defines the batch of meshes in case of instances
  75982. * @param useOverlay Defines if the rendering is for the overlay or the outline
  75983. */
  75984. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  75985. /**
  75986. * Returns whether or not the outline renderer is ready for a given submesh.
  75987. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  75988. * @param subMesh Defines the submesh to check readyness for
  75989. * @param useInstances Defines wheter wee are trying to render instances or not
  75990. * @returns true if ready otherwise false
  75991. */
  75992. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  75993. private _beforeRenderingMesh;
  75994. private _afterRenderingMesh;
  75995. }
  75996. }
  75997. declare module "babylonjs/Rendering/index" {
  75998. export * from "babylonjs/Rendering/boundingBoxRenderer";
  75999. export * from "babylonjs/Rendering/depthRenderer";
  76000. export * from "babylonjs/Rendering/depthRendererSceneComponent";
  76001. export * from "babylonjs/Rendering/edgesRenderer";
  76002. export * from "babylonjs/Rendering/geometryBufferRenderer";
  76003. export * from "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  76004. export * from "babylonjs/Rendering/prePassRenderer";
  76005. export * from "babylonjs/Rendering/prePassRendererSceneComponent";
  76006. export * from "babylonjs/Rendering/outlineRenderer";
  76007. export * from "babylonjs/Rendering/renderingGroup";
  76008. export * from "babylonjs/Rendering/renderingManager";
  76009. export * from "babylonjs/Rendering/utilityLayerRenderer";
  76010. }
  76011. declare module "babylonjs/Sprites/ISprites" {
  76012. /**
  76013. * Defines the basic options interface of a Sprite Frame Source Size.
  76014. */
  76015. export interface ISpriteJSONSpriteSourceSize {
  76016. /**
  76017. * number of the original width of the Frame
  76018. */
  76019. w: number;
  76020. /**
  76021. * number of the original height of the Frame
  76022. */
  76023. h: number;
  76024. }
  76025. /**
  76026. * Defines the basic options interface of a Sprite Frame Data.
  76027. */
  76028. export interface ISpriteJSONSpriteFrameData {
  76029. /**
  76030. * number of the x offset of the Frame
  76031. */
  76032. x: number;
  76033. /**
  76034. * number of the y offset of the Frame
  76035. */
  76036. y: number;
  76037. /**
  76038. * number of the width of the Frame
  76039. */
  76040. w: number;
  76041. /**
  76042. * number of the height of the Frame
  76043. */
  76044. h: number;
  76045. }
  76046. /**
  76047. * Defines the basic options interface of a JSON Sprite.
  76048. */
  76049. export interface ISpriteJSONSprite {
  76050. /**
  76051. * string name of the Frame
  76052. */
  76053. filename: string;
  76054. /**
  76055. * ISpriteJSONSpriteFrame basic object of the frame data
  76056. */
  76057. frame: ISpriteJSONSpriteFrameData;
  76058. /**
  76059. * boolean to flag is the frame was rotated.
  76060. */
  76061. rotated: boolean;
  76062. /**
  76063. * boolean to flag is the frame was trimmed.
  76064. */
  76065. trimmed: boolean;
  76066. /**
  76067. * ISpriteJSONSpriteFrame basic object of the source data
  76068. */
  76069. spriteSourceSize: ISpriteJSONSpriteFrameData;
  76070. /**
  76071. * ISpriteJSONSpriteFrame basic object of the source data
  76072. */
  76073. sourceSize: ISpriteJSONSpriteSourceSize;
  76074. }
  76075. /**
  76076. * Defines the basic options interface of a JSON atlas.
  76077. */
  76078. export interface ISpriteJSONAtlas {
  76079. /**
  76080. * Array of objects that contain the frame data.
  76081. */
  76082. frames: Array<ISpriteJSONSprite>;
  76083. /**
  76084. * object basic object containing the sprite meta data.
  76085. */
  76086. meta?: object;
  76087. }
  76088. }
  76089. declare module "babylonjs/Shaders/spriteMap.fragment" {
  76090. /** @hidden */
  76091. export var spriteMapPixelShader: {
  76092. name: string;
  76093. shader: string;
  76094. };
  76095. }
  76096. declare module "babylonjs/Shaders/spriteMap.vertex" {
  76097. /** @hidden */
  76098. export var spriteMapVertexShader: {
  76099. name: string;
  76100. shader: string;
  76101. };
  76102. }
  76103. declare module "babylonjs/Sprites/spriteMap" {
  76104. import { IDisposable, Scene } from "babylonjs/scene";
  76105. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  76106. import { Texture } from "babylonjs/Materials/Textures/texture";
  76107. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  76108. import { ISpriteJSONSprite, ISpriteJSONAtlas } from "babylonjs/Sprites/ISprites";
  76109. import "babylonjs/Meshes/Builders/planeBuilder";
  76110. import "babylonjs/Shaders/spriteMap.fragment";
  76111. import "babylonjs/Shaders/spriteMap.vertex";
  76112. /**
  76113. * Defines the basic options interface of a SpriteMap
  76114. */
  76115. export interface ISpriteMapOptions {
  76116. /**
  76117. * Vector2 of the number of cells in the grid.
  76118. */
  76119. stageSize?: Vector2;
  76120. /**
  76121. * Vector2 of the size of the output plane in World Units.
  76122. */
  76123. outputSize?: Vector2;
  76124. /**
  76125. * Vector3 of the position of the output plane in World Units.
  76126. */
  76127. outputPosition?: Vector3;
  76128. /**
  76129. * Vector3 of the rotation of the output plane.
  76130. */
  76131. outputRotation?: Vector3;
  76132. /**
  76133. * number of layers that the system will reserve in resources.
  76134. */
  76135. layerCount?: number;
  76136. /**
  76137. * number of max animation frames a single cell will reserve in resources.
  76138. */
  76139. maxAnimationFrames?: number;
  76140. /**
  76141. * number cell index of the base tile when the system compiles.
  76142. */
  76143. baseTile?: number;
  76144. /**
  76145. * boolean flip the sprite after its been repositioned by the framing data.
  76146. */
  76147. flipU?: boolean;
  76148. /**
  76149. * Vector3 scalar of the global RGB values of the SpriteMap.
  76150. */
  76151. colorMultiply?: Vector3;
  76152. }
  76153. /**
  76154. * Defines the IDisposable interface in order to be cleanable from resources.
  76155. */
  76156. export interface ISpriteMap extends IDisposable {
  76157. /**
  76158. * String name of the SpriteMap.
  76159. */
  76160. name: string;
  76161. /**
  76162. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  76163. */
  76164. atlasJSON: ISpriteJSONAtlas;
  76165. /**
  76166. * Texture of the SpriteMap.
  76167. */
  76168. spriteSheet: Texture;
  76169. /**
  76170. * The parameters to initialize the SpriteMap with.
  76171. */
  76172. options: ISpriteMapOptions;
  76173. }
  76174. /**
  76175. * Class used to manage a grid restricted sprite deployment on an Output plane.
  76176. */
  76177. export class SpriteMap implements ISpriteMap {
  76178. /** The Name of the spriteMap */
  76179. name: string;
  76180. /** The JSON file with the frame and meta data */
  76181. atlasJSON: ISpriteJSONAtlas;
  76182. /** The systems Sprite Sheet Texture */
  76183. spriteSheet: Texture;
  76184. /** Arguments passed with the Constructor */
  76185. options: ISpriteMapOptions;
  76186. /** Public Sprite Storage array, parsed from atlasJSON */
  76187. sprites: Array<ISpriteJSONSprite>;
  76188. /** Returns the Number of Sprites in the System */
  76189. get spriteCount(): number;
  76190. /** Returns the Position of Output Plane*/
  76191. get position(): Vector3;
  76192. /** Returns the Position of Output Plane*/
  76193. set position(v: Vector3);
  76194. /** Returns the Rotation of Output Plane*/
  76195. get rotation(): Vector3;
  76196. /** Returns the Rotation of Output Plane*/
  76197. set rotation(v: Vector3);
  76198. /** Sets the AnimationMap*/
  76199. get animationMap(): RawTexture;
  76200. /** Sets the AnimationMap*/
  76201. set animationMap(v: RawTexture);
  76202. /** Scene that the SpriteMap was created in */
  76203. private _scene;
  76204. /** Texture Buffer of Float32 that holds tile frame data*/
  76205. private _frameMap;
  76206. /** Texture Buffers of Float32 that holds tileMap data*/
  76207. private _tileMaps;
  76208. /** Texture Buffer of Float32 that holds Animation Data*/
  76209. private _animationMap;
  76210. /** Custom ShaderMaterial Central to the System*/
  76211. private _material;
  76212. /** Custom ShaderMaterial Central to the System*/
  76213. private _output;
  76214. /** Systems Time Ticker*/
  76215. private _time;
  76216. /**
  76217. * Creates a new SpriteMap
  76218. * @param name defines the SpriteMaps Name
  76219. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  76220. * @param spriteSheet is the Texture that the Sprites are on.
  76221. * @param options a basic deployment configuration
  76222. * @param scene The Scene that the map is deployed on
  76223. */
  76224. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  76225. /**
  76226. * Returns tileID location
  76227. * @returns Vector2 the cell position ID
  76228. */
  76229. getTileID(): Vector2;
  76230. /**
  76231. * Gets the UV location of the mouse over the SpriteMap.
  76232. * @returns Vector2 the UV position of the mouse interaction
  76233. */
  76234. getMousePosition(): Vector2;
  76235. /**
  76236. * Creates the "frame" texture Buffer
  76237. * -------------------------------------
  76238. * Structure of frames
  76239. * "filename": "Falling-Water-2.png",
  76240. * "frame": {"x":69,"y":103,"w":24,"h":32},
  76241. * "rotated": true,
  76242. * "trimmed": true,
  76243. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  76244. * "sourceSize": {"w":32,"h":32}
  76245. * @returns RawTexture of the frameMap
  76246. */
  76247. private _createFrameBuffer;
  76248. /**
  76249. * Creates the tileMap texture Buffer
  76250. * @param buffer normally and array of numbers, or a false to generate from scratch
  76251. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  76252. * @returns RawTexture of the tileMap
  76253. */
  76254. private _createTileBuffer;
  76255. /**
  76256. * Modifies the data of the tileMaps
  76257. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  76258. * @param pos is the iVector2 Coordinates of the Tile
  76259. * @param tile The SpriteIndex of the new Tile
  76260. */
  76261. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  76262. /**
  76263. * Creates the animationMap texture Buffer
  76264. * @param buffer normally and array of numbers, or a false to generate from scratch
  76265. * @returns RawTexture of the animationMap
  76266. */
  76267. private _createTileAnimationBuffer;
  76268. /**
  76269. * Modifies the data of the animationMap
  76270. * @param cellID is the Index of the Sprite
  76271. * @param _frame is the target Animation frame
  76272. * @param toCell is the Target Index of the next frame of the animation
  76273. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  76274. * @param speed is a global scalar of the time variable on the map.
  76275. */
  76276. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  76277. /**
  76278. * Exports the .tilemaps file
  76279. */
  76280. saveTileMaps(): void;
  76281. /**
  76282. * Imports the .tilemaps file
  76283. * @param url of the .tilemaps file
  76284. */
  76285. loadTileMaps(url: string): void;
  76286. /**
  76287. * Release associated resources
  76288. */
  76289. dispose(): void;
  76290. }
  76291. }
  76292. declare module "babylonjs/Sprites/spritePackedManager" {
  76293. import { SpriteManager } from "babylonjs/Sprites/spriteManager";
  76294. import { Scene } from "babylonjs/scene";
  76295. /**
  76296. * Class used to manage multiple sprites of different sizes on the same spritesheet
  76297. * @see https://doc.babylonjs.com/babylon101/sprites
  76298. */
  76299. export class SpritePackedManager extends SpriteManager {
  76300. /** defines the packed manager's name */
  76301. name: string;
  76302. /**
  76303. * Creates a new sprite manager from a packed sprite sheet
  76304. * @param name defines the manager's name
  76305. * @param imgUrl defines the sprite sheet url
  76306. * @param capacity defines the maximum allowed number of sprites
  76307. * @param scene defines the hosting scene
  76308. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  76309. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  76310. * @param samplingMode defines the smapling mode to use with spritesheet
  76311. * @param fromPacked set to true; do not alter
  76312. */
  76313. constructor(
  76314. /** defines the packed manager's name */
  76315. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  76316. }
  76317. }
  76318. declare module "babylonjs/Sprites/index" {
  76319. export * from "babylonjs/Sprites/sprite";
  76320. export * from "babylonjs/Sprites/ISprites";
  76321. export * from "babylonjs/Sprites/spriteManager";
  76322. export * from "babylonjs/Sprites/spriteMap";
  76323. export * from "babylonjs/Sprites/spritePackedManager";
  76324. export * from "babylonjs/Sprites/spriteSceneComponent";
  76325. }
  76326. declare module "babylonjs/States/index" {
  76327. export * from "babylonjs/States/alphaCullingState";
  76328. export * from "babylonjs/States/depthCullingState";
  76329. export * from "babylonjs/States/stencilState";
  76330. }
  76331. declare module "babylonjs/Misc/assetsManager" {
  76332. import { Scene } from "babylonjs/scene";
  76333. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  76334. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  76335. import { Skeleton } from "babylonjs/Bones/skeleton";
  76336. import { Observable } from "babylonjs/Misc/observable";
  76337. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  76338. import { Texture } from "babylonjs/Materials/Textures/texture";
  76339. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  76340. import { HDRCubeTexture } from "babylonjs/Materials/Textures/hdrCubeTexture";
  76341. import { EquiRectangularCubeTexture } from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  76342. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  76343. import { AssetContainer } from "babylonjs/assetContainer";
  76344. /**
  76345. * Defines the list of states available for a task inside a AssetsManager
  76346. */
  76347. export enum AssetTaskState {
  76348. /**
  76349. * Initialization
  76350. */
  76351. INIT = 0,
  76352. /**
  76353. * Running
  76354. */
  76355. RUNNING = 1,
  76356. /**
  76357. * Done
  76358. */
  76359. DONE = 2,
  76360. /**
  76361. * Error
  76362. */
  76363. ERROR = 3
  76364. }
  76365. /**
  76366. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  76367. */
  76368. export abstract class AbstractAssetTask {
  76369. /**
  76370. * Task name
  76371. */ name: string;
  76372. /**
  76373. * Callback called when the task is successful
  76374. */
  76375. onSuccess: (task: any) => void;
  76376. /**
  76377. * Callback called when the task is not successful
  76378. */
  76379. onError: (task: any, message?: string, exception?: any) => void;
  76380. /**
  76381. * Creates a new AssetsManager
  76382. * @param name defines the name of the task
  76383. */
  76384. constructor(
  76385. /**
  76386. * Task name
  76387. */ name: string);
  76388. private _isCompleted;
  76389. private _taskState;
  76390. private _errorObject;
  76391. /**
  76392. * Get if the task is completed
  76393. */
  76394. get isCompleted(): boolean;
  76395. /**
  76396. * Gets the current state of the task
  76397. */
  76398. get taskState(): AssetTaskState;
  76399. /**
  76400. * Gets the current error object (if task is in error)
  76401. */
  76402. get errorObject(): {
  76403. message?: string;
  76404. exception?: any;
  76405. };
  76406. /**
  76407. * Internal only
  76408. * @hidden
  76409. */
  76410. _setErrorObject(message?: string, exception?: any): void;
  76411. /**
  76412. * Execute the current task
  76413. * @param scene defines the scene where you want your assets to be loaded
  76414. * @param onSuccess is a callback called when the task is successfully executed
  76415. * @param onError is a callback called if an error occurs
  76416. */
  76417. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76418. /**
  76419. * Execute the current task
  76420. * @param scene defines the scene where you want your assets to be loaded
  76421. * @param onSuccess is a callback called when the task is successfully executed
  76422. * @param onError is a callback called if an error occurs
  76423. */
  76424. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76425. /**
  76426. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  76427. * This can be used with failed tasks that have the reason for failure fixed.
  76428. */
  76429. reset(): void;
  76430. private onErrorCallback;
  76431. private onDoneCallback;
  76432. }
  76433. /**
  76434. * Define the interface used by progress events raised during assets loading
  76435. */
  76436. export interface IAssetsProgressEvent {
  76437. /**
  76438. * Defines the number of remaining tasks to process
  76439. */
  76440. remainingCount: number;
  76441. /**
  76442. * Defines the total number of tasks
  76443. */
  76444. totalCount: number;
  76445. /**
  76446. * Defines the task that was just processed
  76447. */
  76448. task: AbstractAssetTask;
  76449. }
  76450. /**
  76451. * Class used to share progress information about assets loading
  76452. */
  76453. export class AssetsProgressEvent implements IAssetsProgressEvent {
  76454. /**
  76455. * Defines the number of remaining tasks to process
  76456. */
  76457. remainingCount: number;
  76458. /**
  76459. * Defines the total number of tasks
  76460. */
  76461. totalCount: number;
  76462. /**
  76463. * Defines the task that was just processed
  76464. */
  76465. task: AbstractAssetTask;
  76466. /**
  76467. * Creates a AssetsProgressEvent
  76468. * @param remainingCount defines the number of remaining tasks to process
  76469. * @param totalCount defines the total number of tasks
  76470. * @param task defines the task that was just processed
  76471. */
  76472. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  76473. }
  76474. /**
  76475. * Define a task used by AssetsManager to load assets into a container
  76476. */
  76477. export class ContainerAssetTask extends AbstractAssetTask {
  76478. /**
  76479. * Defines the name of the task
  76480. */
  76481. name: string;
  76482. /**
  76483. * Defines the list of mesh's names you want to load
  76484. */
  76485. meshesNames: any;
  76486. /**
  76487. * Defines the root url to use as a base to load your meshes and associated resources
  76488. */
  76489. rootUrl: string;
  76490. /**
  76491. * Defines the filename or File of the scene to load from
  76492. */
  76493. sceneFilename: string | File;
  76494. /**
  76495. * Get the loaded asset container
  76496. */
  76497. loadedContainer: AssetContainer;
  76498. /**
  76499. * Gets the list of loaded meshes
  76500. */
  76501. loadedMeshes: Array<AbstractMesh>;
  76502. /**
  76503. * Gets the list of loaded particle systems
  76504. */
  76505. loadedParticleSystems: Array<IParticleSystem>;
  76506. /**
  76507. * Gets the list of loaded skeletons
  76508. */
  76509. loadedSkeletons: Array<Skeleton>;
  76510. /**
  76511. * Gets the list of loaded animation groups
  76512. */
  76513. loadedAnimationGroups: Array<AnimationGroup>;
  76514. /**
  76515. * Callback called when the task is successful
  76516. */
  76517. onSuccess: (task: ContainerAssetTask) => void;
  76518. /**
  76519. * Callback called when the task is successful
  76520. */
  76521. onError: (task: ContainerAssetTask, message?: string, exception?: any) => void;
  76522. /**
  76523. * Creates a new ContainerAssetTask
  76524. * @param name defines the name of the task
  76525. * @param meshesNames defines the list of mesh's names you want to load
  76526. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  76527. * @param sceneFilename defines the filename or File of the scene to load from
  76528. */
  76529. constructor(
  76530. /**
  76531. * Defines the name of the task
  76532. */
  76533. name: string,
  76534. /**
  76535. * Defines the list of mesh's names you want to load
  76536. */
  76537. meshesNames: any,
  76538. /**
  76539. * Defines the root url to use as a base to load your meshes and associated resources
  76540. */
  76541. rootUrl: string,
  76542. /**
  76543. * Defines the filename or File of the scene to load from
  76544. */
  76545. sceneFilename: string | File);
  76546. /**
  76547. * Execute the current task
  76548. * @param scene defines the scene where you want your assets to be loaded
  76549. * @param onSuccess is a callback called when the task is successfully executed
  76550. * @param onError is a callback called if an error occurs
  76551. */
  76552. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76553. }
  76554. /**
  76555. * Define a task used by AssetsManager to load meshes
  76556. */
  76557. export class MeshAssetTask extends AbstractAssetTask {
  76558. /**
  76559. * Defines the name of the task
  76560. */
  76561. name: string;
  76562. /**
  76563. * Defines the list of mesh's names you want to load
  76564. */
  76565. meshesNames: any;
  76566. /**
  76567. * Defines the root url to use as a base to load your meshes and associated resources
  76568. */
  76569. rootUrl: string;
  76570. /**
  76571. * Defines the filename or File of the scene to load from
  76572. */
  76573. sceneFilename: string | File;
  76574. /**
  76575. * Gets the list of loaded meshes
  76576. */
  76577. loadedMeshes: Array<AbstractMesh>;
  76578. /**
  76579. * Gets the list of loaded particle systems
  76580. */
  76581. loadedParticleSystems: Array<IParticleSystem>;
  76582. /**
  76583. * Gets the list of loaded skeletons
  76584. */
  76585. loadedSkeletons: Array<Skeleton>;
  76586. /**
  76587. * Gets the list of loaded animation groups
  76588. */
  76589. loadedAnimationGroups: Array<AnimationGroup>;
  76590. /**
  76591. * Callback called when the task is successful
  76592. */
  76593. onSuccess: (task: MeshAssetTask) => void;
  76594. /**
  76595. * Callback called when the task is successful
  76596. */
  76597. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  76598. /**
  76599. * Creates a new MeshAssetTask
  76600. * @param name defines the name of the task
  76601. * @param meshesNames defines the list of mesh's names you want to load
  76602. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  76603. * @param sceneFilename defines the filename or File of the scene to load from
  76604. */
  76605. constructor(
  76606. /**
  76607. * Defines the name of the task
  76608. */
  76609. name: string,
  76610. /**
  76611. * Defines the list of mesh's names you want to load
  76612. */
  76613. meshesNames: any,
  76614. /**
  76615. * Defines the root url to use as a base to load your meshes and associated resources
  76616. */
  76617. rootUrl: string,
  76618. /**
  76619. * Defines the filename or File of the scene to load from
  76620. */
  76621. sceneFilename: string | File);
  76622. /**
  76623. * Execute the current task
  76624. * @param scene defines the scene where you want your assets to be loaded
  76625. * @param onSuccess is a callback called when the task is successfully executed
  76626. * @param onError is a callback called if an error occurs
  76627. */
  76628. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76629. }
  76630. /**
  76631. * Define a task used by AssetsManager to load text content
  76632. */
  76633. export class TextFileAssetTask extends AbstractAssetTask {
  76634. /**
  76635. * Defines the name of the task
  76636. */
  76637. name: string;
  76638. /**
  76639. * Defines the location of the file to load
  76640. */
  76641. url: string;
  76642. /**
  76643. * Gets the loaded text string
  76644. */
  76645. text: string;
  76646. /**
  76647. * Callback called when the task is successful
  76648. */
  76649. onSuccess: (task: TextFileAssetTask) => void;
  76650. /**
  76651. * Callback called when the task is successful
  76652. */
  76653. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  76654. /**
  76655. * Creates a new TextFileAssetTask object
  76656. * @param name defines the name of the task
  76657. * @param url defines the location of the file to load
  76658. */
  76659. constructor(
  76660. /**
  76661. * Defines the name of the task
  76662. */
  76663. name: string,
  76664. /**
  76665. * Defines the location of the file to load
  76666. */
  76667. url: string);
  76668. /**
  76669. * Execute the current task
  76670. * @param scene defines the scene where you want your assets to be loaded
  76671. * @param onSuccess is a callback called when the task is successfully executed
  76672. * @param onError is a callback called if an error occurs
  76673. */
  76674. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76675. }
  76676. /**
  76677. * Define a task used by AssetsManager to load binary data
  76678. */
  76679. export class BinaryFileAssetTask extends AbstractAssetTask {
  76680. /**
  76681. * Defines the name of the task
  76682. */
  76683. name: string;
  76684. /**
  76685. * Defines the location of the file to load
  76686. */
  76687. url: string;
  76688. /**
  76689. * Gets the lodaded data (as an array buffer)
  76690. */
  76691. data: ArrayBuffer;
  76692. /**
  76693. * Callback called when the task is successful
  76694. */
  76695. onSuccess: (task: BinaryFileAssetTask) => void;
  76696. /**
  76697. * Callback called when the task is successful
  76698. */
  76699. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  76700. /**
  76701. * Creates a new BinaryFileAssetTask object
  76702. * @param name defines the name of the new task
  76703. * @param url defines the location of the file to load
  76704. */
  76705. constructor(
  76706. /**
  76707. * Defines the name of the task
  76708. */
  76709. name: string,
  76710. /**
  76711. * Defines the location of the file to load
  76712. */
  76713. url: string);
  76714. /**
  76715. * Execute the current task
  76716. * @param scene defines the scene where you want your assets to be loaded
  76717. * @param onSuccess is a callback called when the task is successfully executed
  76718. * @param onError is a callback called if an error occurs
  76719. */
  76720. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76721. }
  76722. /**
  76723. * Define a task used by AssetsManager to load images
  76724. */
  76725. export class ImageAssetTask extends AbstractAssetTask {
  76726. /**
  76727. * Defines the name of the task
  76728. */
  76729. name: string;
  76730. /**
  76731. * Defines the location of the image to load
  76732. */
  76733. url: string;
  76734. /**
  76735. * Gets the loaded images
  76736. */
  76737. image: HTMLImageElement;
  76738. /**
  76739. * Callback called when the task is successful
  76740. */
  76741. onSuccess: (task: ImageAssetTask) => void;
  76742. /**
  76743. * Callback called when the task is successful
  76744. */
  76745. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  76746. /**
  76747. * Creates a new ImageAssetTask
  76748. * @param name defines the name of the task
  76749. * @param url defines the location of the image to load
  76750. */
  76751. constructor(
  76752. /**
  76753. * Defines the name of the task
  76754. */
  76755. name: string,
  76756. /**
  76757. * Defines the location of the image to load
  76758. */
  76759. url: string);
  76760. /**
  76761. * Execute the current task
  76762. * @param scene defines the scene where you want your assets to be loaded
  76763. * @param onSuccess is a callback called when the task is successfully executed
  76764. * @param onError is a callback called if an error occurs
  76765. */
  76766. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76767. }
  76768. /**
  76769. * Defines the interface used by texture loading tasks
  76770. */
  76771. export interface ITextureAssetTask<TEX extends BaseTexture> {
  76772. /**
  76773. * Gets the loaded texture
  76774. */
  76775. texture: TEX;
  76776. }
  76777. /**
  76778. * Define a task used by AssetsManager to load 2D textures
  76779. */
  76780. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  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. * Defines if mipmap should not be generated (default is false)
  76791. */
  76792. noMipmap?: boolean | undefined;
  76793. /**
  76794. * Defines if texture must be inverted on Y axis (default is true)
  76795. */
  76796. invertY: boolean;
  76797. /**
  76798. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76799. */
  76800. samplingMode: number;
  76801. /**
  76802. * Gets the loaded texture
  76803. */
  76804. texture: Texture;
  76805. /**
  76806. * Callback called when the task is successful
  76807. */
  76808. onSuccess: (task: TextureAssetTask) => void;
  76809. /**
  76810. * Callback called when the task is successful
  76811. */
  76812. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  76813. /**
  76814. * Creates a new TextureAssetTask object
  76815. * @param name defines the name of the task
  76816. * @param url defines the location of the file to load
  76817. * @param noMipmap defines if mipmap should not be generated (default is false)
  76818. * @param invertY defines if texture must be inverted on Y axis (default is true)
  76819. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76820. */
  76821. constructor(
  76822. /**
  76823. * Defines the name of the task
  76824. */
  76825. name: string,
  76826. /**
  76827. * Defines the location of the file to load
  76828. */
  76829. url: string,
  76830. /**
  76831. * Defines if mipmap should not be generated (default is false)
  76832. */
  76833. noMipmap?: boolean | undefined,
  76834. /**
  76835. * Defines if texture must be inverted on Y axis (default is true)
  76836. */
  76837. invertY?: boolean,
  76838. /**
  76839. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76840. */
  76841. samplingMode?: number);
  76842. /**
  76843. * Execute the current task
  76844. * @param scene defines the scene where you want your assets to be loaded
  76845. * @param onSuccess is a callback called when the task is successfully executed
  76846. * @param onError is a callback called if an error occurs
  76847. */
  76848. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76849. }
  76850. /**
  76851. * Define a task used by AssetsManager to load cube textures
  76852. */
  76853. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  76854. /**
  76855. * Defines the name of the task
  76856. */
  76857. name: string;
  76858. /**
  76859. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76860. */
  76861. url: string;
  76862. /**
  76863. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76864. */
  76865. extensions?: string[] | undefined;
  76866. /**
  76867. * Defines if mipmaps should not be generated (default is false)
  76868. */
  76869. noMipmap?: boolean | undefined;
  76870. /**
  76871. * Defines the explicit list of files (undefined by default)
  76872. */
  76873. files?: string[] | undefined;
  76874. /**
  76875. * Gets the loaded texture
  76876. */
  76877. texture: CubeTexture;
  76878. /**
  76879. * Callback called when the task is successful
  76880. */
  76881. onSuccess: (task: CubeTextureAssetTask) => void;
  76882. /**
  76883. * Callback called when the task is successful
  76884. */
  76885. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  76886. /**
  76887. * Creates a new CubeTextureAssetTask
  76888. * @param name defines the name of the task
  76889. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76890. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76891. * @param noMipmap defines if mipmaps should not be generated (default is false)
  76892. * @param files defines the explicit list of files (undefined by default)
  76893. */
  76894. constructor(
  76895. /**
  76896. * Defines the name of the task
  76897. */
  76898. name: string,
  76899. /**
  76900. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76901. */
  76902. url: string,
  76903. /**
  76904. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76905. */
  76906. extensions?: string[] | undefined,
  76907. /**
  76908. * Defines if mipmaps should not be generated (default is false)
  76909. */
  76910. noMipmap?: boolean | undefined,
  76911. /**
  76912. * Defines the explicit list of files (undefined by default)
  76913. */
  76914. files?: string[] | undefined);
  76915. /**
  76916. * Execute the current task
  76917. * @param scene defines the scene where you want your assets to be loaded
  76918. * @param onSuccess is a callback called when the task is successfully executed
  76919. * @param onError is a callback called if an error occurs
  76920. */
  76921. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76922. }
  76923. /**
  76924. * Define a task used by AssetsManager to load HDR cube textures
  76925. */
  76926. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  76927. /**
  76928. * Defines the name of the task
  76929. */
  76930. name: string;
  76931. /**
  76932. * Defines the location of the file to load
  76933. */
  76934. url: string;
  76935. /**
  76936. * Defines the desired size (the more it increases the longer the generation will be)
  76937. */
  76938. size: number;
  76939. /**
  76940. * Defines if mipmaps should not be generated (default is false)
  76941. */
  76942. noMipmap: boolean;
  76943. /**
  76944. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  76945. */
  76946. generateHarmonics: boolean;
  76947. /**
  76948. * 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)
  76949. */
  76950. gammaSpace: boolean;
  76951. /**
  76952. * Internal Use Only
  76953. */
  76954. reserved: boolean;
  76955. /**
  76956. * Gets the loaded texture
  76957. */
  76958. texture: HDRCubeTexture;
  76959. /**
  76960. * Callback called when the task is successful
  76961. */
  76962. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  76963. /**
  76964. * Callback called when the task is successful
  76965. */
  76966. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  76967. /**
  76968. * Creates a new HDRCubeTextureAssetTask object
  76969. * @param name defines the name of the task
  76970. * @param url defines the location of the file to load
  76971. * @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.
  76972. * @param noMipmap defines if mipmaps should not be generated (default is false)
  76973. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  76974. * @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)
  76975. * @param reserved Internal use only
  76976. */
  76977. constructor(
  76978. /**
  76979. * Defines the name of the task
  76980. */
  76981. name: string,
  76982. /**
  76983. * Defines the location of the file to load
  76984. */
  76985. url: string,
  76986. /**
  76987. * Defines the desired size (the more it increases the longer the generation will be)
  76988. */
  76989. size: number,
  76990. /**
  76991. * Defines if mipmaps should not be generated (default is false)
  76992. */
  76993. noMipmap?: boolean,
  76994. /**
  76995. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  76996. */
  76997. generateHarmonics?: boolean,
  76998. /**
  76999. * 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)
  77000. */
  77001. gammaSpace?: boolean,
  77002. /**
  77003. * Internal Use Only
  77004. */
  77005. reserved?: boolean);
  77006. /**
  77007. * Execute the current task
  77008. * @param scene defines the scene where you want your assets to be loaded
  77009. * @param onSuccess is a callback called when the task is successfully executed
  77010. * @param onError is a callback called if an error occurs
  77011. */
  77012. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77013. }
  77014. /**
  77015. * Define a task used by AssetsManager to load Equirectangular cube textures
  77016. */
  77017. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  77018. /**
  77019. * Defines the name of the task
  77020. */
  77021. name: string;
  77022. /**
  77023. * Defines the location of the file to load
  77024. */
  77025. url: string;
  77026. /**
  77027. * Defines the desired size (the more it increases the longer the generation will be)
  77028. */
  77029. size: number;
  77030. /**
  77031. * Defines if mipmaps should not be generated (default is false)
  77032. */
  77033. noMipmap: boolean;
  77034. /**
  77035. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  77036. * but the standard material would require them in Gamma space) (default is true)
  77037. */
  77038. gammaSpace: boolean;
  77039. /**
  77040. * Gets the loaded texture
  77041. */
  77042. texture: EquiRectangularCubeTexture;
  77043. /**
  77044. * Callback called when the task is successful
  77045. */
  77046. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  77047. /**
  77048. * Callback called when the task is successful
  77049. */
  77050. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  77051. /**
  77052. * Creates a new EquiRectangularCubeTextureAssetTask object
  77053. * @param name defines the name of the task
  77054. * @param url defines the location of the file to load
  77055. * @param size defines the desired size (the more it increases the longer the generation will be)
  77056. * If the size is omitted this implies you are using a preprocessed cubemap.
  77057. * @param noMipmap defines if mipmaps should not be generated (default is false)
  77058. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  77059. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  77060. * (default is true)
  77061. */
  77062. constructor(
  77063. /**
  77064. * Defines the name of the task
  77065. */
  77066. name: string,
  77067. /**
  77068. * Defines the location of the file to load
  77069. */
  77070. url: string,
  77071. /**
  77072. * Defines the desired size (the more it increases the longer the generation will be)
  77073. */
  77074. size: number,
  77075. /**
  77076. * Defines if mipmaps should not be generated (default is false)
  77077. */
  77078. noMipmap?: boolean,
  77079. /**
  77080. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  77081. * but the standard material would require them in Gamma space) (default is true)
  77082. */
  77083. gammaSpace?: boolean);
  77084. /**
  77085. * Execute the current task
  77086. * @param scene defines the scene where you want your assets to be loaded
  77087. * @param onSuccess is a callback called when the task is successfully executed
  77088. * @param onError is a callback called if an error occurs
  77089. */
  77090. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77091. }
  77092. /**
  77093. * This class can be used to easily import assets into a scene
  77094. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  77095. */
  77096. export class AssetsManager {
  77097. private _scene;
  77098. private _isLoading;
  77099. protected _tasks: AbstractAssetTask[];
  77100. protected _waitingTasksCount: number;
  77101. protected _totalTasksCount: number;
  77102. /**
  77103. * Callback called when all tasks are processed
  77104. */
  77105. onFinish: (tasks: AbstractAssetTask[]) => void;
  77106. /**
  77107. * Callback called when a task is successful
  77108. */
  77109. onTaskSuccess: (task: AbstractAssetTask) => void;
  77110. /**
  77111. * Callback called when a task had an error
  77112. */
  77113. onTaskError: (task: AbstractAssetTask) => void;
  77114. /**
  77115. * Callback called when a task is done (whatever the result is)
  77116. */
  77117. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  77118. /**
  77119. * Observable called when all tasks are processed
  77120. */
  77121. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  77122. /**
  77123. * Observable called when a task had an error
  77124. */
  77125. onTaskErrorObservable: Observable<AbstractAssetTask>;
  77126. /**
  77127. * Observable called when all tasks were executed
  77128. */
  77129. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  77130. /**
  77131. * Observable called when a task is done (whatever the result is)
  77132. */
  77133. onProgressObservable: Observable<IAssetsProgressEvent>;
  77134. /**
  77135. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  77136. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  77137. */
  77138. useDefaultLoadingScreen: boolean;
  77139. /**
  77140. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  77141. * when all assets have been downloaded.
  77142. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  77143. */
  77144. autoHideLoadingUI: boolean;
  77145. /**
  77146. * Creates a new AssetsManager
  77147. * @param scene defines the scene to work on
  77148. */
  77149. constructor(scene: Scene);
  77150. /**
  77151. * Add a ContainerAssetTask to the list of active tasks
  77152. * @param taskName defines the name of the new task
  77153. * @param meshesNames defines the name of meshes to load
  77154. * @param rootUrl defines the root url to use to locate files
  77155. * @param sceneFilename defines the filename of the scene file
  77156. * @returns a new ContainerAssetTask object
  77157. */
  77158. addContainerTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): ContainerAssetTask;
  77159. /**
  77160. * Add a MeshAssetTask to the list of active tasks
  77161. * @param taskName defines the name of the new task
  77162. * @param meshesNames defines the name of meshes to load
  77163. * @param rootUrl defines the root url to use to locate files
  77164. * @param sceneFilename defines the filename of the scene file
  77165. * @returns a new MeshAssetTask object
  77166. */
  77167. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  77168. /**
  77169. * Add a TextFileAssetTask to the list of active tasks
  77170. * @param taskName defines the name of the new task
  77171. * @param url defines the url of the file to load
  77172. * @returns a new TextFileAssetTask object
  77173. */
  77174. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  77175. /**
  77176. * Add a BinaryFileAssetTask to the list of active tasks
  77177. * @param taskName defines the name of the new task
  77178. * @param url defines the url of the file to load
  77179. * @returns a new BinaryFileAssetTask object
  77180. */
  77181. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  77182. /**
  77183. * Add a ImageAssetTask to the list of active tasks
  77184. * @param taskName defines the name of the new task
  77185. * @param url defines the url of the file to load
  77186. * @returns a new ImageAssetTask object
  77187. */
  77188. addImageTask(taskName: string, url: string): ImageAssetTask;
  77189. /**
  77190. * Add a TextureAssetTask to the list of active tasks
  77191. * @param taskName defines the name of the new task
  77192. * @param url defines the url of the file to load
  77193. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77194. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  77195. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  77196. * @returns a new TextureAssetTask object
  77197. */
  77198. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  77199. /**
  77200. * Add a CubeTextureAssetTask to the list of active tasks
  77201. * @param taskName defines the name of the new task
  77202. * @param url defines the url of the file to load
  77203. * @param extensions defines the extension to use to load the cube map (can be null)
  77204. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77205. * @param files defines the list of files to load (can be null)
  77206. * @returns a new CubeTextureAssetTask object
  77207. */
  77208. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  77209. /**
  77210. *
  77211. * Add a HDRCubeTextureAssetTask to the list of active tasks
  77212. * @param taskName defines the name of the new task
  77213. * @param url defines the url of the file to load
  77214. * @param size defines the size you want for the cubemap (can be null)
  77215. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77216. * @param generateHarmonics defines if you want to automatically generate (true by default)
  77217. * @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)
  77218. * @param reserved Internal use only
  77219. * @returns a new HDRCubeTextureAssetTask object
  77220. */
  77221. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  77222. /**
  77223. *
  77224. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  77225. * @param taskName defines the name of the new task
  77226. * @param url defines the url of the file to load
  77227. * @param size defines the size you want for the cubemap (can be null)
  77228. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77229. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  77230. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  77231. * @returns a new EquiRectangularCubeTextureAssetTask object
  77232. */
  77233. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  77234. /**
  77235. * Remove a task from the assets manager.
  77236. * @param task the task to remove
  77237. */
  77238. removeTask(task: AbstractAssetTask): void;
  77239. private _decreaseWaitingTasksCount;
  77240. private _runTask;
  77241. /**
  77242. * Reset the AssetsManager and remove all tasks
  77243. * @return the current instance of the AssetsManager
  77244. */
  77245. reset(): AssetsManager;
  77246. /**
  77247. * Start the loading process
  77248. * @return the current instance of the AssetsManager
  77249. */
  77250. load(): AssetsManager;
  77251. /**
  77252. * Start the loading process as an async operation
  77253. * @return a promise returning the list of failed tasks
  77254. */
  77255. loadAsync(): Promise<void>;
  77256. }
  77257. }
  77258. declare module "babylonjs/Misc/deferred" {
  77259. /**
  77260. * Wrapper class for promise with external resolve and reject.
  77261. */
  77262. export class Deferred<T> {
  77263. /**
  77264. * The promise associated with this deferred object.
  77265. */
  77266. readonly promise: Promise<T>;
  77267. private _resolve;
  77268. private _reject;
  77269. /**
  77270. * The resolve method of the promise associated with this deferred object.
  77271. */
  77272. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  77273. /**
  77274. * The reject method of the promise associated with this deferred object.
  77275. */
  77276. get reject(): (reason?: any) => void;
  77277. /**
  77278. * Constructor for this deferred object.
  77279. */
  77280. constructor();
  77281. }
  77282. }
  77283. declare module "babylonjs/Misc/meshExploder" {
  77284. import { Mesh } from "babylonjs/Meshes/mesh";
  77285. /**
  77286. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  77287. */
  77288. export class MeshExploder {
  77289. private _centerMesh;
  77290. private _meshes;
  77291. private _meshesOrigins;
  77292. private _toCenterVectors;
  77293. private _scaledDirection;
  77294. private _newPosition;
  77295. private _centerPosition;
  77296. /**
  77297. * Explodes meshes from a center mesh.
  77298. * @param meshes The meshes to explode.
  77299. * @param centerMesh The mesh to be center of explosion.
  77300. */
  77301. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  77302. private _setCenterMesh;
  77303. /**
  77304. * Get class name
  77305. * @returns "MeshExploder"
  77306. */
  77307. getClassName(): string;
  77308. /**
  77309. * "Exploded meshes"
  77310. * @returns Array of meshes with the centerMesh at index 0.
  77311. */
  77312. getMeshes(): Array<Mesh>;
  77313. /**
  77314. * Explodes meshes giving a specific direction
  77315. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  77316. */
  77317. explode(direction?: number): void;
  77318. }
  77319. }
  77320. declare module "babylonjs/Misc/filesInput" {
  77321. import { Engine } from "babylonjs/Engines/engine";
  77322. import { Scene } from "babylonjs/scene";
  77323. import { ISceneLoaderProgressEvent } from "babylonjs/Loading/sceneLoader";
  77324. import { Nullable } from "babylonjs/types";
  77325. /**
  77326. * Class used to help managing file picking and drag'n'drop
  77327. */
  77328. export class FilesInput {
  77329. /**
  77330. * List of files ready to be loaded
  77331. */
  77332. static get FilesToLoad(): {
  77333. [key: string]: File;
  77334. };
  77335. /**
  77336. * Callback called when a file is processed
  77337. */
  77338. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  77339. private _engine;
  77340. private _currentScene;
  77341. private _sceneLoadedCallback;
  77342. private _progressCallback;
  77343. private _additionalRenderLoopLogicCallback;
  77344. private _textureLoadingCallback;
  77345. private _startingProcessingFilesCallback;
  77346. private _onReloadCallback;
  77347. private _errorCallback;
  77348. private _elementToMonitor;
  77349. private _sceneFileToLoad;
  77350. private _filesToLoad;
  77351. /**
  77352. * Creates a new FilesInput
  77353. * @param engine defines the rendering engine
  77354. * @param scene defines the hosting scene
  77355. * @param sceneLoadedCallback callback called when scene is loaded
  77356. * @param progressCallback callback called to track progress
  77357. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  77358. * @param textureLoadingCallback callback called when a texture is loading
  77359. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  77360. * @param onReloadCallback callback called when a reload is requested
  77361. * @param errorCallback callback call if an error occurs
  77362. */
  77363. 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>);
  77364. private _dragEnterHandler;
  77365. private _dragOverHandler;
  77366. private _dropHandler;
  77367. /**
  77368. * Calls this function to listen to drag'n'drop events on a specific DOM element
  77369. * @param elementToMonitor defines the DOM element to track
  77370. */
  77371. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  77372. /** Gets the current list of files to load */
  77373. get filesToLoad(): File[];
  77374. /**
  77375. * Release all associated resources
  77376. */
  77377. dispose(): void;
  77378. private renderFunction;
  77379. private drag;
  77380. private drop;
  77381. private _traverseFolder;
  77382. private _processFiles;
  77383. /**
  77384. * Load files from a drop event
  77385. * @param event defines the drop event to use as source
  77386. */
  77387. loadFiles(event: any): void;
  77388. private _processReload;
  77389. /**
  77390. * Reload the current scene from the loaded files
  77391. */
  77392. reload(): void;
  77393. }
  77394. }
  77395. declare module "babylonjs/Misc/HighDynamicRange/index" {
  77396. export * from "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial";
  77397. export * from "babylonjs/Misc/HighDynamicRange/hdr";
  77398. export * from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  77399. }
  77400. declare module "babylonjs/Misc/sceneOptimizer" {
  77401. import { Scene, IDisposable } from "babylonjs/scene";
  77402. import { Observable } from "babylonjs/Misc/observable";
  77403. /**
  77404. * Defines the root class used to create scene optimization to use with SceneOptimizer
  77405. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77406. */
  77407. export class SceneOptimization {
  77408. /**
  77409. * Defines the priority of this optimization (0 by default which means first in the list)
  77410. */
  77411. priority: number;
  77412. /**
  77413. * Gets a string describing the action executed by the current optimization
  77414. * @returns description string
  77415. */
  77416. getDescription(): string;
  77417. /**
  77418. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77419. * @param scene defines the current scene where to apply this optimization
  77420. * @param optimizer defines the current optimizer
  77421. * @returns true if everything that can be done was applied
  77422. */
  77423. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77424. /**
  77425. * Creates the SceneOptimization object
  77426. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77427. * @param desc defines the description associated with the optimization
  77428. */
  77429. constructor(
  77430. /**
  77431. * Defines the priority of this optimization (0 by default which means first in the list)
  77432. */
  77433. priority?: number);
  77434. }
  77435. /**
  77436. * Defines an optimization used to reduce the size of render target textures
  77437. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77438. */
  77439. export class TextureOptimization extends SceneOptimization {
  77440. /**
  77441. * Defines the priority of this optimization (0 by default which means first in the list)
  77442. */
  77443. priority: number;
  77444. /**
  77445. * 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
  77446. */
  77447. maximumSize: number;
  77448. /**
  77449. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77450. */
  77451. step: number;
  77452. /**
  77453. * Gets a string describing the action executed by the current optimization
  77454. * @returns description string
  77455. */
  77456. getDescription(): string;
  77457. /**
  77458. * Creates the TextureOptimization object
  77459. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77460. * @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
  77461. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77462. */
  77463. constructor(
  77464. /**
  77465. * Defines the priority of this optimization (0 by default which means first in the list)
  77466. */
  77467. priority?: number,
  77468. /**
  77469. * 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
  77470. */
  77471. maximumSize?: number,
  77472. /**
  77473. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77474. */
  77475. step?: number);
  77476. /**
  77477. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77478. * @param scene defines the current scene where to apply this optimization
  77479. * @param optimizer defines the current optimizer
  77480. * @returns true if everything that can be done was applied
  77481. */
  77482. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77483. }
  77484. /**
  77485. * Defines an optimization used to increase or decrease the rendering resolution
  77486. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77487. */
  77488. export class HardwareScalingOptimization extends SceneOptimization {
  77489. /**
  77490. * Defines the priority of this optimization (0 by default which means first in the list)
  77491. */
  77492. priority: number;
  77493. /**
  77494. * Defines the maximum scale to use (2 by default)
  77495. */
  77496. maximumScale: number;
  77497. /**
  77498. * Defines the step to use between two passes (0.5 by default)
  77499. */
  77500. step: number;
  77501. private _currentScale;
  77502. private _directionOffset;
  77503. /**
  77504. * Gets a string describing the action executed by the current optimization
  77505. * @return description string
  77506. */
  77507. getDescription(): string;
  77508. /**
  77509. * Creates the HardwareScalingOptimization object
  77510. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77511. * @param maximumScale defines the maximum scale to use (2 by default)
  77512. * @param step defines the step to use between two passes (0.5 by default)
  77513. */
  77514. constructor(
  77515. /**
  77516. * Defines the priority of this optimization (0 by default which means first in the list)
  77517. */
  77518. priority?: number,
  77519. /**
  77520. * Defines the maximum scale to use (2 by default)
  77521. */
  77522. maximumScale?: number,
  77523. /**
  77524. * Defines the step to use between two passes (0.5 by default)
  77525. */
  77526. step?: number);
  77527. /**
  77528. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77529. * @param scene defines the current scene where to apply this optimization
  77530. * @param optimizer defines the current optimizer
  77531. * @returns true if everything that can be done was applied
  77532. */
  77533. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77534. }
  77535. /**
  77536. * Defines an optimization used to remove shadows
  77537. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77538. */
  77539. export class ShadowsOptimization extends SceneOptimization {
  77540. /**
  77541. * Gets a string describing the action executed by the current optimization
  77542. * @return description string
  77543. */
  77544. getDescription(): string;
  77545. /**
  77546. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77547. * @param scene defines the current scene where to apply this optimization
  77548. * @param optimizer defines the current optimizer
  77549. * @returns true if everything that can be done was applied
  77550. */
  77551. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77552. }
  77553. /**
  77554. * Defines an optimization used to turn post-processes off
  77555. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77556. */
  77557. export class PostProcessesOptimization extends SceneOptimization {
  77558. /**
  77559. * Gets a string describing the action executed by the current optimization
  77560. * @return description string
  77561. */
  77562. getDescription(): string;
  77563. /**
  77564. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77565. * @param scene defines the current scene where to apply this optimization
  77566. * @param optimizer defines the current optimizer
  77567. * @returns true if everything that can be done was applied
  77568. */
  77569. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77570. }
  77571. /**
  77572. * Defines an optimization used to turn lens flares off
  77573. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77574. */
  77575. export class LensFlaresOptimization extends SceneOptimization {
  77576. /**
  77577. * Gets a string describing the action executed by the current optimization
  77578. * @return description string
  77579. */
  77580. getDescription(): string;
  77581. /**
  77582. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77583. * @param scene defines the current scene where to apply this optimization
  77584. * @param optimizer defines the current optimizer
  77585. * @returns true if everything that can be done was applied
  77586. */
  77587. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77588. }
  77589. /**
  77590. * Defines an optimization based on user defined callback.
  77591. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77592. */
  77593. export class CustomOptimization extends SceneOptimization {
  77594. /**
  77595. * Callback called to apply the custom optimization.
  77596. */
  77597. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  77598. /**
  77599. * Callback called to get custom description
  77600. */
  77601. onGetDescription: () => string;
  77602. /**
  77603. * Gets a string describing the action executed by the current optimization
  77604. * @returns description string
  77605. */
  77606. getDescription(): string;
  77607. /**
  77608. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77609. * @param scene defines the current scene where to apply this optimization
  77610. * @param optimizer defines the current optimizer
  77611. * @returns true if everything that can be done was applied
  77612. */
  77613. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77614. }
  77615. /**
  77616. * Defines an optimization used to turn particles off
  77617. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77618. */
  77619. export class ParticlesOptimization extends SceneOptimization {
  77620. /**
  77621. * Gets a string describing the action executed by the current optimization
  77622. * @return description string
  77623. */
  77624. getDescription(): string;
  77625. /**
  77626. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77627. * @param scene defines the current scene where to apply this optimization
  77628. * @param optimizer defines the current optimizer
  77629. * @returns true if everything that can be done was applied
  77630. */
  77631. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77632. }
  77633. /**
  77634. * Defines an optimization used to turn render targets off
  77635. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77636. */
  77637. export class RenderTargetsOptimization extends SceneOptimization {
  77638. /**
  77639. * Gets a string describing the action executed by the current optimization
  77640. * @return description string
  77641. */
  77642. getDescription(): string;
  77643. /**
  77644. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77645. * @param scene defines the current scene where to apply this optimization
  77646. * @param optimizer defines the current optimizer
  77647. * @returns true if everything that can be done was applied
  77648. */
  77649. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77650. }
  77651. /**
  77652. * Defines an optimization used to merge meshes with compatible materials
  77653. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77654. */
  77655. export class MergeMeshesOptimization extends SceneOptimization {
  77656. private static _UpdateSelectionTree;
  77657. /**
  77658. * Gets or sets a boolean which defines if optimization octree has to be updated
  77659. */
  77660. static get UpdateSelectionTree(): boolean;
  77661. /**
  77662. * Gets or sets a boolean which defines if optimization octree has to be updated
  77663. */
  77664. static set UpdateSelectionTree(value: boolean);
  77665. /**
  77666. * Gets a string describing the action executed by the current optimization
  77667. * @return description string
  77668. */
  77669. getDescription(): string;
  77670. private _canBeMerged;
  77671. /**
  77672. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77673. * @param scene defines the current scene where to apply this optimization
  77674. * @param optimizer defines the current optimizer
  77675. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  77676. * @returns true if everything that can be done was applied
  77677. */
  77678. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  77679. }
  77680. /**
  77681. * Defines a list of options used by SceneOptimizer
  77682. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77683. */
  77684. export class SceneOptimizerOptions {
  77685. /**
  77686. * Defines the target frame rate to reach (60 by default)
  77687. */
  77688. targetFrameRate: number;
  77689. /**
  77690. * Defines the interval between two checkes (2000ms by default)
  77691. */
  77692. trackerDuration: number;
  77693. /**
  77694. * Gets the list of optimizations to apply
  77695. */
  77696. optimizations: SceneOptimization[];
  77697. /**
  77698. * Creates a new list of options used by SceneOptimizer
  77699. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  77700. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  77701. */
  77702. constructor(
  77703. /**
  77704. * Defines the target frame rate to reach (60 by default)
  77705. */
  77706. targetFrameRate?: number,
  77707. /**
  77708. * Defines the interval between two checkes (2000ms by default)
  77709. */
  77710. trackerDuration?: number);
  77711. /**
  77712. * Add a new optimization
  77713. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  77714. * @returns the current SceneOptimizerOptions
  77715. */
  77716. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  77717. /**
  77718. * Add a new custom optimization
  77719. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  77720. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  77721. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77722. * @returns the current SceneOptimizerOptions
  77723. */
  77724. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  77725. /**
  77726. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  77727. * @param targetFrameRate defines the target frame rate (60 by default)
  77728. * @returns a SceneOptimizerOptions object
  77729. */
  77730. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77731. /**
  77732. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  77733. * @param targetFrameRate defines the target frame rate (60 by default)
  77734. * @returns a SceneOptimizerOptions object
  77735. */
  77736. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77737. /**
  77738. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  77739. * @param targetFrameRate defines the target frame rate (60 by default)
  77740. * @returns a SceneOptimizerOptions object
  77741. */
  77742. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77743. }
  77744. /**
  77745. * Class used to run optimizations in order to reach a target frame rate
  77746. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77747. */
  77748. export class SceneOptimizer implements IDisposable {
  77749. private _isRunning;
  77750. private _options;
  77751. private _scene;
  77752. private _currentPriorityLevel;
  77753. private _targetFrameRate;
  77754. private _trackerDuration;
  77755. private _currentFrameRate;
  77756. private _sceneDisposeObserver;
  77757. private _improvementMode;
  77758. /**
  77759. * Defines an observable called when the optimizer reaches the target frame rate
  77760. */
  77761. onSuccessObservable: Observable<SceneOptimizer>;
  77762. /**
  77763. * Defines an observable called when the optimizer enables an optimization
  77764. */
  77765. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  77766. /**
  77767. * Defines an observable called when the optimizer is not able to reach the target frame rate
  77768. */
  77769. onFailureObservable: Observable<SceneOptimizer>;
  77770. /**
  77771. * Gets a boolean indicating if the optimizer is in improvement mode
  77772. */
  77773. get isInImprovementMode(): boolean;
  77774. /**
  77775. * Gets the current priority level (0 at start)
  77776. */
  77777. get currentPriorityLevel(): number;
  77778. /**
  77779. * Gets the current frame rate checked by the SceneOptimizer
  77780. */
  77781. get currentFrameRate(): number;
  77782. /**
  77783. * Gets or sets the current target frame rate (60 by default)
  77784. */
  77785. get targetFrameRate(): number;
  77786. /**
  77787. * Gets or sets the current target frame rate (60 by default)
  77788. */
  77789. set targetFrameRate(value: number);
  77790. /**
  77791. * Gets or sets the current interval between two checks (every 2000ms by default)
  77792. */
  77793. get trackerDuration(): number;
  77794. /**
  77795. * Gets or sets the current interval between two checks (every 2000ms by default)
  77796. */
  77797. set trackerDuration(value: number);
  77798. /**
  77799. * Gets the list of active optimizations
  77800. */
  77801. get optimizations(): SceneOptimization[];
  77802. /**
  77803. * Creates a new SceneOptimizer
  77804. * @param scene defines the scene to work on
  77805. * @param options defines the options to use with the SceneOptimizer
  77806. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  77807. * @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)
  77808. */
  77809. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  77810. /**
  77811. * Stops the current optimizer
  77812. */
  77813. stop(): void;
  77814. /**
  77815. * Reset the optimizer to initial step (current priority level = 0)
  77816. */
  77817. reset(): void;
  77818. /**
  77819. * Start the optimizer. By default it will try to reach a specific framerate
  77820. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  77821. */
  77822. start(): void;
  77823. private _checkCurrentState;
  77824. /**
  77825. * Release all resources
  77826. */
  77827. dispose(): void;
  77828. /**
  77829. * Helper function to create a SceneOptimizer with one single line of code
  77830. * @param scene defines the scene to work on
  77831. * @param options defines the options to use with the SceneOptimizer
  77832. * @param onSuccess defines a callback to call on success
  77833. * @param onFailure defines a callback to call on failure
  77834. * @returns the new SceneOptimizer object
  77835. */
  77836. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  77837. }
  77838. }
  77839. declare module "babylonjs/Misc/sceneSerializer" {
  77840. import { Scene } from "babylonjs/scene";
  77841. /**
  77842. * Class used to serialize a scene into a string
  77843. */
  77844. export class SceneSerializer {
  77845. /**
  77846. * Clear cache used by a previous serialization
  77847. */
  77848. static ClearCache(): void;
  77849. /**
  77850. * Serialize a scene into a JSON compatible object
  77851. * @param scene defines the scene to serialize
  77852. * @returns a JSON compatible object
  77853. */
  77854. static Serialize(scene: Scene): any;
  77855. /**
  77856. * Serialize a mesh into a JSON compatible object
  77857. * @param toSerialize defines the mesh to serialize
  77858. * @param withParents defines if parents must be serialized as well
  77859. * @param withChildren defines if children must be serialized as well
  77860. * @returns a JSON compatible object
  77861. */
  77862. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  77863. }
  77864. }
  77865. declare module "babylonjs/Misc/textureTools" {
  77866. import { Texture } from "babylonjs/Materials/Textures/texture";
  77867. /**
  77868. * Class used to host texture specific utilities
  77869. */
  77870. export class TextureTools {
  77871. /**
  77872. * Uses the GPU to create a copy texture rescaled at a given size
  77873. * @param texture Texture to copy from
  77874. * @param width defines the desired width
  77875. * @param height defines the desired height
  77876. * @param useBilinearMode defines if bilinear mode has to be used
  77877. * @return the generated texture
  77878. */
  77879. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  77880. }
  77881. }
  77882. declare module "babylonjs/Misc/videoRecorder" {
  77883. import { Nullable } from "babylonjs/types";
  77884. import { Engine } from "babylonjs/Engines/engine";
  77885. /**
  77886. * This represents the different options available for the video capture.
  77887. */
  77888. export interface VideoRecorderOptions {
  77889. /** Defines the mime type of the video. */
  77890. mimeType: string;
  77891. /** Defines the FPS the video should be recorded at. */
  77892. fps: number;
  77893. /** Defines the chunk size for the recording data. */
  77894. recordChunckSize: number;
  77895. /** The audio tracks to attach to the recording. */
  77896. audioTracks?: MediaStreamTrack[];
  77897. }
  77898. /**
  77899. * This can help with recording videos from BabylonJS.
  77900. * This is based on the available WebRTC functionalities of the browser.
  77901. *
  77902. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  77903. */
  77904. export class VideoRecorder {
  77905. private static readonly _defaultOptions;
  77906. /**
  77907. * Returns whether or not the VideoRecorder is available in your browser.
  77908. * @param engine Defines the Babylon Engine.
  77909. * @returns true if supported otherwise false.
  77910. */
  77911. static IsSupported(engine: Engine): boolean;
  77912. private readonly _options;
  77913. private _canvas;
  77914. private _mediaRecorder;
  77915. private _recordedChunks;
  77916. private _fileName;
  77917. private _resolve;
  77918. private _reject;
  77919. /**
  77920. * True when a recording is already in progress.
  77921. */
  77922. get isRecording(): boolean;
  77923. /**
  77924. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  77925. * @param engine Defines the BabylonJS Engine you wish to record.
  77926. * @param options Defines options that can be used to customize the capture.
  77927. */
  77928. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  77929. /**
  77930. * Stops the current recording before the default capture timeout passed in the startRecording function.
  77931. */
  77932. stopRecording(): void;
  77933. /**
  77934. * Starts recording the canvas for a max duration specified in parameters.
  77935. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  77936. * If null no automatic download will start and you can rely on the promise to get the data back.
  77937. * @param maxDuration Defines the maximum recording time in seconds.
  77938. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  77939. * @return A promise callback at the end of the recording with the video data in Blob.
  77940. */
  77941. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  77942. /**
  77943. * Releases internal resources used during the recording.
  77944. */
  77945. dispose(): void;
  77946. private _handleDataAvailable;
  77947. private _handleError;
  77948. private _handleStop;
  77949. }
  77950. }
  77951. declare module "babylonjs/Misc/screenshotTools" {
  77952. import { Camera } from "babylonjs/Cameras/camera";
  77953. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  77954. import { Engine } from "babylonjs/Engines/engine";
  77955. /**
  77956. * Class containing a set of static utilities functions for screenshots
  77957. */
  77958. export class ScreenshotTools {
  77959. /**
  77960. * Captures a screenshot of the current rendering
  77961. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  77962. * @param engine defines the rendering engine
  77963. * @param camera defines the source camera
  77964. * @param size This parameter can be set to a single number or to an object with the
  77965. * following (optional) properties: precision, width, height. If a single number is passed,
  77966. * it will be used for both width and height. If an object is passed, the screenshot size
  77967. * will be derived from the parameters. The precision property is a multiplier allowing
  77968. * rendering at a higher or lower resolution
  77969. * @param successCallback defines the callback receives a single parameter which contains the
  77970. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  77971. * src parameter of an <img> to display it
  77972. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  77973. * Check your browser for supported MIME types
  77974. */
  77975. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  77976. /**
  77977. * Captures a screenshot of the current rendering
  77978. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  77979. * @param engine defines the rendering engine
  77980. * @param camera defines the source camera
  77981. * @param size This parameter can be set to a single number or to an object with the
  77982. * following (optional) properties: precision, width, height. If a single number is passed,
  77983. * it will be used for both width and height. If an object is passed, the screenshot size
  77984. * will be derived from the parameters. The precision property is a multiplier allowing
  77985. * rendering at a higher or lower resolution
  77986. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  77987. * Check your browser for supported MIME types
  77988. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  77989. * to the src parameter of an <img> to display it
  77990. */
  77991. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  77992. /**
  77993. * Generates an image screenshot from the specified camera.
  77994. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  77995. * @param engine The engine to use for rendering
  77996. * @param camera The camera to use for rendering
  77997. * @param size This parameter can be set to a single number or to an object with the
  77998. * following (optional) properties: precision, width, height. If a single number is passed,
  77999. * it will be used for both width and height. If an object is passed, the screenshot size
  78000. * will be derived from the parameters. The precision property is a multiplier allowing
  78001. * rendering at a higher or lower resolution
  78002. * @param successCallback The callback receives a single parameter which contains the
  78003. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  78004. * src parameter of an <img> to display it
  78005. * @param mimeType The MIME type of the screenshot image (default: image/png).
  78006. * Check your browser for supported MIME types
  78007. * @param samples Texture samples (default: 1)
  78008. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  78009. * @param fileName A name for for the downloaded file.
  78010. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  78011. * @param enableStencilBuffer Whether the stencil buffer should be enabled or not (default: false)
  78012. */
  78013. 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;
  78014. /**
  78015. * Generates an image screenshot from the specified camera.
  78016. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78017. * @param engine The engine to use for rendering
  78018. * @param camera The camera to use for rendering
  78019. * @param size This parameter can be set to a single number or to an object with the
  78020. * following (optional) properties: precision, width, height. If a single number is passed,
  78021. * it will be used for both width and height. If an object is passed, the screenshot size
  78022. * will be derived from the parameters. The precision property is a multiplier allowing
  78023. * rendering at a higher or lower resolution
  78024. * @param mimeType The MIME type of the screenshot image (default: image/png).
  78025. * Check your browser for supported MIME types
  78026. * @param samples Texture samples (default: 1)
  78027. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  78028. * @param fileName A name for for the downloaded file.
  78029. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  78030. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  78031. * to the src parameter of an <img> to display it
  78032. */
  78033. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  78034. /**
  78035. * Gets height and width for screenshot size
  78036. * @private
  78037. */
  78038. private static _getScreenshotSize;
  78039. }
  78040. }
  78041. declare module "babylonjs/Misc/dataReader" {
  78042. /**
  78043. * Interface for a data buffer
  78044. */
  78045. export interface IDataBuffer {
  78046. /**
  78047. * Reads bytes from the data buffer.
  78048. * @param byteOffset The byte offset to read
  78049. * @param byteLength The byte length to read
  78050. * @returns A promise that resolves when the bytes are read
  78051. */
  78052. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  78053. /**
  78054. * The byte length of the buffer.
  78055. */
  78056. readonly byteLength: number;
  78057. }
  78058. /**
  78059. * Utility class for reading from a data buffer
  78060. */
  78061. export class DataReader {
  78062. /**
  78063. * The data buffer associated with this data reader.
  78064. */
  78065. readonly buffer: IDataBuffer;
  78066. /**
  78067. * The current byte offset from the beginning of the data buffer.
  78068. */
  78069. byteOffset: number;
  78070. private _dataView;
  78071. private _dataByteOffset;
  78072. /**
  78073. * Constructor
  78074. * @param buffer The buffer to read
  78075. */
  78076. constructor(buffer: IDataBuffer);
  78077. /**
  78078. * Loads the given byte length.
  78079. * @param byteLength The byte length to load
  78080. * @returns A promise that resolves when the load is complete
  78081. */
  78082. loadAsync(byteLength: number): Promise<void>;
  78083. /**
  78084. * Read a unsigned 32-bit integer from the currently loaded data range.
  78085. * @returns The 32-bit integer read
  78086. */
  78087. readUint32(): number;
  78088. /**
  78089. * Read a byte array from the currently loaded data range.
  78090. * @param byteLength The byte length to read
  78091. * @returns The byte array read
  78092. */
  78093. readUint8Array(byteLength: number): Uint8Array;
  78094. /**
  78095. * Read a string from the currently loaded data range.
  78096. * @param byteLength The byte length to read
  78097. * @returns The string read
  78098. */
  78099. readString(byteLength: number): string;
  78100. /**
  78101. * Skips the given byte length the currently loaded data range.
  78102. * @param byteLength The byte length to skip
  78103. */
  78104. skipBytes(byteLength: number): void;
  78105. }
  78106. }
  78107. declare module "babylonjs/Misc/dataStorage" {
  78108. /**
  78109. * Class for storing data to local storage if available or in-memory storage otherwise
  78110. */
  78111. export class DataStorage {
  78112. private static _Storage;
  78113. private static _GetStorage;
  78114. /**
  78115. * Reads a string from the data storage
  78116. * @param key The key to read
  78117. * @param defaultValue The value if the key doesn't exist
  78118. * @returns The string value
  78119. */
  78120. static ReadString(key: string, defaultValue: string): string;
  78121. /**
  78122. * Writes a string to the data storage
  78123. * @param key The key to write
  78124. * @param value The value to write
  78125. */
  78126. static WriteString(key: string, value: string): void;
  78127. /**
  78128. * Reads a boolean from the data storage
  78129. * @param key The key to read
  78130. * @param defaultValue The value if the key doesn't exist
  78131. * @returns The boolean value
  78132. */
  78133. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  78134. /**
  78135. * Writes a boolean to the data storage
  78136. * @param key The key to write
  78137. * @param value The value to write
  78138. */
  78139. static WriteBoolean(key: string, value: boolean): void;
  78140. /**
  78141. * Reads a number from the data storage
  78142. * @param key The key to read
  78143. * @param defaultValue The value if the key doesn't exist
  78144. * @returns The number value
  78145. */
  78146. static ReadNumber(key: string, defaultValue: number): number;
  78147. /**
  78148. * Writes a number to the data storage
  78149. * @param key The key to write
  78150. * @param value The value to write
  78151. */
  78152. static WriteNumber(key: string, value: number): void;
  78153. }
  78154. }
  78155. declare module "babylonjs/Misc/sceneRecorder" {
  78156. import { Scene } from "babylonjs/scene";
  78157. /**
  78158. * Class used to record delta files between 2 scene states
  78159. */
  78160. export class SceneRecorder {
  78161. private _trackedScene;
  78162. private _savedJSON;
  78163. /**
  78164. * Track a given scene. This means the current scene state will be considered the original state
  78165. * @param scene defines the scene to track
  78166. */
  78167. track(scene: Scene): void;
  78168. /**
  78169. * Get the delta between current state and original state
  78170. * @returns a string containing the delta
  78171. */
  78172. getDelta(): any;
  78173. private _compareArray;
  78174. private _compareObjects;
  78175. private _compareCollections;
  78176. private static GetShadowGeneratorById;
  78177. /**
  78178. * Apply a given delta to a given scene
  78179. * @param deltaJSON defines the JSON containing the delta
  78180. * @param scene defines the scene to apply the delta to
  78181. */
  78182. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  78183. private static _ApplyPropertiesToEntity;
  78184. private static _ApplyDeltaForEntity;
  78185. }
  78186. }
  78187. declare module "babylonjs/Misc/index" {
  78188. export * from "babylonjs/Misc/andOrNotEvaluator";
  78189. export * from "babylonjs/Misc/assetsManager";
  78190. export * from "babylonjs/Misc/basis";
  78191. export * from "babylonjs/Misc/dds";
  78192. export * from "babylonjs/Misc/decorators";
  78193. export * from "babylonjs/Misc/deferred";
  78194. export * from "babylonjs/Misc/environmentTextureTools";
  78195. export * from "babylonjs/Misc/meshExploder";
  78196. export * from "babylonjs/Misc/filesInput";
  78197. export * from "babylonjs/Misc/HighDynamicRange/index";
  78198. export * from "babylonjs/Misc/khronosTextureContainer";
  78199. export * from "babylonjs/Misc/observable";
  78200. export * from "babylonjs/Misc/performanceMonitor";
  78201. export * from "babylonjs/Misc/promise";
  78202. export * from "babylonjs/Misc/sceneOptimizer";
  78203. export * from "babylonjs/Misc/sceneSerializer";
  78204. export * from "babylonjs/Misc/smartArray";
  78205. export * from "babylonjs/Misc/stringDictionary";
  78206. export * from "babylonjs/Misc/tags";
  78207. export * from "babylonjs/Misc/textureTools";
  78208. export * from "babylonjs/Misc/tga";
  78209. export * from "babylonjs/Misc/tools";
  78210. export * from "babylonjs/Misc/videoRecorder";
  78211. export * from "babylonjs/Misc/virtualJoystick";
  78212. export * from "babylonjs/Misc/workerPool";
  78213. export * from "babylonjs/Misc/logger";
  78214. export * from "babylonjs/Misc/typeStore";
  78215. export * from "babylonjs/Misc/filesInputStore";
  78216. export * from "babylonjs/Misc/deepCopier";
  78217. export * from "babylonjs/Misc/pivotTools";
  78218. export * from "babylonjs/Misc/precisionDate";
  78219. export * from "babylonjs/Misc/screenshotTools";
  78220. export * from "babylonjs/Misc/typeStore";
  78221. export * from "babylonjs/Misc/webRequest";
  78222. export * from "babylonjs/Misc/iInspectable";
  78223. export * from "babylonjs/Misc/brdfTextureTools";
  78224. export * from "babylonjs/Misc/rgbdTextureTools";
  78225. export * from "babylonjs/Misc/gradients";
  78226. export * from "babylonjs/Misc/perfCounter";
  78227. export * from "babylonjs/Misc/fileRequest";
  78228. export * from "babylonjs/Misc/customAnimationFrameRequester";
  78229. export * from "babylonjs/Misc/retryStrategy";
  78230. export * from "babylonjs/Misc/interfaces/screenshotSize";
  78231. export * from "babylonjs/Misc/canvasGenerator";
  78232. export * from "babylonjs/Misc/fileTools";
  78233. export * from "babylonjs/Misc/stringTools";
  78234. export * from "babylonjs/Misc/dataReader";
  78235. export * from "babylonjs/Misc/minMaxReducer";
  78236. export * from "babylonjs/Misc/depthReducer";
  78237. export * from "babylonjs/Misc/dataStorage";
  78238. export * from "babylonjs/Misc/sceneRecorder";
  78239. }
  78240. declare module "babylonjs/XR/features/WebXRHitTestLegacy" {
  78241. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  78242. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78243. import { Observable } from "babylonjs/Misc/observable";
  78244. import { Matrix } from "babylonjs/Maths/math.vector";
  78245. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78246. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78247. /**
  78248. * An interface for all Hit test features
  78249. */
  78250. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  78251. /**
  78252. * Triggered when new babylon (transformed) hit test results are available
  78253. */
  78254. onHitTestResultObservable: Observable<T[]>;
  78255. }
  78256. /**
  78257. * Options used for hit testing
  78258. */
  78259. export interface IWebXRLegacyHitTestOptions {
  78260. /**
  78261. * Only test when user interacted with the scene. Default - hit test every frame
  78262. */
  78263. testOnPointerDownOnly?: boolean;
  78264. /**
  78265. * The node to use to transform the local results to world coordinates
  78266. */
  78267. worldParentNode?: TransformNode;
  78268. }
  78269. /**
  78270. * Interface defining the babylon result of raycasting/hit-test
  78271. */
  78272. export interface IWebXRLegacyHitResult {
  78273. /**
  78274. * Transformation matrix that can be applied to a node that will put it in the hit point location
  78275. */
  78276. transformationMatrix: Matrix;
  78277. /**
  78278. * The native hit test result
  78279. */
  78280. xrHitResult: XRHitResult | XRHitTestResult;
  78281. }
  78282. /**
  78283. * The currently-working hit-test module.
  78284. * Hit test (or Ray-casting) is used to interact with the real world.
  78285. * For further information read here - https://github.com/immersive-web/hit-test
  78286. */
  78287. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  78288. /**
  78289. * options to use when constructing this feature
  78290. */
  78291. readonly options: IWebXRLegacyHitTestOptions;
  78292. private _direction;
  78293. private _mat;
  78294. private _onSelectEnabled;
  78295. private _origin;
  78296. /**
  78297. * The module's name
  78298. */
  78299. static readonly Name: string;
  78300. /**
  78301. * The (Babylon) version of this module.
  78302. * This is an integer representing the implementation version.
  78303. * This number does not correspond to the WebXR specs version
  78304. */
  78305. static readonly Version: number;
  78306. /**
  78307. * Populated with the last native XR Hit Results
  78308. */
  78309. lastNativeXRHitResults: XRHitResult[];
  78310. /**
  78311. * Triggered when new babylon (transformed) hit test results are available
  78312. */
  78313. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  78314. /**
  78315. * Creates a new instance of the (legacy version) hit test feature
  78316. * @param _xrSessionManager an instance of WebXRSessionManager
  78317. * @param options options to use when constructing this feature
  78318. */
  78319. constructor(_xrSessionManager: WebXRSessionManager,
  78320. /**
  78321. * options to use when constructing this feature
  78322. */
  78323. options?: IWebXRLegacyHitTestOptions);
  78324. /**
  78325. * execute a hit test with an XR Ray
  78326. *
  78327. * @param xrSession a native xrSession that will execute this hit test
  78328. * @param xrRay the ray (position and direction) to use for ray-casting
  78329. * @param referenceSpace native XR reference space to use for the hit-test
  78330. * @param filter filter function that will filter the results
  78331. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  78332. */
  78333. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  78334. /**
  78335. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  78336. * @param event the (select) event to use to select with
  78337. * @param referenceSpace the reference space to use for this hit test
  78338. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  78339. */
  78340. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  78341. /**
  78342. * attach this feature
  78343. * Will usually be called by the features manager
  78344. *
  78345. * @returns true if successful.
  78346. */
  78347. attach(): boolean;
  78348. /**
  78349. * detach this feature.
  78350. * Will usually be called by the features manager
  78351. *
  78352. * @returns true if successful.
  78353. */
  78354. detach(): boolean;
  78355. /**
  78356. * Dispose this feature and all of the resources attached
  78357. */
  78358. dispose(): void;
  78359. protected _onXRFrame(frame: XRFrame): void;
  78360. private _onHitTestResults;
  78361. private _onSelect;
  78362. }
  78363. }
  78364. declare module "babylonjs/XR/features/WebXRHitTest" {
  78365. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78366. import { Observable } from "babylonjs/Misc/observable";
  78367. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  78368. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78369. import { IWebXRLegacyHitTestOptions, IWebXRLegacyHitResult, IWebXRHitTestFeature } from "babylonjs/XR/features/WebXRHitTestLegacy";
  78370. /**
  78371. * Options used for hit testing (version 2)
  78372. */
  78373. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  78374. /**
  78375. * Do not create a permanent hit test. Will usually be used when only
  78376. * transient inputs are needed.
  78377. */
  78378. disablePermanentHitTest?: boolean;
  78379. /**
  78380. * Enable transient (for example touch-based) hit test inspections
  78381. */
  78382. enableTransientHitTest?: boolean;
  78383. /**
  78384. * Offset ray for the permanent hit test
  78385. */
  78386. offsetRay?: Vector3;
  78387. /**
  78388. * Offset ray for the transient hit test
  78389. */
  78390. transientOffsetRay?: Vector3;
  78391. /**
  78392. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  78393. */
  78394. useReferenceSpace?: boolean;
  78395. /**
  78396. * Override the default entity type(s) of the hit-test result
  78397. */
  78398. entityTypes?: XRHitTestTrackableType[];
  78399. }
  78400. /**
  78401. * Interface defining the babylon result of hit-test
  78402. */
  78403. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  78404. /**
  78405. * The input source that generated this hit test (if transient)
  78406. */
  78407. inputSource?: XRInputSource;
  78408. /**
  78409. * Is this a transient hit test
  78410. */
  78411. isTransient?: boolean;
  78412. /**
  78413. * Position of the hit test result
  78414. */
  78415. position: Vector3;
  78416. /**
  78417. * Rotation of the hit test result
  78418. */
  78419. rotationQuaternion: Quaternion;
  78420. /**
  78421. * The native hit test result
  78422. */
  78423. xrHitResult: XRHitTestResult;
  78424. }
  78425. /**
  78426. * The currently-working hit-test module.
  78427. * Hit test (or Ray-casting) is used to interact with the real world.
  78428. * For further information read here - https://github.com/immersive-web/hit-test
  78429. *
  78430. * Tested on chrome (mobile) 80.
  78431. */
  78432. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  78433. /**
  78434. * options to use when constructing this feature
  78435. */
  78436. readonly options: IWebXRHitTestOptions;
  78437. private _tmpMat;
  78438. private _tmpPos;
  78439. private _tmpQuat;
  78440. private _transientXrHitTestSource;
  78441. private _xrHitTestSource;
  78442. private initHitTestSource;
  78443. /**
  78444. * The module's name
  78445. */
  78446. static readonly Name: string;
  78447. /**
  78448. * The (Babylon) version of this module.
  78449. * This is an integer representing the implementation version.
  78450. * This number does not correspond to the WebXR specs version
  78451. */
  78452. static readonly Version: number;
  78453. /**
  78454. * When set to true, each hit test will have its own position/rotation objects
  78455. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  78456. * the developers will clone them or copy them as they see fit.
  78457. */
  78458. autoCloneTransformation: boolean;
  78459. /**
  78460. * Triggered when new babylon (transformed) hit test results are available
  78461. */
  78462. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  78463. /**
  78464. * Use this to temporarily pause hit test checks.
  78465. */
  78466. paused: boolean;
  78467. /**
  78468. * Creates a new instance of the hit test feature
  78469. * @param _xrSessionManager an instance of WebXRSessionManager
  78470. * @param options options to use when constructing this feature
  78471. */
  78472. constructor(_xrSessionManager: WebXRSessionManager,
  78473. /**
  78474. * options to use when constructing this feature
  78475. */
  78476. options?: IWebXRHitTestOptions);
  78477. /**
  78478. * attach this feature
  78479. * Will usually be called by the features manager
  78480. *
  78481. * @returns true if successful.
  78482. */
  78483. attach(): boolean;
  78484. /**
  78485. * detach this feature.
  78486. * Will usually be called by the features manager
  78487. *
  78488. * @returns true if successful.
  78489. */
  78490. detach(): boolean;
  78491. /**
  78492. * Dispose this feature and all of the resources attached
  78493. */
  78494. dispose(): void;
  78495. protected _onXRFrame(frame: XRFrame): void;
  78496. private _processWebXRHitTestResult;
  78497. }
  78498. }
  78499. declare module "babylonjs/XR/features/WebXRAnchorSystem" {
  78500. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78501. import { Observable } from "babylonjs/Misc/observable";
  78502. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  78503. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78504. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78505. import { IWebXRHitResult } from "babylonjs/XR/features/WebXRHitTest";
  78506. /**
  78507. * Configuration options of the anchor system
  78508. */
  78509. export interface IWebXRAnchorSystemOptions {
  78510. /**
  78511. * a node that will be used to convert local to world coordinates
  78512. */
  78513. worldParentNode?: TransformNode;
  78514. /**
  78515. * If set to true a reference of the created anchors will be kept until the next session starts
  78516. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  78517. */
  78518. doNotRemoveAnchorsOnSessionEnded?: boolean;
  78519. }
  78520. /**
  78521. * A babylon container for an XR Anchor
  78522. */
  78523. export interface IWebXRAnchor {
  78524. /**
  78525. * A babylon-assigned ID for this anchor
  78526. */
  78527. id: number;
  78528. /**
  78529. * Transformation matrix to apply to an object attached to this anchor
  78530. */
  78531. transformationMatrix: Matrix;
  78532. /**
  78533. * The native anchor object
  78534. */
  78535. xrAnchor: XRAnchor;
  78536. /**
  78537. * if defined, this object will be constantly updated by the anchor's position and rotation
  78538. */
  78539. attachedNode?: TransformNode;
  78540. }
  78541. /**
  78542. * An implementation of the anchor system for WebXR.
  78543. * For further information see https://github.com/immersive-web/anchors/
  78544. */
  78545. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  78546. private _options;
  78547. private _lastFrameDetected;
  78548. private _trackedAnchors;
  78549. private _referenceSpaceForFrameAnchors;
  78550. private _futureAnchors;
  78551. /**
  78552. * The module's name
  78553. */
  78554. static readonly Name: string;
  78555. /**
  78556. * The (Babylon) version of this module.
  78557. * This is an integer representing the implementation version.
  78558. * This number does not correspond to the WebXR specs version
  78559. */
  78560. static readonly Version: number;
  78561. /**
  78562. * Observers registered here will be executed when a new anchor was added to the session
  78563. */
  78564. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  78565. /**
  78566. * Observers registered here will be executed when an anchor was removed from the session
  78567. */
  78568. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  78569. /**
  78570. * Observers registered here will be executed when an existing anchor updates
  78571. * This can execute N times every frame
  78572. */
  78573. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  78574. /**
  78575. * Set the reference space to use for anchor creation, when not using a hit test.
  78576. * Will default to the session's reference space if not defined
  78577. */
  78578. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  78579. /**
  78580. * constructs a new anchor system
  78581. * @param _xrSessionManager an instance of WebXRSessionManager
  78582. * @param _options configuration object for this feature
  78583. */
  78584. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  78585. private _tmpVector;
  78586. private _tmpQuaternion;
  78587. private _populateTmpTransformation;
  78588. /**
  78589. * Create a new anchor point using a hit test result at a specific point in the scene
  78590. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  78591. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  78592. *
  78593. * @param hitTestResult The hit test result to use for this anchor creation
  78594. * @param position an optional position offset for this anchor
  78595. * @param rotationQuaternion an optional rotation offset for this anchor
  78596. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  78597. */
  78598. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  78599. /**
  78600. * Add a new anchor at a specific position and rotation
  78601. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  78602. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  78603. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  78604. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  78605. *
  78606. * @param position the position in which to add an anchor
  78607. * @param rotationQuaternion an optional rotation for the anchor transformation
  78608. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  78609. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  78610. */
  78611. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  78612. /**
  78613. * detach this feature.
  78614. * Will usually be called by the features manager
  78615. *
  78616. * @returns true if successful.
  78617. */
  78618. detach(): boolean;
  78619. /**
  78620. * Dispose this feature and all of the resources attached
  78621. */
  78622. dispose(): void;
  78623. protected _onXRFrame(frame: XRFrame): void;
  78624. /**
  78625. * avoiding using Array.find for global support.
  78626. * @param xrAnchor the plane to find in the array
  78627. */
  78628. private _findIndexInAnchorArray;
  78629. private _updateAnchorWithXRFrame;
  78630. private _createAnchorAtTransformation;
  78631. }
  78632. }
  78633. declare module "babylonjs/XR/features/WebXRPlaneDetector" {
  78634. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78635. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78636. import { Observable } from "babylonjs/Misc/observable";
  78637. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  78638. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78639. /**
  78640. * Options used in the plane detector module
  78641. */
  78642. export interface IWebXRPlaneDetectorOptions {
  78643. /**
  78644. * The node to use to transform the local results to world coordinates
  78645. */
  78646. worldParentNode?: TransformNode;
  78647. /**
  78648. * If set to true a reference of the created planes will be kept until the next session starts
  78649. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  78650. */
  78651. doNotRemovePlanesOnSessionEnded?: boolean;
  78652. }
  78653. /**
  78654. * A babylon interface for a WebXR plane.
  78655. * A Plane is actually a polygon, built from N points in space
  78656. *
  78657. * Supported in chrome 79, not supported in canary 81 ATM
  78658. */
  78659. export interface IWebXRPlane {
  78660. /**
  78661. * a babylon-assigned ID for this polygon
  78662. */
  78663. id: number;
  78664. /**
  78665. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  78666. */
  78667. polygonDefinition: Array<Vector3>;
  78668. /**
  78669. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  78670. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  78671. */
  78672. transformationMatrix: Matrix;
  78673. /**
  78674. * the native xr-plane object
  78675. */
  78676. xrPlane: XRPlane;
  78677. }
  78678. /**
  78679. * The plane detector is used to detect planes in the real world when in AR
  78680. * For more information see https://github.com/immersive-web/real-world-geometry/
  78681. */
  78682. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  78683. private _options;
  78684. private _detectedPlanes;
  78685. private _enabled;
  78686. private _lastFrameDetected;
  78687. /**
  78688. * The module's name
  78689. */
  78690. static readonly Name: string;
  78691. /**
  78692. * The (Babylon) version of this module.
  78693. * This is an integer representing the implementation version.
  78694. * This number does not correspond to the WebXR specs version
  78695. */
  78696. static readonly Version: number;
  78697. /**
  78698. * Observers registered here will be executed when a new plane was added to the session
  78699. */
  78700. onPlaneAddedObservable: Observable<IWebXRPlane>;
  78701. /**
  78702. * Observers registered here will be executed when a plane is no longer detected in the session
  78703. */
  78704. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  78705. /**
  78706. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  78707. * This can execute N times every frame
  78708. */
  78709. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  78710. /**
  78711. * construct a new Plane Detector
  78712. * @param _xrSessionManager an instance of xr Session manager
  78713. * @param _options configuration to use when constructing this feature
  78714. */
  78715. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  78716. /**
  78717. * detach this feature.
  78718. * Will usually be called by the features manager
  78719. *
  78720. * @returns true if successful.
  78721. */
  78722. detach(): boolean;
  78723. /**
  78724. * Dispose this feature and all of the resources attached
  78725. */
  78726. dispose(): void;
  78727. protected _onXRFrame(frame: XRFrame): void;
  78728. private _init;
  78729. private _updatePlaneWithXRPlane;
  78730. /**
  78731. * avoiding using Array.find for global support.
  78732. * @param xrPlane the plane to find in the array
  78733. */
  78734. private findIndexInPlaneArray;
  78735. }
  78736. }
  78737. declare module "babylonjs/XR/features/WebXRBackgroundRemover" {
  78738. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78739. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  78740. import { Observable } from "babylonjs/Misc/observable";
  78741. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78742. /**
  78743. * Options interface for the background remover plugin
  78744. */
  78745. export interface IWebXRBackgroundRemoverOptions {
  78746. /**
  78747. * Further background meshes to disable when entering AR
  78748. */
  78749. backgroundMeshes?: AbstractMesh[];
  78750. /**
  78751. * flags to configure the removal of the environment helper.
  78752. * If not set, the entire background will be removed. If set, flags should be set as well.
  78753. */
  78754. environmentHelperRemovalFlags?: {
  78755. /**
  78756. * Should the skybox be removed (default false)
  78757. */
  78758. skyBox?: boolean;
  78759. /**
  78760. * Should the ground be removed (default false)
  78761. */
  78762. ground?: boolean;
  78763. };
  78764. /**
  78765. * don't disable the environment helper
  78766. */
  78767. ignoreEnvironmentHelper?: boolean;
  78768. }
  78769. /**
  78770. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  78771. */
  78772. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  78773. /**
  78774. * read-only options to be used in this module
  78775. */
  78776. readonly options: IWebXRBackgroundRemoverOptions;
  78777. /**
  78778. * The module's name
  78779. */
  78780. static readonly Name: string;
  78781. /**
  78782. * The (Babylon) version of this module.
  78783. * This is an integer representing the implementation version.
  78784. * This number does not correspond to the WebXR specs version
  78785. */
  78786. static readonly Version: number;
  78787. /**
  78788. * registered observers will be triggered when the background state changes
  78789. */
  78790. onBackgroundStateChangedObservable: Observable<boolean>;
  78791. /**
  78792. * constructs a new background remover module
  78793. * @param _xrSessionManager the session manager for this module
  78794. * @param options read-only options to be used in this module
  78795. */
  78796. constructor(_xrSessionManager: WebXRSessionManager,
  78797. /**
  78798. * read-only options to be used in this module
  78799. */
  78800. options?: IWebXRBackgroundRemoverOptions);
  78801. /**
  78802. * attach this feature
  78803. * Will usually be called by the features manager
  78804. *
  78805. * @returns true if successful.
  78806. */
  78807. attach(): boolean;
  78808. /**
  78809. * detach this feature.
  78810. * Will usually be called by the features manager
  78811. *
  78812. * @returns true if successful.
  78813. */
  78814. detach(): boolean;
  78815. /**
  78816. * Dispose this feature and all of the resources attached
  78817. */
  78818. dispose(): void;
  78819. protected _onXRFrame(_xrFrame: XRFrame): void;
  78820. private _setBackgroundState;
  78821. }
  78822. }
  78823. declare module "babylonjs/XR/features/WebXRControllerPhysics" {
  78824. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78825. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  78826. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  78827. import { WebXRInput } from "babylonjs/XR/webXRInput";
  78828. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78829. import { Nullable } from "babylonjs/types";
  78830. /**
  78831. * Options for the controller physics feature
  78832. */
  78833. export class IWebXRControllerPhysicsOptions {
  78834. /**
  78835. * Should the headset get its own impostor
  78836. */
  78837. enableHeadsetImpostor?: boolean;
  78838. /**
  78839. * Optional parameters for the headset impostor
  78840. */
  78841. headsetImpostorParams?: {
  78842. /**
  78843. * The type of impostor to create. Default is sphere
  78844. */
  78845. impostorType: number;
  78846. /**
  78847. * the size of the impostor. Defaults to 10cm
  78848. */
  78849. impostorSize?: number | {
  78850. width: number;
  78851. height: number;
  78852. depth: number;
  78853. };
  78854. /**
  78855. * Friction definitions
  78856. */
  78857. friction?: number;
  78858. /**
  78859. * Restitution
  78860. */
  78861. restitution?: number;
  78862. };
  78863. /**
  78864. * The physics properties of the future impostors
  78865. */
  78866. physicsProperties?: {
  78867. /**
  78868. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  78869. * Note that this requires a physics engine that supports mesh impostors!
  78870. */
  78871. useControllerMesh?: boolean;
  78872. /**
  78873. * The type of impostor to create. Default is sphere
  78874. */
  78875. impostorType?: number;
  78876. /**
  78877. * the size of the impostor. Defaults to 10cm
  78878. */
  78879. impostorSize?: number | {
  78880. width: number;
  78881. height: number;
  78882. depth: number;
  78883. };
  78884. /**
  78885. * Friction definitions
  78886. */
  78887. friction?: number;
  78888. /**
  78889. * Restitution
  78890. */
  78891. restitution?: number;
  78892. };
  78893. /**
  78894. * the xr input to use with this pointer selection
  78895. */
  78896. xrInput: WebXRInput;
  78897. }
  78898. /**
  78899. * Add physics impostor to your webxr controllers,
  78900. * including naive calculation of their linear and angular velocity
  78901. */
  78902. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  78903. private readonly _options;
  78904. private _attachController;
  78905. private _controllers;
  78906. private _debugMode;
  78907. private _delta;
  78908. private _headsetImpostor?;
  78909. private _headsetMesh?;
  78910. private _lastTimestamp;
  78911. private _tmpQuaternion;
  78912. private _tmpVector;
  78913. /**
  78914. * The module's name
  78915. */
  78916. static readonly Name: string;
  78917. /**
  78918. * The (Babylon) version of this module.
  78919. * This is an integer representing the implementation version.
  78920. * This number does not correspond to the webxr specs version
  78921. */
  78922. static readonly Version: number;
  78923. /**
  78924. * Construct a new Controller Physics Feature
  78925. * @param _xrSessionManager the corresponding xr session manager
  78926. * @param _options options to create this feature with
  78927. */
  78928. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  78929. /**
  78930. * @hidden
  78931. * enable debugging - will show console outputs and the impostor mesh
  78932. */
  78933. _enablePhysicsDebug(): void;
  78934. /**
  78935. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  78936. * @param xrController the controller to add
  78937. */
  78938. addController(xrController: WebXRInputSource): void;
  78939. /**
  78940. * attach this feature
  78941. * Will usually be called by the features manager
  78942. *
  78943. * @returns true if successful.
  78944. */
  78945. attach(): boolean;
  78946. /**
  78947. * detach this feature.
  78948. * Will usually be called by the features manager
  78949. *
  78950. * @returns true if successful.
  78951. */
  78952. detach(): boolean;
  78953. /**
  78954. * Get the headset impostor, if enabled
  78955. * @returns the impostor
  78956. */
  78957. getHeadsetImpostor(): PhysicsImpostor | undefined;
  78958. /**
  78959. * Get the physics impostor of a specific controller.
  78960. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  78961. * @param controller the controller or the controller id of which to get the impostor
  78962. * @returns the impostor or null
  78963. */
  78964. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  78965. /**
  78966. * Update the physics properties provided in the constructor
  78967. * @param newProperties the new properties object
  78968. */
  78969. setPhysicsProperties(newProperties: {
  78970. impostorType?: number;
  78971. impostorSize?: number | {
  78972. width: number;
  78973. height: number;
  78974. depth: number;
  78975. };
  78976. friction?: number;
  78977. restitution?: number;
  78978. }): void;
  78979. protected _onXRFrame(_xrFrame: any): void;
  78980. private _detachController;
  78981. }
  78982. }
  78983. declare module "babylonjs/XR/features/WebXRFeaturePointSystem" {
  78984. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78985. import { Observable } from "babylonjs/Misc/observable";
  78986. import { Vector3 } from "babylonjs/Maths/math.vector";
  78987. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78988. /**
  78989. * A babylon interface for a "WebXR" feature point.
  78990. * Represents the position and confidence value of a given feature point.
  78991. */
  78992. export interface IWebXRFeaturePoint {
  78993. /**
  78994. * Represents the position of the feature point in world space.
  78995. */
  78996. position: Vector3;
  78997. /**
  78998. * Represents the confidence value of the feature point in world space. 0 being least confident, and 1 being most confident.
  78999. */
  79000. confidenceValue: number;
  79001. }
  79002. /**
  79003. * The feature point system is used to detect feature points from real world geometry.
  79004. * This feature is currently experimental and only supported on BabylonNative, and should not be used in the browser.
  79005. * The newly introduced API can be seen in webxr.nativeextensions.d.ts and described in FeaturePoints.md.
  79006. */
  79007. export class WebXRFeaturePointSystem extends WebXRAbstractFeature {
  79008. private _enabled;
  79009. private _featurePointCloud;
  79010. /**
  79011. * The module's name
  79012. */
  79013. static readonly Name: string;
  79014. /**
  79015. * The (Babylon) version of this module.
  79016. * This is an integer representing the implementation version.
  79017. * This number does not correspond to the WebXR specs version
  79018. */
  79019. static readonly Version: number;
  79020. /**
  79021. * Observers registered here will be executed whenever new feature points are added (on XRFrame while the session is tracking).
  79022. * Will notify the observers about which feature points have been added.
  79023. */
  79024. readonly onFeaturePointsAddedObservable: Observable<number[]>;
  79025. /**
  79026. * Observers registered here will be executed whenever a feature point has been updated (on XRFrame while the session is tracking).
  79027. * Will notify the observers about which feature points have been updated.
  79028. */
  79029. readonly onFeaturePointsUpdatedObservable: Observable<number[]>;
  79030. /**
  79031. * The current feature point cloud maintained across frames.
  79032. */
  79033. get featurePointCloud(): Array<IWebXRFeaturePoint>;
  79034. /**
  79035. * construct the feature point system
  79036. * @param _xrSessionManager an instance of xr Session manager
  79037. */
  79038. constructor(_xrSessionManager: WebXRSessionManager);
  79039. /**
  79040. * Detach this feature.
  79041. * Will usually be called by the features manager
  79042. *
  79043. * @returns true if successful.
  79044. */
  79045. detach(): boolean;
  79046. /**
  79047. * Dispose this feature and all of the resources attached
  79048. */
  79049. dispose(): void;
  79050. /**
  79051. * On receiving a new XR frame if this feature is attached notify observers new feature point data is available.
  79052. */
  79053. protected _onXRFrame(frame: XRFrame): void;
  79054. /**
  79055. * Initializes the feature. If the feature point feature is not available for this environment do not mark the feature as enabled.
  79056. */
  79057. private _init;
  79058. }
  79059. }
  79060. declare module "babylonjs/XR/features/WebXRHandTracking" {
  79061. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79062. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79063. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79064. import { Mesh } from "babylonjs/Meshes/mesh";
  79065. import { WebXRInput } from "babylonjs/XR/webXRInput";
  79066. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  79067. import { Nullable } from "babylonjs/types";
  79068. import { IDisposable } from "babylonjs/scene";
  79069. import { Observable } from "babylonjs/Misc/observable";
  79070. /**
  79071. * Configuration interface for the hand tracking feature
  79072. */
  79073. export interface IWebXRHandTrackingOptions {
  79074. /**
  79075. * The xrInput that will be used as source for new hands
  79076. */
  79077. xrInput: WebXRInput;
  79078. /**
  79079. * Configuration object for the joint meshes
  79080. */
  79081. jointMeshes?: {
  79082. /**
  79083. * Should the meshes created be invisible (defaults to false)
  79084. */
  79085. invisible?: boolean;
  79086. /**
  79087. * A source mesh to be used to create instances. Defaults to a sphere.
  79088. * This mesh will be the source for all other (25) meshes.
  79089. * It should have the general size of a single unit, as the instances will be scaled according to the provided radius
  79090. */
  79091. sourceMesh?: Mesh;
  79092. /**
  79093. * Should the source mesh stay visible. Defaults to false
  79094. */
  79095. keepOriginalVisible?: boolean;
  79096. /**
  79097. * Scale factor for all instances (defaults to 2)
  79098. */
  79099. scaleFactor?: number;
  79100. /**
  79101. * Should each instance have its own physics impostor
  79102. */
  79103. enablePhysics?: boolean;
  79104. /**
  79105. * If enabled, override default physics properties
  79106. */
  79107. physicsProps?: {
  79108. friction?: number;
  79109. restitution?: number;
  79110. impostorType?: number;
  79111. };
  79112. /**
  79113. * For future use - a single hand-mesh that will be updated according to the XRHand data provided
  79114. */
  79115. handMesh?: AbstractMesh;
  79116. };
  79117. }
  79118. /**
  79119. * Parts of the hands divided to writs and finger names
  79120. */
  79121. export const enum HandPart {
  79122. /**
  79123. * HandPart - Wrist
  79124. */
  79125. WRIST = "wrist",
  79126. /**
  79127. * HandPart - The THumb
  79128. */
  79129. THUMB = "thumb",
  79130. /**
  79131. * HandPart - Index finger
  79132. */
  79133. INDEX = "index",
  79134. /**
  79135. * HandPart - Middle finger
  79136. */
  79137. MIDDLE = "middle",
  79138. /**
  79139. * HandPart - Ring finger
  79140. */
  79141. RING = "ring",
  79142. /**
  79143. * HandPart - Little finger
  79144. */
  79145. LITTLE = "little"
  79146. }
  79147. /**
  79148. * Representing a single hand (with its corresponding native XRHand object)
  79149. */
  79150. export class WebXRHand implements IDisposable {
  79151. /** the controller to which the hand correlates */
  79152. readonly xrController: WebXRInputSource;
  79153. /** the meshes to be used to track the hand joints */
  79154. readonly trackedMeshes: AbstractMesh[];
  79155. /**
  79156. * Hand-parts definition (key is HandPart)
  79157. */
  79158. static HandPartsDefinition: {
  79159. [key: string]: number[];
  79160. };
  79161. /**
  79162. * Populate the HandPartsDefinition object.
  79163. * This is called as a side effect since certain browsers don't have XRHand defined.
  79164. */
  79165. static _PopulateHandPartsDefinition(): void;
  79166. /**
  79167. * Construct a new hand object
  79168. * @param xrController the controller to which the hand correlates
  79169. * @param trackedMeshes the meshes to be used to track the hand joints
  79170. */
  79171. constructor(
  79172. /** the controller to which the hand correlates */
  79173. xrController: WebXRInputSource,
  79174. /** the meshes to be used to track the hand joints */
  79175. trackedMeshes: AbstractMesh[]);
  79176. /**
  79177. * Update this hand from the latest xr frame
  79178. * @param xrFrame xrFrame to update from
  79179. * @param referenceSpace The current viewer reference space
  79180. * @param scaleFactor optional scale factor for the meshes
  79181. */
  79182. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace, scaleFactor?: number): void;
  79183. /**
  79184. * Get meshes of part of the hand
  79185. * @param part the part of hand to get
  79186. * @returns An array of meshes that correlate to the hand part requested
  79187. */
  79188. getHandPartMeshes(part: HandPart): AbstractMesh[];
  79189. /**
  79190. * Dispose this Hand object
  79191. */
  79192. dispose(): void;
  79193. }
  79194. /**
  79195. * WebXR Hand Joint tracking feature, available for selected browsers and devices
  79196. */
  79197. export class WebXRHandTracking extends WebXRAbstractFeature {
  79198. /**
  79199. * options to use when constructing this feature
  79200. */
  79201. readonly options: IWebXRHandTrackingOptions;
  79202. private static _idCounter;
  79203. /**
  79204. * The module's name
  79205. */
  79206. static readonly Name: string;
  79207. /**
  79208. * The (Babylon) version of this module.
  79209. * This is an integer representing the implementation version.
  79210. * This number does not correspond to the WebXR specs version
  79211. */
  79212. static readonly Version: number;
  79213. /**
  79214. * This observable will notify registered observers when a new hand object was added and initialized
  79215. */
  79216. onHandAddedObservable: Observable<WebXRHand>;
  79217. /**
  79218. * This observable will notify its observers right before the hand object is disposed
  79219. */
  79220. onHandRemovedObservable: Observable<WebXRHand>;
  79221. private _hands;
  79222. /**
  79223. * Creates a new instance of the hit test feature
  79224. * @param _xrSessionManager an instance of WebXRSessionManager
  79225. * @param options options to use when constructing this feature
  79226. */
  79227. constructor(_xrSessionManager: WebXRSessionManager,
  79228. /**
  79229. * options to use when constructing this feature
  79230. */
  79231. options: IWebXRHandTrackingOptions);
  79232. /**
  79233. * Check if the needed objects are defined.
  79234. * This does not mean that the feature is enabled, but that the objects needed are well defined.
  79235. */
  79236. isCompatible(): boolean;
  79237. /**
  79238. * attach this feature
  79239. * Will usually be called by the features manager
  79240. *
  79241. * @returns true if successful.
  79242. */
  79243. attach(): boolean;
  79244. /**
  79245. * detach this feature.
  79246. * Will usually be called by the features manager
  79247. *
  79248. * @returns true if successful.
  79249. */
  79250. detach(): boolean;
  79251. /**
  79252. * Dispose this feature and all of the resources attached
  79253. */
  79254. dispose(): void;
  79255. /**
  79256. * Get the hand object according to the controller id
  79257. * @param controllerId the controller id to which we want to get the hand
  79258. * @returns null if not found or the WebXRHand object if found
  79259. */
  79260. getHandByControllerId(controllerId: string): Nullable<WebXRHand>;
  79261. /**
  79262. * Get a hand object according to the requested handedness
  79263. * @param handedness the handedness to request
  79264. * @returns null if not found or the WebXRHand object if found
  79265. */
  79266. getHandByHandedness(handedness: XRHandedness): Nullable<WebXRHand>;
  79267. protected _onXRFrame(_xrFrame: XRFrame): void;
  79268. private _attachHand;
  79269. private _detachHand;
  79270. }
  79271. }
  79272. declare module "babylonjs/XR/features/index" {
  79273. export * from "babylonjs/XR/features/WebXRHitTestLegacy";
  79274. export * from "babylonjs/XR/features/WebXRAnchorSystem";
  79275. export * from "babylonjs/XR/features/WebXRPlaneDetector";
  79276. export * from "babylonjs/XR/features/WebXRBackgroundRemover";
  79277. export * from "babylonjs/XR/features/WebXRControllerTeleportation";
  79278. export * from "babylonjs/XR/features/WebXRControllerPointerSelection";
  79279. export * from "babylonjs/XR/features/WebXRControllerPhysics";
  79280. export * from "babylonjs/XR/features/WebXRHitTest";
  79281. export * from "babylonjs/XR/features/WebXRFeaturePointSystem";
  79282. export * from "babylonjs/XR/features/WebXRHandTracking";
  79283. }
  79284. declare module "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController" {
  79285. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79286. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79287. import { Scene } from "babylonjs/scene";
  79288. /**
  79289. * The motion controller class for all microsoft mixed reality controllers
  79290. */
  79291. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  79292. protected readonly _mapping: {
  79293. defaultButton: {
  79294. valueNodeName: string;
  79295. unpressedNodeName: string;
  79296. pressedNodeName: string;
  79297. };
  79298. defaultAxis: {
  79299. valueNodeName: string;
  79300. minNodeName: string;
  79301. maxNodeName: string;
  79302. };
  79303. buttons: {
  79304. "xr-standard-trigger": {
  79305. rootNodeName: string;
  79306. componentProperty: string;
  79307. states: string[];
  79308. };
  79309. "xr-standard-squeeze": {
  79310. rootNodeName: string;
  79311. componentProperty: string;
  79312. states: string[];
  79313. };
  79314. "xr-standard-touchpad": {
  79315. rootNodeName: string;
  79316. labelAnchorNodeName: string;
  79317. touchPointNodeName: string;
  79318. };
  79319. "xr-standard-thumbstick": {
  79320. rootNodeName: string;
  79321. componentProperty: string;
  79322. states: string[];
  79323. };
  79324. };
  79325. axes: {
  79326. "xr-standard-touchpad": {
  79327. "x-axis": {
  79328. rootNodeName: string;
  79329. };
  79330. "y-axis": {
  79331. rootNodeName: string;
  79332. };
  79333. };
  79334. "xr-standard-thumbstick": {
  79335. "x-axis": {
  79336. rootNodeName: string;
  79337. };
  79338. "y-axis": {
  79339. rootNodeName: string;
  79340. };
  79341. };
  79342. };
  79343. };
  79344. /**
  79345. * The base url used to load the left and right controller models
  79346. */
  79347. static MODEL_BASE_URL: string;
  79348. /**
  79349. * The name of the left controller model file
  79350. */
  79351. static MODEL_LEFT_FILENAME: string;
  79352. /**
  79353. * The name of the right controller model file
  79354. */
  79355. static MODEL_RIGHT_FILENAME: string;
  79356. profileId: string;
  79357. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  79358. protected _getFilenameAndPath(): {
  79359. filename: string;
  79360. path: string;
  79361. };
  79362. protected _getModelLoadingConstraints(): boolean;
  79363. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79364. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79365. protected _updateModel(): void;
  79366. }
  79367. }
  79368. declare module "babylonjs/XR/motionController/webXROculusTouchMotionController" {
  79369. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79370. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79371. import { Scene } from "babylonjs/scene";
  79372. /**
  79373. * The motion controller class for oculus touch (quest, rift).
  79374. * This class supports legacy mapping as well the standard xr mapping
  79375. */
  79376. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  79377. private _forceLegacyControllers;
  79378. private _modelRootNode;
  79379. /**
  79380. * The base url used to load the left and right controller models
  79381. */
  79382. static MODEL_BASE_URL: string;
  79383. /**
  79384. * The name of the left controller model file
  79385. */
  79386. static MODEL_LEFT_FILENAME: string;
  79387. /**
  79388. * The name of the right controller model file
  79389. */
  79390. static MODEL_RIGHT_FILENAME: string;
  79391. /**
  79392. * Base Url for the Quest controller model.
  79393. */
  79394. static QUEST_MODEL_BASE_URL: string;
  79395. profileId: string;
  79396. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  79397. protected _getFilenameAndPath(): {
  79398. filename: string;
  79399. path: string;
  79400. };
  79401. protected _getModelLoadingConstraints(): boolean;
  79402. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79403. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79404. protected _updateModel(): void;
  79405. /**
  79406. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  79407. * between the touch and touch 2.
  79408. */
  79409. private _isQuest;
  79410. }
  79411. }
  79412. declare module "babylonjs/XR/motionController/webXRHTCViveMotionController" {
  79413. import { IMinimalMotionControllerObject, MotionControllerHandedness, WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79414. import { Scene } from "babylonjs/scene";
  79415. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79416. /**
  79417. * The motion controller class for the standard HTC-Vive controllers
  79418. */
  79419. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  79420. private _modelRootNode;
  79421. /**
  79422. * The base url used to load the left and right controller models
  79423. */
  79424. static MODEL_BASE_URL: string;
  79425. /**
  79426. * File name for the controller model.
  79427. */
  79428. static MODEL_FILENAME: string;
  79429. profileId: string;
  79430. /**
  79431. * Create a new Vive motion controller object
  79432. * @param scene the scene to use to create this controller
  79433. * @param gamepadObject the corresponding gamepad object
  79434. * @param handedness the handedness of the controller
  79435. */
  79436. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  79437. protected _getFilenameAndPath(): {
  79438. filename: string;
  79439. path: string;
  79440. };
  79441. protected _getModelLoadingConstraints(): boolean;
  79442. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79443. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79444. protected _updateModel(): void;
  79445. }
  79446. }
  79447. declare module "babylonjs/XR/motionController/index" {
  79448. export * from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79449. export * from "babylonjs/XR/motionController/webXRControllerComponent";
  79450. export * from "babylonjs/XR/motionController/webXRGenericMotionController";
  79451. export * from "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController";
  79452. export * from "babylonjs/XR/motionController/webXRMotionControllerManager";
  79453. export * from "babylonjs/XR/motionController/webXROculusTouchMotionController";
  79454. export * from "babylonjs/XR/motionController/webXRHTCViveMotionController";
  79455. export * from "babylonjs/XR/motionController/webXRProfiledMotionController";
  79456. }
  79457. declare module "babylonjs/XR/index" {
  79458. export * from "babylonjs/XR/webXRCamera";
  79459. export * from "babylonjs/XR/webXREnterExitUI";
  79460. export * from "babylonjs/XR/webXRExperienceHelper";
  79461. export * from "babylonjs/XR/webXRInput";
  79462. export * from "babylonjs/XR/webXRInputSource";
  79463. export * from "babylonjs/XR/webXRManagedOutputCanvas";
  79464. export * from "babylonjs/XR/webXRTypes";
  79465. export * from "babylonjs/XR/webXRSessionManager";
  79466. export * from "babylonjs/XR/webXRDefaultExperience";
  79467. export * from "babylonjs/XR/webXRFeaturesManager";
  79468. export * from "babylonjs/XR/features/index";
  79469. export * from "babylonjs/XR/motionController/index";
  79470. }
  79471. declare module "babylonjs/index" {
  79472. export * from "babylonjs/abstractScene";
  79473. export * from "babylonjs/Actions/index";
  79474. export * from "babylonjs/Animations/index";
  79475. export * from "babylonjs/assetContainer";
  79476. export * from "babylonjs/Audio/index";
  79477. export * from "babylonjs/Behaviors/index";
  79478. export * from "babylonjs/Bones/index";
  79479. export * from "babylonjs/Cameras/index";
  79480. export * from "babylonjs/Collisions/index";
  79481. export * from "babylonjs/Culling/index";
  79482. export * from "babylonjs/Debug/index";
  79483. export * from "babylonjs/DeviceInput/index";
  79484. export * from "babylonjs/Engines/index";
  79485. export * from "babylonjs/Events/index";
  79486. export * from "babylonjs/Gamepads/index";
  79487. export * from "babylonjs/Gizmos/index";
  79488. export * from "babylonjs/Helpers/index";
  79489. export * from "babylonjs/Instrumentation/index";
  79490. export * from "babylonjs/Layers/index";
  79491. export * from "babylonjs/LensFlares/index";
  79492. export * from "babylonjs/Lights/index";
  79493. export * from "babylonjs/Loading/index";
  79494. export * from "babylonjs/Materials/index";
  79495. export * from "babylonjs/Maths/index";
  79496. export * from "babylonjs/Meshes/index";
  79497. export * from "babylonjs/Morph/index";
  79498. export * from "babylonjs/Navigation/index";
  79499. export * from "babylonjs/node";
  79500. export * from "babylonjs/Offline/index";
  79501. export * from "babylonjs/Particles/index";
  79502. export * from "babylonjs/Physics/index";
  79503. export * from "babylonjs/PostProcesses/index";
  79504. export * from "babylonjs/Probes/index";
  79505. export * from "babylonjs/Rendering/index";
  79506. export * from "babylonjs/scene";
  79507. export * from "babylonjs/sceneComponent";
  79508. export * from "babylonjs/Sprites/index";
  79509. export * from "babylonjs/States/index";
  79510. export * from "babylonjs/Misc/index";
  79511. export * from "babylonjs/XR/index";
  79512. export * from "babylonjs/types";
  79513. }
  79514. declare module "babylonjs/Animations/pathCursor" {
  79515. import { Vector3 } from "babylonjs/Maths/math.vector";
  79516. import { Path2 } from "babylonjs/Maths/math.path";
  79517. /**
  79518. * A cursor which tracks a point on a path
  79519. */
  79520. export class PathCursor {
  79521. private path;
  79522. /**
  79523. * Stores path cursor callbacks for when an onchange event is triggered
  79524. */
  79525. private _onchange;
  79526. /**
  79527. * The value of the path cursor
  79528. */
  79529. value: number;
  79530. /**
  79531. * The animation array of the path cursor
  79532. */
  79533. animations: Animation[];
  79534. /**
  79535. * Initializes the path cursor
  79536. * @param path The path to track
  79537. */
  79538. constructor(path: Path2);
  79539. /**
  79540. * Gets the cursor point on the path
  79541. * @returns A point on the path cursor at the cursor location
  79542. */
  79543. getPoint(): Vector3;
  79544. /**
  79545. * Moves the cursor ahead by the step amount
  79546. * @param step The amount to move the cursor forward
  79547. * @returns This path cursor
  79548. */
  79549. moveAhead(step?: number): PathCursor;
  79550. /**
  79551. * Moves the cursor behind by the step amount
  79552. * @param step The amount to move the cursor back
  79553. * @returns This path cursor
  79554. */
  79555. moveBack(step?: number): PathCursor;
  79556. /**
  79557. * Moves the cursor by the step amount
  79558. * If the step amount is greater than one, an exception is thrown
  79559. * @param step The amount to move the cursor
  79560. * @returns This path cursor
  79561. */
  79562. move(step: number): PathCursor;
  79563. /**
  79564. * Ensures that the value is limited between zero and one
  79565. * @returns This path cursor
  79566. */
  79567. private ensureLimits;
  79568. /**
  79569. * Runs onchange callbacks on change (used by the animation engine)
  79570. * @returns This path cursor
  79571. */
  79572. private raiseOnChange;
  79573. /**
  79574. * Executes a function on change
  79575. * @param f A path cursor onchange callback
  79576. * @returns This path cursor
  79577. */
  79578. onchange(f: (cursor: PathCursor) => void): PathCursor;
  79579. }
  79580. }
  79581. declare module "babylonjs/Engines/Processors/Expressions/Operators/index" {
  79582. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator";
  79583. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator";
  79584. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator";
  79585. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator";
  79586. }
  79587. declare module "babylonjs/Engines/Processors/Expressions/index" {
  79588. export * from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  79589. export * from "babylonjs/Engines/Processors/Expressions/Operators/index";
  79590. }
  79591. declare module "babylonjs/Engines/Processors/index" {
  79592. export * from "babylonjs/Engines/Processors/iShaderProcessor";
  79593. export * from "babylonjs/Engines/Processors/Expressions/index";
  79594. export * from "babylonjs/Engines/Processors/shaderCodeConditionNode";
  79595. export * from "babylonjs/Engines/Processors/shaderCodeCursor";
  79596. export * from "babylonjs/Engines/Processors/shaderCodeNode";
  79597. export * from "babylonjs/Engines/Processors/shaderCodeTestNode";
  79598. export * from "babylonjs/Engines/Processors/shaderProcessingOptions";
  79599. export * from "babylonjs/Engines/Processors/shaderProcessor";
  79600. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  79601. }
  79602. declare module "babylonjs/Legacy/legacy" {
  79603. import * as Babylon from "babylonjs/index";
  79604. export * from "babylonjs/index";
  79605. }
  79606. declare module "babylonjs/Shaders/blur.fragment" {
  79607. /** @hidden */
  79608. export var blurPixelShader: {
  79609. name: string;
  79610. shader: string;
  79611. };
  79612. }
  79613. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertexDeclaration" {
  79614. /** @hidden */
  79615. export var pointCloudVertexDeclaration: {
  79616. name: string;
  79617. shader: string;
  79618. };
  79619. }
  79620. declare module "babylonjs" {
  79621. export * from "babylonjs/Legacy/legacy";
  79622. }
  79623. declare module BABYLON {
  79624. /** Alias type for value that can be null */
  79625. export type Nullable<T> = T | null;
  79626. /**
  79627. * Alias type for number that are floats
  79628. * @ignorenaming
  79629. */
  79630. export type float = number;
  79631. /**
  79632. * Alias type for number that are doubles.
  79633. * @ignorenaming
  79634. */
  79635. export type double = number;
  79636. /**
  79637. * Alias type for number that are integer
  79638. * @ignorenaming
  79639. */
  79640. export type int = number;
  79641. /** Alias type for number array or Float32Array */
  79642. export type FloatArray = number[] | Float32Array;
  79643. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  79644. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  79645. /**
  79646. * Alias for types that can be used by a Buffer or VertexBuffer.
  79647. */
  79648. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  79649. /**
  79650. * Alias type for primitive types
  79651. * @ignorenaming
  79652. */
  79653. type Primitive = undefined | null | boolean | string | number | Function;
  79654. /**
  79655. * Type modifier to make all the properties of an object Readonly
  79656. */
  79657. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  79658. /**
  79659. * Type modifier to make all the properties of an object Readonly recursively
  79660. */
  79661. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  79662. /**
  79663. * Type modifier to make object properties readonly.
  79664. */
  79665. export type DeepImmutableObject<T> = {
  79666. readonly [K in keyof T]: DeepImmutable<T[K]>;
  79667. };
  79668. /** @hidden */
  79669. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  79670. }
  79671. }
  79672. declare module BABYLON {
  79673. /**
  79674. * A class serves as a medium between the observable and its observers
  79675. */
  79676. export class EventState {
  79677. /**
  79678. * Create a new EventState
  79679. * @param mask defines the mask associated with this state
  79680. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  79681. * @param target defines the original target of the state
  79682. * @param currentTarget defines the current target of the state
  79683. */
  79684. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  79685. /**
  79686. * Initialize the current event state
  79687. * @param mask defines the mask associated with this state
  79688. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  79689. * @param target defines the original target of the state
  79690. * @param currentTarget defines the current target of the state
  79691. * @returns the current event state
  79692. */
  79693. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  79694. /**
  79695. * An Observer can set this property to true to prevent subsequent observers of being notified
  79696. */
  79697. skipNextObservers: boolean;
  79698. /**
  79699. * Get the mask value that were used to trigger the event corresponding to this EventState object
  79700. */
  79701. mask: number;
  79702. /**
  79703. * The object that originally notified the event
  79704. */
  79705. target?: any;
  79706. /**
  79707. * The current object in the bubbling phase
  79708. */
  79709. currentTarget?: any;
  79710. /**
  79711. * This will be populated with the return value of the last function that was executed.
  79712. * If it is the first function in the callback chain it will be the event data.
  79713. */
  79714. lastReturnValue?: any;
  79715. }
  79716. /**
  79717. * Represent an Observer registered to a given Observable object.
  79718. */
  79719. export class Observer<T> {
  79720. /**
  79721. * Defines the callback to call when the observer is notified
  79722. */
  79723. callback: (eventData: T, eventState: EventState) => void;
  79724. /**
  79725. * Defines the mask of the observer (used to filter notifications)
  79726. */
  79727. mask: number;
  79728. /**
  79729. * Defines the current scope used to restore the JS context
  79730. */
  79731. scope: any;
  79732. /** @hidden */
  79733. _willBeUnregistered: boolean;
  79734. /**
  79735. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  79736. */
  79737. unregisterOnNextCall: boolean;
  79738. /**
  79739. * Creates a new observer
  79740. * @param callback defines the callback to call when the observer is notified
  79741. * @param mask defines the mask of the observer (used to filter notifications)
  79742. * @param scope defines the current scope used to restore the JS context
  79743. */
  79744. constructor(
  79745. /**
  79746. * Defines the callback to call when the observer is notified
  79747. */
  79748. callback: (eventData: T, eventState: EventState) => void,
  79749. /**
  79750. * Defines the mask of the observer (used to filter notifications)
  79751. */
  79752. mask: number,
  79753. /**
  79754. * Defines the current scope used to restore the JS context
  79755. */
  79756. scope?: any);
  79757. }
  79758. /**
  79759. * Represent a list of observers registered to multiple Observables object.
  79760. */
  79761. export class MultiObserver<T> {
  79762. private _observers;
  79763. private _observables;
  79764. /**
  79765. * Release associated resources
  79766. */
  79767. dispose(): void;
  79768. /**
  79769. * Raise a callback when one of the observable will notify
  79770. * @param observables defines a list of observables to watch
  79771. * @param callback defines the callback to call on notification
  79772. * @param mask defines the mask used to filter notifications
  79773. * @param scope defines the current scope used to restore the JS context
  79774. * @returns the new MultiObserver
  79775. */
  79776. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  79777. }
  79778. /**
  79779. * The Observable class is a simple implementation of the Observable pattern.
  79780. *
  79781. * 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.
  79782. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  79783. * 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).
  79784. * 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.
  79785. */
  79786. export class Observable<T> {
  79787. private _observers;
  79788. private _eventState;
  79789. private _onObserverAdded;
  79790. /**
  79791. * Gets the list of observers
  79792. */
  79793. get observers(): Array<Observer<T>>;
  79794. /**
  79795. * Creates a new observable
  79796. * @param onObserverAdded defines a callback to call when a new observer is added
  79797. */
  79798. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  79799. /**
  79800. * Create a new Observer with the specified callback
  79801. * @param callback the callback that will be executed for that Observer
  79802. * @param mask the mask used to filter observers
  79803. * @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.
  79804. * @param scope optional scope for the callback to be called from
  79805. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  79806. * @returns the new observer created for the callback
  79807. */
  79808. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  79809. /**
  79810. * Create a new Observer with the specified callback and unregisters after the next notification
  79811. * @param callback the callback that will be executed for that Observer
  79812. * @returns the new observer created for the callback
  79813. */
  79814. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  79815. /**
  79816. * Remove an Observer from the Observable object
  79817. * @param observer the instance of the Observer to remove
  79818. * @returns false if it doesn't belong to this Observable
  79819. */
  79820. remove(observer: Nullable<Observer<T>>): boolean;
  79821. /**
  79822. * Remove a callback from the Observable object
  79823. * @param callback the callback to remove
  79824. * @param scope optional scope. If used only the callbacks with this scope will be removed
  79825. * @returns false if it doesn't belong to this Observable
  79826. */
  79827. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  79828. private _deferUnregister;
  79829. private _remove;
  79830. /**
  79831. * Moves the observable to the top of the observer list making it get called first when notified
  79832. * @param observer the observer to move
  79833. */
  79834. makeObserverTopPriority(observer: Observer<T>): void;
  79835. /**
  79836. * Moves the observable to the bottom of the observer list making it get called last when notified
  79837. * @param observer the observer to move
  79838. */
  79839. makeObserverBottomPriority(observer: Observer<T>): void;
  79840. /**
  79841. * Notify all Observers by calling their respective callback with the given data
  79842. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  79843. * @param eventData defines the data to send to all observers
  79844. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  79845. * @param target defines the original target of the state
  79846. * @param currentTarget defines the current target of the state
  79847. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  79848. */
  79849. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  79850. /**
  79851. * Calling this will execute each callback, expecting it to be a promise or return a value.
  79852. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  79853. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  79854. * and it is crucial that all callbacks will be executed.
  79855. * The order of the callbacks is kept, callbacks are not executed parallel.
  79856. *
  79857. * @param eventData The data to be sent to each callback
  79858. * @param mask is used to filter observers defaults to -1
  79859. * @param target defines the callback target (see EventState)
  79860. * @param currentTarget defines he current object in the bubbling phase
  79861. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  79862. */
  79863. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  79864. /**
  79865. * Notify a specific observer
  79866. * @param observer defines the observer to notify
  79867. * @param eventData defines the data to be sent to each callback
  79868. * @param mask is used to filter observers defaults to -1
  79869. */
  79870. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  79871. /**
  79872. * Gets a boolean indicating if the observable has at least one observer
  79873. * @returns true is the Observable has at least one Observer registered
  79874. */
  79875. hasObservers(): boolean;
  79876. /**
  79877. * Clear the list of observers
  79878. */
  79879. clear(): void;
  79880. /**
  79881. * Clone the current observable
  79882. * @returns a new observable
  79883. */
  79884. clone(): Observable<T>;
  79885. /**
  79886. * Does this observable handles observer registered with a given mask
  79887. * @param mask defines the mask to be tested
  79888. * @return whether or not one observer registered with the given mask is handeled
  79889. **/
  79890. hasSpecificMask(mask?: number): boolean;
  79891. }
  79892. }
  79893. declare module BABYLON {
  79894. /**
  79895. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  79896. * Babylon.js
  79897. */
  79898. export class DomManagement {
  79899. /**
  79900. * Checks if the window object exists
  79901. * @returns true if the window object exists
  79902. */
  79903. static IsWindowObjectExist(): boolean;
  79904. /**
  79905. * Checks if the navigator object exists
  79906. * @returns true if the navigator object exists
  79907. */
  79908. static IsNavigatorAvailable(): boolean;
  79909. /**
  79910. * Check if the document object exists
  79911. * @returns true if the document object exists
  79912. */
  79913. static IsDocumentAvailable(): boolean;
  79914. /**
  79915. * Extracts text content from a DOM element hierarchy
  79916. * @param element defines the root element
  79917. * @returns a string
  79918. */
  79919. static GetDOMTextContent(element: HTMLElement): string;
  79920. }
  79921. }
  79922. declare module BABYLON {
  79923. /**
  79924. * Logger used througouht the application to allow configuration of
  79925. * the log level required for the messages.
  79926. */
  79927. export class Logger {
  79928. /**
  79929. * No log
  79930. */
  79931. static readonly NoneLogLevel: number;
  79932. /**
  79933. * Only message logs
  79934. */
  79935. static readonly MessageLogLevel: number;
  79936. /**
  79937. * Only warning logs
  79938. */
  79939. static readonly WarningLogLevel: number;
  79940. /**
  79941. * Only error logs
  79942. */
  79943. static readonly ErrorLogLevel: number;
  79944. /**
  79945. * All logs
  79946. */
  79947. static readonly AllLogLevel: number;
  79948. private static _LogCache;
  79949. /**
  79950. * Gets a value indicating the number of loading errors
  79951. * @ignorenaming
  79952. */
  79953. static errorsCount: number;
  79954. /**
  79955. * Callback called when a new log is added
  79956. */
  79957. static OnNewCacheEntry: (entry: string) => void;
  79958. private static _AddLogEntry;
  79959. private static _FormatMessage;
  79960. private static _LogDisabled;
  79961. private static _LogEnabled;
  79962. private static _WarnDisabled;
  79963. private static _WarnEnabled;
  79964. private static _ErrorDisabled;
  79965. private static _ErrorEnabled;
  79966. /**
  79967. * Log a message to the console
  79968. */
  79969. static Log: (message: string) => void;
  79970. /**
  79971. * Write a warning message to the console
  79972. */
  79973. static Warn: (message: string) => void;
  79974. /**
  79975. * Write an error message to the console
  79976. */
  79977. static Error: (message: string) => void;
  79978. /**
  79979. * Gets current log cache (list of logs)
  79980. */
  79981. static get LogCache(): string;
  79982. /**
  79983. * Clears the log cache
  79984. */
  79985. static ClearLogCache(): void;
  79986. /**
  79987. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  79988. */
  79989. static set LogLevels(level: number);
  79990. }
  79991. }
  79992. declare module BABYLON {
  79993. /** @hidden */
  79994. export class _TypeStore {
  79995. /** @hidden */
  79996. static RegisteredTypes: {
  79997. [key: string]: Object;
  79998. };
  79999. /** @hidden */
  80000. static GetClass(fqdn: string): any;
  80001. }
  80002. }
  80003. declare module BABYLON {
  80004. /**
  80005. * Helper to manipulate strings
  80006. */
  80007. export class StringTools {
  80008. /**
  80009. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  80010. * @param str Source string
  80011. * @param suffix Suffix to search for in the source string
  80012. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  80013. */
  80014. static EndsWith(str: string, suffix: string): boolean;
  80015. /**
  80016. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  80017. * @param str Source string
  80018. * @param suffix Suffix to search for in the source string
  80019. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  80020. */
  80021. static StartsWith(str: string, suffix: string): boolean;
  80022. /**
  80023. * Decodes a buffer into a string
  80024. * @param buffer The buffer to decode
  80025. * @returns The decoded string
  80026. */
  80027. static Decode(buffer: Uint8Array | Uint16Array): string;
  80028. /**
  80029. * Encode a buffer to a base64 string
  80030. * @param buffer defines the buffer to encode
  80031. * @returns the encoded string
  80032. */
  80033. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  80034. /**
  80035. * Converts a number to string and pads with preceeding zeroes until it is of specified length.
  80036. * @param num the number to convert and pad
  80037. * @param length the expected length of the string
  80038. * @returns the padded string
  80039. */
  80040. static PadNumber(num: number, length: number): string;
  80041. }
  80042. }
  80043. declare module BABYLON {
  80044. /**
  80045. * Class containing a set of static utilities functions for deep copy.
  80046. */
  80047. export class DeepCopier {
  80048. /**
  80049. * Tries to copy an object by duplicating every property
  80050. * @param source defines the source object
  80051. * @param destination defines the target object
  80052. * @param doNotCopyList defines a list of properties to avoid
  80053. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  80054. */
  80055. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  80056. }
  80057. }
  80058. declare module BABYLON {
  80059. /**
  80060. * Class containing a set of static utilities functions for precision date
  80061. */
  80062. export class PrecisionDate {
  80063. /**
  80064. * Gets either window.performance.now() if supported or Date.now() else
  80065. */
  80066. static get Now(): number;
  80067. }
  80068. }
  80069. declare module BABYLON {
  80070. /** @hidden */
  80071. export class _DevTools {
  80072. static WarnImport(name: string): string;
  80073. }
  80074. }
  80075. declare module BABYLON {
  80076. /**
  80077. * Interface used to define the mechanism to get data from the network
  80078. */
  80079. export interface IWebRequest {
  80080. /**
  80081. * Returns client's response url
  80082. */
  80083. responseURL: string;
  80084. /**
  80085. * Returns client's status
  80086. */
  80087. status: number;
  80088. /**
  80089. * Returns client's status as a text
  80090. */
  80091. statusText: string;
  80092. }
  80093. }
  80094. declare module BABYLON {
  80095. /**
  80096. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  80097. */
  80098. export class WebRequest implements IWebRequest {
  80099. private _xhr;
  80100. /**
  80101. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  80102. * i.e. when loading files, where the server/service expects an Authorization header
  80103. */
  80104. static CustomRequestHeaders: {
  80105. [key: string]: string;
  80106. };
  80107. /**
  80108. * Add callback functions in this array to update all the requests before they get sent to the network
  80109. */
  80110. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  80111. private _injectCustomRequestHeaders;
  80112. /**
  80113. * Gets or sets a function to be called when loading progress changes
  80114. */
  80115. get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  80116. set onprogress(value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null);
  80117. /**
  80118. * Returns client's state
  80119. */
  80120. get readyState(): number;
  80121. /**
  80122. * Returns client's status
  80123. */
  80124. get status(): number;
  80125. /**
  80126. * Returns client's status as a text
  80127. */
  80128. get statusText(): string;
  80129. /**
  80130. * Returns client's response
  80131. */
  80132. get response(): any;
  80133. /**
  80134. * Returns client's response url
  80135. */
  80136. get responseURL(): string;
  80137. /**
  80138. * Returns client's response as text
  80139. */
  80140. get responseText(): string;
  80141. /**
  80142. * Gets or sets the expected response type
  80143. */
  80144. get responseType(): XMLHttpRequestResponseType;
  80145. set responseType(value: XMLHttpRequestResponseType);
  80146. /** @hidden */
  80147. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  80148. /** @hidden */
  80149. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  80150. /**
  80151. * Cancels any network activity
  80152. */
  80153. abort(): void;
  80154. /**
  80155. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  80156. * @param body defines an optional request body
  80157. */
  80158. send(body?: Document | BodyInit | null): void;
  80159. /**
  80160. * Sets the request method, request URL
  80161. * @param method defines the method to use (GET, POST, etc..)
  80162. * @param url defines the url to connect with
  80163. */
  80164. open(method: string, url: string): void;
  80165. /**
  80166. * Sets the value of a request header.
  80167. * @param name The name of the header whose value is to be set
  80168. * @param value The value to set as the body of the header
  80169. */
  80170. setRequestHeader(name: string, value: string): void;
  80171. /**
  80172. * Get the string containing the text of a particular header's value.
  80173. * @param name The name of the header
  80174. * @returns The string containing the text of the given header name
  80175. */
  80176. getResponseHeader(name: string): Nullable<string>;
  80177. }
  80178. }
  80179. declare module BABYLON {
  80180. /**
  80181. * File request interface
  80182. */
  80183. export interface IFileRequest {
  80184. /**
  80185. * Raised when the request is complete (success or error).
  80186. */
  80187. onCompleteObservable: Observable<IFileRequest>;
  80188. /**
  80189. * Aborts the request for a file.
  80190. */
  80191. abort: () => void;
  80192. }
  80193. }
  80194. declare module BABYLON {
  80195. /**
  80196. * Define options used to create a render target texture
  80197. */
  80198. export class RenderTargetCreationOptions {
  80199. /**
  80200. * Specifies is mipmaps must be generated
  80201. */
  80202. generateMipMaps?: boolean;
  80203. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  80204. generateDepthBuffer?: boolean;
  80205. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  80206. generateStencilBuffer?: boolean;
  80207. /** Defines texture type (int by default) */
  80208. type?: number;
  80209. /** Defines sampling mode (trilinear by default) */
  80210. samplingMode?: number;
  80211. /** Defines format (RGBA by default) */
  80212. format?: number;
  80213. }
  80214. }
  80215. declare module BABYLON {
  80216. /** Defines the cross module used constants to avoid circular dependncies */
  80217. export class Constants {
  80218. /** Defines that alpha blending is disabled */
  80219. static readonly ALPHA_DISABLE: number;
  80220. /** Defines that alpha blending is SRC ALPHA * SRC + DEST */
  80221. static readonly ALPHA_ADD: number;
  80222. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  80223. static readonly ALPHA_COMBINE: number;
  80224. /** Defines that alpha blending is DEST - SRC * DEST */
  80225. static readonly ALPHA_SUBTRACT: number;
  80226. /** Defines that alpha blending is SRC * DEST */
  80227. static readonly ALPHA_MULTIPLY: number;
  80228. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC) * DEST */
  80229. static readonly ALPHA_MAXIMIZED: number;
  80230. /** Defines that alpha blending is SRC + DEST */
  80231. static readonly ALPHA_ONEONE: number;
  80232. /** Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST */
  80233. static readonly ALPHA_PREMULTIPLIED: number;
  80234. /**
  80235. * Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST
  80236. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  80237. */
  80238. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  80239. /** Defines that alpha blending is CST * SRC + (1 - CST) * DEST */
  80240. static readonly ALPHA_INTERPOLATE: number;
  80241. /**
  80242. * Defines that alpha blending is SRC + (1 - SRC) * DEST
  80243. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  80244. */
  80245. static readonly ALPHA_SCREENMODE: number;
  80246. /**
  80247. * Defines that alpha blending is SRC + DST
  80248. * Alpha will be set to SRC ALPHA + DST ALPHA
  80249. */
  80250. static readonly ALPHA_ONEONE_ONEONE: number;
  80251. /**
  80252. * Defines that alpha blending is SRC * DST ALPHA + DST
  80253. * Alpha will be set to 0
  80254. */
  80255. static readonly ALPHA_ALPHATOCOLOR: number;
  80256. /**
  80257. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  80258. */
  80259. static readonly ALPHA_REVERSEONEMINUS: number;
  80260. /**
  80261. * Defines that alpha blending is SRC + DST * (1 - SRC ALPHA)
  80262. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  80263. */
  80264. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  80265. /**
  80266. * Defines that alpha blending is SRC + DST
  80267. * Alpha will be set to SRC ALPHA
  80268. */
  80269. static readonly ALPHA_ONEONE_ONEZERO: number;
  80270. /**
  80271. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  80272. * Alpha will be set to DST ALPHA
  80273. */
  80274. static readonly ALPHA_EXCLUSION: number;
  80275. /** Defines that alpha blending equation a SUM */
  80276. static readonly ALPHA_EQUATION_ADD: number;
  80277. /** Defines that alpha blending equation a SUBSTRACTION */
  80278. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  80279. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  80280. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  80281. /** Defines that alpha blending equation a MAX operation */
  80282. static readonly ALPHA_EQUATION_MAX: number;
  80283. /** Defines that alpha blending equation a MIN operation */
  80284. static readonly ALPHA_EQUATION_MIN: number;
  80285. /**
  80286. * Defines that alpha blending equation a DARKEN operation:
  80287. * It takes the min of the src and sums the alpha channels.
  80288. */
  80289. static readonly ALPHA_EQUATION_DARKEN: number;
  80290. /** Defines that the ressource is not delayed*/
  80291. static readonly DELAYLOADSTATE_NONE: number;
  80292. /** Defines that the ressource was successfully delay loaded */
  80293. static readonly DELAYLOADSTATE_LOADED: number;
  80294. /** Defines that the ressource is currently delay loading */
  80295. static readonly DELAYLOADSTATE_LOADING: number;
  80296. /** Defines that the ressource is delayed and has not started loading */
  80297. static readonly DELAYLOADSTATE_NOTLOADED: number;
  80298. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  80299. static readonly NEVER: number;
  80300. /** 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 */
  80301. static readonly ALWAYS: number;
  80302. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  80303. static readonly LESS: number;
  80304. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  80305. static readonly EQUAL: number;
  80306. /** 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 */
  80307. static readonly LEQUAL: number;
  80308. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  80309. static readonly GREATER: number;
  80310. /** 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 */
  80311. static readonly GEQUAL: number;
  80312. /** 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 */
  80313. static readonly NOTEQUAL: number;
  80314. /** Passed to stencilOperation to specify that stencil value must be kept */
  80315. static readonly KEEP: number;
  80316. /** Passed to stencilOperation to specify that stencil value must be replaced */
  80317. static readonly REPLACE: number;
  80318. /** Passed to stencilOperation to specify that stencil value must be incremented */
  80319. static readonly INCR: number;
  80320. /** Passed to stencilOperation to specify that stencil value must be decremented */
  80321. static readonly DECR: number;
  80322. /** Passed to stencilOperation to specify that stencil value must be inverted */
  80323. static readonly INVERT: number;
  80324. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  80325. static readonly INCR_WRAP: number;
  80326. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  80327. static readonly DECR_WRAP: number;
  80328. /** Texture is not repeating outside of 0..1 UVs */
  80329. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  80330. /** Texture is repeating outside of 0..1 UVs */
  80331. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  80332. /** Texture is repeating and mirrored */
  80333. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  80334. /** ALPHA */
  80335. static readonly TEXTUREFORMAT_ALPHA: number;
  80336. /** LUMINANCE */
  80337. static readonly TEXTUREFORMAT_LUMINANCE: number;
  80338. /** LUMINANCE_ALPHA */
  80339. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  80340. /** RGB */
  80341. static readonly TEXTUREFORMAT_RGB: number;
  80342. /** RGBA */
  80343. static readonly TEXTUREFORMAT_RGBA: number;
  80344. /** RED */
  80345. static readonly TEXTUREFORMAT_RED: number;
  80346. /** RED (2nd reference) */
  80347. static readonly TEXTUREFORMAT_R: number;
  80348. /** RG */
  80349. static readonly TEXTUREFORMAT_RG: number;
  80350. /** RED_INTEGER */
  80351. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  80352. /** RED_INTEGER (2nd reference) */
  80353. static readonly TEXTUREFORMAT_R_INTEGER: number;
  80354. /** RG_INTEGER */
  80355. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  80356. /** RGB_INTEGER */
  80357. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  80358. /** RGBA_INTEGER */
  80359. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  80360. /** UNSIGNED_BYTE */
  80361. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  80362. /** UNSIGNED_BYTE (2nd reference) */
  80363. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  80364. /** FLOAT */
  80365. static readonly TEXTURETYPE_FLOAT: number;
  80366. /** HALF_FLOAT */
  80367. static readonly TEXTURETYPE_HALF_FLOAT: number;
  80368. /** BYTE */
  80369. static readonly TEXTURETYPE_BYTE: number;
  80370. /** SHORT */
  80371. static readonly TEXTURETYPE_SHORT: number;
  80372. /** UNSIGNED_SHORT */
  80373. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  80374. /** INT */
  80375. static readonly TEXTURETYPE_INT: number;
  80376. /** UNSIGNED_INT */
  80377. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  80378. /** UNSIGNED_SHORT_4_4_4_4 */
  80379. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  80380. /** UNSIGNED_SHORT_5_5_5_1 */
  80381. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  80382. /** UNSIGNED_SHORT_5_6_5 */
  80383. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  80384. /** UNSIGNED_INT_2_10_10_10_REV */
  80385. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  80386. /** UNSIGNED_INT_24_8 */
  80387. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  80388. /** UNSIGNED_INT_10F_11F_11F_REV */
  80389. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  80390. /** UNSIGNED_INT_5_9_9_9_REV */
  80391. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  80392. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  80393. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  80394. /** nearest is mag = nearest and min = nearest and no mip */
  80395. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  80396. /** mag = nearest and min = nearest and mip = none */
  80397. static readonly TEXTURE_NEAREST_NEAREST: number;
  80398. /** Bilinear is mag = linear and min = linear and no mip */
  80399. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  80400. /** mag = linear and min = linear and mip = none */
  80401. static readonly TEXTURE_LINEAR_LINEAR: number;
  80402. /** Trilinear is mag = linear and min = linear and mip = linear */
  80403. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  80404. /** Trilinear is mag = linear and min = linear and mip = linear */
  80405. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  80406. /** mag = nearest and min = nearest and mip = nearest */
  80407. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  80408. /** mag = nearest and min = linear and mip = nearest */
  80409. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  80410. /** mag = nearest and min = linear and mip = linear */
  80411. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  80412. /** mag = nearest and min = linear and mip = none */
  80413. static readonly TEXTURE_NEAREST_LINEAR: number;
  80414. /** nearest is mag = nearest and min = nearest and mip = linear */
  80415. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  80416. /** mag = linear and min = nearest and mip = nearest */
  80417. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  80418. /** mag = linear and min = nearest and mip = linear */
  80419. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  80420. /** Bilinear is mag = linear and min = linear and mip = nearest */
  80421. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  80422. /** mag = linear and min = nearest and mip = none */
  80423. static readonly TEXTURE_LINEAR_NEAREST: number;
  80424. /** Explicit coordinates mode */
  80425. static readonly TEXTURE_EXPLICIT_MODE: number;
  80426. /** Spherical coordinates mode */
  80427. static readonly TEXTURE_SPHERICAL_MODE: number;
  80428. /** Planar coordinates mode */
  80429. static readonly TEXTURE_PLANAR_MODE: number;
  80430. /** Cubic coordinates mode */
  80431. static readonly TEXTURE_CUBIC_MODE: number;
  80432. /** Projection coordinates mode */
  80433. static readonly TEXTURE_PROJECTION_MODE: number;
  80434. /** Skybox coordinates mode */
  80435. static readonly TEXTURE_SKYBOX_MODE: number;
  80436. /** Inverse Cubic coordinates mode */
  80437. static readonly TEXTURE_INVCUBIC_MODE: number;
  80438. /** Equirectangular coordinates mode */
  80439. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  80440. /** Equirectangular Fixed coordinates mode */
  80441. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  80442. /** Equirectangular Fixed Mirrored coordinates mode */
  80443. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  80444. /** Offline (baking) quality for texture filtering */
  80445. static readonly TEXTURE_FILTERING_QUALITY_OFFLINE: number;
  80446. /** High quality for texture filtering */
  80447. static readonly TEXTURE_FILTERING_QUALITY_HIGH: number;
  80448. /** Medium quality for texture filtering */
  80449. static readonly TEXTURE_FILTERING_QUALITY_MEDIUM: number;
  80450. /** Low quality for texture filtering */
  80451. static readonly TEXTURE_FILTERING_QUALITY_LOW: number;
  80452. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  80453. static readonly SCALEMODE_FLOOR: number;
  80454. /** Defines that texture rescaling will look for the nearest power of 2 size */
  80455. static readonly SCALEMODE_NEAREST: number;
  80456. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  80457. static readonly SCALEMODE_CEILING: number;
  80458. /**
  80459. * The dirty texture flag value
  80460. */
  80461. static readonly MATERIAL_TextureDirtyFlag: number;
  80462. /**
  80463. * The dirty light flag value
  80464. */
  80465. static readonly MATERIAL_LightDirtyFlag: number;
  80466. /**
  80467. * The dirty fresnel flag value
  80468. */
  80469. static readonly MATERIAL_FresnelDirtyFlag: number;
  80470. /**
  80471. * The dirty attribute flag value
  80472. */
  80473. static readonly MATERIAL_AttributesDirtyFlag: number;
  80474. /**
  80475. * The dirty misc flag value
  80476. */
  80477. static readonly MATERIAL_MiscDirtyFlag: number;
  80478. /**
  80479. * The all dirty flag value
  80480. */
  80481. static readonly MATERIAL_AllDirtyFlag: number;
  80482. /**
  80483. * Returns the triangle fill mode
  80484. */
  80485. static readonly MATERIAL_TriangleFillMode: number;
  80486. /**
  80487. * Returns the wireframe mode
  80488. */
  80489. static readonly MATERIAL_WireFrameFillMode: number;
  80490. /**
  80491. * Returns the point fill mode
  80492. */
  80493. static readonly MATERIAL_PointFillMode: number;
  80494. /**
  80495. * Returns the point list draw mode
  80496. */
  80497. static readonly MATERIAL_PointListDrawMode: number;
  80498. /**
  80499. * Returns the line list draw mode
  80500. */
  80501. static readonly MATERIAL_LineListDrawMode: number;
  80502. /**
  80503. * Returns the line loop draw mode
  80504. */
  80505. static readonly MATERIAL_LineLoopDrawMode: number;
  80506. /**
  80507. * Returns the line strip draw mode
  80508. */
  80509. static readonly MATERIAL_LineStripDrawMode: number;
  80510. /**
  80511. * Returns the triangle strip draw mode
  80512. */
  80513. static readonly MATERIAL_TriangleStripDrawMode: number;
  80514. /**
  80515. * Returns the triangle fan draw mode
  80516. */
  80517. static readonly MATERIAL_TriangleFanDrawMode: number;
  80518. /**
  80519. * Stores the clock-wise side orientation
  80520. */
  80521. static readonly MATERIAL_ClockWiseSideOrientation: number;
  80522. /**
  80523. * Stores the counter clock-wise side orientation
  80524. */
  80525. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  80526. /**
  80527. * Nothing
  80528. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80529. */
  80530. static readonly ACTION_NothingTrigger: number;
  80531. /**
  80532. * On pick
  80533. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80534. */
  80535. static readonly ACTION_OnPickTrigger: number;
  80536. /**
  80537. * On left pick
  80538. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80539. */
  80540. static readonly ACTION_OnLeftPickTrigger: number;
  80541. /**
  80542. * On right pick
  80543. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80544. */
  80545. static readonly ACTION_OnRightPickTrigger: number;
  80546. /**
  80547. * On center pick
  80548. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80549. */
  80550. static readonly ACTION_OnCenterPickTrigger: number;
  80551. /**
  80552. * On pick down
  80553. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80554. */
  80555. static readonly ACTION_OnPickDownTrigger: number;
  80556. /**
  80557. * On double pick
  80558. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80559. */
  80560. static readonly ACTION_OnDoublePickTrigger: number;
  80561. /**
  80562. * On pick up
  80563. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80564. */
  80565. static readonly ACTION_OnPickUpTrigger: number;
  80566. /**
  80567. * On pick out.
  80568. * This trigger will only be raised if you also declared a OnPickDown
  80569. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80570. */
  80571. static readonly ACTION_OnPickOutTrigger: number;
  80572. /**
  80573. * On long press
  80574. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80575. */
  80576. static readonly ACTION_OnLongPressTrigger: number;
  80577. /**
  80578. * On pointer over
  80579. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80580. */
  80581. static readonly ACTION_OnPointerOverTrigger: number;
  80582. /**
  80583. * On pointer out
  80584. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80585. */
  80586. static readonly ACTION_OnPointerOutTrigger: number;
  80587. /**
  80588. * On every frame
  80589. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80590. */
  80591. static readonly ACTION_OnEveryFrameTrigger: number;
  80592. /**
  80593. * On intersection enter
  80594. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80595. */
  80596. static readonly ACTION_OnIntersectionEnterTrigger: number;
  80597. /**
  80598. * On intersection exit
  80599. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80600. */
  80601. static readonly ACTION_OnIntersectionExitTrigger: number;
  80602. /**
  80603. * On key down
  80604. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80605. */
  80606. static readonly ACTION_OnKeyDownTrigger: number;
  80607. /**
  80608. * On key up
  80609. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80610. */
  80611. static readonly ACTION_OnKeyUpTrigger: number;
  80612. /**
  80613. * Billboard mode will only apply to Y axis
  80614. */
  80615. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  80616. /**
  80617. * Billboard mode will apply to all axes
  80618. */
  80619. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  80620. /**
  80621. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  80622. */
  80623. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  80624. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  80625. * Test order :
  80626. * Is the bounding sphere outside the frustum ?
  80627. * If not, are the bounding box vertices outside the frustum ?
  80628. * It not, then the cullable object is in the frustum.
  80629. */
  80630. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  80631. /** Culling strategy : Bounding Sphere Only.
  80632. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  80633. * It's also less accurate than the standard because some not visible objects can still be selected.
  80634. * Test : is the bounding sphere outside the frustum ?
  80635. * If not, then the cullable object is in the frustum.
  80636. */
  80637. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  80638. /** Culling strategy : Optimistic Inclusion.
  80639. * This in an inclusion test first, then the standard exclusion test.
  80640. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  80641. * 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.
  80642. * Anyway, it's as accurate as the standard strategy.
  80643. * Test :
  80644. * Is the cullable object bounding sphere center in the frustum ?
  80645. * If not, apply the default culling strategy.
  80646. */
  80647. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  80648. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  80649. * This in an inclusion test first, then the bounding sphere only exclusion test.
  80650. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  80651. * 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.
  80652. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  80653. * Test :
  80654. * Is the cullable object bounding sphere center in the frustum ?
  80655. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  80656. */
  80657. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  80658. /**
  80659. * No logging while loading
  80660. */
  80661. static readonly SCENELOADER_NO_LOGGING: number;
  80662. /**
  80663. * Minimal logging while loading
  80664. */
  80665. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  80666. /**
  80667. * Summary logging while loading
  80668. */
  80669. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  80670. /**
  80671. * Detailled logging while loading
  80672. */
  80673. static readonly SCENELOADER_DETAILED_LOGGING: number;
  80674. /**
  80675. * Prepass texture index for color
  80676. */
  80677. static readonly PREPASS_COLOR_INDEX: number;
  80678. /**
  80679. * Prepass texture index for irradiance
  80680. */
  80681. static readonly PREPASS_IRRADIANCE_INDEX: number;
  80682. /**
  80683. * Prepass texture index for depth + normal
  80684. */
  80685. static readonly PREPASS_DEPTHNORMAL_INDEX: number;
  80686. /**
  80687. * Prepass texture index for albedo
  80688. */
  80689. static readonly PREPASS_ALBEDO_INDEX: number;
  80690. }
  80691. }
  80692. declare module BABYLON {
  80693. /**
  80694. * This represents the required contract to create a new type of texture loader.
  80695. */
  80696. export interface IInternalTextureLoader {
  80697. /**
  80698. * Defines wether the loader supports cascade loading the different faces.
  80699. */
  80700. supportCascades: boolean;
  80701. /**
  80702. * This returns if the loader support the current file information.
  80703. * @param extension defines the file extension of the file being loaded
  80704. * @param mimeType defines the optional mime type of the file being loaded
  80705. * @returns true if the loader can load the specified file
  80706. */
  80707. canLoad(extension: string, mimeType?: string): boolean;
  80708. /**
  80709. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  80710. * @param data contains the texture data
  80711. * @param texture defines the BabylonJS internal texture
  80712. * @param createPolynomials will be true if polynomials have been requested
  80713. * @param onLoad defines the callback to trigger once the texture is ready
  80714. * @param onError defines the callback to trigger in case of error
  80715. */
  80716. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  80717. /**
  80718. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  80719. * @param data contains the texture data
  80720. * @param texture defines the BabylonJS internal texture
  80721. * @param callback defines the method to call once ready to upload
  80722. */
  80723. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  80724. }
  80725. }
  80726. declare module BABYLON {
  80727. /**
  80728. * Class used to store and describe the pipeline context associated with an effect
  80729. */
  80730. export interface IPipelineContext {
  80731. /**
  80732. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  80733. */
  80734. isAsync: boolean;
  80735. /**
  80736. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  80737. */
  80738. isReady: boolean;
  80739. /** @hidden */
  80740. _getVertexShaderCode(): string | null;
  80741. /** @hidden */
  80742. _getFragmentShaderCode(): string | null;
  80743. /** @hidden */
  80744. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  80745. }
  80746. }
  80747. declare module BABYLON {
  80748. /**
  80749. * Class used to store gfx data (like WebGLBuffer)
  80750. */
  80751. export class DataBuffer {
  80752. /**
  80753. * Gets or sets the number of objects referencing this buffer
  80754. */
  80755. references: number;
  80756. /** Gets or sets the size of the underlying buffer */
  80757. capacity: number;
  80758. /**
  80759. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  80760. */
  80761. is32Bits: boolean;
  80762. /**
  80763. * Gets the underlying buffer
  80764. */
  80765. get underlyingResource(): any;
  80766. }
  80767. }
  80768. declare module BABYLON {
  80769. /** @hidden */
  80770. export interface IShaderProcessor {
  80771. attributeProcessor?: (attribute: string) => string;
  80772. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  80773. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  80774. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  80775. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  80776. lineProcessor?: (line: string, isFragment: boolean) => string;
  80777. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  80778. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  80779. }
  80780. }
  80781. declare module BABYLON {
  80782. /** @hidden */
  80783. export interface ProcessingOptions {
  80784. defines: string[];
  80785. indexParameters: any;
  80786. isFragment: boolean;
  80787. shouldUseHighPrecisionShader: boolean;
  80788. supportsUniformBuffers: boolean;
  80789. shadersRepository: string;
  80790. includesShadersStore: {
  80791. [key: string]: string;
  80792. };
  80793. processor?: IShaderProcessor;
  80794. version: string;
  80795. platformName: string;
  80796. lookForClosingBracketForUniformBuffer?: boolean;
  80797. }
  80798. }
  80799. declare module BABYLON {
  80800. /** @hidden */
  80801. export class ShaderCodeNode {
  80802. line: string;
  80803. children: ShaderCodeNode[];
  80804. additionalDefineKey?: string;
  80805. additionalDefineValue?: string;
  80806. isValid(preprocessors: {
  80807. [key: string]: string;
  80808. }): boolean;
  80809. process(preprocessors: {
  80810. [key: string]: string;
  80811. }, options: ProcessingOptions): string;
  80812. }
  80813. }
  80814. declare module BABYLON {
  80815. /** @hidden */
  80816. export class ShaderCodeCursor {
  80817. private _lines;
  80818. lineIndex: number;
  80819. get currentLine(): string;
  80820. get canRead(): boolean;
  80821. set lines(value: string[]);
  80822. }
  80823. }
  80824. declare module BABYLON {
  80825. /** @hidden */
  80826. export class ShaderCodeConditionNode extends ShaderCodeNode {
  80827. process(preprocessors: {
  80828. [key: string]: string;
  80829. }, options: ProcessingOptions): string;
  80830. }
  80831. }
  80832. declare module BABYLON {
  80833. /** @hidden */
  80834. export class ShaderDefineExpression {
  80835. isTrue(preprocessors: {
  80836. [key: string]: string;
  80837. }): boolean;
  80838. private static _OperatorPriority;
  80839. private static _Stack;
  80840. static postfixToInfix(postfix: string[]): string;
  80841. static infixToPostfix(infix: string): string[];
  80842. }
  80843. }
  80844. declare module BABYLON {
  80845. /** @hidden */
  80846. export class ShaderCodeTestNode extends ShaderCodeNode {
  80847. testExpression: ShaderDefineExpression;
  80848. isValid(preprocessors: {
  80849. [key: string]: string;
  80850. }): boolean;
  80851. }
  80852. }
  80853. declare module BABYLON {
  80854. /** @hidden */
  80855. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  80856. define: string;
  80857. not: boolean;
  80858. constructor(define: string, not?: boolean);
  80859. isTrue(preprocessors: {
  80860. [key: string]: string;
  80861. }): boolean;
  80862. }
  80863. }
  80864. declare module BABYLON {
  80865. /** @hidden */
  80866. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  80867. leftOperand: ShaderDefineExpression;
  80868. rightOperand: ShaderDefineExpression;
  80869. isTrue(preprocessors: {
  80870. [key: string]: string;
  80871. }): boolean;
  80872. }
  80873. }
  80874. declare module BABYLON {
  80875. /** @hidden */
  80876. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  80877. leftOperand: ShaderDefineExpression;
  80878. rightOperand: ShaderDefineExpression;
  80879. isTrue(preprocessors: {
  80880. [key: string]: string;
  80881. }): boolean;
  80882. }
  80883. }
  80884. declare module BABYLON {
  80885. /** @hidden */
  80886. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  80887. define: string;
  80888. operand: string;
  80889. testValue: string;
  80890. constructor(define: string, operand: string, testValue: string);
  80891. isTrue(preprocessors: {
  80892. [key: string]: string;
  80893. }): boolean;
  80894. }
  80895. }
  80896. declare module BABYLON {
  80897. /**
  80898. * Class used to enable access to offline support
  80899. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  80900. */
  80901. export interface IOfflineProvider {
  80902. /**
  80903. * Gets a boolean indicating if scene must be saved in the database
  80904. */
  80905. enableSceneOffline: boolean;
  80906. /**
  80907. * Gets a boolean indicating if textures must be saved in the database
  80908. */
  80909. enableTexturesOffline: boolean;
  80910. /**
  80911. * Open the offline support and make it available
  80912. * @param successCallback defines the callback to call on success
  80913. * @param errorCallback defines the callback to call on error
  80914. */
  80915. open(successCallback: () => void, errorCallback: () => void): void;
  80916. /**
  80917. * Loads an image from the offline support
  80918. * @param url defines the url to load from
  80919. * @param image defines the target DOM image
  80920. */
  80921. loadImage(url: string, image: HTMLImageElement): void;
  80922. /**
  80923. * Loads a file from offline support
  80924. * @param url defines the URL to load from
  80925. * @param sceneLoaded defines a callback to call on success
  80926. * @param progressCallBack defines a callback to call when progress changed
  80927. * @param errorCallback defines a callback to call on error
  80928. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  80929. */
  80930. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  80931. }
  80932. }
  80933. declare module BABYLON {
  80934. /**
  80935. * Class used to help managing file picking and drag'n'drop
  80936. * File Storage
  80937. */
  80938. export class FilesInputStore {
  80939. /**
  80940. * List of files ready to be loaded
  80941. */
  80942. static FilesToLoad: {
  80943. [key: string]: File;
  80944. };
  80945. }
  80946. }
  80947. declare module BABYLON {
  80948. /**
  80949. * Class used to define a retry strategy when error happens while loading assets
  80950. */
  80951. export class RetryStrategy {
  80952. /**
  80953. * Function used to defines an exponential back off strategy
  80954. * @param maxRetries defines the maximum number of retries (3 by default)
  80955. * @param baseInterval defines the interval between retries
  80956. * @returns the strategy function to use
  80957. */
  80958. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  80959. }
  80960. }
  80961. declare module BABYLON {
  80962. /**
  80963. * @ignore
  80964. * Application error to support additional information when loading a file
  80965. */
  80966. export abstract class BaseError extends Error {
  80967. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  80968. }
  80969. }
  80970. declare module BABYLON {
  80971. /** @ignore */
  80972. export class LoadFileError extends BaseError {
  80973. request?: WebRequest;
  80974. file?: File;
  80975. /**
  80976. * Creates a new LoadFileError
  80977. * @param message defines the message of the error
  80978. * @param request defines the optional web request
  80979. * @param file defines the optional file
  80980. */
  80981. constructor(message: string, object?: WebRequest | File);
  80982. }
  80983. /** @ignore */
  80984. export class RequestFileError extends BaseError {
  80985. request: WebRequest;
  80986. /**
  80987. * Creates a new LoadFileError
  80988. * @param message defines the message of the error
  80989. * @param request defines the optional web request
  80990. */
  80991. constructor(message: string, request: WebRequest);
  80992. }
  80993. /** @ignore */
  80994. export class ReadFileError extends BaseError {
  80995. file: File;
  80996. /**
  80997. * Creates a new ReadFileError
  80998. * @param message defines the message of the error
  80999. * @param file defines the optional file
  81000. */
  81001. constructor(message: string, file: File);
  81002. }
  81003. /**
  81004. * @hidden
  81005. */
  81006. export class FileTools {
  81007. /**
  81008. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  81009. */
  81010. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  81011. /**
  81012. * Gets or sets the base URL to use to load assets
  81013. */
  81014. static BaseUrl: string;
  81015. /**
  81016. * Default behaviour for cors in the application.
  81017. * It can be a string if the expected behavior is identical in the entire app.
  81018. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  81019. */
  81020. static CorsBehavior: string | ((url: string | string[]) => string);
  81021. /**
  81022. * Gets or sets a function used to pre-process url before using them to load assets
  81023. */
  81024. static PreprocessUrl: (url: string) => string;
  81025. /**
  81026. * Removes unwanted characters from an url
  81027. * @param url defines the url to clean
  81028. * @returns the cleaned url
  81029. */
  81030. private static _CleanUrl;
  81031. /**
  81032. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  81033. * @param url define the url we are trying
  81034. * @param element define the dom element where to configure the cors policy
  81035. */
  81036. static SetCorsBehavior(url: string | string[], element: {
  81037. crossOrigin: string | null;
  81038. }): void;
  81039. /**
  81040. * Loads an image as an HTMLImageElement.
  81041. * @param input url string, ArrayBuffer, or Blob to load
  81042. * @param onLoad callback called when the image successfully loads
  81043. * @param onError callback called when the image fails to load
  81044. * @param offlineProvider offline provider for caching
  81045. * @param mimeType optional mime type
  81046. * @returns the HTMLImageElement of the loaded image
  81047. */
  81048. 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>;
  81049. /**
  81050. * Reads a file from a File object
  81051. * @param file defines the file to load
  81052. * @param onSuccess defines the callback to call when data is loaded
  81053. * @param onProgress defines the callback to call during loading process
  81054. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  81055. * @param onError defines the callback to call when an error occurs
  81056. * @returns a file request object
  81057. */
  81058. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  81059. /**
  81060. * Loads a file from a url
  81061. * @param url url to load
  81062. * @param onSuccess callback called when the file successfully loads
  81063. * @param onProgress callback called while file is loading (if the server supports this mode)
  81064. * @param offlineProvider defines the offline provider for caching
  81065. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81066. * @param onError callback called when the file fails to load
  81067. * @returns a file request object
  81068. */
  81069. 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;
  81070. /**
  81071. * Loads a file
  81072. * @param url url to load
  81073. * @param onSuccess callback called when the file successfully loads
  81074. * @param onProgress callback called while file is loading (if the server supports this mode)
  81075. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81076. * @param onError callback called when the file fails to load
  81077. * @param onOpened callback called when the web request is opened
  81078. * @returns a file request object
  81079. */
  81080. 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;
  81081. /**
  81082. * Checks if the loaded document was accessed via `file:`-Protocol.
  81083. * @returns boolean
  81084. */
  81085. static IsFileURL(): boolean;
  81086. }
  81087. }
  81088. declare module BABYLON {
  81089. /** @hidden */
  81090. export class ShaderProcessor {
  81091. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  81092. private static _ProcessPrecision;
  81093. private static _ExtractOperation;
  81094. private static _BuildSubExpression;
  81095. private static _BuildExpression;
  81096. private static _MoveCursorWithinIf;
  81097. private static _MoveCursor;
  81098. private static _EvaluatePreProcessors;
  81099. private static _PreparePreProcessors;
  81100. private static _ProcessShaderConversion;
  81101. private static _ProcessIncludes;
  81102. /**
  81103. * Loads a file from a url
  81104. * @param url url to load
  81105. * @param onSuccess callback called when the file successfully loads
  81106. * @param onProgress callback called while file is loading (if the server supports this mode)
  81107. * @param offlineProvider defines the offline provider for caching
  81108. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81109. * @param onError callback called when the file fails to load
  81110. * @returns a file request object
  81111. * @hidden
  81112. */
  81113. 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;
  81114. }
  81115. }
  81116. declare module BABYLON {
  81117. /**
  81118. * @hidden
  81119. */
  81120. export interface IColor4Like {
  81121. r: float;
  81122. g: float;
  81123. b: float;
  81124. a: float;
  81125. }
  81126. /**
  81127. * @hidden
  81128. */
  81129. export interface IColor3Like {
  81130. r: float;
  81131. g: float;
  81132. b: float;
  81133. }
  81134. /**
  81135. * @hidden
  81136. */
  81137. export interface IVector4Like {
  81138. x: float;
  81139. y: float;
  81140. z: float;
  81141. w: float;
  81142. }
  81143. /**
  81144. * @hidden
  81145. */
  81146. export interface IVector3Like {
  81147. x: float;
  81148. y: float;
  81149. z: float;
  81150. }
  81151. /**
  81152. * @hidden
  81153. */
  81154. export interface IVector2Like {
  81155. x: float;
  81156. y: float;
  81157. }
  81158. /**
  81159. * @hidden
  81160. */
  81161. export interface IMatrixLike {
  81162. toArray(): DeepImmutable<Float32Array | Array<number>>;
  81163. updateFlag: int;
  81164. }
  81165. /**
  81166. * @hidden
  81167. */
  81168. export interface IViewportLike {
  81169. x: float;
  81170. y: float;
  81171. width: float;
  81172. height: float;
  81173. }
  81174. /**
  81175. * @hidden
  81176. */
  81177. export interface IPlaneLike {
  81178. normal: IVector3Like;
  81179. d: float;
  81180. normalize(): void;
  81181. }
  81182. }
  81183. declare module BABYLON {
  81184. /**
  81185. * Interface used to define common properties for effect fallbacks
  81186. */
  81187. export interface IEffectFallbacks {
  81188. /**
  81189. * Removes the defines that should be removed when falling back.
  81190. * @param currentDefines defines the current define statements for the shader.
  81191. * @param effect defines the current effect we try to compile
  81192. * @returns The resulting defines with defines of the current rank removed.
  81193. */
  81194. reduce(currentDefines: string, effect: Effect): string;
  81195. /**
  81196. * Removes the fallback from the bound mesh.
  81197. */
  81198. unBindMesh(): void;
  81199. /**
  81200. * Checks to see if more fallbacks are still availible.
  81201. */
  81202. hasMoreFallbacks: boolean;
  81203. }
  81204. }
  81205. declare module BABYLON {
  81206. /**
  81207. * Class used to evalaute queries containing `and` and `or` operators
  81208. */
  81209. export class AndOrNotEvaluator {
  81210. /**
  81211. * Evaluate a query
  81212. * @param query defines the query to evaluate
  81213. * @param evaluateCallback defines the callback used to filter result
  81214. * @returns true if the query matches
  81215. */
  81216. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  81217. private static _HandleParenthesisContent;
  81218. private static _SimplifyNegation;
  81219. }
  81220. }
  81221. declare module BABYLON {
  81222. /**
  81223. * Class used to store custom tags
  81224. */
  81225. export class Tags {
  81226. /**
  81227. * Adds support for tags on the given object
  81228. * @param obj defines the object to use
  81229. */
  81230. static EnableFor(obj: any): void;
  81231. /**
  81232. * Removes tags support
  81233. * @param obj defines the object to use
  81234. */
  81235. static DisableFor(obj: any): void;
  81236. /**
  81237. * Gets a boolean indicating if the given object has tags
  81238. * @param obj defines the object to use
  81239. * @returns a boolean
  81240. */
  81241. static HasTags(obj: any): boolean;
  81242. /**
  81243. * Gets the tags available on a given object
  81244. * @param obj defines the object to use
  81245. * @param asString defines if the tags must be returned as a string instead of an array of strings
  81246. * @returns the tags
  81247. */
  81248. static GetTags(obj: any, asString?: boolean): any;
  81249. /**
  81250. * Adds tags to an object
  81251. * @param obj defines the object to use
  81252. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  81253. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  81254. */
  81255. static AddTagsTo(obj: any, tagsString: string): void;
  81256. /**
  81257. * @hidden
  81258. */
  81259. static _AddTagTo(obj: any, tag: string): void;
  81260. /**
  81261. * Removes specific tags from a specific object
  81262. * @param obj defines the object to use
  81263. * @param tagsString defines the tags to remove
  81264. */
  81265. static RemoveTagsFrom(obj: any, tagsString: string): void;
  81266. /**
  81267. * @hidden
  81268. */
  81269. static _RemoveTagFrom(obj: any, tag: string): void;
  81270. /**
  81271. * Defines if tags hosted on an object match a given query
  81272. * @param obj defines the object to use
  81273. * @param tagsQuery defines the tag query
  81274. * @returns a boolean
  81275. */
  81276. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  81277. }
  81278. }
  81279. declare module BABYLON {
  81280. /**
  81281. * Scalar computation library
  81282. */
  81283. export class Scalar {
  81284. /**
  81285. * Two pi constants convenient for computation.
  81286. */
  81287. static TwoPi: number;
  81288. /**
  81289. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  81290. * @param a number
  81291. * @param b number
  81292. * @param epsilon (default = 1.401298E-45)
  81293. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  81294. */
  81295. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  81296. /**
  81297. * Returns a string : the upper case translation of the number i to hexadecimal.
  81298. * @param i number
  81299. * @returns the upper case translation of the number i to hexadecimal.
  81300. */
  81301. static ToHex(i: number): string;
  81302. /**
  81303. * Returns -1 if value is negative and +1 is value is positive.
  81304. * @param value the value
  81305. * @returns the value itself if it's equal to zero.
  81306. */
  81307. static Sign(value: number): number;
  81308. /**
  81309. * Returns the value itself if it's between min and max.
  81310. * Returns min if the value is lower than min.
  81311. * Returns max if the value is greater than max.
  81312. * @param value the value to clmap
  81313. * @param min the min value to clamp to (default: 0)
  81314. * @param max the max value to clamp to (default: 1)
  81315. * @returns the clamped value
  81316. */
  81317. static Clamp(value: number, min?: number, max?: number): number;
  81318. /**
  81319. * the log2 of value.
  81320. * @param value the value to compute log2 of
  81321. * @returns the log2 of value.
  81322. */
  81323. static Log2(value: number): number;
  81324. /**
  81325. * Loops the value, so that it is never larger than length and never smaller than 0.
  81326. *
  81327. * This is similar to the modulo operator but it works with floating point numbers.
  81328. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  81329. * With t = 5 and length = 2.5, the result would be 0.0.
  81330. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  81331. * @param value the value
  81332. * @param length the length
  81333. * @returns the looped value
  81334. */
  81335. static Repeat(value: number, length: number): number;
  81336. /**
  81337. * Normalize the value between 0.0 and 1.0 using min and max values
  81338. * @param value value to normalize
  81339. * @param min max to normalize between
  81340. * @param max min to normalize between
  81341. * @returns the normalized value
  81342. */
  81343. static Normalize(value: number, min: number, max: number): number;
  81344. /**
  81345. * Denormalize the value from 0.0 and 1.0 using min and max values
  81346. * @param normalized value to denormalize
  81347. * @param min max to denormalize between
  81348. * @param max min to denormalize between
  81349. * @returns the denormalized value
  81350. */
  81351. static Denormalize(normalized: number, min: number, max: number): number;
  81352. /**
  81353. * Calculates the shortest difference between two given angles given in degrees.
  81354. * @param current current angle in degrees
  81355. * @param target target angle in degrees
  81356. * @returns the delta
  81357. */
  81358. static DeltaAngle(current: number, target: number): number;
  81359. /**
  81360. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  81361. * @param tx value
  81362. * @param length length
  81363. * @returns The returned value will move back and forth between 0 and length
  81364. */
  81365. static PingPong(tx: number, length: number): number;
  81366. /**
  81367. * Interpolates between min and max with smoothing at the limits.
  81368. *
  81369. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  81370. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  81371. * @param from from
  81372. * @param to to
  81373. * @param tx value
  81374. * @returns the smooth stepped value
  81375. */
  81376. static SmoothStep(from: number, to: number, tx: number): number;
  81377. /**
  81378. * Moves a value current towards target.
  81379. *
  81380. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  81381. * Negative values of maxDelta pushes the value away from target.
  81382. * @param current current value
  81383. * @param target target value
  81384. * @param maxDelta max distance to move
  81385. * @returns resulting value
  81386. */
  81387. static MoveTowards(current: number, target: number, maxDelta: number): number;
  81388. /**
  81389. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  81390. *
  81391. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  81392. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  81393. * @param current current value
  81394. * @param target target value
  81395. * @param maxDelta max distance to move
  81396. * @returns resulting angle
  81397. */
  81398. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  81399. /**
  81400. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  81401. * @param start start value
  81402. * @param end target value
  81403. * @param amount amount to lerp between
  81404. * @returns the lerped value
  81405. */
  81406. static Lerp(start: number, end: number, amount: number): number;
  81407. /**
  81408. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  81409. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  81410. * @param start start value
  81411. * @param end target value
  81412. * @param amount amount to lerp between
  81413. * @returns the lerped value
  81414. */
  81415. static LerpAngle(start: number, end: number, amount: number): number;
  81416. /**
  81417. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  81418. * @param a start value
  81419. * @param b target value
  81420. * @param value value between a and b
  81421. * @returns the inverseLerp value
  81422. */
  81423. static InverseLerp(a: number, b: number, value: number): number;
  81424. /**
  81425. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  81426. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  81427. * @param value1 spline value
  81428. * @param tangent1 spline value
  81429. * @param value2 spline value
  81430. * @param tangent2 spline value
  81431. * @param amount input value
  81432. * @returns hermite result
  81433. */
  81434. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  81435. /**
  81436. * Returns a random float number between and min and max values
  81437. * @param min min value of random
  81438. * @param max max value of random
  81439. * @returns random value
  81440. */
  81441. static RandomRange(min: number, max: number): number;
  81442. /**
  81443. * This function returns percentage of a number in a given range.
  81444. *
  81445. * RangeToPercent(40,20,60) will return 0.5 (50%)
  81446. * RangeToPercent(34,0,100) will return 0.34 (34%)
  81447. * @param number to convert to percentage
  81448. * @param min min range
  81449. * @param max max range
  81450. * @returns the percentage
  81451. */
  81452. static RangeToPercent(number: number, min: number, max: number): number;
  81453. /**
  81454. * This function returns number that corresponds to the percentage in a given range.
  81455. *
  81456. * PercentToRange(0.34,0,100) will return 34.
  81457. * @param percent to convert to number
  81458. * @param min min range
  81459. * @param max max range
  81460. * @returns the number
  81461. */
  81462. static PercentToRange(percent: number, min: number, max: number): number;
  81463. /**
  81464. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  81465. * @param angle The angle to normalize in radian.
  81466. * @return The converted angle.
  81467. */
  81468. static NormalizeRadians(angle: number): number;
  81469. }
  81470. }
  81471. declare module BABYLON {
  81472. /**
  81473. * Constant used to convert a value to gamma space
  81474. * @ignorenaming
  81475. */
  81476. export const ToGammaSpace: number;
  81477. /**
  81478. * Constant used to convert a value to linear space
  81479. * @ignorenaming
  81480. */
  81481. export const ToLinearSpace = 2.2;
  81482. /**
  81483. * Constant used to define the minimal number value in Babylon.js
  81484. * @ignorenaming
  81485. */
  81486. let Epsilon: number;
  81487. }
  81488. declare module BABYLON {
  81489. /**
  81490. * Class used to represent a viewport on screen
  81491. */
  81492. export class Viewport {
  81493. /** viewport left coordinate */
  81494. x: number;
  81495. /** viewport top coordinate */
  81496. y: number;
  81497. /**viewport width */
  81498. width: number;
  81499. /** viewport height */
  81500. height: number;
  81501. /**
  81502. * Creates a Viewport object located at (x, y) and sized (width, height)
  81503. * @param x defines viewport left coordinate
  81504. * @param y defines viewport top coordinate
  81505. * @param width defines the viewport width
  81506. * @param height defines the viewport height
  81507. */
  81508. constructor(
  81509. /** viewport left coordinate */
  81510. x: number,
  81511. /** viewport top coordinate */
  81512. y: number,
  81513. /**viewport width */
  81514. width: number,
  81515. /** viewport height */
  81516. height: number);
  81517. /**
  81518. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  81519. * @param renderWidth defines the rendering width
  81520. * @param renderHeight defines the rendering height
  81521. * @returns a new Viewport
  81522. */
  81523. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  81524. /**
  81525. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  81526. * @param renderWidth defines the rendering width
  81527. * @param renderHeight defines the rendering height
  81528. * @param ref defines the target viewport
  81529. * @returns the current viewport
  81530. */
  81531. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  81532. /**
  81533. * Returns a new Viewport copied from the current one
  81534. * @returns a new Viewport
  81535. */
  81536. clone(): Viewport;
  81537. }
  81538. }
  81539. declare module BABYLON {
  81540. /**
  81541. * Class containing a set of static utilities functions for arrays.
  81542. */
  81543. export class ArrayTools {
  81544. /**
  81545. * Returns an array of the given size filled with element built from the given constructor and the paramters
  81546. * @param size the number of element to construct and put in the array
  81547. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  81548. * @returns a new array filled with new objects
  81549. */
  81550. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  81551. }
  81552. }
  81553. declare module BABYLON {
  81554. /**
  81555. * Represents a plane by the equation ax + by + cz + d = 0
  81556. */
  81557. export class Plane {
  81558. private static _TmpMatrix;
  81559. /**
  81560. * Normal of the plane (a,b,c)
  81561. */
  81562. normal: Vector3;
  81563. /**
  81564. * d component of the plane
  81565. */
  81566. d: number;
  81567. /**
  81568. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  81569. * @param a a component of the plane
  81570. * @param b b component of the plane
  81571. * @param c c component of the plane
  81572. * @param d d component of the plane
  81573. */
  81574. constructor(a: number, b: number, c: number, d: number);
  81575. /**
  81576. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  81577. */
  81578. asArray(): number[];
  81579. /**
  81580. * @returns a new plane copied from the current Plane.
  81581. */
  81582. clone(): Plane;
  81583. /**
  81584. * @returns the string "Plane".
  81585. */
  81586. getClassName(): string;
  81587. /**
  81588. * @returns the Plane hash code.
  81589. */
  81590. getHashCode(): number;
  81591. /**
  81592. * Normalize the current Plane in place.
  81593. * @returns the updated Plane.
  81594. */
  81595. normalize(): Plane;
  81596. /**
  81597. * Applies a transformation the plane and returns the result
  81598. * @param transformation the transformation matrix to be applied to the plane
  81599. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  81600. */
  81601. transform(transformation: DeepImmutable<Matrix>): Plane;
  81602. /**
  81603. * Compute the dot product between the point and the plane normal
  81604. * @param point point to calculate the dot product with
  81605. * @returns the dot product (float) of the point coordinates and the plane normal.
  81606. */
  81607. dotCoordinate(point: DeepImmutable<Vector3>): number;
  81608. /**
  81609. * Updates the current Plane from the plane defined by the three given points.
  81610. * @param point1 one of the points used to contruct the plane
  81611. * @param point2 one of the points used to contruct the plane
  81612. * @param point3 one of the points used to contruct the plane
  81613. * @returns the updated Plane.
  81614. */
  81615. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  81616. /**
  81617. * Checks if the plane is facing a given direction
  81618. * @param direction the direction to check if the plane is facing
  81619. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  81620. * @returns True is the vector "direction" is the same side than the plane normal.
  81621. */
  81622. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  81623. /**
  81624. * Calculates the distance to a point
  81625. * @param point point to calculate distance to
  81626. * @returns the signed distance (float) from the given point to the Plane.
  81627. */
  81628. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  81629. /**
  81630. * Creates a plane from an array
  81631. * @param array the array to create a plane from
  81632. * @returns a new Plane from the given array.
  81633. */
  81634. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  81635. /**
  81636. * Creates a plane from three points
  81637. * @param point1 point used to create the plane
  81638. * @param point2 point used to create the plane
  81639. * @param point3 point used to create the plane
  81640. * @returns a new Plane defined by the three given points.
  81641. */
  81642. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  81643. /**
  81644. * Creates a plane from an origin point and a normal
  81645. * @param origin origin of the plane to be constructed
  81646. * @param normal normal of the plane to be constructed
  81647. * @returns a new Plane the normal vector to this plane at the given origin point.
  81648. * Note : the vector "normal" is updated because normalized.
  81649. */
  81650. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  81651. /**
  81652. * Calculates the distance from a plane and a point
  81653. * @param origin origin of the plane to be constructed
  81654. * @param normal normal of the plane to be constructed
  81655. * @param point point to calculate distance to
  81656. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  81657. */
  81658. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  81659. }
  81660. }
  81661. declare module BABYLON {
  81662. /** @hidden */
  81663. export class PerformanceConfigurator {
  81664. /** @hidden */
  81665. static MatrixUse64Bits: boolean;
  81666. /** @hidden */
  81667. static MatrixTrackPrecisionChange: boolean;
  81668. /** @hidden */
  81669. static MatrixCurrentType: any;
  81670. /** @hidden */
  81671. static MatrixTrackedMatrices: Array<any> | null;
  81672. /** @hidden */
  81673. static SetMatrixPrecision(use64bits: boolean): void;
  81674. }
  81675. }
  81676. declare module BABYLON {
  81677. /**
  81678. * Class representing a vector containing 2 coordinates
  81679. */
  81680. export class Vector2 {
  81681. /** defines the first coordinate */
  81682. x: number;
  81683. /** defines the second coordinate */
  81684. y: number;
  81685. /**
  81686. * Creates a new Vector2 from the given x and y coordinates
  81687. * @param x defines the first coordinate
  81688. * @param y defines the second coordinate
  81689. */
  81690. constructor(
  81691. /** defines the first coordinate */
  81692. x?: number,
  81693. /** defines the second coordinate */
  81694. y?: number);
  81695. /**
  81696. * Gets a string with the Vector2 coordinates
  81697. * @returns a string with the Vector2 coordinates
  81698. */
  81699. toString(): string;
  81700. /**
  81701. * Gets class name
  81702. * @returns the string "Vector2"
  81703. */
  81704. getClassName(): string;
  81705. /**
  81706. * Gets current vector hash code
  81707. * @returns the Vector2 hash code as a number
  81708. */
  81709. getHashCode(): number;
  81710. /**
  81711. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  81712. * @param array defines the source array
  81713. * @param index defines the offset in source array
  81714. * @returns the current Vector2
  81715. */
  81716. toArray(array: FloatArray, index?: number): Vector2;
  81717. /**
  81718. * Update the current vector from an array
  81719. * @param array defines the destination array
  81720. * @param index defines the offset in the destination array
  81721. * @returns the current Vector3
  81722. */
  81723. fromArray(array: FloatArray, index?: number): Vector2;
  81724. /**
  81725. * Copy the current vector to an array
  81726. * @returns a new array with 2 elements: the Vector2 coordinates.
  81727. */
  81728. asArray(): number[];
  81729. /**
  81730. * Sets the Vector2 coordinates with the given Vector2 coordinates
  81731. * @param source defines the source Vector2
  81732. * @returns the current updated Vector2
  81733. */
  81734. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  81735. /**
  81736. * Sets the Vector2 coordinates with the given floats
  81737. * @param x defines the first coordinate
  81738. * @param y defines the second coordinate
  81739. * @returns the current updated Vector2
  81740. */
  81741. copyFromFloats(x: number, y: number): Vector2;
  81742. /**
  81743. * Sets the Vector2 coordinates with the given floats
  81744. * @param x defines the first coordinate
  81745. * @param y defines the second coordinate
  81746. * @returns the current updated Vector2
  81747. */
  81748. set(x: number, y: number): Vector2;
  81749. /**
  81750. * Add another vector with the current one
  81751. * @param otherVector defines the other vector
  81752. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  81753. */
  81754. add(otherVector: DeepImmutable<Vector2>): Vector2;
  81755. /**
  81756. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  81757. * @param otherVector defines the other vector
  81758. * @param result defines the target vector
  81759. * @returns the unmodified current Vector2
  81760. */
  81761. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81762. /**
  81763. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  81764. * @param otherVector defines the other vector
  81765. * @returns the current updated Vector2
  81766. */
  81767. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81768. /**
  81769. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  81770. * @param otherVector defines the other vector
  81771. * @returns a new Vector2
  81772. */
  81773. addVector3(otherVector: Vector3): Vector2;
  81774. /**
  81775. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  81776. * @param otherVector defines the other vector
  81777. * @returns a new Vector2
  81778. */
  81779. subtract(otherVector: Vector2): Vector2;
  81780. /**
  81781. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  81782. * @param otherVector defines the other vector
  81783. * @param result defines the target vector
  81784. * @returns the unmodified current Vector2
  81785. */
  81786. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81787. /**
  81788. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  81789. * @param otherVector defines the other vector
  81790. * @returns the current updated Vector2
  81791. */
  81792. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81793. /**
  81794. * Multiplies in place the current Vector2 coordinates by the given ones
  81795. * @param otherVector defines the other vector
  81796. * @returns the current updated Vector2
  81797. */
  81798. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81799. /**
  81800. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  81801. * @param otherVector defines the other vector
  81802. * @returns a new Vector2
  81803. */
  81804. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  81805. /**
  81806. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  81807. * @param otherVector defines the other vector
  81808. * @param result defines the target vector
  81809. * @returns the unmodified current Vector2
  81810. */
  81811. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81812. /**
  81813. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  81814. * @param x defines the first coordinate
  81815. * @param y defines the second coordinate
  81816. * @returns a new Vector2
  81817. */
  81818. multiplyByFloats(x: number, y: number): Vector2;
  81819. /**
  81820. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  81821. * @param otherVector defines the other vector
  81822. * @returns a new Vector2
  81823. */
  81824. divide(otherVector: Vector2): Vector2;
  81825. /**
  81826. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  81827. * @param otherVector defines the other vector
  81828. * @param result defines the target vector
  81829. * @returns the unmodified current Vector2
  81830. */
  81831. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81832. /**
  81833. * Divides the current Vector2 coordinates by the given ones
  81834. * @param otherVector defines the other vector
  81835. * @returns the current updated Vector2
  81836. */
  81837. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81838. /**
  81839. * Gets a new Vector2 with current Vector2 negated coordinates
  81840. * @returns a new Vector2
  81841. */
  81842. negate(): Vector2;
  81843. /**
  81844. * Negate this vector in place
  81845. * @returns this
  81846. */
  81847. negateInPlace(): Vector2;
  81848. /**
  81849. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  81850. * @param result defines the Vector3 object where to store the result
  81851. * @returns the current Vector2
  81852. */
  81853. negateToRef(result: Vector2): Vector2;
  81854. /**
  81855. * Multiply the Vector2 coordinates by scale
  81856. * @param scale defines the scaling factor
  81857. * @returns the current updated Vector2
  81858. */
  81859. scaleInPlace(scale: number): Vector2;
  81860. /**
  81861. * Returns a new Vector2 scaled by "scale" from the current Vector2
  81862. * @param scale defines the scaling factor
  81863. * @returns a new Vector2
  81864. */
  81865. scale(scale: number): Vector2;
  81866. /**
  81867. * Scale the current Vector2 values by a factor to a given Vector2
  81868. * @param scale defines the scale factor
  81869. * @param result defines the Vector2 object where to store the result
  81870. * @returns the unmodified current Vector2
  81871. */
  81872. scaleToRef(scale: number, result: Vector2): Vector2;
  81873. /**
  81874. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  81875. * @param scale defines the scale factor
  81876. * @param result defines the Vector2 object where to store the result
  81877. * @returns the unmodified current Vector2
  81878. */
  81879. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  81880. /**
  81881. * Gets a boolean if two vectors are equals
  81882. * @param otherVector defines the other vector
  81883. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  81884. */
  81885. equals(otherVector: DeepImmutable<Vector2>): boolean;
  81886. /**
  81887. * Gets a boolean if two vectors are equals (using an epsilon value)
  81888. * @param otherVector defines the other vector
  81889. * @param epsilon defines the minimal distance to consider equality
  81890. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  81891. */
  81892. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  81893. /**
  81894. * Gets a new Vector2 from current Vector2 floored values
  81895. * @returns a new Vector2
  81896. */
  81897. floor(): Vector2;
  81898. /**
  81899. * Gets a new Vector2 from current Vector2 floored values
  81900. * @returns a new Vector2
  81901. */
  81902. fract(): Vector2;
  81903. /**
  81904. * Gets the length of the vector
  81905. * @returns the vector length (float)
  81906. */
  81907. length(): number;
  81908. /**
  81909. * Gets the vector squared length
  81910. * @returns the vector squared length (float)
  81911. */
  81912. lengthSquared(): number;
  81913. /**
  81914. * Normalize the vector
  81915. * @returns the current updated Vector2
  81916. */
  81917. normalize(): Vector2;
  81918. /**
  81919. * Gets a new Vector2 copied from the Vector2
  81920. * @returns a new Vector2
  81921. */
  81922. clone(): Vector2;
  81923. /**
  81924. * Gets a new Vector2(0, 0)
  81925. * @returns a new Vector2
  81926. */
  81927. static Zero(): Vector2;
  81928. /**
  81929. * Gets a new Vector2(1, 1)
  81930. * @returns a new Vector2
  81931. */
  81932. static One(): Vector2;
  81933. /**
  81934. * Gets a new Vector2 set from the given index element of the given array
  81935. * @param array defines the data source
  81936. * @param offset defines the offset in the data source
  81937. * @returns a new Vector2
  81938. */
  81939. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  81940. /**
  81941. * Sets "result" from the given index element of the given array
  81942. * @param array defines the data source
  81943. * @param offset defines the offset in the data source
  81944. * @param result defines the target vector
  81945. */
  81946. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  81947. /**
  81948. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  81949. * @param value1 defines 1st point of control
  81950. * @param value2 defines 2nd point of control
  81951. * @param value3 defines 3rd point of control
  81952. * @param value4 defines 4th point of control
  81953. * @param amount defines the interpolation factor
  81954. * @returns a new Vector2
  81955. */
  81956. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  81957. /**
  81958. * 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".
  81959. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  81960. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  81961. * @param value defines the value to clamp
  81962. * @param min defines the lower limit
  81963. * @param max defines the upper limit
  81964. * @returns a new Vector2
  81965. */
  81966. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  81967. /**
  81968. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  81969. * @param value1 defines the 1st control point
  81970. * @param tangent1 defines the outgoing tangent
  81971. * @param value2 defines the 2nd control point
  81972. * @param tangent2 defines the incoming tangent
  81973. * @param amount defines the interpolation factor
  81974. * @returns a new Vector2
  81975. */
  81976. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  81977. /**
  81978. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  81979. * @param start defines the start vector
  81980. * @param end defines the end vector
  81981. * @param amount defines the interpolation factor
  81982. * @returns a new Vector2
  81983. */
  81984. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  81985. /**
  81986. * Gets the dot product of the vector "left" and the vector "right"
  81987. * @param left defines first vector
  81988. * @param right defines second vector
  81989. * @returns the dot product (float)
  81990. */
  81991. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  81992. /**
  81993. * Returns a new Vector2 equal to the normalized given vector
  81994. * @param vector defines the vector to normalize
  81995. * @returns a new Vector2
  81996. */
  81997. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  81998. /**
  81999. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  82000. * @param left defines 1st vector
  82001. * @param right defines 2nd vector
  82002. * @returns a new Vector2
  82003. */
  82004. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  82005. /**
  82006. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  82007. * @param left defines 1st vector
  82008. * @param right defines 2nd vector
  82009. * @returns a new Vector2
  82010. */
  82011. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  82012. /**
  82013. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  82014. * @param vector defines the vector to transform
  82015. * @param transformation defines the matrix to apply
  82016. * @returns a new Vector2
  82017. */
  82018. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  82019. /**
  82020. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  82021. * @param vector defines the vector to transform
  82022. * @param transformation defines the matrix to apply
  82023. * @param result defines the target vector
  82024. */
  82025. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  82026. /**
  82027. * Determines if a given vector is included in a triangle
  82028. * @param p defines the vector to test
  82029. * @param p0 defines 1st triangle point
  82030. * @param p1 defines 2nd triangle point
  82031. * @param p2 defines 3rd triangle point
  82032. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  82033. */
  82034. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  82035. /**
  82036. * Gets the distance between the vectors "value1" and "value2"
  82037. * @param value1 defines first vector
  82038. * @param value2 defines second vector
  82039. * @returns the distance between vectors
  82040. */
  82041. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  82042. /**
  82043. * Returns the squared distance between the vectors "value1" and "value2"
  82044. * @param value1 defines first vector
  82045. * @param value2 defines second vector
  82046. * @returns the squared distance between vectors
  82047. */
  82048. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  82049. /**
  82050. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  82051. * @param value1 defines first vector
  82052. * @param value2 defines second vector
  82053. * @returns a new Vector2
  82054. */
  82055. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  82056. /**
  82057. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  82058. * @param p defines the middle point
  82059. * @param segA defines one point of the segment
  82060. * @param segB defines the other point of the segment
  82061. * @returns the shortest distance
  82062. */
  82063. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  82064. }
  82065. /**
  82066. * Class used to store (x,y,z) vector representation
  82067. * A Vector3 is the main object used in 3D geometry
  82068. * It can represent etiher the coordinates of a point the space, either a direction
  82069. * Reminder: js uses a left handed forward facing system
  82070. */
  82071. export class Vector3 {
  82072. private static _UpReadOnly;
  82073. private static _ZeroReadOnly;
  82074. /** @hidden */
  82075. _x: number;
  82076. /** @hidden */
  82077. _y: number;
  82078. /** @hidden */
  82079. _z: number;
  82080. /** @hidden */
  82081. _isDirty: boolean;
  82082. /** Gets or sets the x coordinate */
  82083. get x(): number;
  82084. set x(value: number);
  82085. /** Gets or sets the y coordinate */
  82086. get y(): number;
  82087. set y(value: number);
  82088. /** Gets or sets the z coordinate */
  82089. get z(): number;
  82090. set z(value: number);
  82091. /**
  82092. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  82093. * @param x defines the first coordinates (on X axis)
  82094. * @param y defines the second coordinates (on Y axis)
  82095. * @param z defines the third coordinates (on Z axis)
  82096. */
  82097. constructor(x?: number, y?: number, z?: number);
  82098. /**
  82099. * Creates a string representation of the Vector3
  82100. * @returns a string with the Vector3 coordinates.
  82101. */
  82102. toString(): string;
  82103. /**
  82104. * Gets the class name
  82105. * @returns the string "Vector3"
  82106. */
  82107. getClassName(): string;
  82108. /**
  82109. * Creates the Vector3 hash code
  82110. * @returns a number which tends to be unique between Vector3 instances
  82111. */
  82112. getHashCode(): number;
  82113. /**
  82114. * Creates an array containing three elements : the coordinates of the Vector3
  82115. * @returns a new array of numbers
  82116. */
  82117. asArray(): number[];
  82118. /**
  82119. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  82120. * @param array defines the destination array
  82121. * @param index defines the offset in the destination array
  82122. * @returns the current Vector3
  82123. */
  82124. toArray(array: FloatArray, index?: number): Vector3;
  82125. /**
  82126. * Update the current vector from an array
  82127. * @param array defines the destination array
  82128. * @param index defines the offset in the destination array
  82129. * @returns the current Vector3
  82130. */
  82131. fromArray(array: FloatArray, index?: number): Vector3;
  82132. /**
  82133. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  82134. * @returns a new Quaternion object, computed from the Vector3 coordinates
  82135. */
  82136. toQuaternion(): Quaternion;
  82137. /**
  82138. * Adds the given vector to the current Vector3
  82139. * @param otherVector defines the second operand
  82140. * @returns the current updated Vector3
  82141. */
  82142. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82143. /**
  82144. * Adds the given coordinates to the current Vector3
  82145. * @param x defines the x coordinate of the operand
  82146. * @param y defines the y coordinate of the operand
  82147. * @param z defines the z coordinate of the operand
  82148. * @returns the current updated Vector3
  82149. */
  82150. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82151. /**
  82152. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  82153. * @param otherVector defines the second operand
  82154. * @returns the resulting Vector3
  82155. */
  82156. add(otherVector: DeepImmutable<Vector3>): Vector3;
  82157. /**
  82158. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  82159. * @param otherVector defines the second operand
  82160. * @param result defines the Vector3 object where to store the result
  82161. * @returns the current Vector3
  82162. */
  82163. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82164. /**
  82165. * Subtract the given vector from the current Vector3
  82166. * @param otherVector defines the second operand
  82167. * @returns the current updated Vector3
  82168. */
  82169. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82170. /**
  82171. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  82172. * @param otherVector defines the second operand
  82173. * @returns the resulting Vector3
  82174. */
  82175. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  82176. /**
  82177. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  82178. * @param otherVector defines the second operand
  82179. * @param result defines the Vector3 object where to store the result
  82180. * @returns the current Vector3
  82181. */
  82182. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82183. /**
  82184. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  82185. * @param x defines the x coordinate of the operand
  82186. * @param y defines the y coordinate of the operand
  82187. * @param z defines the z coordinate of the operand
  82188. * @returns the resulting Vector3
  82189. */
  82190. subtractFromFloats(x: number, y: number, z: number): Vector3;
  82191. /**
  82192. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  82193. * @param x defines the x coordinate of the operand
  82194. * @param y defines the y coordinate of the operand
  82195. * @param z defines the z coordinate of the operand
  82196. * @param result defines the Vector3 object where to store the result
  82197. * @returns the current Vector3
  82198. */
  82199. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  82200. /**
  82201. * Gets a new Vector3 set with the current Vector3 negated coordinates
  82202. * @returns a new Vector3
  82203. */
  82204. negate(): Vector3;
  82205. /**
  82206. * Negate this vector in place
  82207. * @returns this
  82208. */
  82209. negateInPlace(): Vector3;
  82210. /**
  82211. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  82212. * @param result defines the Vector3 object where to store the result
  82213. * @returns the current Vector3
  82214. */
  82215. negateToRef(result: Vector3): Vector3;
  82216. /**
  82217. * Multiplies the Vector3 coordinates by the float "scale"
  82218. * @param scale defines the multiplier factor
  82219. * @returns the current updated Vector3
  82220. */
  82221. scaleInPlace(scale: number): Vector3;
  82222. /**
  82223. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  82224. * @param scale defines the multiplier factor
  82225. * @returns a new Vector3
  82226. */
  82227. scale(scale: number): Vector3;
  82228. /**
  82229. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  82230. * @param scale defines the multiplier factor
  82231. * @param result defines the Vector3 object where to store the result
  82232. * @returns the current Vector3
  82233. */
  82234. scaleToRef(scale: number, result: Vector3): Vector3;
  82235. /**
  82236. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  82237. * @param scale defines the scale factor
  82238. * @param result defines the Vector3 object where to store the result
  82239. * @returns the unmodified current Vector3
  82240. */
  82241. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  82242. /**
  82243. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  82244. * @param origin defines the origin of the projection ray
  82245. * @param plane defines the plane to project to
  82246. * @returns the projected vector3
  82247. */
  82248. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  82249. /**
  82250. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  82251. * @param origin defines the origin of the projection ray
  82252. * @param plane defines the plane to project to
  82253. * @param result defines the Vector3 where to store the result
  82254. */
  82255. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  82256. /**
  82257. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  82258. * @param otherVector defines the second operand
  82259. * @returns true if both vectors are equals
  82260. */
  82261. equals(otherVector: DeepImmutable<Vector3>): boolean;
  82262. /**
  82263. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  82264. * @param otherVector defines the second operand
  82265. * @param epsilon defines the minimal distance to define values as equals
  82266. * @returns true if both vectors are distant less than epsilon
  82267. */
  82268. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  82269. /**
  82270. * Returns true if the current Vector3 coordinates equals the given floats
  82271. * @param x defines the x coordinate of the operand
  82272. * @param y defines the y coordinate of the operand
  82273. * @param z defines the z coordinate of the operand
  82274. * @returns true if both vectors are equals
  82275. */
  82276. equalsToFloats(x: number, y: number, z: number): boolean;
  82277. /**
  82278. * Multiplies the current Vector3 coordinates by the given ones
  82279. * @param otherVector defines the second operand
  82280. * @returns the current updated Vector3
  82281. */
  82282. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82283. /**
  82284. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  82285. * @param otherVector defines the second operand
  82286. * @returns the new Vector3
  82287. */
  82288. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  82289. /**
  82290. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  82291. * @param otherVector defines the second operand
  82292. * @param result defines the Vector3 object where to store the result
  82293. * @returns the current Vector3
  82294. */
  82295. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82296. /**
  82297. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  82298. * @param x defines the x coordinate of the operand
  82299. * @param y defines the y coordinate of the operand
  82300. * @param z defines the z coordinate of the operand
  82301. * @returns the new Vector3
  82302. */
  82303. multiplyByFloats(x: number, y: number, z: number): Vector3;
  82304. /**
  82305. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  82306. * @param otherVector defines the second operand
  82307. * @returns the new Vector3
  82308. */
  82309. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  82310. /**
  82311. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  82312. * @param otherVector defines the second operand
  82313. * @param result defines the Vector3 object where to store the result
  82314. * @returns the current Vector3
  82315. */
  82316. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82317. /**
  82318. * Divides the current Vector3 coordinates by the given ones.
  82319. * @param otherVector defines the second operand
  82320. * @returns the current updated Vector3
  82321. */
  82322. divideInPlace(otherVector: Vector3): Vector3;
  82323. /**
  82324. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  82325. * @param other defines the second operand
  82326. * @returns the current updated Vector3
  82327. */
  82328. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  82329. /**
  82330. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  82331. * @param other defines the second operand
  82332. * @returns the current updated Vector3
  82333. */
  82334. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  82335. /**
  82336. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  82337. * @param x defines the x coordinate of the operand
  82338. * @param y defines the y coordinate of the operand
  82339. * @param z defines the z coordinate of the operand
  82340. * @returns the current updated Vector3
  82341. */
  82342. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82343. /**
  82344. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  82345. * @param x defines the x coordinate of the operand
  82346. * @param y defines the y coordinate of the operand
  82347. * @param z defines the z coordinate of the operand
  82348. * @returns the current updated Vector3
  82349. */
  82350. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82351. /**
  82352. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  82353. * Check if is non uniform within a certain amount of decimal places to account for this
  82354. * @param epsilon the amount the values can differ
  82355. * @returns if the the vector is non uniform to a certain number of decimal places
  82356. */
  82357. isNonUniformWithinEpsilon(epsilon: number): boolean;
  82358. /**
  82359. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  82360. */
  82361. get isNonUniform(): boolean;
  82362. /**
  82363. * Gets a new Vector3 from current Vector3 floored values
  82364. * @returns a new Vector3
  82365. */
  82366. floor(): Vector3;
  82367. /**
  82368. * Gets a new Vector3 from current Vector3 floored values
  82369. * @returns a new Vector3
  82370. */
  82371. fract(): Vector3;
  82372. /**
  82373. * Gets the length of the Vector3
  82374. * @returns the length of the Vector3
  82375. */
  82376. length(): number;
  82377. /**
  82378. * Gets the squared length of the Vector3
  82379. * @returns squared length of the Vector3
  82380. */
  82381. lengthSquared(): number;
  82382. /**
  82383. * Normalize the current Vector3.
  82384. * Please note that this is an in place operation.
  82385. * @returns the current updated Vector3
  82386. */
  82387. normalize(): Vector3;
  82388. /**
  82389. * Reorders the x y z properties of the vector in place
  82390. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  82391. * @returns the current updated vector
  82392. */
  82393. reorderInPlace(order: string): this;
  82394. /**
  82395. * Rotates the vector around 0,0,0 by a quaternion
  82396. * @param quaternion the rotation quaternion
  82397. * @param result vector to store the result
  82398. * @returns the resulting vector
  82399. */
  82400. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  82401. /**
  82402. * Rotates a vector around a given point
  82403. * @param quaternion the rotation quaternion
  82404. * @param point the point to rotate around
  82405. * @param result vector to store the result
  82406. * @returns the resulting vector
  82407. */
  82408. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  82409. /**
  82410. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  82411. * The cross product is then orthogonal to both current and "other"
  82412. * @param other defines the right operand
  82413. * @returns the cross product
  82414. */
  82415. cross(other: Vector3): Vector3;
  82416. /**
  82417. * Normalize the current Vector3 with the given input length.
  82418. * Please note that this is an in place operation.
  82419. * @param len the length of the vector
  82420. * @returns the current updated Vector3
  82421. */
  82422. normalizeFromLength(len: number): Vector3;
  82423. /**
  82424. * Normalize the current Vector3 to a new vector
  82425. * @returns the new Vector3
  82426. */
  82427. normalizeToNew(): Vector3;
  82428. /**
  82429. * Normalize the current Vector3 to the reference
  82430. * @param reference define the Vector3 to update
  82431. * @returns the updated Vector3
  82432. */
  82433. normalizeToRef(reference: Vector3): Vector3;
  82434. /**
  82435. * Creates a new Vector3 copied from the current Vector3
  82436. * @returns the new Vector3
  82437. */
  82438. clone(): Vector3;
  82439. /**
  82440. * Copies the given vector coordinates to the current Vector3 ones
  82441. * @param source defines the source Vector3
  82442. * @returns the current updated Vector3
  82443. */
  82444. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  82445. /**
  82446. * Copies the given floats to the current Vector3 coordinates
  82447. * @param x defines the x coordinate of the operand
  82448. * @param y defines the y coordinate of the operand
  82449. * @param z defines the z coordinate of the operand
  82450. * @returns the current updated Vector3
  82451. */
  82452. copyFromFloats(x: number, y: number, z: number): Vector3;
  82453. /**
  82454. * Copies the given floats to the current Vector3 coordinates
  82455. * @param x defines the x coordinate of the operand
  82456. * @param y defines the y coordinate of the operand
  82457. * @param z defines the z coordinate of the operand
  82458. * @returns the current updated Vector3
  82459. */
  82460. set(x: number, y: number, z: number): Vector3;
  82461. /**
  82462. * Copies the given float to the current Vector3 coordinates
  82463. * @param v defines the x, y and z coordinates of the operand
  82464. * @returns the current updated Vector3
  82465. */
  82466. setAll(v: number): Vector3;
  82467. /**
  82468. * Get the clip factor between two vectors
  82469. * @param vector0 defines the first operand
  82470. * @param vector1 defines the second operand
  82471. * @param axis defines the axis to use
  82472. * @param size defines the size along the axis
  82473. * @returns the clip factor
  82474. */
  82475. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  82476. /**
  82477. * Get angle between two vectors
  82478. * @param vector0 angle between vector0 and vector1
  82479. * @param vector1 angle between vector0 and vector1
  82480. * @param normal direction of the normal
  82481. * @return the angle between vector0 and vector1
  82482. */
  82483. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  82484. /**
  82485. * Returns a new Vector3 set from the index "offset" of the given array
  82486. * @param array defines the source array
  82487. * @param offset defines the offset in the source array
  82488. * @returns the new Vector3
  82489. */
  82490. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  82491. /**
  82492. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  82493. * @param array defines the source array
  82494. * @param offset defines the offset in the source array
  82495. * @returns the new Vector3
  82496. * @deprecated Please use FromArray instead.
  82497. */
  82498. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  82499. /**
  82500. * Sets the given vector "result" with the element values from the index "offset" of the given array
  82501. * @param array defines the source array
  82502. * @param offset defines the offset in the source array
  82503. * @param result defines the Vector3 where to store the result
  82504. */
  82505. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  82506. /**
  82507. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  82508. * @param array defines the source array
  82509. * @param offset defines the offset in the source array
  82510. * @param result defines the Vector3 where to store the result
  82511. * @deprecated Please use FromArrayToRef instead.
  82512. */
  82513. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  82514. /**
  82515. * Sets the given vector "result" with the given floats.
  82516. * @param x defines the x coordinate of the source
  82517. * @param y defines the y coordinate of the source
  82518. * @param z defines the z coordinate of the source
  82519. * @param result defines the Vector3 where to store the result
  82520. */
  82521. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  82522. /**
  82523. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  82524. * @returns a new empty Vector3
  82525. */
  82526. static Zero(): Vector3;
  82527. /**
  82528. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  82529. * @returns a new unit Vector3
  82530. */
  82531. static One(): Vector3;
  82532. /**
  82533. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  82534. * @returns a new up Vector3
  82535. */
  82536. static Up(): Vector3;
  82537. /**
  82538. * Gets a up Vector3 that must not be updated
  82539. */
  82540. static get UpReadOnly(): DeepImmutable<Vector3>;
  82541. /**
  82542. * Gets a zero Vector3 that must not be updated
  82543. */
  82544. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  82545. /**
  82546. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  82547. * @returns a new down Vector3
  82548. */
  82549. static Down(): Vector3;
  82550. /**
  82551. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  82552. * @param rightHandedSystem is the scene right-handed (negative z)
  82553. * @returns a new forward Vector3
  82554. */
  82555. static Forward(rightHandedSystem?: boolean): Vector3;
  82556. /**
  82557. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  82558. * @param rightHandedSystem is the scene right-handed (negative-z)
  82559. * @returns a new forward Vector3
  82560. */
  82561. static Backward(rightHandedSystem?: boolean): Vector3;
  82562. /**
  82563. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  82564. * @returns a new right Vector3
  82565. */
  82566. static Right(): Vector3;
  82567. /**
  82568. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  82569. * @returns a new left Vector3
  82570. */
  82571. static Left(): Vector3;
  82572. /**
  82573. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  82574. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  82575. * @param vector defines the Vector3 to transform
  82576. * @param transformation defines the transformation matrix
  82577. * @returns the transformed Vector3
  82578. */
  82579. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  82580. /**
  82581. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  82582. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  82583. * @param vector defines the Vector3 to transform
  82584. * @param transformation defines the transformation matrix
  82585. * @param result defines the Vector3 where to store the result
  82586. */
  82587. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82588. /**
  82589. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  82590. * This method computes tranformed coordinates only, not transformed direction vectors
  82591. * @param x define the x coordinate of the source vector
  82592. * @param y define the y coordinate of the source vector
  82593. * @param z define the z coordinate of the source vector
  82594. * @param transformation defines the transformation matrix
  82595. * @param result defines the Vector3 where to store the result
  82596. */
  82597. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82598. /**
  82599. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  82600. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82601. * @param vector defines the Vector3 to transform
  82602. * @param transformation defines the transformation matrix
  82603. * @returns the new Vector3
  82604. */
  82605. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  82606. /**
  82607. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  82608. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82609. * @param vector defines the Vector3 to transform
  82610. * @param transformation defines the transformation matrix
  82611. * @param result defines the Vector3 where to store the result
  82612. */
  82613. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82614. /**
  82615. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  82616. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82617. * @param x define the x coordinate of the source vector
  82618. * @param y define the y coordinate of the source vector
  82619. * @param z define the z coordinate of the source vector
  82620. * @param transformation defines the transformation matrix
  82621. * @param result defines the Vector3 where to store the result
  82622. */
  82623. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82624. /**
  82625. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  82626. * @param value1 defines the first control point
  82627. * @param value2 defines the second control point
  82628. * @param value3 defines the third control point
  82629. * @param value4 defines the fourth control point
  82630. * @param amount defines the amount on the spline to use
  82631. * @returns the new Vector3
  82632. */
  82633. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  82634. /**
  82635. * 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"
  82636. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  82637. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  82638. * @param value defines the current value
  82639. * @param min defines the lower range value
  82640. * @param max defines the upper range value
  82641. * @returns the new Vector3
  82642. */
  82643. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  82644. /**
  82645. * 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"
  82646. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  82647. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  82648. * @param value defines the current value
  82649. * @param min defines the lower range value
  82650. * @param max defines the upper range value
  82651. * @param result defines the Vector3 where to store the result
  82652. */
  82653. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  82654. /**
  82655. * Checks if a given vector is inside a specific range
  82656. * @param v defines the vector to test
  82657. * @param min defines the minimum range
  82658. * @param max defines the maximum range
  82659. */
  82660. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  82661. /**
  82662. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  82663. * @param value1 defines the first control point
  82664. * @param tangent1 defines the first tangent vector
  82665. * @param value2 defines the second control point
  82666. * @param tangent2 defines the second tangent vector
  82667. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  82668. * @returns the new Vector3
  82669. */
  82670. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  82671. /**
  82672. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  82673. * @param start defines the start value
  82674. * @param end defines the end value
  82675. * @param amount max defines amount between both (between 0 and 1)
  82676. * @returns the new Vector3
  82677. */
  82678. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  82679. /**
  82680. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  82681. * @param start defines the start value
  82682. * @param end defines the end value
  82683. * @param amount max defines amount between both (between 0 and 1)
  82684. * @param result defines the Vector3 where to store the result
  82685. */
  82686. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  82687. /**
  82688. * Returns the dot product (float) between the vectors "left" and "right"
  82689. * @param left defines the left operand
  82690. * @param right defines the right operand
  82691. * @returns the dot product
  82692. */
  82693. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  82694. /**
  82695. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  82696. * The cross product is then orthogonal to both "left" and "right"
  82697. * @param left defines the left operand
  82698. * @param right defines the right operand
  82699. * @returns the cross product
  82700. */
  82701. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82702. /**
  82703. * Sets the given vector "result" with the cross product of "left" and "right"
  82704. * The cross product is then orthogonal to both "left" and "right"
  82705. * @param left defines the left operand
  82706. * @param right defines the right operand
  82707. * @param result defines the Vector3 where to store the result
  82708. */
  82709. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  82710. /**
  82711. * Returns a new Vector3 as the normalization of the given vector
  82712. * @param vector defines the Vector3 to normalize
  82713. * @returns the new Vector3
  82714. */
  82715. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  82716. /**
  82717. * Sets the given vector "result" with the normalization of the given first vector
  82718. * @param vector defines the Vector3 to normalize
  82719. * @param result defines the Vector3 where to store the result
  82720. */
  82721. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  82722. /**
  82723. * Project a Vector3 onto screen space
  82724. * @param vector defines the Vector3 to project
  82725. * @param world defines the world matrix to use
  82726. * @param transform defines the transform (view x projection) matrix to use
  82727. * @param viewport defines the screen viewport to use
  82728. * @returns the new Vector3
  82729. */
  82730. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  82731. /** @hidden */
  82732. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  82733. /**
  82734. * Unproject from screen space to object space
  82735. * @param source defines the screen space Vector3 to use
  82736. * @param viewportWidth defines the current width of the viewport
  82737. * @param viewportHeight defines the current height of the viewport
  82738. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82739. * @param transform defines the transform (view x projection) matrix to use
  82740. * @returns the new Vector3
  82741. */
  82742. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  82743. /**
  82744. * Unproject from screen space to object space
  82745. * @param source defines the screen space Vector3 to use
  82746. * @param viewportWidth defines the current width of the viewport
  82747. * @param viewportHeight defines the current height of the viewport
  82748. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82749. * @param view defines the view matrix to use
  82750. * @param projection defines the projection matrix to use
  82751. * @returns the new Vector3
  82752. */
  82753. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  82754. /**
  82755. * Unproject from screen space to object space
  82756. * @param source defines the screen space Vector3 to use
  82757. * @param viewportWidth defines the current width of the viewport
  82758. * @param viewportHeight defines the current height of the viewport
  82759. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82760. * @param view defines the view matrix to use
  82761. * @param projection defines the projection matrix to use
  82762. * @param result defines the Vector3 where to store the result
  82763. */
  82764. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  82765. /**
  82766. * Unproject from screen space to object space
  82767. * @param sourceX defines the screen space x coordinate to use
  82768. * @param sourceY defines the screen space y coordinate to use
  82769. * @param sourceZ defines the screen space z coordinate to use
  82770. * @param viewportWidth defines the current width of the viewport
  82771. * @param viewportHeight defines the current height of the viewport
  82772. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82773. * @param view defines the view matrix to use
  82774. * @param projection defines the projection matrix to use
  82775. * @param result defines the Vector3 where to store the result
  82776. */
  82777. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  82778. /**
  82779. * Gets the minimal coordinate values between two Vector3
  82780. * @param left defines the first operand
  82781. * @param right defines the second operand
  82782. * @returns the new Vector3
  82783. */
  82784. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82785. /**
  82786. * Gets the maximal coordinate values between two Vector3
  82787. * @param left defines the first operand
  82788. * @param right defines the second operand
  82789. * @returns the new Vector3
  82790. */
  82791. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82792. /**
  82793. * Returns the distance between the vectors "value1" and "value2"
  82794. * @param value1 defines the first operand
  82795. * @param value2 defines the second operand
  82796. * @returns the distance
  82797. */
  82798. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  82799. /**
  82800. * Returns the squared distance between the vectors "value1" and "value2"
  82801. * @param value1 defines the first operand
  82802. * @param value2 defines the second operand
  82803. * @returns the squared distance
  82804. */
  82805. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  82806. /**
  82807. * Returns a new Vector3 located at the center between "value1" and "value2"
  82808. * @param value1 defines the first operand
  82809. * @param value2 defines the second operand
  82810. * @returns the new Vector3
  82811. */
  82812. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  82813. /**
  82814. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  82815. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  82816. * to something in order to rotate it from its local system to the given target system
  82817. * Note: axis1, axis2 and axis3 are normalized during this operation
  82818. * @param axis1 defines the first axis
  82819. * @param axis2 defines the second axis
  82820. * @param axis3 defines the third axis
  82821. * @returns a new Vector3
  82822. */
  82823. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  82824. /**
  82825. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  82826. * @param axis1 defines the first axis
  82827. * @param axis2 defines the second axis
  82828. * @param axis3 defines the third axis
  82829. * @param ref defines the Vector3 where to store the result
  82830. */
  82831. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  82832. }
  82833. /**
  82834. * Vector4 class created for EulerAngle class conversion to Quaternion
  82835. */
  82836. export class Vector4 {
  82837. /** x value of the vector */
  82838. x: number;
  82839. /** y value of the vector */
  82840. y: number;
  82841. /** z value of the vector */
  82842. z: number;
  82843. /** w value of the vector */
  82844. w: number;
  82845. /**
  82846. * Creates a Vector4 object from the given floats.
  82847. * @param x x value of the vector
  82848. * @param y y value of the vector
  82849. * @param z z value of the vector
  82850. * @param w w value of the vector
  82851. */
  82852. constructor(
  82853. /** x value of the vector */
  82854. x: number,
  82855. /** y value of the vector */
  82856. y: number,
  82857. /** z value of the vector */
  82858. z: number,
  82859. /** w value of the vector */
  82860. w: number);
  82861. /**
  82862. * Returns the string with the Vector4 coordinates.
  82863. * @returns a string containing all the vector values
  82864. */
  82865. toString(): string;
  82866. /**
  82867. * Returns the string "Vector4".
  82868. * @returns "Vector4"
  82869. */
  82870. getClassName(): string;
  82871. /**
  82872. * Returns the Vector4 hash code.
  82873. * @returns a unique hash code
  82874. */
  82875. getHashCode(): number;
  82876. /**
  82877. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  82878. * @returns the resulting array
  82879. */
  82880. asArray(): number[];
  82881. /**
  82882. * Populates the given array from the given index with the Vector4 coordinates.
  82883. * @param array array to populate
  82884. * @param index index of the array to start at (default: 0)
  82885. * @returns the Vector4.
  82886. */
  82887. toArray(array: FloatArray, index?: number): Vector4;
  82888. /**
  82889. * Update the current vector from an array
  82890. * @param array defines the destination array
  82891. * @param index defines the offset in the destination array
  82892. * @returns the current Vector3
  82893. */
  82894. fromArray(array: FloatArray, index?: number): Vector4;
  82895. /**
  82896. * Adds the given vector to the current Vector4.
  82897. * @param otherVector the vector to add
  82898. * @returns the updated Vector4.
  82899. */
  82900. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  82901. /**
  82902. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  82903. * @param otherVector the vector to add
  82904. * @returns the resulting vector
  82905. */
  82906. add(otherVector: DeepImmutable<Vector4>): Vector4;
  82907. /**
  82908. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  82909. * @param otherVector the vector to add
  82910. * @param result the vector to store the result
  82911. * @returns the current Vector4.
  82912. */
  82913. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  82914. /**
  82915. * Subtract in place the given vector from the current Vector4.
  82916. * @param otherVector the vector to subtract
  82917. * @returns the updated Vector4.
  82918. */
  82919. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  82920. /**
  82921. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  82922. * @param otherVector the vector to add
  82923. * @returns the new vector with the result
  82924. */
  82925. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  82926. /**
  82927. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  82928. * @param otherVector the vector to subtract
  82929. * @param result the vector to store the result
  82930. * @returns the current Vector4.
  82931. */
  82932. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  82933. /**
  82934. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  82935. */
  82936. /**
  82937. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  82938. * @param x value to subtract
  82939. * @param y value to subtract
  82940. * @param z value to subtract
  82941. * @param w value to subtract
  82942. * @returns new vector containing the result
  82943. */
  82944. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  82945. /**
  82946. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  82947. * @param x value to subtract
  82948. * @param y value to subtract
  82949. * @param z value to subtract
  82950. * @param w value to subtract
  82951. * @param result the vector to store the result in
  82952. * @returns the current Vector4.
  82953. */
  82954. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  82955. /**
  82956. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  82957. * @returns a new vector with the negated values
  82958. */
  82959. negate(): Vector4;
  82960. /**
  82961. * Negate this vector in place
  82962. * @returns this
  82963. */
  82964. negateInPlace(): Vector4;
  82965. /**
  82966. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  82967. * @param result defines the Vector3 object where to store the result
  82968. * @returns the current Vector4
  82969. */
  82970. negateToRef(result: Vector4): Vector4;
  82971. /**
  82972. * Multiplies the current Vector4 coordinates by scale (float).
  82973. * @param scale the number to scale with
  82974. * @returns the updated Vector4.
  82975. */
  82976. scaleInPlace(scale: number): Vector4;
  82977. /**
  82978. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  82979. * @param scale the number to scale with
  82980. * @returns a new vector with the result
  82981. */
  82982. scale(scale: number): Vector4;
  82983. /**
  82984. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  82985. * @param scale the number to scale with
  82986. * @param result a vector to store the result in
  82987. * @returns the current Vector4.
  82988. */
  82989. scaleToRef(scale: number, result: Vector4): Vector4;
  82990. /**
  82991. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  82992. * @param scale defines the scale factor
  82993. * @param result defines the Vector4 object where to store the result
  82994. * @returns the unmodified current Vector4
  82995. */
  82996. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  82997. /**
  82998. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  82999. * @param otherVector the vector to compare against
  83000. * @returns true if they are equal
  83001. */
  83002. equals(otherVector: DeepImmutable<Vector4>): boolean;
  83003. /**
  83004. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  83005. * @param otherVector vector to compare against
  83006. * @param epsilon (Default: very small number)
  83007. * @returns true if they are equal
  83008. */
  83009. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  83010. /**
  83011. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  83012. * @param x x value to compare against
  83013. * @param y y value to compare against
  83014. * @param z z value to compare against
  83015. * @param w w value to compare against
  83016. * @returns true if equal
  83017. */
  83018. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  83019. /**
  83020. * Multiplies in place the current Vector4 by the given one.
  83021. * @param otherVector vector to multiple with
  83022. * @returns the updated Vector4.
  83023. */
  83024. multiplyInPlace(otherVector: Vector4): Vector4;
  83025. /**
  83026. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  83027. * @param otherVector vector to multiple with
  83028. * @returns resulting new vector
  83029. */
  83030. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  83031. /**
  83032. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  83033. * @param otherVector vector to multiple with
  83034. * @param result vector to store the result
  83035. * @returns the current Vector4.
  83036. */
  83037. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83038. /**
  83039. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  83040. * @param x x value multiply with
  83041. * @param y y value multiply with
  83042. * @param z z value multiply with
  83043. * @param w w value multiply with
  83044. * @returns resulting new vector
  83045. */
  83046. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  83047. /**
  83048. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  83049. * @param otherVector vector to devide with
  83050. * @returns resulting new vector
  83051. */
  83052. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  83053. /**
  83054. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  83055. * @param otherVector vector to devide with
  83056. * @param result vector to store the result
  83057. * @returns the current Vector4.
  83058. */
  83059. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83060. /**
  83061. * Divides the current Vector3 coordinates by the given ones.
  83062. * @param otherVector vector to devide with
  83063. * @returns the updated Vector3.
  83064. */
  83065. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  83066. /**
  83067. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  83068. * @param other defines the second operand
  83069. * @returns the current updated Vector4
  83070. */
  83071. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  83072. /**
  83073. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  83074. * @param other defines the second operand
  83075. * @returns the current updated Vector4
  83076. */
  83077. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  83078. /**
  83079. * Gets a new Vector4 from current Vector4 floored values
  83080. * @returns a new Vector4
  83081. */
  83082. floor(): Vector4;
  83083. /**
  83084. * Gets a new Vector4 from current Vector3 floored values
  83085. * @returns a new Vector4
  83086. */
  83087. fract(): Vector4;
  83088. /**
  83089. * Returns the Vector4 length (float).
  83090. * @returns the length
  83091. */
  83092. length(): number;
  83093. /**
  83094. * Returns the Vector4 squared length (float).
  83095. * @returns the length squared
  83096. */
  83097. lengthSquared(): number;
  83098. /**
  83099. * Normalizes in place the Vector4.
  83100. * @returns the updated Vector4.
  83101. */
  83102. normalize(): Vector4;
  83103. /**
  83104. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  83105. * @returns this converted to a new vector3
  83106. */
  83107. toVector3(): Vector3;
  83108. /**
  83109. * Returns a new Vector4 copied from the current one.
  83110. * @returns the new cloned vector
  83111. */
  83112. clone(): Vector4;
  83113. /**
  83114. * Updates the current Vector4 with the given one coordinates.
  83115. * @param source the source vector to copy from
  83116. * @returns the updated Vector4.
  83117. */
  83118. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  83119. /**
  83120. * Updates the current Vector4 coordinates with the given floats.
  83121. * @param x float to copy from
  83122. * @param y float to copy from
  83123. * @param z float to copy from
  83124. * @param w float to copy from
  83125. * @returns the updated Vector4.
  83126. */
  83127. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  83128. /**
  83129. * Updates the current Vector4 coordinates with the given floats.
  83130. * @param x float to set from
  83131. * @param y float to set from
  83132. * @param z float to set from
  83133. * @param w float to set from
  83134. * @returns the updated Vector4.
  83135. */
  83136. set(x: number, y: number, z: number, w: number): Vector4;
  83137. /**
  83138. * Copies the given float to the current Vector3 coordinates
  83139. * @param v defines the x, y, z and w coordinates of the operand
  83140. * @returns the current updated Vector3
  83141. */
  83142. setAll(v: number): Vector4;
  83143. /**
  83144. * Returns a new Vector4 set from the starting index of the given array.
  83145. * @param array the array to pull values from
  83146. * @param offset the offset into the array to start at
  83147. * @returns the new vector
  83148. */
  83149. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  83150. /**
  83151. * Updates the given vector "result" from the starting index of the given array.
  83152. * @param array the array to pull values from
  83153. * @param offset the offset into the array to start at
  83154. * @param result the vector to store the result in
  83155. */
  83156. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  83157. /**
  83158. * Updates the given vector "result" from the starting index of the given Float32Array.
  83159. * @param array the array to pull values from
  83160. * @param offset the offset into the array to start at
  83161. * @param result the vector to store the result in
  83162. */
  83163. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  83164. /**
  83165. * Updates the given vector "result" coordinates from the given floats.
  83166. * @param x float to set from
  83167. * @param y float to set from
  83168. * @param z float to set from
  83169. * @param w float to set from
  83170. * @param result the vector to the floats in
  83171. */
  83172. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  83173. /**
  83174. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  83175. * @returns the new vector
  83176. */
  83177. static Zero(): Vector4;
  83178. /**
  83179. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  83180. * @returns the new vector
  83181. */
  83182. static One(): Vector4;
  83183. /**
  83184. * Returns a new normalized Vector4 from the given one.
  83185. * @param vector the vector to normalize
  83186. * @returns the vector
  83187. */
  83188. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  83189. /**
  83190. * Updates the given vector "result" from the normalization of the given one.
  83191. * @param vector the vector to normalize
  83192. * @param result the vector to store the result in
  83193. */
  83194. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  83195. /**
  83196. * Returns a vector with the minimum values from the left and right vectors
  83197. * @param left left vector to minimize
  83198. * @param right right vector to minimize
  83199. * @returns a new vector with the minimum of the left and right vector values
  83200. */
  83201. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  83202. /**
  83203. * Returns a vector with the maximum values from the left and right vectors
  83204. * @param left left vector to maximize
  83205. * @param right right vector to maximize
  83206. * @returns a new vector with the maximum of the left and right vector values
  83207. */
  83208. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  83209. /**
  83210. * Returns the distance (float) between the vectors "value1" and "value2".
  83211. * @param value1 value to calulate the distance between
  83212. * @param value2 value to calulate the distance between
  83213. * @return the distance between the two vectors
  83214. */
  83215. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  83216. /**
  83217. * Returns the squared distance (float) between the vectors "value1" and "value2".
  83218. * @param value1 value to calulate the distance between
  83219. * @param value2 value to calulate the distance between
  83220. * @return the distance between the two vectors squared
  83221. */
  83222. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  83223. /**
  83224. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  83225. * @param value1 value to calulate the center between
  83226. * @param value2 value to calulate the center between
  83227. * @return the center between the two vectors
  83228. */
  83229. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  83230. /**
  83231. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  83232. * This methods computes transformed normalized direction vectors only.
  83233. * @param vector the vector to transform
  83234. * @param transformation the transformation matrix to apply
  83235. * @returns the new vector
  83236. */
  83237. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  83238. /**
  83239. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  83240. * This methods computes transformed normalized direction vectors only.
  83241. * @param vector the vector to transform
  83242. * @param transformation the transformation matrix to apply
  83243. * @param result the vector to store the result in
  83244. */
  83245. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  83246. /**
  83247. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  83248. * This methods computes transformed normalized direction vectors only.
  83249. * @param x value to transform
  83250. * @param y value to transform
  83251. * @param z value to transform
  83252. * @param w value to transform
  83253. * @param transformation the transformation matrix to apply
  83254. * @param result the vector to store the results in
  83255. */
  83256. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  83257. /**
  83258. * Creates a new Vector4 from a Vector3
  83259. * @param source defines the source data
  83260. * @param w defines the 4th component (default is 0)
  83261. * @returns a new Vector4
  83262. */
  83263. static FromVector3(source: Vector3, w?: number): Vector4;
  83264. }
  83265. /**
  83266. * Class used to store quaternion data
  83267. * @see https://en.wikipedia.org/wiki/Quaternion
  83268. * @see https://doc.babylonjs.com/features/position,_rotation,_scaling
  83269. */
  83270. export class Quaternion {
  83271. /** @hidden */
  83272. _x: number;
  83273. /** @hidden */
  83274. _y: number;
  83275. /** @hidden */
  83276. _z: number;
  83277. /** @hidden */
  83278. _w: number;
  83279. /** @hidden */
  83280. _isDirty: boolean;
  83281. /** Gets or sets the x coordinate */
  83282. get x(): number;
  83283. set x(value: number);
  83284. /** Gets or sets the y coordinate */
  83285. get y(): number;
  83286. set y(value: number);
  83287. /** Gets or sets the z coordinate */
  83288. get z(): number;
  83289. set z(value: number);
  83290. /** Gets or sets the w coordinate */
  83291. get w(): number;
  83292. set w(value: number);
  83293. /**
  83294. * Creates a new Quaternion from the given floats
  83295. * @param x defines the first component (0 by default)
  83296. * @param y defines the second component (0 by default)
  83297. * @param z defines the third component (0 by default)
  83298. * @param w defines the fourth component (1.0 by default)
  83299. */
  83300. constructor(x?: number, y?: number, z?: number, w?: number);
  83301. /**
  83302. * Gets a string representation for the current quaternion
  83303. * @returns a string with the Quaternion coordinates
  83304. */
  83305. toString(): string;
  83306. /**
  83307. * Gets the class name of the quaternion
  83308. * @returns the string "Quaternion"
  83309. */
  83310. getClassName(): string;
  83311. /**
  83312. * Gets a hash code for this quaternion
  83313. * @returns the quaternion hash code
  83314. */
  83315. getHashCode(): number;
  83316. /**
  83317. * Copy the quaternion to an array
  83318. * @returns a new array populated with 4 elements from the quaternion coordinates
  83319. */
  83320. asArray(): number[];
  83321. /**
  83322. * Check if two quaternions are equals
  83323. * @param otherQuaternion defines the second operand
  83324. * @return true if the current quaternion and the given one coordinates are strictly equals
  83325. */
  83326. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  83327. /**
  83328. * Gets a boolean if two quaternions are equals (using an epsilon value)
  83329. * @param otherQuaternion defines the other quaternion
  83330. * @param epsilon defines the minimal distance to consider equality
  83331. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  83332. */
  83333. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  83334. /**
  83335. * Clone the current quaternion
  83336. * @returns a new quaternion copied from the current one
  83337. */
  83338. clone(): Quaternion;
  83339. /**
  83340. * Copy a quaternion to the current one
  83341. * @param other defines the other quaternion
  83342. * @returns the updated current quaternion
  83343. */
  83344. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  83345. /**
  83346. * Updates the current quaternion with the given float coordinates
  83347. * @param x defines the x coordinate
  83348. * @param y defines the y coordinate
  83349. * @param z defines the z coordinate
  83350. * @param w defines the w coordinate
  83351. * @returns the updated current quaternion
  83352. */
  83353. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  83354. /**
  83355. * Updates the current quaternion from the given float coordinates
  83356. * @param x defines the x coordinate
  83357. * @param y defines the y coordinate
  83358. * @param z defines the z coordinate
  83359. * @param w defines the w coordinate
  83360. * @returns the updated current quaternion
  83361. */
  83362. set(x: number, y: number, z: number, w: number): Quaternion;
  83363. /**
  83364. * Adds two quaternions
  83365. * @param other defines the second operand
  83366. * @returns a new quaternion as the addition result of the given one and the current quaternion
  83367. */
  83368. add(other: DeepImmutable<Quaternion>): Quaternion;
  83369. /**
  83370. * Add a quaternion to the current one
  83371. * @param other defines the quaternion to add
  83372. * @returns the current quaternion
  83373. */
  83374. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  83375. /**
  83376. * Subtract two quaternions
  83377. * @param other defines the second operand
  83378. * @returns a new quaternion as the subtraction result of the given one from the current one
  83379. */
  83380. subtract(other: Quaternion): Quaternion;
  83381. /**
  83382. * Multiplies the current quaternion by a scale factor
  83383. * @param value defines the scale factor
  83384. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  83385. */
  83386. scale(value: number): Quaternion;
  83387. /**
  83388. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  83389. * @param scale defines the scale factor
  83390. * @param result defines the Quaternion object where to store the result
  83391. * @returns the unmodified current quaternion
  83392. */
  83393. scaleToRef(scale: number, result: Quaternion): Quaternion;
  83394. /**
  83395. * Multiplies in place the current quaternion by a scale factor
  83396. * @param value defines the scale factor
  83397. * @returns the current modified quaternion
  83398. */
  83399. scaleInPlace(value: number): Quaternion;
  83400. /**
  83401. * Scale the current quaternion values by a factor and add the result to a given quaternion
  83402. * @param scale defines the scale factor
  83403. * @param result defines the Quaternion object where to store the result
  83404. * @returns the unmodified current quaternion
  83405. */
  83406. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  83407. /**
  83408. * Multiplies two quaternions
  83409. * @param q1 defines the second operand
  83410. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  83411. */
  83412. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  83413. /**
  83414. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  83415. * @param q1 defines the second operand
  83416. * @param result defines the target quaternion
  83417. * @returns the current quaternion
  83418. */
  83419. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  83420. /**
  83421. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  83422. * @param q1 defines the second operand
  83423. * @returns the currentupdated quaternion
  83424. */
  83425. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  83426. /**
  83427. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  83428. * @param ref defines the target quaternion
  83429. * @returns the current quaternion
  83430. */
  83431. conjugateToRef(ref: Quaternion): Quaternion;
  83432. /**
  83433. * Conjugates in place (1-q) the current quaternion
  83434. * @returns the current updated quaternion
  83435. */
  83436. conjugateInPlace(): Quaternion;
  83437. /**
  83438. * Conjugates in place (1-q) the current quaternion
  83439. * @returns a new quaternion
  83440. */
  83441. conjugate(): Quaternion;
  83442. /**
  83443. * Gets length of current quaternion
  83444. * @returns the quaternion length (float)
  83445. */
  83446. length(): number;
  83447. /**
  83448. * Normalize in place the current quaternion
  83449. * @returns the current updated quaternion
  83450. */
  83451. normalize(): Quaternion;
  83452. /**
  83453. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  83454. * @param order is a reserved parameter and is ignore for now
  83455. * @returns a new Vector3 containing the Euler angles
  83456. */
  83457. toEulerAngles(order?: string): Vector3;
  83458. /**
  83459. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  83460. * @param result defines the vector which will be filled with the Euler angles
  83461. * @param order is a reserved parameter and is ignore for now
  83462. * @returns the current unchanged quaternion
  83463. */
  83464. toEulerAnglesToRef(result: Vector3): Quaternion;
  83465. /**
  83466. * Updates the given rotation matrix with the current quaternion values
  83467. * @param result defines the target matrix
  83468. * @returns the current unchanged quaternion
  83469. */
  83470. toRotationMatrix(result: Matrix): Quaternion;
  83471. /**
  83472. * Updates the current quaternion from the given rotation matrix values
  83473. * @param matrix defines the source matrix
  83474. * @returns the current updated quaternion
  83475. */
  83476. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  83477. /**
  83478. * Creates a new quaternion from a rotation matrix
  83479. * @param matrix defines the source matrix
  83480. * @returns a new quaternion created from the given rotation matrix values
  83481. */
  83482. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  83483. /**
  83484. * Updates the given quaternion with the given rotation matrix values
  83485. * @param matrix defines the source matrix
  83486. * @param result defines the target quaternion
  83487. */
  83488. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  83489. /**
  83490. * Returns the dot product (float) between the quaternions "left" and "right"
  83491. * @param left defines the left operand
  83492. * @param right defines the right operand
  83493. * @returns the dot product
  83494. */
  83495. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  83496. /**
  83497. * Checks if the two quaternions are close to each other
  83498. * @param quat0 defines the first quaternion to check
  83499. * @param quat1 defines the second quaternion to check
  83500. * @returns true if the two quaternions are close to each other
  83501. */
  83502. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  83503. /**
  83504. * Creates an empty quaternion
  83505. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  83506. */
  83507. static Zero(): Quaternion;
  83508. /**
  83509. * Inverse a given quaternion
  83510. * @param q defines the source quaternion
  83511. * @returns a new quaternion as the inverted current quaternion
  83512. */
  83513. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  83514. /**
  83515. * Inverse a given quaternion
  83516. * @param q defines the source quaternion
  83517. * @param result the quaternion the result will be stored in
  83518. * @returns the result quaternion
  83519. */
  83520. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  83521. /**
  83522. * Creates an identity quaternion
  83523. * @returns the identity quaternion
  83524. */
  83525. static Identity(): Quaternion;
  83526. /**
  83527. * Gets a boolean indicating if the given quaternion is identity
  83528. * @param quaternion defines the quaternion to check
  83529. * @returns true if the quaternion is identity
  83530. */
  83531. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  83532. /**
  83533. * Creates a quaternion from a rotation around an axis
  83534. * @param axis defines the axis to use
  83535. * @param angle defines the angle to use
  83536. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  83537. */
  83538. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  83539. /**
  83540. * Creates a rotation around an axis and stores it into the given quaternion
  83541. * @param axis defines the axis to use
  83542. * @param angle defines the angle to use
  83543. * @param result defines the target quaternion
  83544. * @returns the target quaternion
  83545. */
  83546. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  83547. /**
  83548. * Creates a new quaternion from data stored into an array
  83549. * @param array defines the data source
  83550. * @param offset defines the offset in the source array where the data starts
  83551. * @returns a new quaternion
  83552. */
  83553. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  83554. /**
  83555. * Updates the given quaternion "result" from the starting index of the given array.
  83556. * @param array the array to pull values from
  83557. * @param offset the offset into the array to start at
  83558. * @param result the quaternion to store the result in
  83559. */
  83560. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  83561. /**
  83562. * Create a quaternion from Euler rotation angles
  83563. * @param x Pitch
  83564. * @param y Yaw
  83565. * @param z Roll
  83566. * @returns the new Quaternion
  83567. */
  83568. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  83569. /**
  83570. * Updates a quaternion from Euler rotation angles
  83571. * @param x Pitch
  83572. * @param y Yaw
  83573. * @param z Roll
  83574. * @param result the quaternion to store the result
  83575. * @returns the updated quaternion
  83576. */
  83577. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  83578. /**
  83579. * Create a quaternion from Euler rotation vector
  83580. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  83581. * @returns the new Quaternion
  83582. */
  83583. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  83584. /**
  83585. * Updates a quaternion from Euler rotation vector
  83586. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  83587. * @param result the quaternion to store the result
  83588. * @returns the updated quaternion
  83589. */
  83590. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  83591. /**
  83592. * Creates a new quaternion from the given Euler float angles (y, x, z)
  83593. * @param yaw defines the rotation around Y axis
  83594. * @param pitch defines the rotation around X axis
  83595. * @param roll defines the rotation around Z axis
  83596. * @returns the new quaternion
  83597. */
  83598. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  83599. /**
  83600. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  83601. * @param yaw defines the rotation around Y axis
  83602. * @param pitch defines the rotation around X axis
  83603. * @param roll defines the rotation around Z axis
  83604. * @param result defines the target quaternion
  83605. */
  83606. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  83607. /**
  83608. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  83609. * @param alpha defines the rotation around first axis
  83610. * @param beta defines the rotation around second axis
  83611. * @param gamma defines the rotation around third axis
  83612. * @returns the new quaternion
  83613. */
  83614. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  83615. /**
  83616. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  83617. * @param alpha defines the rotation around first axis
  83618. * @param beta defines the rotation around second axis
  83619. * @param gamma defines the rotation around third axis
  83620. * @param result defines the target quaternion
  83621. */
  83622. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  83623. /**
  83624. * 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)
  83625. * @param axis1 defines the first axis
  83626. * @param axis2 defines the second axis
  83627. * @param axis3 defines the third axis
  83628. * @returns the new quaternion
  83629. */
  83630. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  83631. /**
  83632. * 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
  83633. * @param axis1 defines the first axis
  83634. * @param axis2 defines the second axis
  83635. * @param axis3 defines the third axis
  83636. * @param ref defines the target quaternion
  83637. */
  83638. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  83639. /**
  83640. * Interpolates between two quaternions
  83641. * @param left defines first quaternion
  83642. * @param right defines second quaternion
  83643. * @param amount defines the gradient to use
  83644. * @returns the new interpolated quaternion
  83645. */
  83646. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  83647. /**
  83648. * Interpolates between two quaternions and stores it into a target quaternion
  83649. * @param left defines first quaternion
  83650. * @param right defines second quaternion
  83651. * @param amount defines the gradient to use
  83652. * @param result defines the target quaternion
  83653. */
  83654. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  83655. /**
  83656. * Interpolate between two quaternions using Hermite interpolation
  83657. * @param value1 defines first quaternion
  83658. * @param tangent1 defines the incoming tangent
  83659. * @param value2 defines second quaternion
  83660. * @param tangent2 defines the outgoing tangent
  83661. * @param amount defines the target quaternion
  83662. * @returns the new interpolated quaternion
  83663. */
  83664. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  83665. }
  83666. /**
  83667. * Class used to store matrix data (4x4)
  83668. */
  83669. export class Matrix {
  83670. /**
  83671. * Gets the precision of matrix computations
  83672. */
  83673. static get Use64Bits(): boolean;
  83674. private static _updateFlagSeed;
  83675. private static _identityReadOnly;
  83676. private _isIdentity;
  83677. private _isIdentityDirty;
  83678. private _isIdentity3x2;
  83679. private _isIdentity3x2Dirty;
  83680. /**
  83681. * Gets the update flag of the matrix which is an unique number for the matrix.
  83682. * It will be incremented every time the matrix data change.
  83683. * You can use it to speed the comparison between two versions of the same matrix.
  83684. */
  83685. updateFlag: number;
  83686. private readonly _m;
  83687. /**
  83688. * Gets the internal data of the matrix
  83689. */
  83690. get m(): DeepImmutable<Float32Array | Array<number>>;
  83691. /** @hidden */
  83692. _markAsUpdated(): void;
  83693. /** @hidden */
  83694. private _updateIdentityStatus;
  83695. /**
  83696. * Creates an empty matrix (filled with zeros)
  83697. */
  83698. constructor();
  83699. /**
  83700. * Check if the current matrix is identity
  83701. * @returns true is the matrix is the identity matrix
  83702. */
  83703. isIdentity(): boolean;
  83704. /**
  83705. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  83706. * @returns true is the matrix is the identity matrix
  83707. */
  83708. isIdentityAs3x2(): boolean;
  83709. /**
  83710. * Gets the determinant of the matrix
  83711. * @returns the matrix determinant
  83712. */
  83713. determinant(): number;
  83714. /**
  83715. * Returns the matrix as a Float32Array or Array<number>
  83716. * @returns the matrix underlying array
  83717. */
  83718. toArray(): DeepImmutable<Float32Array | Array<number>>;
  83719. /**
  83720. * Returns the matrix as a Float32Array or Array<number>
  83721. * @returns the matrix underlying array.
  83722. */
  83723. asArray(): DeepImmutable<Float32Array | Array<number>>;
  83724. /**
  83725. * Inverts the current matrix in place
  83726. * @returns the current inverted matrix
  83727. */
  83728. invert(): Matrix;
  83729. /**
  83730. * Sets all the matrix elements to zero
  83731. * @returns the current matrix
  83732. */
  83733. reset(): Matrix;
  83734. /**
  83735. * Adds the current matrix with a second one
  83736. * @param other defines the matrix to add
  83737. * @returns a new matrix as the addition of the current matrix and the given one
  83738. */
  83739. add(other: DeepImmutable<Matrix>): Matrix;
  83740. /**
  83741. * Sets the given matrix "result" to the addition of the current matrix and the given one
  83742. * @param other defines the matrix to add
  83743. * @param result defines the target matrix
  83744. * @returns the current matrix
  83745. */
  83746. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  83747. /**
  83748. * Adds in place the given matrix to the current matrix
  83749. * @param other defines the second operand
  83750. * @returns the current updated matrix
  83751. */
  83752. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  83753. /**
  83754. * Sets the given matrix to the current inverted Matrix
  83755. * @param other defines the target matrix
  83756. * @returns the unmodified current matrix
  83757. */
  83758. invertToRef(other: Matrix): Matrix;
  83759. /**
  83760. * add a value at the specified position in the current Matrix
  83761. * @param index the index of the value within the matrix. between 0 and 15.
  83762. * @param value the value to be added
  83763. * @returns the current updated matrix
  83764. */
  83765. addAtIndex(index: number, value: number): Matrix;
  83766. /**
  83767. * mutiply the specified position in the current Matrix by a value
  83768. * @param index the index of the value within the matrix. between 0 and 15.
  83769. * @param value the value to be added
  83770. * @returns the current updated matrix
  83771. */
  83772. multiplyAtIndex(index: number, value: number): Matrix;
  83773. /**
  83774. * Inserts the translation vector (using 3 floats) in the current matrix
  83775. * @param x defines the 1st component of the translation
  83776. * @param y defines the 2nd component of the translation
  83777. * @param z defines the 3rd component of the translation
  83778. * @returns the current updated matrix
  83779. */
  83780. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  83781. /**
  83782. * Adds the translation vector (using 3 floats) in the current matrix
  83783. * @param x defines the 1st component of the translation
  83784. * @param y defines the 2nd component of the translation
  83785. * @param z defines the 3rd component of the translation
  83786. * @returns the current updated matrix
  83787. */
  83788. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  83789. /**
  83790. * Inserts the translation vector in the current matrix
  83791. * @param vector3 defines the translation to insert
  83792. * @returns the current updated matrix
  83793. */
  83794. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  83795. /**
  83796. * Gets the translation value of the current matrix
  83797. * @returns a new Vector3 as the extracted translation from the matrix
  83798. */
  83799. getTranslation(): Vector3;
  83800. /**
  83801. * Fill a Vector3 with the extracted translation from the matrix
  83802. * @param result defines the Vector3 where to store the translation
  83803. * @returns the current matrix
  83804. */
  83805. getTranslationToRef(result: Vector3): Matrix;
  83806. /**
  83807. * Remove rotation and scaling part from the matrix
  83808. * @returns the updated matrix
  83809. */
  83810. removeRotationAndScaling(): Matrix;
  83811. /**
  83812. * Multiply two matrices
  83813. * @param other defines the second operand
  83814. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  83815. */
  83816. multiply(other: DeepImmutable<Matrix>): Matrix;
  83817. /**
  83818. * Copy the current matrix from the given one
  83819. * @param other defines the source matrix
  83820. * @returns the current updated matrix
  83821. */
  83822. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  83823. /**
  83824. * Populates the given array from the starting index with the current matrix values
  83825. * @param array defines the target array
  83826. * @param offset defines the offset in the target array where to start storing values
  83827. * @returns the current matrix
  83828. */
  83829. copyToArray(array: Float32Array | Array<number>, offset?: number): Matrix;
  83830. /**
  83831. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  83832. * @param other defines the second operand
  83833. * @param result defines the matrix where to store the multiplication
  83834. * @returns the current matrix
  83835. */
  83836. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  83837. /**
  83838. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  83839. * @param other defines the second operand
  83840. * @param result defines the array where to store the multiplication
  83841. * @param offset defines the offset in the target array where to start storing values
  83842. * @returns the current matrix
  83843. */
  83844. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array | Array<number>, offset: number): Matrix;
  83845. /**
  83846. * Check equality between this matrix and a second one
  83847. * @param value defines the second matrix to compare
  83848. * @returns true is the current matrix and the given one values are strictly equal
  83849. */
  83850. equals(value: DeepImmutable<Matrix>): boolean;
  83851. /**
  83852. * Clone the current matrix
  83853. * @returns a new matrix from the current matrix
  83854. */
  83855. clone(): Matrix;
  83856. /**
  83857. * Returns the name of the current matrix class
  83858. * @returns the string "Matrix"
  83859. */
  83860. getClassName(): string;
  83861. /**
  83862. * Gets the hash code of the current matrix
  83863. * @returns the hash code
  83864. */
  83865. getHashCode(): number;
  83866. /**
  83867. * Decomposes the current Matrix into a translation, rotation and scaling components
  83868. * @param scale defines the scale vector3 given as a reference to update
  83869. * @param rotation defines the rotation quaternion given as a reference to update
  83870. * @param translation defines the translation vector3 given as a reference to update
  83871. * @returns true if operation was successful
  83872. */
  83873. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  83874. /**
  83875. * Gets specific row of the matrix
  83876. * @param index defines the number of the row to get
  83877. * @returns the index-th row of the current matrix as a new Vector4
  83878. */
  83879. getRow(index: number): Nullable<Vector4>;
  83880. /**
  83881. * Sets the index-th row of the current matrix to the vector4 values
  83882. * @param index defines the number of the row to set
  83883. * @param row defines the target vector4
  83884. * @returns the updated current matrix
  83885. */
  83886. setRow(index: number, row: Vector4): Matrix;
  83887. /**
  83888. * Compute the transpose of the matrix
  83889. * @returns the new transposed matrix
  83890. */
  83891. transpose(): Matrix;
  83892. /**
  83893. * Compute the transpose of the matrix and store it in a given matrix
  83894. * @param result defines the target matrix
  83895. * @returns the current matrix
  83896. */
  83897. transposeToRef(result: Matrix): Matrix;
  83898. /**
  83899. * Sets the index-th row of the current matrix with the given 4 x float values
  83900. * @param index defines the row index
  83901. * @param x defines the x component to set
  83902. * @param y defines the y component to set
  83903. * @param z defines the z component to set
  83904. * @param w defines the w component to set
  83905. * @returns the updated current matrix
  83906. */
  83907. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  83908. /**
  83909. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  83910. * @param scale defines the scale factor
  83911. * @returns a new matrix
  83912. */
  83913. scale(scale: number): Matrix;
  83914. /**
  83915. * Scale the current matrix values by a factor to a given result matrix
  83916. * @param scale defines the scale factor
  83917. * @param result defines the matrix to store the result
  83918. * @returns the current matrix
  83919. */
  83920. scaleToRef(scale: number, result: Matrix): Matrix;
  83921. /**
  83922. * Scale the current matrix values by a factor and add the result to a given matrix
  83923. * @param scale defines the scale factor
  83924. * @param result defines the Matrix to store the result
  83925. * @returns the current matrix
  83926. */
  83927. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  83928. /**
  83929. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  83930. * @param ref matrix to store the result
  83931. */
  83932. toNormalMatrix(ref: Matrix): void;
  83933. /**
  83934. * Gets only rotation part of the current matrix
  83935. * @returns a new matrix sets to the extracted rotation matrix from the current one
  83936. */
  83937. getRotationMatrix(): Matrix;
  83938. /**
  83939. * Extracts the rotation matrix from the current one and sets it as the given "result"
  83940. * @param result defines the target matrix to store data to
  83941. * @returns the current matrix
  83942. */
  83943. getRotationMatrixToRef(result: Matrix): Matrix;
  83944. /**
  83945. * Toggles model matrix from being right handed to left handed in place and vice versa
  83946. */
  83947. toggleModelMatrixHandInPlace(): void;
  83948. /**
  83949. * Toggles projection matrix from being right handed to left handed in place and vice versa
  83950. */
  83951. toggleProjectionMatrixHandInPlace(): void;
  83952. /**
  83953. * Creates a matrix from an array
  83954. * @param array defines the source array
  83955. * @param offset defines an offset in the source array
  83956. * @returns a new Matrix set from the starting index of the given array
  83957. */
  83958. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  83959. /**
  83960. * Copy the content of an array into a given matrix
  83961. * @param array defines the source array
  83962. * @param offset defines an offset in the source array
  83963. * @param result defines the target matrix
  83964. */
  83965. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  83966. /**
  83967. * Stores an array into a matrix after having multiplied each component by a given factor
  83968. * @param array defines the source array
  83969. * @param offset defines the offset in the source array
  83970. * @param scale defines the scaling factor
  83971. * @param result defines the target matrix
  83972. */
  83973. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array | Array<number>>, offset: number, scale: number, result: Matrix): void;
  83974. /**
  83975. * Gets an identity matrix that must not be updated
  83976. */
  83977. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  83978. /**
  83979. * Stores a list of values (16) inside a given matrix
  83980. * @param initialM11 defines 1st value of 1st row
  83981. * @param initialM12 defines 2nd value of 1st row
  83982. * @param initialM13 defines 3rd value of 1st row
  83983. * @param initialM14 defines 4th value of 1st row
  83984. * @param initialM21 defines 1st value of 2nd row
  83985. * @param initialM22 defines 2nd value of 2nd row
  83986. * @param initialM23 defines 3rd value of 2nd row
  83987. * @param initialM24 defines 4th value of 2nd row
  83988. * @param initialM31 defines 1st value of 3rd row
  83989. * @param initialM32 defines 2nd value of 3rd row
  83990. * @param initialM33 defines 3rd value of 3rd row
  83991. * @param initialM34 defines 4th value of 3rd row
  83992. * @param initialM41 defines 1st value of 4th row
  83993. * @param initialM42 defines 2nd value of 4th row
  83994. * @param initialM43 defines 3rd value of 4th row
  83995. * @param initialM44 defines 4th value of 4th row
  83996. * @param result defines the target matrix
  83997. */
  83998. 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;
  83999. /**
  84000. * Creates new matrix from a list of values (16)
  84001. * @param initialM11 defines 1st value of 1st row
  84002. * @param initialM12 defines 2nd value of 1st row
  84003. * @param initialM13 defines 3rd value of 1st row
  84004. * @param initialM14 defines 4th value of 1st row
  84005. * @param initialM21 defines 1st value of 2nd row
  84006. * @param initialM22 defines 2nd value of 2nd row
  84007. * @param initialM23 defines 3rd value of 2nd row
  84008. * @param initialM24 defines 4th value of 2nd row
  84009. * @param initialM31 defines 1st value of 3rd row
  84010. * @param initialM32 defines 2nd value of 3rd row
  84011. * @param initialM33 defines 3rd value of 3rd row
  84012. * @param initialM34 defines 4th value of 3rd row
  84013. * @param initialM41 defines 1st value of 4th row
  84014. * @param initialM42 defines 2nd value of 4th row
  84015. * @param initialM43 defines 3rd value of 4th row
  84016. * @param initialM44 defines 4th value of 4th row
  84017. * @returns the new matrix
  84018. */
  84019. 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;
  84020. /**
  84021. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  84022. * @param scale defines the scale vector3
  84023. * @param rotation defines the rotation quaternion
  84024. * @param translation defines the translation vector3
  84025. * @returns a new matrix
  84026. */
  84027. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  84028. /**
  84029. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  84030. * @param scale defines the scale vector3
  84031. * @param rotation defines the rotation quaternion
  84032. * @param translation defines the translation vector3
  84033. * @param result defines the target matrix
  84034. */
  84035. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  84036. /**
  84037. * Creates a new identity matrix
  84038. * @returns a new identity matrix
  84039. */
  84040. static Identity(): Matrix;
  84041. /**
  84042. * Creates a new identity matrix and stores the result in a given matrix
  84043. * @param result defines the target matrix
  84044. */
  84045. static IdentityToRef(result: Matrix): void;
  84046. /**
  84047. * Creates a new zero matrix
  84048. * @returns a new zero matrix
  84049. */
  84050. static Zero(): Matrix;
  84051. /**
  84052. * Creates a new rotation matrix for "angle" radians around the X axis
  84053. * @param angle defines the angle (in radians) to use
  84054. * @return the new matrix
  84055. */
  84056. static RotationX(angle: number): Matrix;
  84057. /**
  84058. * Creates a new matrix as the invert of a given matrix
  84059. * @param source defines the source matrix
  84060. * @returns the new matrix
  84061. */
  84062. static Invert(source: DeepImmutable<Matrix>): Matrix;
  84063. /**
  84064. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  84065. * @param angle defines the angle (in radians) to use
  84066. * @param result defines the target matrix
  84067. */
  84068. static RotationXToRef(angle: number, result: Matrix): void;
  84069. /**
  84070. * Creates a new rotation matrix for "angle" radians around the Y axis
  84071. * @param angle defines the angle (in radians) to use
  84072. * @return the new matrix
  84073. */
  84074. static RotationY(angle: number): Matrix;
  84075. /**
  84076. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  84077. * @param angle defines the angle (in radians) to use
  84078. * @param result defines the target matrix
  84079. */
  84080. static RotationYToRef(angle: number, result: Matrix): void;
  84081. /**
  84082. * Creates a new rotation matrix for "angle" radians around the Z axis
  84083. * @param angle defines the angle (in radians) to use
  84084. * @return the new matrix
  84085. */
  84086. static RotationZ(angle: number): Matrix;
  84087. /**
  84088. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  84089. * @param angle defines the angle (in radians) to use
  84090. * @param result defines the target matrix
  84091. */
  84092. static RotationZToRef(angle: number, result: Matrix): void;
  84093. /**
  84094. * Creates a new rotation matrix for "angle" radians around the given axis
  84095. * @param axis defines the axis to use
  84096. * @param angle defines the angle (in radians) to use
  84097. * @return the new matrix
  84098. */
  84099. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  84100. /**
  84101. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  84102. * @param axis defines the axis to use
  84103. * @param angle defines the angle (in radians) to use
  84104. * @param result defines the target matrix
  84105. */
  84106. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  84107. /**
  84108. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  84109. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  84110. * @param from defines the vector to align
  84111. * @param to defines the vector to align to
  84112. * @param result defines the target matrix
  84113. */
  84114. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  84115. /**
  84116. * Creates a rotation matrix
  84117. * @param yaw defines the yaw angle in radians (Y axis)
  84118. * @param pitch defines the pitch angle in radians (X axis)
  84119. * @param roll defines the roll angle in radians (Z axis)
  84120. * @returns the new rotation matrix
  84121. */
  84122. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  84123. /**
  84124. * Creates a rotation matrix and stores it in a given matrix
  84125. * @param yaw defines the yaw angle in radians (Y axis)
  84126. * @param pitch defines the pitch angle in radians (X axis)
  84127. * @param roll defines the roll angle in radians (Z axis)
  84128. * @param result defines the target matrix
  84129. */
  84130. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  84131. /**
  84132. * Creates a scaling matrix
  84133. * @param x defines the scale factor on X axis
  84134. * @param y defines the scale factor on Y axis
  84135. * @param z defines the scale factor on Z axis
  84136. * @returns the new matrix
  84137. */
  84138. static Scaling(x: number, y: number, z: number): Matrix;
  84139. /**
  84140. * Creates a scaling matrix and stores it in a given matrix
  84141. * @param x defines the scale factor on X axis
  84142. * @param y defines the scale factor on Y axis
  84143. * @param z defines the scale factor on Z axis
  84144. * @param result defines the target matrix
  84145. */
  84146. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  84147. /**
  84148. * Creates a translation matrix
  84149. * @param x defines the translation on X axis
  84150. * @param y defines the translation on Y axis
  84151. * @param z defines the translationon Z axis
  84152. * @returns the new matrix
  84153. */
  84154. static Translation(x: number, y: number, z: number): Matrix;
  84155. /**
  84156. * Creates a translation matrix and stores it in a given matrix
  84157. * @param x defines the translation on X axis
  84158. * @param y defines the translation on Y axis
  84159. * @param z defines the translationon Z axis
  84160. * @param result defines the target matrix
  84161. */
  84162. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  84163. /**
  84164. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  84165. * @param startValue defines the start value
  84166. * @param endValue defines the end value
  84167. * @param gradient defines the gradient factor
  84168. * @returns the new matrix
  84169. */
  84170. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  84171. /**
  84172. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  84173. * @param startValue defines the start value
  84174. * @param endValue defines the end value
  84175. * @param gradient defines the gradient factor
  84176. * @param result defines the Matrix object where to store data
  84177. */
  84178. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  84179. /**
  84180. * Builds a new matrix whose values are computed by:
  84181. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  84182. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  84183. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  84184. * @param startValue defines the first matrix
  84185. * @param endValue defines the second matrix
  84186. * @param gradient defines the gradient between the two matrices
  84187. * @returns the new matrix
  84188. */
  84189. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  84190. /**
  84191. * Update a matrix to values which are computed by:
  84192. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  84193. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  84194. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  84195. * @param startValue defines the first matrix
  84196. * @param endValue defines the second matrix
  84197. * @param gradient defines the gradient between the two matrices
  84198. * @param result defines the target matrix
  84199. */
  84200. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  84201. /**
  84202. * 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"
  84203. * This function works in left handed mode
  84204. * @param eye defines the final position of the entity
  84205. * @param target defines where the entity should look at
  84206. * @param up defines the up vector for the entity
  84207. * @returns the new matrix
  84208. */
  84209. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  84210. /**
  84211. * 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".
  84212. * This function works in left handed mode
  84213. * @param eye defines the final position of the entity
  84214. * @param target defines where the entity should look at
  84215. * @param up defines the up vector for the entity
  84216. * @param result defines the target matrix
  84217. */
  84218. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  84219. /**
  84220. * 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"
  84221. * This function works in right handed mode
  84222. * @param eye defines the final position of the entity
  84223. * @param target defines where the entity should look at
  84224. * @param up defines the up vector for the entity
  84225. * @returns the new matrix
  84226. */
  84227. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  84228. /**
  84229. * 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".
  84230. * This function works in right handed mode
  84231. * @param eye defines the final position of the entity
  84232. * @param target defines where the entity should look at
  84233. * @param up defines the up vector for the entity
  84234. * @param result defines the target matrix
  84235. */
  84236. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  84237. /**
  84238. * Create a left-handed orthographic projection matrix
  84239. * @param width defines the viewport width
  84240. * @param height defines the viewport height
  84241. * @param znear defines the near clip plane
  84242. * @param zfar defines the far clip plane
  84243. * @returns a new matrix as a left-handed orthographic projection matrix
  84244. */
  84245. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  84246. /**
  84247. * Store a left-handed orthographic projection to a given matrix
  84248. * @param width defines the viewport width
  84249. * @param height defines the viewport height
  84250. * @param znear defines the near clip plane
  84251. * @param zfar defines the far clip plane
  84252. * @param result defines the target matrix
  84253. */
  84254. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  84255. /**
  84256. * Create a left-handed orthographic projection matrix
  84257. * @param left defines the viewport left coordinate
  84258. * @param right defines the viewport right coordinate
  84259. * @param bottom defines the viewport bottom coordinate
  84260. * @param top defines the viewport top coordinate
  84261. * @param znear defines the near clip plane
  84262. * @param zfar defines the far clip plane
  84263. * @returns a new matrix as a left-handed orthographic projection matrix
  84264. */
  84265. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  84266. /**
  84267. * Stores a left-handed orthographic projection into a given matrix
  84268. * @param left defines the viewport left coordinate
  84269. * @param right defines the viewport right coordinate
  84270. * @param bottom defines the viewport bottom coordinate
  84271. * @param top defines the viewport top coordinate
  84272. * @param znear defines the near clip plane
  84273. * @param zfar defines the far clip plane
  84274. * @param result defines the target matrix
  84275. */
  84276. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  84277. /**
  84278. * Creates a right-handed orthographic projection matrix
  84279. * @param left defines the viewport left coordinate
  84280. * @param right defines the viewport right coordinate
  84281. * @param bottom defines the viewport bottom coordinate
  84282. * @param top defines the viewport top coordinate
  84283. * @param znear defines the near clip plane
  84284. * @param zfar defines the far clip plane
  84285. * @returns a new matrix as a right-handed orthographic projection matrix
  84286. */
  84287. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  84288. /**
  84289. * Stores a right-handed orthographic projection into a given matrix
  84290. * @param left defines the viewport left coordinate
  84291. * @param right defines the viewport right coordinate
  84292. * @param bottom defines the viewport bottom coordinate
  84293. * @param top defines the viewport top coordinate
  84294. * @param znear defines the near clip plane
  84295. * @param zfar defines the far clip plane
  84296. * @param result defines the target matrix
  84297. */
  84298. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  84299. /**
  84300. * Creates a left-handed perspective projection matrix
  84301. * @param width defines the viewport width
  84302. * @param height defines the viewport height
  84303. * @param znear defines the near clip plane
  84304. * @param zfar defines the far clip plane
  84305. * @returns a new matrix as a left-handed perspective projection matrix
  84306. */
  84307. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  84308. /**
  84309. * Creates a left-handed perspective projection matrix
  84310. * @param fov defines the horizontal field of view
  84311. * @param aspect defines the aspect ratio
  84312. * @param znear defines the near clip plane
  84313. * @param zfar defines the far clip plane
  84314. * @returns a new matrix as a left-handed perspective projection matrix
  84315. */
  84316. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  84317. /**
  84318. * Stores a left-handed perspective projection into a given matrix
  84319. * @param fov defines the horizontal field of view
  84320. * @param aspect defines the aspect ratio
  84321. * @param znear defines the near clip plane
  84322. * @param zfar defines the far clip plane
  84323. * @param result defines the target matrix
  84324. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84325. */
  84326. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84327. /**
  84328. * Stores a left-handed perspective projection into a given matrix with depth reversed
  84329. * @param fov defines the horizontal field of view
  84330. * @param aspect defines the aspect ratio
  84331. * @param znear defines the near clip plane
  84332. * @param zfar not used as infinity is used as far clip
  84333. * @param result defines the target matrix
  84334. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84335. */
  84336. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84337. /**
  84338. * Creates a right-handed perspective projection matrix
  84339. * @param fov defines the horizontal field of view
  84340. * @param aspect defines the aspect ratio
  84341. * @param znear defines the near clip plane
  84342. * @param zfar defines the far clip plane
  84343. * @returns a new matrix as a right-handed perspective projection matrix
  84344. */
  84345. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  84346. /**
  84347. * Stores a right-handed perspective projection into a given matrix
  84348. * @param fov defines the horizontal field of view
  84349. * @param aspect defines the aspect ratio
  84350. * @param znear defines the near clip plane
  84351. * @param zfar defines the far clip plane
  84352. * @param result defines the target matrix
  84353. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84354. */
  84355. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84356. /**
  84357. * Stores a right-handed perspective projection into a given matrix
  84358. * @param fov defines the horizontal field of view
  84359. * @param aspect defines the aspect ratio
  84360. * @param znear defines the near clip plane
  84361. * @param zfar not used as infinity is used as far clip
  84362. * @param result defines the target matrix
  84363. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84364. */
  84365. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84366. /**
  84367. * Stores a perspective projection for WebVR info a given matrix
  84368. * @param fov defines the field of view
  84369. * @param znear defines the near clip plane
  84370. * @param zfar defines the far clip plane
  84371. * @param result defines the target matrix
  84372. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  84373. */
  84374. static PerspectiveFovWebVRToRef(fov: {
  84375. upDegrees: number;
  84376. downDegrees: number;
  84377. leftDegrees: number;
  84378. rightDegrees: number;
  84379. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  84380. /**
  84381. * Computes a complete transformation matrix
  84382. * @param viewport defines the viewport to use
  84383. * @param world defines the world matrix
  84384. * @param view defines the view matrix
  84385. * @param projection defines the projection matrix
  84386. * @param zmin defines the near clip plane
  84387. * @param zmax defines the far clip plane
  84388. * @returns the transformation matrix
  84389. */
  84390. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  84391. /**
  84392. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  84393. * @param matrix defines the matrix to use
  84394. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  84395. */
  84396. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  84397. /**
  84398. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  84399. * @param matrix defines the matrix to use
  84400. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  84401. */
  84402. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  84403. /**
  84404. * Compute the transpose of a given matrix
  84405. * @param matrix defines the matrix to transpose
  84406. * @returns the new matrix
  84407. */
  84408. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  84409. /**
  84410. * Compute the transpose of a matrix and store it in a target matrix
  84411. * @param matrix defines the matrix to transpose
  84412. * @param result defines the target matrix
  84413. */
  84414. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  84415. /**
  84416. * Computes a reflection matrix from a plane
  84417. * @param plane defines the reflection plane
  84418. * @returns a new matrix
  84419. */
  84420. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  84421. /**
  84422. * Computes a reflection matrix from a plane
  84423. * @param plane defines the reflection plane
  84424. * @param result defines the target matrix
  84425. */
  84426. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  84427. /**
  84428. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  84429. * @param xaxis defines the value of the 1st axis
  84430. * @param yaxis defines the value of the 2nd axis
  84431. * @param zaxis defines the value of the 3rd axis
  84432. * @param result defines the target matrix
  84433. */
  84434. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  84435. /**
  84436. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  84437. * @param quat defines the quaternion to use
  84438. * @param result defines the target matrix
  84439. */
  84440. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  84441. }
  84442. /**
  84443. * @hidden
  84444. */
  84445. export class TmpVectors {
  84446. static Vector2: Vector2[];
  84447. static Vector3: Vector3[];
  84448. static Vector4: Vector4[];
  84449. static Quaternion: Quaternion[];
  84450. static Matrix: Matrix[];
  84451. }
  84452. }
  84453. declare module BABYLON {
  84454. /**
  84455. * Defines potential orientation for back face culling
  84456. */
  84457. export enum Orientation {
  84458. /**
  84459. * Clockwise
  84460. */
  84461. CW = 0,
  84462. /** Counter clockwise */
  84463. CCW = 1
  84464. }
  84465. /** Class used to represent a Bezier curve */
  84466. export class BezierCurve {
  84467. /**
  84468. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  84469. * @param t defines the time
  84470. * @param x1 defines the left coordinate on X axis
  84471. * @param y1 defines the left coordinate on Y axis
  84472. * @param x2 defines the right coordinate on X axis
  84473. * @param y2 defines the right coordinate on Y axis
  84474. * @returns the interpolated value
  84475. */
  84476. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  84477. }
  84478. /**
  84479. * Defines angle representation
  84480. */
  84481. export class Angle {
  84482. private _radians;
  84483. /**
  84484. * Creates an Angle object of "radians" radians (float).
  84485. * @param radians the angle in radians
  84486. */
  84487. constructor(radians: number);
  84488. /**
  84489. * Get value in degrees
  84490. * @returns the Angle value in degrees (float)
  84491. */
  84492. degrees(): number;
  84493. /**
  84494. * Get value in radians
  84495. * @returns the Angle value in radians (float)
  84496. */
  84497. radians(): number;
  84498. /**
  84499. * Gets a new Angle object valued with the gradient angle, in radians, of the line joining two points
  84500. * @param a defines first point as the origin
  84501. * @param b defines point
  84502. * @returns a new Angle
  84503. */
  84504. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  84505. /**
  84506. * Gets a new Angle object from the given float in radians
  84507. * @param radians defines the angle value in radians
  84508. * @returns a new Angle
  84509. */
  84510. static FromRadians(radians: number): Angle;
  84511. /**
  84512. * Gets a new Angle object from the given float in degrees
  84513. * @param degrees defines the angle value in degrees
  84514. * @returns a new Angle
  84515. */
  84516. static FromDegrees(degrees: number): Angle;
  84517. }
  84518. /**
  84519. * This represents an arc in a 2d space.
  84520. */
  84521. export class Arc2 {
  84522. /** Defines the start point of the arc */
  84523. startPoint: Vector2;
  84524. /** Defines the mid point of the arc */
  84525. midPoint: Vector2;
  84526. /** Defines the end point of the arc */
  84527. endPoint: Vector2;
  84528. /**
  84529. * Defines the center point of the arc.
  84530. */
  84531. centerPoint: Vector2;
  84532. /**
  84533. * Defines the radius of the arc.
  84534. */
  84535. radius: number;
  84536. /**
  84537. * Defines the angle of the arc (from mid point to end point).
  84538. */
  84539. angle: Angle;
  84540. /**
  84541. * Defines the start angle of the arc (from start point to middle point).
  84542. */
  84543. startAngle: Angle;
  84544. /**
  84545. * Defines the orientation of the arc (clock wise/counter clock wise).
  84546. */
  84547. orientation: Orientation;
  84548. /**
  84549. * Creates an Arc object from the three given points : start, middle and end.
  84550. * @param startPoint Defines the start point of the arc
  84551. * @param midPoint Defines the midlle point of the arc
  84552. * @param endPoint Defines the end point of the arc
  84553. */
  84554. constructor(
  84555. /** Defines the start point of the arc */
  84556. startPoint: Vector2,
  84557. /** Defines the mid point of the arc */
  84558. midPoint: Vector2,
  84559. /** Defines the end point of the arc */
  84560. endPoint: Vector2);
  84561. }
  84562. /**
  84563. * Represents a 2D path made up of multiple 2D points
  84564. */
  84565. export class Path2 {
  84566. private _points;
  84567. private _length;
  84568. /**
  84569. * If the path start and end point are the same
  84570. */
  84571. closed: boolean;
  84572. /**
  84573. * Creates a Path2 object from the starting 2D coordinates x and y.
  84574. * @param x the starting points x value
  84575. * @param y the starting points y value
  84576. */
  84577. constructor(x: number, y: number);
  84578. /**
  84579. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  84580. * @param x the added points x value
  84581. * @param y the added points y value
  84582. * @returns the updated Path2.
  84583. */
  84584. addLineTo(x: number, y: number): Path2;
  84585. /**
  84586. * 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.
  84587. * @param midX middle point x value
  84588. * @param midY middle point y value
  84589. * @param endX end point x value
  84590. * @param endY end point y value
  84591. * @param numberOfSegments (default: 36)
  84592. * @returns the updated Path2.
  84593. */
  84594. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  84595. /**
  84596. * Closes the Path2.
  84597. * @returns the Path2.
  84598. */
  84599. close(): Path2;
  84600. /**
  84601. * Gets the sum of the distance between each sequential point in the path
  84602. * @returns the Path2 total length (float).
  84603. */
  84604. length(): number;
  84605. /**
  84606. * Gets the points which construct the path
  84607. * @returns the Path2 internal array of points.
  84608. */
  84609. getPoints(): Vector2[];
  84610. /**
  84611. * Retreives the point at the distance aways from the starting point
  84612. * @param normalizedLengthPosition the length along the path to retreive the point from
  84613. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  84614. */
  84615. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  84616. /**
  84617. * Creates a new path starting from an x and y position
  84618. * @param x starting x value
  84619. * @param y starting y value
  84620. * @returns a new Path2 starting at the coordinates (x, y).
  84621. */
  84622. static StartingAt(x: number, y: number): Path2;
  84623. }
  84624. /**
  84625. * Represents a 3D path made up of multiple 3D points
  84626. */
  84627. export class Path3D {
  84628. /**
  84629. * an array of Vector3, the curve axis of the Path3D
  84630. */
  84631. path: Vector3[];
  84632. private _curve;
  84633. private _distances;
  84634. private _tangents;
  84635. private _normals;
  84636. private _binormals;
  84637. private _raw;
  84638. private _alignTangentsWithPath;
  84639. private readonly _pointAtData;
  84640. /**
  84641. * new Path3D(path, normal, raw)
  84642. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  84643. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  84644. * @param path an array of Vector3, the curve axis of the Path3D
  84645. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  84646. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  84647. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  84648. */
  84649. constructor(
  84650. /**
  84651. * an array of Vector3, the curve axis of the Path3D
  84652. */
  84653. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  84654. /**
  84655. * Returns the Path3D array of successive Vector3 designing its curve.
  84656. * @returns the Path3D array of successive Vector3 designing its curve.
  84657. */
  84658. getCurve(): Vector3[];
  84659. /**
  84660. * Returns the Path3D array of successive Vector3 designing its curve.
  84661. * @returns the Path3D array of successive Vector3 designing its curve.
  84662. */
  84663. getPoints(): Vector3[];
  84664. /**
  84665. * @returns the computed length (float) of the path.
  84666. */
  84667. length(): number;
  84668. /**
  84669. * Returns an array populated with tangent vectors on each Path3D curve point.
  84670. * @returns an array populated with tangent vectors on each Path3D curve point.
  84671. */
  84672. getTangents(): Vector3[];
  84673. /**
  84674. * Returns an array populated with normal vectors on each Path3D curve point.
  84675. * @returns an array populated with normal vectors on each Path3D curve point.
  84676. */
  84677. getNormals(): Vector3[];
  84678. /**
  84679. * Returns an array populated with binormal vectors on each Path3D curve point.
  84680. * @returns an array populated with binormal vectors on each Path3D curve point.
  84681. */
  84682. getBinormals(): Vector3[];
  84683. /**
  84684. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  84685. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  84686. */
  84687. getDistances(): number[];
  84688. /**
  84689. * Returns an interpolated point along this path
  84690. * @param position the position of the point along this path, from 0.0 to 1.0
  84691. * @returns a new Vector3 as the point
  84692. */
  84693. getPointAt(position: number): Vector3;
  84694. /**
  84695. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  84696. * @param position the position of the point along this path, from 0.0 to 1.0
  84697. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  84698. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  84699. */
  84700. getTangentAt(position: number, interpolated?: boolean): Vector3;
  84701. /**
  84702. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  84703. * @param position the position of the point along this path, from 0.0 to 1.0
  84704. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  84705. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  84706. */
  84707. getNormalAt(position: number, interpolated?: boolean): Vector3;
  84708. /**
  84709. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  84710. * @param position the position of the point along this path, from 0.0 to 1.0
  84711. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  84712. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  84713. */
  84714. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  84715. /**
  84716. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  84717. * @param position the position of the point along this path, from 0.0 to 1.0
  84718. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  84719. */
  84720. getDistanceAt(position: number): number;
  84721. /**
  84722. * Returns the array index of the previous point of an interpolated point along this path
  84723. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  84724. * @returns the array index
  84725. */
  84726. getPreviousPointIndexAt(position: number): number;
  84727. /**
  84728. * 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)
  84729. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  84730. * @returns the sub position
  84731. */
  84732. getSubPositionAt(position: number): number;
  84733. /**
  84734. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  84735. * @param target the vector of which to get the closest position to
  84736. * @returns the position of the closest virtual point on this path to the target vector
  84737. */
  84738. getClosestPositionTo(target: Vector3): number;
  84739. /**
  84740. * Returns a sub path (slice) of this path
  84741. * @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
  84742. * @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
  84743. * @returns a sub path (slice) of this path
  84744. */
  84745. slice(start?: number, end?: number): Path3D;
  84746. /**
  84747. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  84748. * @param path path which all values are copied into the curves points
  84749. * @param firstNormal which should be projected onto the curve
  84750. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  84751. * @returns the same object updated.
  84752. */
  84753. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  84754. private _compute;
  84755. private _getFirstNonNullVector;
  84756. private _getLastNonNullVector;
  84757. private _normalVector;
  84758. /**
  84759. * Updates the point at data for an interpolated point along this curve
  84760. * @param position the position of the point along this curve, from 0.0 to 1.0
  84761. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  84762. * @returns the (updated) point at data
  84763. */
  84764. private _updatePointAtData;
  84765. /**
  84766. * Updates the point at data from the specified parameters
  84767. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  84768. * @param point the interpolated point
  84769. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  84770. */
  84771. private _setPointAtData;
  84772. /**
  84773. * Updates the point at interpolation matrix for the tangents, normals and binormals
  84774. */
  84775. private _updateInterpolationMatrix;
  84776. }
  84777. /**
  84778. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  84779. * A Curve3 is designed from a series of successive Vector3.
  84780. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  84781. */
  84782. export class Curve3 {
  84783. private _points;
  84784. private _length;
  84785. /**
  84786. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  84787. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  84788. * @param v1 (Vector3) the control point
  84789. * @param v2 (Vector3) the end point of the Quadratic Bezier
  84790. * @param nbPoints (integer) the wanted number of points in the curve
  84791. * @returns the created Curve3
  84792. */
  84793. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84794. /**
  84795. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  84796. * @param v0 (Vector3) the origin point of the Cubic Bezier
  84797. * @param v1 (Vector3) the first control point
  84798. * @param v2 (Vector3) the second control point
  84799. * @param v3 (Vector3) the end point of the Cubic Bezier
  84800. * @param nbPoints (integer) the wanted number of points in the curve
  84801. * @returns the created Curve3
  84802. */
  84803. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84804. /**
  84805. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  84806. * @param p1 (Vector3) the origin point of the Hermite Spline
  84807. * @param t1 (Vector3) the tangent vector at the origin point
  84808. * @param p2 (Vector3) the end point of the Hermite Spline
  84809. * @param t2 (Vector3) the tangent vector at the end point
  84810. * @param nbPoints (integer) the wanted number of points in the curve
  84811. * @returns the created Curve3
  84812. */
  84813. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84814. /**
  84815. * Returns a Curve3 object along a CatmullRom Spline curve :
  84816. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  84817. * @param nbPoints (integer) the wanted number of points between each curve control points
  84818. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  84819. * @returns the created Curve3
  84820. */
  84821. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  84822. /**
  84823. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  84824. * A Curve3 is designed from a series of successive Vector3.
  84825. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  84826. * @param points points which make up the curve
  84827. */
  84828. constructor(points: Vector3[]);
  84829. /**
  84830. * @returns the Curve3 stored array of successive Vector3
  84831. */
  84832. getPoints(): Vector3[];
  84833. /**
  84834. * @returns the computed length (float) of the curve.
  84835. */
  84836. length(): number;
  84837. /**
  84838. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  84839. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  84840. * curveA and curveB keep unchanged.
  84841. * @param curve the curve to continue from this curve
  84842. * @returns the newly constructed curve
  84843. */
  84844. continue(curve: DeepImmutable<Curve3>): Curve3;
  84845. private _computeLength;
  84846. }
  84847. }
  84848. declare module BABYLON {
  84849. /**
  84850. * This represents the main contract an easing function should follow.
  84851. * Easing functions are used throughout the animation system.
  84852. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84853. */
  84854. export interface IEasingFunction {
  84855. /**
  84856. * Given an input gradient between 0 and 1, this returns the corrseponding value
  84857. * of the easing function.
  84858. * The link below provides some of the most common examples of easing functions.
  84859. * @see https://easings.net/
  84860. * @param gradient Defines the value between 0 and 1 we want the easing value for
  84861. * @returns the corresponding value on the curve defined by the easing function
  84862. */
  84863. ease(gradient: number): number;
  84864. }
  84865. /**
  84866. * Base class used for every default easing function.
  84867. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84868. */
  84869. export class EasingFunction implements IEasingFunction {
  84870. /**
  84871. * Interpolation follows the mathematical formula associated with the easing function.
  84872. */
  84873. static readonly EASINGMODE_EASEIN: number;
  84874. /**
  84875. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  84876. */
  84877. static readonly EASINGMODE_EASEOUT: number;
  84878. /**
  84879. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  84880. */
  84881. static readonly EASINGMODE_EASEINOUT: number;
  84882. private _easingMode;
  84883. /**
  84884. * Sets the easing mode of the current function.
  84885. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  84886. */
  84887. setEasingMode(easingMode: number): void;
  84888. /**
  84889. * Gets the current easing mode.
  84890. * @returns the easing mode
  84891. */
  84892. getEasingMode(): number;
  84893. /**
  84894. * @hidden
  84895. */
  84896. easeInCore(gradient: number): number;
  84897. /**
  84898. * Given an input gradient between 0 and 1, this returns the corresponding value
  84899. * of the easing function.
  84900. * @param gradient Defines the value between 0 and 1 we want the easing value for
  84901. * @returns the corresponding value on the curve defined by the easing function
  84902. */
  84903. ease(gradient: number): number;
  84904. }
  84905. /**
  84906. * Easing function with a circle shape (see link below).
  84907. * @see https://easings.net/#easeInCirc
  84908. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84909. */
  84910. export class CircleEase extends EasingFunction implements IEasingFunction {
  84911. /** @hidden */
  84912. easeInCore(gradient: number): number;
  84913. }
  84914. /**
  84915. * Easing function with a ease back shape (see link below).
  84916. * @see https://easings.net/#easeInBack
  84917. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84918. */
  84919. export class BackEase extends EasingFunction implements IEasingFunction {
  84920. /** Defines the amplitude of the function */
  84921. amplitude: number;
  84922. /**
  84923. * Instantiates a back ease easing
  84924. * @see https://easings.net/#easeInBack
  84925. * @param amplitude Defines the amplitude of the function
  84926. */
  84927. constructor(
  84928. /** Defines the amplitude of the function */
  84929. amplitude?: number);
  84930. /** @hidden */
  84931. easeInCore(gradient: number): number;
  84932. }
  84933. /**
  84934. * Easing function with a bouncing shape (see link below).
  84935. * @see https://easings.net/#easeInBounce
  84936. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84937. */
  84938. export class BounceEase extends EasingFunction implements IEasingFunction {
  84939. /** Defines the number of bounces */
  84940. bounces: number;
  84941. /** Defines the amplitude of the bounce */
  84942. bounciness: number;
  84943. /**
  84944. * Instantiates a bounce easing
  84945. * @see https://easings.net/#easeInBounce
  84946. * @param bounces Defines the number of bounces
  84947. * @param bounciness Defines the amplitude of the bounce
  84948. */
  84949. constructor(
  84950. /** Defines the number of bounces */
  84951. bounces?: number,
  84952. /** Defines the amplitude of the bounce */
  84953. bounciness?: number);
  84954. /** @hidden */
  84955. easeInCore(gradient: number): number;
  84956. }
  84957. /**
  84958. * Easing function with a power of 3 shape (see link below).
  84959. * @see https://easings.net/#easeInCubic
  84960. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84961. */
  84962. export class CubicEase extends EasingFunction implements IEasingFunction {
  84963. /** @hidden */
  84964. easeInCore(gradient: number): number;
  84965. }
  84966. /**
  84967. * Easing function with an elastic shape (see link below).
  84968. * @see https://easings.net/#easeInElastic
  84969. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84970. */
  84971. export class ElasticEase extends EasingFunction implements IEasingFunction {
  84972. /** Defines the number of oscillations*/
  84973. oscillations: number;
  84974. /** Defines the amplitude of the oscillations*/
  84975. springiness: number;
  84976. /**
  84977. * Instantiates an elastic easing function
  84978. * @see https://easings.net/#easeInElastic
  84979. * @param oscillations Defines the number of oscillations
  84980. * @param springiness Defines the amplitude of the oscillations
  84981. */
  84982. constructor(
  84983. /** Defines the number of oscillations*/
  84984. oscillations?: number,
  84985. /** Defines the amplitude of the oscillations*/
  84986. springiness?: number);
  84987. /** @hidden */
  84988. easeInCore(gradient: number): number;
  84989. }
  84990. /**
  84991. * Easing function with an exponential shape (see link below).
  84992. * @see https://easings.net/#easeInExpo
  84993. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84994. */
  84995. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  84996. /** Defines the exponent of the function */
  84997. exponent: number;
  84998. /**
  84999. * Instantiates an exponential easing function
  85000. * @see https://easings.net/#easeInExpo
  85001. * @param exponent Defines the exponent of the function
  85002. */
  85003. constructor(
  85004. /** Defines the exponent of the function */
  85005. exponent?: number);
  85006. /** @hidden */
  85007. easeInCore(gradient: number): number;
  85008. }
  85009. /**
  85010. * Easing function with a power shape (see link below).
  85011. * @see https://easings.net/#easeInQuad
  85012. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85013. */
  85014. export class PowerEase extends EasingFunction implements IEasingFunction {
  85015. /** Defines the power of the function */
  85016. power: number;
  85017. /**
  85018. * Instantiates an power base easing function
  85019. * @see https://easings.net/#easeInQuad
  85020. * @param power Defines the power of the function
  85021. */
  85022. constructor(
  85023. /** Defines the power of the function */
  85024. power?: number);
  85025. /** @hidden */
  85026. easeInCore(gradient: number): number;
  85027. }
  85028. /**
  85029. * Easing function with a power of 2 shape (see link below).
  85030. * @see https://easings.net/#easeInQuad
  85031. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85032. */
  85033. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  85034. /** @hidden */
  85035. easeInCore(gradient: number): number;
  85036. }
  85037. /**
  85038. * Easing function with a power of 4 shape (see link below).
  85039. * @see https://easings.net/#easeInQuart
  85040. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85041. */
  85042. export class QuarticEase extends EasingFunction implements IEasingFunction {
  85043. /** @hidden */
  85044. easeInCore(gradient: number): number;
  85045. }
  85046. /**
  85047. * Easing function with a power of 5 shape (see link below).
  85048. * @see https://easings.net/#easeInQuint
  85049. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85050. */
  85051. export class QuinticEase extends EasingFunction implements IEasingFunction {
  85052. /** @hidden */
  85053. easeInCore(gradient: number): number;
  85054. }
  85055. /**
  85056. * Easing function with a sin shape (see link below).
  85057. * @see https://easings.net/#easeInSine
  85058. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85059. */
  85060. export class SineEase extends EasingFunction implements IEasingFunction {
  85061. /** @hidden */
  85062. easeInCore(gradient: number): number;
  85063. }
  85064. /**
  85065. * Easing function with a bezier shape (see link below).
  85066. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  85067. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85068. */
  85069. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  85070. /** Defines the x component of the start tangent in the bezier curve */
  85071. x1: number;
  85072. /** Defines the y component of the start tangent in the bezier curve */
  85073. y1: number;
  85074. /** Defines the x component of the end tangent in the bezier curve */
  85075. x2: number;
  85076. /** Defines the y component of the end tangent in the bezier curve */
  85077. y2: number;
  85078. /**
  85079. * Instantiates a bezier function
  85080. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  85081. * @param x1 Defines the x component of the start tangent in the bezier curve
  85082. * @param y1 Defines the y component of the start tangent in the bezier curve
  85083. * @param x2 Defines the x component of the end tangent in the bezier curve
  85084. * @param y2 Defines the y component of the end tangent in the bezier curve
  85085. */
  85086. constructor(
  85087. /** Defines the x component of the start tangent in the bezier curve */
  85088. x1?: number,
  85089. /** Defines the y component of the start tangent in the bezier curve */
  85090. y1?: number,
  85091. /** Defines the x component of the end tangent in the bezier curve */
  85092. x2?: number,
  85093. /** Defines the y component of the end tangent in the bezier curve */
  85094. y2?: number);
  85095. /** @hidden */
  85096. easeInCore(gradient: number): number;
  85097. }
  85098. }
  85099. declare module BABYLON {
  85100. /**
  85101. * Class used to hold a RBG color
  85102. */
  85103. export class Color3 {
  85104. /**
  85105. * Defines the red component (between 0 and 1, default is 0)
  85106. */
  85107. r: number;
  85108. /**
  85109. * Defines the green component (between 0 and 1, default is 0)
  85110. */
  85111. g: number;
  85112. /**
  85113. * Defines the blue component (between 0 and 1, default is 0)
  85114. */
  85115. b: number;
  85116. /**
  85117. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  85118. * @param r defines the red component (between 0 and 1, default is 0)
  85119. * @param g defines the green component (between 0 and 1, default is 0)
  85120. * @param b defines the blue component (between 0 and 1, default is 0)
  85121. */
  85122. constructor(
  85123. /**
  85124. * Defines the red component (between 0 and 1, default is 0)
  85125. */
  85126. r?: number,
  85127. /**
  85128. * Defines the green component (between 0 and 1, default is 0)
  85129. */
  85130. g?: number,
  85131. /**
  85132. * Defines the blue component (between 0 and 1, default is 0)
  85133. */
  85134. b?: number);
  85135. /**
  85136. * Creates a string with the Color3 current values
  85137. * @returns the string representation of the Color3 object
  85138. */
  85139. toString(): string;
  85140. /**
  85141. * Returns the string "Color3"
  85142. * @returns "Color3"
  85143. */
  85144. getClassName(): string;
  85145. /**
  85146. * Compute the Color3 hash code
  85147. * @returns an unique number that can be used to hash Color3 objects
  85148. */
  85149. getHashCode(): number;
  85150. /**
  85151. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  85152. * @param array defines the array where to store the r,g,b components
  85153. * @param index defines an optional index in the target array to define where to start storing values
  85154. * @returns the current Color3 object
  85155. */
  85156. toArray(array: FloatArray, index?: number): Color3;
  85157. /**
  85158. * Update the current color with values stored in an array from the starting index of the given array
  85159. * @param array defines the source array
  85160. * @param offset defines an offset in the source array
  85161. * @returns the current Color3 object
  85162. */
  85163. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  85164. /**
  85165. * Returns a new Color4 object from the current Color3 and the given alpha
  85166. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  85167. * @returns a new Color4 object
  85168. */
  85169. toColor4(alpha?: number): Color4;
  85170. /**
  85171. * Returns a new array populated with 3 numeric elements : red, green and blue values
  85172. * @returns the new array
  85173. */
  85174. asArray(): number[];
  85175. /**
  85176. * Returns the luminance value
  85177. * @returns a float value
  85178. */
  85179. toLuminance(): number;
  85180. /**
  85181. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  85182. * @param otherColor defines the second operand
  85183. * @returns the new Color3 object
  85184. */
  85185. multiply(otherColor: DeepImmutable<Color3>): Color3;
  85186. /**
  85187. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  85188. * @param otherColor defines the second operand
  85189. * @param result defines the Color3 object where to store the result
  85190. * @returns the current Color3
  85191. */
  85192. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85193. /**
  85194. * Determines equality between Color3 objects
  85195. * @param otherColor defines the second operand
  85196. * @returns true if the rgb values are equal to the given ones
  85197. */
  85198. equals(otherColor: DeepImmutable<Color3>): boolean;
  85199. /**
  85200. * Determines equality between the current Color3 object and a set of r,b,g values
  85201. * @param r defines the red component to check
  85202. * @param g defines the green component to check
  85203. * @param b defines the blue component to check
  85204. * @returns true if the rgb values are equal to the given ones
  85205. */
  85206. equalsFloats(r: number, g: number, b: number): boolean;
  85207. /**
  85208. * Multiplies in place each rgb value by scale
  85209. * @param scale defines the scaling factor
  85210. * @returns the updated Color3
  85211. */
  85212. scale(scale: number): Color3;
  85213. /**
  85214. * Multiplies the rgb values by scale and stores the result into "result"
  85215. * @param scale defines the scaling factor
  85216. * @param result defines the Color3 object where to store the result
  85217. * @returns the unmodified current Color3
  85218. */
  85219. scaleToRef(scale: number, result: Color3): Color3;
  85220. /**
  85221. * Scale the current Color3 values by a factor and add the result to a given Color3
  85222. * @param scale defines the scale factor
  85223. * @param result defines color to store the result into
  85224. * @returns the unmodified current Color3
  85225. */
  85226. scaleAndAddToRef(scale: number, result: Color3): Color3;
  85227. /**
  85228. * Clamps the rgb values by the min and max values and stores the result into "result"
  85229. * @param min defines minimum clamping value (default is 0)
  85230. * @param max defines maximum clamping value (default is 1)
  85231. * @param result defines color to store the result into
  85232. * @returns the original Color3
  85233. */
  85234. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  85235. /**
  85236. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  85237. * @param otherColor defines the second operand
  85238. * @returns the new Color3
  85239. */
  85240. add(otherColor: DeepImmutable<Color3>): Color3;
  85241. /**
  85242. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  85243. * @param otherColor defines the second operand
  85244. * @param result defines Color3 object to store the result into
  85245. * @returns the unmodified current Color3
  85246. */
  85247. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85248. /**
  85249. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  85250. * @param otherColor defines the second operand
  85251. * @returns the new Color3
  85252. */
  85253. subtract(otherColor: DeepImmutable<Color3>): Color3;
  85254. /**
  85255. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  85256. * @param otherColor defines the second operand
  85257. * @param result defines Color3 object to store the result into
  85258. * @returns the unmodified current Color3
  85259. */
  85260. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85261. /**
  85262. * Copy the current object
  85263. * @returns a new Color3 copied the current one
  85264. */
  85265. clone(): Color3;
  85266. /**
  85267. * Copies the rgb values from the source in the current Color3
  85268. * @param source defines the source Color3 object
  85269. * @returns the updated Color3 object
  85270. */
  85271. copyFrom(source: DeepImmutable<Color3>): Color3;
  85272. /**
  85273. * Updates the Color3 rgb values from the given floats
  85274. * @param r defines the red component to read from
  85275. * @param g defines the green component to read from
  85276. * @param b defines the blue component to read from
  85277. * @returns the current Color3 object
  85278. */
  85279. copyFromFloats(r: number, g: number, b: number): Color3;
  85280. /**
  85281. * Updates the Color3 rgb values from the given floats
  85282. * @param r defines the red component to read from
  85283. * @param g defines the green component to read from
  85284. * @param b defines the blue component to read from
  85285. * @returns the current Color3 object
  85286. */
  85287. set(r: number, g: number, b: number): Color3;
  85288. /**
  85289. * Compute the Color3 hexadecimal code as a string
  85290. * @returns a string containing the hexadecimal representation of the Color3 object
  85291. */
  85292. toHexString(): string;
  85293. /**
  85294. * Computes a new Color3 converted from the current one to linear space
  85295. * @returns a new Color3 object
  85296. */
  85297. toLinearSpace(): Color3;
  85298. /**
  85299. * Converts current color in rgb space to HSV values
  85300. * @returns a new color3 representing the HSV values
  85301. */
  85302. toHSV(): Color3;
  85303. /**
  85304. * Converts current color in rgb space to HSV values
  85305. * @param result defines the Color3 where to store the HSV values
  85306. */
  85307. toHSVToRef(result: Color3): void;
  85308. /**
  85309. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  85310. * @param convertedColor defines the Color3 object where to store the linear space version
  85311. * @returns the unmodified Color3
  85312. */
  85313. toLinearSpaceToRef(convertedColor: Color3): Color3;
  85314. /**
  85315. * Computes a new Color3 converted from the current one to gamma space
  85316. * @returns a new Color3 object
  85317. */
  85318. toGammaSpace(): Color3;
  85319. /**
  85320. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  85321. * @param convertedColor defines the Color3 object where to store the gamma space version
  85322. * @returns the unmodified Color3
  85323. */
  85324. toGammaSpaceToRef(convertedColor: Color3): Color3;
  85325. private static _BlackReadOnly;
  85326. /**
  85327. * Convert Hue, saturation and value to a Color3 (RGB)
  85328. * @param hue defines the hue
  85329. * @param saturation defines the saturation
  85330. * @param value defines the value
  85331. * @param result defines the Color3 where to store the RGB values
  85332. */
  85333. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  85334. /**
  85335. * Creates a new Color3 from the string containing valid hexadecimal values
  85336. * @param hex defines a string containing valid hexadecimal values
  85337. * @returns a new Color3 object
  85338. */
  85339. static FromHexString(hex: string): Color3;
  85340. /**
  85341. * Creates a new Color3 from the starting index of the given array
  85342. * @param array defines the source array
  85343. * @param offset defines an offset in the source array
  85344. * @returns a new Color3 object
  85345. */
  85346. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  85347. /**
  85348. * Creates a new Color3 from the starting index element of the given array
  85349. * @param array defines the source array to read from
  85350. * @param offset defines the offset in the source array
  85351. * @param result defines the target Color3 object
  85352. */
  85353. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color3): void;
  85354. /**
  85355. * Creates a new Color3 from integer values (< 256)
  85356. * @param r defines the red component to read from (value between 0 and 255)
  85357. * @param g defines the green component to read from (value between 0 and 255)
  85358. * @param b defines the blue component to read from (value between 0 and 255)
  85359. * @returns a new Color3 object
  85360. */
  85361. static FromInts(r: number, g: number, b: number): Color3;
  85362. /**
  85363. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  85364. * @param start defines the start Color3 value
  85365. * @param end defines the end Color3 value
  85366. * @param amount defines the gradient value between start and end
  85367. * @returns a new Color3 object
  85368. */
  85369. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  85370. /**
  85371. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  85372. * @param left defines the start value
  85373. * @param right defines the end value
  85374. * @param amount defines the gradient factor
  85375. * @param result defines the Color3 object where to store the result
  85376. */
  85377. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  85378. /**
  85379. * Returns a Color3 value containing a red color
  85380. * @returns a new Color3 object
  85381. */
  85382. static Red(): Color3;
  85383. /**
  85384. * Returns a Color3 value containing a green color
  85385. * @returns a new Color3 object
  85386. */
  85387. static Green(): Color3;
  85388. /**
  85389. * Returns a Color3 value containing a blue color
  85390. * @returns a new Color3 object
  85391. */
  85392. static Blue(): Color3;
  85393. /**
  85394. * Returns a Color3 value containing a black color
  85395. * @returns a new Color3 object
  85396. */
  85397. static Black(): Color3;
  85398. /**
  85399. * Gets a Color3 value containing a black color that must not be updated
  85400. */
  85401. static get BlackReadOnly(): DeepImmutable<Color3>;
  85402. /**
  85403. * Returns a Color3 value containing a white color
  85404. * @returns a new Color3 object
  85405. */
  85406. static White(): Color3;
  85407. /**
  85408. * Returns a Color3 value containing a purple color
  85409. * @returns a new Color3 object
  85410. */
  85411. static Purple(): Color3;
  85412. /**
  85413. * Returns a Color3 value containing a magenta color
  85414. * @returns a new Color3 object
  85415. */
  85416. static Magenta(): Color3;
  85417. /**
  85418. * Returns a Color3 value containing a yellow color
  85419. * @returns a new Color3 object
  85420. */
  85421. static Yellow(): Color3;
  85422. /**
  85423. * Returns a Color3 value containing a gray color
  85424. * @returns a new Color3 object
  85425. */
  85426. static Gray(): Color3;
  85427. /**
  85428. * Returns a Color3 value containing a teal color
  85429. * @returns a new Color3 object
  85430. */
  85431. static Teal(): Color3;
  85432. /**
  85433. * Returns a Color3 value containing a random color
  85434. * @returns a new Color3 object
  85435. */
  85436. static Random(): Color3;
  85437. }
  85438. /**
  85439. * Class used to hold a RBGA color
  85440. */
  85441. export class Color4 {
  85442. /**
  85443. * Defines the red component (between 0 and 1, default is 0)
  85444. */
  85445. r: number;
  85446. /**
  85447. * Defines the green component (between 0 and 1, default is 0)
  85448. */
  85449. g: number;
  85450. /**
  85451. * Defines the blue component (between 0 and 1, default is 0)
  85452. */
  85453. b: number;
  85454. /**
  85455. * Defines the alpha component (between 0 and 1, default is 1)
  85456. */
  85457. a: number;
  85458. /**
  85459. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  85460. * @param r defines the red component (between 0 and 1, default is 0)
  85461. * @param g defines the green component (between 0 and 1, default is 0)
  85462. * @param b defines the blue component (between 0 and 1, default is 0)
  85463. * @param a defines the alpha component (between 0 and 1, default is 1)
  85464. */
  85465. constructor(
  85466. /**
  85467. * Defines the red component (between 0 and 1, default is 0)
  85468. */
  85469. r?: number,
  85470. /**
  85471. * Defines the green component (between 0 and 1, default is 0)
  85472. */
  85473. g?: number,
  85474. /**
  85475. * Defines the blue component (between 0 and 1, default is 0)
  85476. */
  85477. b?: number,
  85478. /**
  85479. * Defines the alpha component (between 0 and 1, default is 1)
  85480. */
  85481. a?: number);
  85482. /**
  85483. * Adds in place the given Color4 values to the current Color4 object
  85484. * @param right defines the second operand
  85485. * @returns the current updated Color4 object
  85486. */
  85487. addInPlace(right: DeepImmutable<Color4>): Color4;
  85488. /**
  85489. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  85490. * @returns the new array
  85491. */
  85492. asArray(): number[];
  85493. /**
  85494. * Stores from the starting index in the given array the Color4 successive values
  85495. * @param array defines the array where to store the r,g,b components
  85496. * @param index defines an optional index in the target array to define where to start storing values
  85497. * @returns the current Color4 object
  85498. */
  85499. toArray(array: number[], index?: number): Color4;
  85500. /**
  85501. * Update the current color with values stored in an array from the starting index of the given array
  85502. * @param array defines the source array
  85503. * @param offset defines an offset in the source array
  85504. * @returns the current Color4 object
  85505. */
  85506. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  85507. /**
  85508. * Determines equality between Color4 objects
  85509. * @param otherColor defines the second operand
  85510. * @returns true if the rgba values are equal to the given ones
  85511. */
  85512. equals(otherColor: DeepImmutable<Color4>): boolean;
  85513. /**
  85514. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  85515. * @param right defines the second operand
  85516. * @returns a new Color4 object
  85517. */
  85518. add(right: DeepImmutable<Color4>): Color4;
  85519. /**
  85520. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  85521. * @param right defines the second operand
  85522. * @returns a new Color4 object
  85523. */
  85524. subtract(right: DeepImmutable<Color4>): Color4;
  85525. /**
  85526. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  85527. * @param right defines the second operand
  85528. * @param result defines the Color4 object where to store the result
  85529. * @returns the current Color4 object
  85530. */
  85531. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  85532. /**
  85533. * Creates a new Color4 with the current Color4 values multiplied by scale
  85534. * @param scale defines the scaling factor to apply
  85535. * @returns a new Color4 object
  85536. */
  85537. scale(scale: number): Color4;
  85538. /**
  85539. * Multiplies the current Color4 values by scale and stores the result in "result"
  85540. * @param scale defines the scaling factor to apply
  85541. * @param result defines the Color4 object where to store the result
  85542. * @returns the current unmodified Color4
  85543. */
  85544. scaleToRef(scale: number, result: Color4): Color4;
  85545. /**
  85546. * Scale the current Color4 values by a factor and add the result to a given Color4
  85547. * @param scale defines the scale factor
  85548. * @param result defines the Color4 object where to store the result
  85549. * @returns the unmodified current Color4
  85550. */
  85551. scaleAndAddToRef(scale: number, result: Color4): Color4;
  85552. /**
  85553. * Clamps the rgb values by the min and max values and stores the result into "result"
  85554. * @param min defines minimum clamping value (default is 0)
  85555. * @param max defines maximum clamping value (default is 1)
  85556. * @param result defines color to store the result into.
  85557. * @returns the cuurent Color4
  85558. */
  85559. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  85560. /**
  85561. * Multipy an Color4 value by another and return a new Color4 object
  85562. * @param color defines the Color4 value to multiply by
  85563. * @returns a new Color4 object
  85564. */
  85565. multiply(color: Color4): Color4;
  85566. /**
  85567. * Multipy a Color4 value by another and push the result in a reference value
  85568. * @param color defines the Color4 value to multiply by
  85569. * @param result defines the Color4 to fill the result in
  85570. * @returns the result Color4
  85571. */
  85572. multiplyToRef(color: Color4, result: Color4): Color4;
  85573. /**
  85574. * Creates a string with the Color4 current values
  85575. * @returns the string representation of the Color4 object
  85576. */
  85577. toString(): string;
  85578. /**
  85579. * Returns the string "Color4"
  85580. * @returns "Color4"
  85581. */
  85582. getClassName(): string;
  85583. /**
  85584. * Compute the Color4 hash code
  85585. * @returns an unique number that can be used to hash Color4 objects
  85586. */
  85587. getHashCode(): number;
  85588. /**
  85589. * Creates a new Color4 copied from the current one
  85590. * @returns a new Color4 object
  85591. */
  85592. clone(): Color4;
  85593. /**
  85594. * Copies the given Color4 values into the current one
  85595. * @param source defines the source Color4 object
  85596. * @returns the current updated Color4 object
  85597. */
  85598. copyFrom(source: Color4): Color4;
  85599. /**
  85600. * Copies the given float values into the current one
  85601. * @param r defines the red component to read from
  85602. * @param g defines the green component to read from
  85603. * @param b defines the blue component to read from
  85604. * @param a defines the alpha component to read from
  85605. * @returns the current updated Color4 object
  85606. */
  85607. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  85608. /**
  85609. * Copies the given float values into the current one
  85610. * @param r defines the red component to read from
  85611. * @param g defines the green component to read from
  85612. * @param b defines the blue component to read from
  85613. * @param a defines the alpha component to read from
  85614. * @returns the current updated Color4 object
  85615. */
  85616. set(r: number, g: number, b: number, a: number): Color4;
  85617. /**
  85618. * Compute the Color4 hexadecimal code as a string
  85619. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  85620. * @returns a string containing the hexadecimal representation of the Color4 object
  85621. */
  85622. toHexString(returnAsColor3?: boolean): string;
  85623. /**
  85624. * Computes a new Color4 converted from the current one to linear space
  85625. * @returns a new Color4 object
  85626. */
  85627. toLinearSpace(): Color4;
  85628. /**
  85629. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  85630. * @param convertedColor defines the Color4 object where to store the linear space version
  85631. * @returns the unmodified Color4
  85632. */
  85633. toLinearSpaceToRef(convertedColor: Color4): Color4;
  85634. /**
  85635. * Computes a new Color4 converted from the current one to gamma space
  85636. * @returns a new Color4 object
  85637. */
  85638. toGammaSpace(): Color4;
  85639. /**
  85640. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  85641. * @param convertedColor defines the Color4 object where to store the gamma space version
  85642. * @returns the unmodified Color4
  85643. */
  85644. toGammaSpaceToRef(convertedColor: Color4): Color4;
  85645. /**
  85646. * Creates a new Color4 from the string containing valid hexadecimal values
  85647. * @param hex defines a string containing valid hexadecimal values
  85648. * @returns a new Color4 object
  85649. */
  85650. static FromHexString(hex: string): Color4;
  85651. /**
  85652. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  85653. * @param left defines the start value
  85654. * @param right defines the end value
  85655. * @param amount defines the gradient factor
  85656. * @returns a new Color4 object
  85657. */
  85658. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  85659. /**
  85660. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  85661. * @param left defines the start value
  85662. * @param right defines the end value
  85663. * @param amount defines the gradient factor
  85664. * @param result defines the Color4 object where to store data
  85665. */
  85666. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  85667. /**
  85668. * Creates a new Color4 from a Color3 and an alpha value
  85669. * @param color3 defines the source Color3 to read from
  85670. * @param alpha defines the alpha component (1.0 by default)
  85671. * @returns a new Color4 object
  85672. */
  85673. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  85674. /**
  85675. * Creates a new Color4 from the starting index element of the given array
  85676. * @param array defines the source array to read from
  85677. * @param offset defines the offset in the source array
  85678. * @returns a new Color4 object
  85679. */
  85680. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  85681. /**
  85682. * Creates a new Color4 from the starting index element of the given array
  85683. * @param array defines the source array to read from
  85684. * @param offset defines the offset in the source array
  85685. * @param result defines the target Color4 object
  85686. */
  85687. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color4): void;
  85688. /**
  85689. * Creates a new Color3 from integer values (< 256)
  85690. * @param r defines the red component to read from (value between 0 and 255)
  85691. * @param g defines the green component to read from (value between 0 and 255)
  85692. * @param b defines the blue component to read from (value between 0 and 255)
  85693. * @param a defines the alpha component to read from (value between 0 and 255)
  85694. * @returns a new Color3 object
  85695. */
  85696. static FromInts(r: number, g: number, b: number, a: number): Color4;
  85697. /**
  85698. * Check the content of a given array and convert it to an array containing RGBA data
  85699. * If the original array was already containing count * 4 values then it is returned directly
  85700. * @param colors defines the array to check
  85701. * @param count defines the number of RGBA data to expect
  85702. * @returns an array containing count * 4 values (RGBA)
  85703. */
  85704. static CheckColors4(colors: number[], count: number): number[];
  85705. }
  85706. /**
  85707. * @hidden
  85708. */
  85709. export class TmpColors {
  85710. static Color3: Color3[];
  85711. static Color4: Color4[];
  85712. }
  85713. }
  85714. declare module BABYLON {
  85715. /**
  85716. * Defines an interface which represents an animation key frame
  85717. */
  85718. export interface IAnimationKey {
  85719. /**
  85720. * Frame of the key frame
  85721. */
  85722. frame: number;
  85723. /**
  85724. * Value at the specifies key frame
  85725. */
  85726. value: any;
  85727. /**
  85728. * The input tangent for the cubic hermite spline
  85729. */
  85730. inTangent?: any;
  85731. /**
  85732. * The output tangent for the cubic hermite spline
  85733. */
  85734. outTangent?: any;
  85735. /**
  85736. * The animation interpolation type
  85737. */
  85738. interpolation?: AnimationKeyInterpolation;
  85739. }
  85740. /**
  85741. * Enum for the animation key frame interpolation type
  85742. */
  85743. export enum AnimationKeyInterpolation {
  85744. /**
  85745. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  85746. */
  85747. STEP = 1
  85748. }
  85749. }
  85750. declare module BABYLON {
  85751. /**
  85752. * Represents the range of an animation
  85753. */
  85754. export class AnimationRange {
  85755. /**The name of the animation range**/
  85756. name: string;
  85757. /**The starting frame of the animation */
  85758. from: number;
  85759. /**The ending frame of the animation*/
  85760. to: number;
  85761. /**
  85762. * Initializes the range of an animation
  85763. * @param name The name of the animation range
  85764. * @param from The starting frame of the animation
  85765. * @param to The ending frame of the animation
  85766. */
  85767. constructor(
  85768. /**The name of the animation range**/
  85769. name: string,
  85770. /**The starting frame of the animation */
  85771. from: number,
  85772. /**The ending frame of the animation*/
  85773. to: number);
  85774. /**
  85775. * Makes a copy of the animation range
  85776. * @returns A copy of the animation range
  85777. */
  85778. clone(): AnimationRange;
  85779. }
  85780. }
  85781. declare module BABYLON {
  85782. /**
  85783. * Composed of a frame, and an action function
  85784. */
  85785. export class AnimationEvent {
  85786. /** The frame for which the event is triggered **/
  85787. frame: number;
  85788. /** The event to perform when triggered **/
  85789. action: (currentFrame: number) => void;
  85790. /** Specifies if the event should be triggered only once**/
  85791. onlyOnce?: boolean | undefined;
  85792. /**
  85793. * Specifies if the animation event is done
  85794. */
  85795. isDone: boolean;
  85796. /**
  85797. * Initializes the animation event
  85798. * @param frame The frame for which the event is triggered
  85799. * @param action The event to perform when triggered
  85800. * @param onlyOnce Specifies if the event should be triggered only once
  85801. */
  85802. constructor(
  85803. /** The frame for which the event is triggered **/
  85804. frame: number,
  85805. /** The event to perform when triggered **/
  85806. action: (currentFrame: number) => void,
  85807. /** Specifies if the event should be triggered only once**/
  85808. onlyOnce?: boolean | undefined);
  85809. /** @hidden */
  85810. _clone(): AnimationEvent;
  85811. }
  85812. }
  85813. declare module BABYLON {
  85814. /**
  85815. * Interface used to define a behavior
  85816. */
  85817. export interface Behavior<T> {
  85818. /** gets or sets behavior's name */
  85819. name: string;
  85820. /**
  85821. * Function called when the behavior needs to be initialized (after attaching it to a target)
  85822. */
  85823. init(): void;
  85824. /**
  85825. * Called when the behavior is attached to a target
  85826. * @param target defines the target where the behavior is attached to
  85827. */
  85828. attach(target: T): void;
  85829. /**
  85830. * Called when the behavior is detached from its target
  85831. */
  85832. detach(): void;
  85833. }
  85834. /**
  85835. * Interface implemented by classes supporting behaviors
  85836. */
  85837. export interface IBehaviorAware<T> {
  85838. /**
  85839. * Attach a behavior
  85840. * @param behavior defines the behavior to attach
  85841. * @returns the current host
  85842. */
  85843. addBehavior(behavior: Behavior<T>): T;
  85844. /**
  85845. * Remove a behavior from the current object
  85846. * @param behavior defines the behavior to detach
  85847. * @returns the current host
  85848. */
  85849. removeBehavior(behavior: Behavior<T>): T;
  85850. /**
  85851. * Gets a behavior using its name to search
  85852. * @param name defines the name to search
  85853. * @returns the behavior or null if not found
  85854. */
  85855. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  85856. }
  85857. }
  85858. declare module BABYLON {
  85859. /**
  85860. * Defines an array and its length.
  85861. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  85862. */
  85863. export interface ISmartArrayLike<T> {
  85864. /**
  85865. * The data of the array.
  85866. */
  85867. data: Array<T>;
  85868. /**
  85869. * The active length of the array.
  85870. */
  85871. length: number;
  85872. }
  85873. /**
  85874. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  85875. */
  85876. export class SmartArray<T> implements ISmartArrayLike<T> {
  85877. /**
  85878. * The full set of data from the array.
  85879. */
  85880. data: Array<T>;
  85881. /**
  85882. * The active length of the array.
  85883. */
  85884. length: number;
  85885. protected _id: number;
  85886. /**
  85887. * Instantiates a Smart Array.
  85888. * @param capacity defines the default capacity of the array.
  85889. */
  85890. constructor(capacity: number);
  85891. /**
  85892. * Pushes a value at the end of the active data.
  85893. * @param value defines the object to push in the array.
  85894. */
  85895. push(value: T): void;
  85896. /**
  85897. * Iterates over the active data and apply the lambda to them.
  85898. * @param func defines the action to apply on each value.
  85899. */
  85900. forEach(func: (content: T) => void): void;
  85901. /**
  85902. * Sorts the full sets of data.
  85903. * @param compareFn defines the comparison function to apply.
  85904. */
  85905. sort(compareFn: (a: T, b: T) => number): void;
  85906. /**
  85907. * Resets the active data to an empty array.
  85908. */
  85909. reset(): void;
  85910. /**
  85911. * Releases all the data from the array as well as the array.
  85912. */
  85913. dispose(): void;
  85914. /**
  85915. * Concats the active data with a given array.
  85916. * @param array defines the data to concatenate with.
  85917. */
  85918. concat(array: any): void;
  85919. /**
  85920. * Returns the position of a value in the active data.
  85921. * @param value defines the value to find the index for
  85922. * @returns the index if found in the active data otherwise -1
  85923. */
  85924. indexOf(value: T): number;
  85925. /**
  85926. * Returns whether an element is part of the active data.
  85927. * @param value defines the value to look for
  85928. * @returns true if found in the active data otherwise false
  85929. */
  85930. contains(value: T): boolean;
  85931. private static _GlobalId;
  85932. }
  85933. /**
  85934. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  85935. * The data in this array can only be present once
  85936. */
  85937. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  85938. private _duplicateId;
  85939. /**
  85940. * Pushes a value at the end of the active data.
  85941. * THIS DOES NOT PREVENT DUPPLICATE DATA
  85942. * @param value defines the object to push in the array.
  85943. */
  85944. push(value: T): void;
  85945. /**
  85946. * Pushes a value at the end of the active data.
  85947. * If the data is already present, it won t be added again
  85948. * @param value defines the object to push in the array.
  85949. * @returns true if added false if it was already present
  85950. */
  85951. pushNoDuplicate(value: T): boolean;
  85952. /**
  85953. * Resets the active data to an empty array.
  85954. */
  85955. reset(): void;
  85956. /**
  85957. * Concats the active data with a given array.
  85958. * This ensures no dupplicate will be present in the result.
  85959. * @param array defines the data to concatenate with.
  85960. */
  85961. concatWithNoDuplicate(array: any): void;
  85962. }
  85963. }
  85964. declare module BABYLON {
  85965. /**
  85966. * @ignore
  85967. * This is a list of all the different input types that are available in the application.
  85968. * Fo instance: ArcRotateCameraGamepadInput...
  85969. */
  85970. export var CameraInputTypes: {};
  85971. /**
  85972. * This is the contract to implement in order to create a new input class.
  85973. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  85974. */
  85975. export interface ICameraInput<TCamera extends Camera> {
  85976. /**
  85977. * Defines the camera the input is attached to.
  85978. */
  85979. camera: Nullable<TCamera>;
  85980. /**
  85981. * Gets the class name of the current intput.
  85982. * @returns the class name
  85983. */
  85984. getClassName(): string;
  85985. /**
  85986. * Get the friendly name associated with the input class.
  85987. * @returns the input friendly name
  85988. */
  85989. getSimpleName(): string;
  85990. /**
  85991. * Attach the input controls to a specific dom element to get the input from.
  85992. * @param element Defines the element the controls should be listened from
  85993. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  85994. */
  85995. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  85996. /**
  85997. * Detach the current controls from the specified dom element.
  85998. * @param element Defines the element to stop listening the inputs from
  85999. */
  86000. detachControl(element: Nullable<HTMLElement>): void;
  86001. /**
  86002. * Update the current camera state depending on the inputs that have been used this frame.
  86003. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  86004. */
  86005. checkInputs?: () => void;
  86006. }
  86007. /**
  86008. * Represents a map of input types to input instance or input index to input instance.
  86009. */
  86010. export interface CameraInputsMap<TCamera extends Camera> {
  86011. /**
  86012. * Accessor to the input by input type.
  86013. */
  86014. [name: string]: ICameraInput<TCamera>;
  86015. /**
  86016. * Accessor to the input by input index.
  86017. */
  86018. [idx: number]: ICameraInput<TCamera>;
  86019. }
  86020. /**
  86021. * This represents the input manager used within a camera.
  86022. * It helps dealing with all the different kind of input attached to a camera.
  86023. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  86024. */
  86025. export class CameraInputsManager<TCamera extends Camera> {
  86026. /**
  86027. * Defines the list of inputs attahed to the camera.
  86028. */
  86029. attached: CameraInputsMap<TCamera>;
  86030. /**
  86031. * Defines the dom element the camera is collecting inputs from.
  86032. * This is null if the controls have not been attached.
  86033. */
  86034. attachedElement: Nullable<HTMLElement>;
  86035. /**
  86036. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86037. */
  86038. noPreventDefault: boolean;
  86039. /**
  86040. * Defined the camera the input manager belongs to.
  86041. */
  86042. camera: TCamera;
  86043. /**
  86044. * Update the current camera state depending on the inputs that have been used this frame.
  86045. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  86046. */
  86047. checkInputs: () => void;
  86048. /**
  86049. * Instantiate a new Camera Input Manager.
  86050. * @param camera Defines the camera the input manager blongs to
  86051. */
  86052. constructor(camera: TCamera);
  86053. /**
  86054. * Add an input method to a camera
  86055. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  86056. * @param input camera input method
  86057. */
  86058. add(input: ICameraInput<TCamera>): void;
  86059. /**
  86060. * Remove a specific input method from a camera
  86061. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  86062. * @param inputToRemove camera input method
  86063. */
  86064. remove(inputToRemove: ICameraInput<TCamera>): void;
  86065. /**
  86066. * Remove a specific input type from a camera
  86067. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  86068. * @param inputType the type of the input to remove
  86069. */
  86070. removeByType(inputType: string): void;
  86071. private _addCheckInputs;
  86072. /**
  86073. * Attach the input controls to the currently attached dom element to listen the events from.
  86074. * @param input Defines the input to attach
  86075. */
  86076. attachInput(input: ICameraInput<TCamera>): void;
  86077. /**
  86078. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  86079. * @param element Defines the dom element to collect the events from
  86080. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86081. */
  86082. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  86083. /**
  86084. * Detach the current manager inputs controls from a specific dom element.
  86085. * @param element Defines the dom element to collect the events from
  86086. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  86087. */
  86088. detachElement(element: HTMLElement, disconnect?: boolean): void;
  86089. /**
  86090. * Rebuild the dynamic inputCheck function from the current list of
  86091. * defined inputs in the manager.
  86092. */
  86093. rebuildInputCheck(): void;
  86094. /**
  86095. * Remove all attached input methods from a camera
  86096. */
  86097. clear(): void;
  86098. /**
  86099. * Serialize the current input manager attached to a camera.
  86100. * This ensures than once parsed,
  86101. * the input associated to the camera will be identical to the current ones
  86102. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  86103. */
  86104. serialize(serializedCamera: any): void;
  86105. /**
  86106. * Parses an input manager serialized JSON to restore the previous list of inputs
  86107. * and states associated to a camera.
  86108. * @param parsedCamera Defines the JSON to parse
  86109. */
  86110. parse(parsedCamera: any): void;
  86111. }
  86112. }
  86113. declare module BABYLON {
  86114. /**
  86115. * Class used to store data that will be store in GPU memory
  86116. */
  86117. export class Buffer {
  86118. private _engine;
  86119. private _buffer;
  86120. /** @hidden */
  86121. _data: Nullable<DataArray>;
  86122. private _updatable;
  86123. private _instanced;
  86124. private _divisor;
  86125. /**
  86126. * Gets the byte stride.
  86127. */
  86128. readonly byteStride: number;
  86129. /**
  86130. * Constructor
  86131. * @param engine the engine
  86132. * @param data the data to use for this buffer
  86133. * @param updatable whether the data is updatable
  86134. * @param stride the stride (optional)
  86135. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  86136. * @param instanced whether the buffer is instanced (optional)
  86137. * @param useBytes set to true if the stride in in bytes (optional)
  86138. * @param divisor sets an optional divisor for instances (1 by default)
  86139. */
  86140. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  86141. /**
  86142. * Create a new VertexBuffer based on the current buffer
  86143. * @param kind defines the vertex buffer kind (position, normal, etc.)
  86144. * @param offset defines offset in the buffer (0 by default)
  86145. * @param size defines the size in floats of attributes (position is 3 for instance)
  86146. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  86147. * @param instanced defines if the vertex buffer contains indexed data
  86148. * @param useBytes defines if the offset and stride are in bytes *
  86149. * @param divisor sets an optional divisor for instances (1 by default)
  86150. * @returns the new vertex buffer
  86151. */
  86152. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  86153. /**
  86154. * Gets a boolean indicating if the Buffer is updatable?
  86155. * @returns true if the buffer is updatable
  86156. */
  86157. isUpdatable(): boolean;
  86158. /**
  86159. * Gets current buffer's data
  86160. * @returns a DataArray or null
  86161. */
  86162. getData(): Nullable<DataArray>;
  86163. /**
  86164. * Gets underlying native buffer
  86165. * @returns underlying native buffer
  86166. */
  86167. getBuffer(): Nullable<DataBuffer>;
  86168. /**
  86169. * Gets the stride in float32 units (i.e. byte stride / 4).
  86170. * May not be an integer if the byte stride is not divisible by 4.
  86171. * @returns the stride in float32 units
  86172. * @deprecated Please use byteStride instead.
  86173. */
  86174. getStrideSize(): number;
  86175. /**
  86176. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  86177. * @param data defines the data to store
  86178. */
  86179. create(data?: Nullable<DataArray>): void;
  86180. /** @hidden */
  86181. _rebuild(): void;
  86182. /**
  86183. * Update current buffer data
  86184. * @param data defines the data to store
  86185. */
  86186. update(data: DataArray): void;
  86187. /**
  86188. * Updates the data directly.
  86189. * @param data the new data
  86190. * @param offset the new offset
  86191. * @param vertexCount the vertex count (optional)
  86192. * @param useBytes set to true if the offset is in bytes
  86193. */
  86194. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  86195. /**
  86196. * Release all resources
  86197. */
  86198. dispose(): void;
  86199. }
  86200. /**
  86201. * Specialized buffer used to store vertex data
  86202. */
  86203. export class VertexBuffer {
  86204. /** @hidden */
  86205. _buffer: Buffer;
  86206. private _kind;
  86207. private _size;
  86208. private _ownsBuffer;
  86209. private _instanced;
  86210. private _instanceDivisor;
  86211. /**
  86212. * The byte type.
  86213. */
  86214. static readonly BYTE: number;
  86215. /**
  86216. * The unsigned byte type.
  86217. */
  86218. static readonly UNSIGNED_BYTE: number;
  86219. /**
  86220. * The short type.
  86221. */
  86222. static readonly SHORT: number;
  86223. /**
  86224. * The unsigned short type.
  86225. */
  86226. static readonly UNSIGNED_SHORT: number;
  86227. /**
  86228. * The integer type.
  86229. */
  86230. static readonly INT: number;
  86231. /**
  86232. * The unsigned integer type.
  86233. */
  86234. static readonly UNSIGNED_INT: number;
  86235. /**
  86236. * The float type.
  86237. */
  86238. static readonly FLOAT: number;
  86239. /**
  86240. * Gets or sets the instance divisor when in instanced mode
  86241. */
  86242. get instanceDivisor(): number;
  86243. set instanceDivisor(value: number);
  86244. /**
  86245. * Gets the byte stride.
  86246. */
  86247. readonly byteStride: number;
  86248. /**
  86249. * Gets the byte offset.
  86250. */
  86251. readonly byteOffset: number;
  86252. /**
  86253. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  86254. */
  86255. readonly normalized: boolean;
  86256. /**
  86257. * Gets the data type of each component in the array.
  86258. */
  86259. readonly type: number;
  86260. /**
  86261. * Constructor
  86262. * @param engine the engine
  86263. * @param data the data to use for this vertex buffer
  86264. * @param kind the vertex buffer kind
  86265. * @param updatable whether the data is updatable
  86266. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  86267. * @param stride the stride (optional)
  86268. * @param instanced whether the buffer is instanced (optional)
  86269. * @param offset the offset of the data (optional)
  86270. * @param size the number of components (optional)
  86271. * @param type the type of the component (optional)
  86272. * @param normalized whether the data contains normalized data (optional)
  86273. * @param useBytes set to true if stride and offset are in bytes (optional)
  86274. * @param divisor defines the instance divisor to use (1 by default)
  86275. */
  86276. 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);
  86277. /** @hidden */
  86278. _rebuild(): void;
  86279. /**
  86280. * Returns the kind of the VertexBuffer (string)
  86281. * @returns a string
  86282. */
  86283. getKind(): string;
  86284. /**
  86285. * Gets a boolean indicating if the VertexBuffer is updatable?
  86286. * @returns true if the buffer is updatable
  86287. */
  86288. isUpdatable(): boolean;
  86289. /**
  86290. * Gets current buffer's data
  86291. * @returns a DataArray or null
  86292. */
  86293. getData(): Nullable<DataArray>;
  86294. /**
  86295. * Gets underlying native buffer
  86296. * @returns underlying native buffer
  86297. */
  86298. getBuffer(): Nullable<DataBuffer>;
  86299. /**
  86300. * Gets the stride in float32 units (i.e. byte stride / 4).
  86301. * May not be an integer if the byte stride is not divisible by 4.
  86302. * @returns the stride in float32 units
  86303. * @deprecated Please use byteStride instead.
  86304. */
  86305. getStrideSize(): number;
  86306. /**
  86307. * Returns the offset as a multiple of the type byte length.
  86308. * @returns the offset in bytes
  86309. * @deprecated Please use byteOffset instead.
  86310. */
  86311. getOffset(): number;
  86312. /**
  86313. * Returns the number of components per vertex attribute (integer)
  86314. * @returns the size in float
  86315. */
  86316. getSize(): number;
  86317. /**
  86318. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  86319. * @returns true if this buffer is instanced
  86320. */
  86321. getIsInstanced(): boolean;
  86322. /**
  86323. * Returns the instancing divisor, zero for non-instanced (integer).
  86324. * @returns a number
  86325. */
  86326. getInstanceDivisor(): number;
  86327. /**
  86328. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  86329. * @param data defines the data to store
  86330. */
  86331. create(data?: DataArray): void;
  86332. /**
  86333. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  86334. * This function will create a new buffer if the current one is not updatable
  86335. * @param data defines the data to store
  86336. */
  86337. update(data: DataArray): void;
  86338. /**
  86339. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  86340. * Returns the directly updated WebGLBuffer.
  86341. * @param data the new data
  86342. * @param offset the new offset
  86343. * @param useBytes set to true if the offset is in bytes
  86344. */
  86345. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  86346. /**
  86347. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  86348. */
  86349. dispose(): void;
  86350. /**
  86351. * Enumerates each value of this vertex buffer as numbers.
  86352. * @param count the number of values to enumerate
  86353. * @param callback the callback function called for each value
  86354. */
  86355. forEach(count: number, callback: (value: number, index: number) => void): void;
  86356. /**
  86357. * Positions
  86358. */
  86359. static readonly PositionKind: string;
  86360. /**
  86361. * Normals
  86362. */
  86363. static readonly NormalKind: string;
  86364. /**
  86365. * Tangents
  86366. */
  86367. static readonly TangentKind: string;
  86368. /**
  86369. * Texture coordinates
  86370. */
  86371. static readonly UVKind: string;
  86372. /**
  86373. * Texture coordinates 2
  86374. */
  86375. static readonly UV2Kind: string;
  86376. /**
  86377. * Texture coordinates 3
  86378. */
  86379. static readonly UV3Kind: string;
  86380. /**
  86381. * Texture coordinates 4
  86382. */
  86383. static readonly UV4Kind: string;
  86384. /**
  86385. * Texture coordinates 5
  86386. */
  86387. static readonly UV5Kind: string;
  86388. /**
  86389. * Texture coordinates 6
  86390. */
  86391. static readonly UV6Kind: string;
  86392. /**
  86393. * Colors
  86394. */
  86395. static readonly ColorKind: string;
  86396. /**
  86397. * Matrix indices (for bones)
  86398. */
  86399. static readonly MatricesIndicesKind: string;
  86400. /**
  86401. * Matrix weights (for bones)
  86402. */
  86403. static readonly MatricesWeightsKind: string;
  86404. /**
  86405. * Additional matrix indices (for bones)
  86406. */
  86407. static readonly MatricesIndicesExtraKind: string;
  86408. /**
  86409. * Additional matrix weights (for bones)
  86410. */
  86411. static readonly MatricesWeightsExtraKind: string;
  86412. /**
  86413. * Deduces the stride given a kind.
  86414. * @param kind The kind string to deduce
  86415. * @returns The deduced stride
  86416. */
  86417. static DeduceStride(kind: string): number;
  86418. /**
  86419. * Gets the byte length of the given type.
  86420. * @param type the type
  86421. * @returns the number of bytes
  86422. */
  86423. static GetTypeByteLength(type: number): number;
  86424. /**
  86425. * Enumerates each value of the given parameters as numbers.
  86426. * @param data the data to enumerate
  86427. * @param byteOffset the byte offset of the data
  86428. * @param byteStride the byte stride of the data
  86429. * @param componentCount the number of components per element
  86430. * @param componentType the type of the component
  86431. * @param count the number of values to enumerate
  86432. * @param normalized whether the data is normalized
  86433. * @param callback the callback function called for each value
  86434. */
  86435. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  86436. private static _GetFloatValue;
  86437. }
  86438. }
  86439. declare module BABYLON {
  86440. /**
  86441. * @hidden
  86442. */
  86443. export class IntersectionInfo {
  86444. bu: Nullable<number>;
  86445. bv: Nullable<number>;
  86446. distance: number;
  86447. faceId: number;
  86448. subMeshId: number;
  86449. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  86450. }
  86451. }
  86452. declare module BABYLON {
  86453. /**
  86454. * Class used to store bounding sphere information
  86455. */
  86456. export class BoundingSphere {
  86457. /**
  86458. * Gets the center of the bounding sphere in local space
  86459. */
  86460. readonly center: Vector3;
  86461. /**
  86462. * Radius of the bounding sphere in local space
  86463. */
  86464. radius: number;
  86465. /**
  86466. * Gets the center of the bounding sphere in world space
  86467. */
  86468. readonly centerWorld: Vector3;
  86469. /**
  86470. * Radius of the bounding sphere in world space
  86471. */
  86472. radiusWorld: number;
  86473. /**
  86474. * Gets the minimum vector in local space
  86475. */
  86476. readonly minimum: Vector3;
  86477. /**
  86478. * Gets the maximum vector in local space
  86479. */
  86480. readonly maximum: Vector3;
  86481. private _worldMatrix;
  86482. private static readonly TmpVector3;
  86483. /**
  86484. * Creates a new bounding sphere
  86485. * @param min defines the minimum vector (in local space)
  86486. * @param max defines the maximum vector (in local space)
  86487. * @param worldMatrix defines the new world matrix
  86488. */
  86489. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86490. /**
  86491. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  86492. * @param min defines the new minimum vector (in local space)
  86493. * @param max defines the new maximum vector (in local space)
  86494. * @param worldMatrix defines the new world matrix
  86495. */
  86496. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86497. /**
  86498. * Scale the current bounding sphere by applying a scale factor
  86499. * @param factor defines the scale factor to apply
  86500. * @returns the current bounding box
  86501. */
  86502. scale(factor: number): BoundingSphere;
  86503. /**
  86504. * Gets the world matrix of the bounding box
  86505. * @returns a matrix
  86506. */
  86507. getWorldMatrix(): DeepImmutable<Matrix>;
  86508. /** @hidden */
  86509. _update(worldMatrix: DeepImmutable<Matrix>): void;
  86510. /**
  86511. * Tests if the bounding sphere is intersecting the frustum planes
  86512. * @param frustumPlanes defines the frustum planes to test
  86513. * @returns true if there is an intersection
  86514. */
  86515. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86516. /**
  86517. * Tests if the bounding sphere center is in between the frustum planes.
  86518. * Used for optimistic fast inclusion.
  86519. * @param frustumPlanes defines the frustum planes to test
  86520. * @returns true if the sphere center is in between the frustum planes
  86521. */
  86522. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86523. /**
  86524. * Tests if a point is inside the bounding sphere
  86525. * @param point defines the point to test
  86526. * @returns true if the point is inside the bounding sphere
  86527. */
  86528. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86529. /**
  86530. * Checks if two sphere intersct
  86531. * @param sphere0 sphere 0
  86532. * @param sphere1 sphere 1
  86533. * @returns true if the speres intersect
  86534. */
  86535. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  86536. }
  86537. }
  86538. declare module BABYLON {
  86539. /**
  86540. * Class used to store bounding box information
  86541. */
  86542. export class BoundingBox implements ICullable {
  86543. /**
  86544. * Gets the 8 vectors representing the bounding box in local space
  86545. */
  86546. readonly vectors: Vector3[];
  86547. /**
  86548. * Gets the center of the bounding box in local space
  86549. */
  86550. readonly center: Vector3;
  86551. /**
  86552. * Gets the center of the bounding box in world space
  86553. */
  86554. readonly centerWorld: Vector3;
  86555. /**
  86556. * Gets the extend size in local space
  86557. */
  86558. readonly extendSize: Vector3;
  86559. /**
  86560. * Gets the extend size in world space
  86561. */
  86562. readonly extendSizeWorld: Vector3;
  86563. /**
  86564. * Gets the OBB (object bounding box) directions
  86565. */
  86566. readonly directions: Vector3[];
  86567. /**
  86568. * Gets the 8 vectors representing the bounding box in world space
  86569. */
  86570. readonly vectorsWorld: Vector3[];
  86571. /**
  86572. * Gets the minimum vector in world space
  86573. */
  86574. readonly minimumWorld: Vector3;
  86575. /**
  86576. * Gets the maximum vector in world space
  86577. */
  86578. readonly maximumWorld: Vector3;
  86579. /**
  86580. * Gets the minimum vector in local space
  86581. */
  86582. readonly minimum: Vector3;
  86583. /**
  86584. * Gets the maximum vector in local space
  86585. */
  86586. readonly maximum: Vector3;
  86587. private _worldMatrix;
  86588. private static readonly TmpVector3;
  86589. /**
  86590. * @hidden
  86591. */
  86592. _tag: number;
  86593. /**
  86594. * Creates a new bounding box
  86595. * @param min defines the minimum vector (in local space)
  86596. * @param max defines the maximum vector (in local space)
  86597. * @param worldMatrix defines the new world matrix
  86598. */
  86599. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86600. /**
  86601. * Recreates the entire bounding box from scratch as if we call the constructor in place
  86602. * @param min defines the new minimum vector (in local space)
  86603. * @param max defines the new maximum vector (in local space)
  86604. * @param worldMatrix defines the new world matrix
  86605. */
  86606. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86607. /**
  86608. * Scale the current bounding box by applying a scale factor
  86609. * @param factor defines the scale factor to apply
  86610. * @returns the current bounding box
  86611. */
  86612. scale(factor: number): BoundingBox;
  86613. /**
  86614. * Gets the world matrix of the bounding box
  86615. * @returns a matrix
  86616. */
  86617. getWorldMatrix(): DeepImmutable<Matrix>;
  86618. /** @hidden */
  86619. _update(world: DeepImmutable<Matrix>): void;
  86620. /**
  86621. * Tests if the bounding box is intersecting the frustum planes
  86622. * @param frustumPlanes defines the frustum planes to test
  86623. * @returns true if there is an intersection
  86624. */
  86625. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86626. /**
  86627. * Tests if the bounding box is entirely inside the frustum planes
  86628. * @param frustumPlanes defines the frustum planes to test
  86629. * @returns true if there is an inclusion
  86630. */
  86631. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86632. /**
  86633. * Tests if a point is inside the bounding box
  86634. * @param point defines the point to test
  86635. * @returns true if the point is inside the bounding box
  86636. */
  86637. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86638. /**
  86639. * Tests if the bounding box intersects with a bounding sphere
  86640. * @param sphere defines the sphere to test
  86641. * @returns true if there is an intersection
  86642. */
  86643. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  86644. /**
  86645. * Tests if the bounding box intersects with a box defined by a min and max vectors
  86646. * @param min defines the min vector to use
  86647. * @param max defines the max vector to use
  86648. * @returns true if there is an intersection
  86649. */
  86650. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  86651. /**
  86652. * Tests if two bounding boxes are intersections
  86653. * @param box0 defines the first box to test
  86654. * @param box1 defines the second box to test
  86655. * @returns true if there is an intersection
  86656. */
  86657. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  86658. /**
  86659. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  86660. * @param minPoint defines the minimum vector of the bounding box
  86661. * @param maxPoint defines the maximum vector of the bounding box
  86662. * @param sphereCenter defines the sphere center
  86663. * @param sphereRadius defines the sphere radius
  86664. * @returns true if there is an intersection
  86665. */
  86666. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  86667. /**
  86668. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  86669. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  86670. * @param frustumPlanes defines the frustum planes to test
  86671. * @return true if there is an inclusion
  86672. */
  86673. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86674. /**
  86675. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  86676. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  86677. * @param frustumPlanes defines the frustum planes to test
  86678. * @return true if there is an intersection
  86679. */
  86680. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86681. }
  86682. }
  86683. declare module BABYLON {
  86684. /** @hidden */
  86685. export class Collider {
  86686. /** Define if a collision was found */
  86687. collisionFound: boolean;
  86688. /**
  86689. * Define last intersection point in local space
  86690. */
  86691. intersectionPoint: Vector3;
  86692. /**
  86693. * Define last collided mesh
  86694. */
  86695. collidedMesh: Nullable<AbstractMesh>;
  86696. private _collisionPoint;
  86697. private _planeIntersectionPoint;
  86698. private _tempVector;
  86699. private _tempVector2;
  86700. private _tempVector3;
  86701. private _tempVector4;
  86702. private _edge;
  86703. private _baseToVertex;
  86704. private _destinationPoint;
  86705. private _slidePlaneNormal;
  86706. private _displacementVector;
  86707. /** @hidden */
  86708. _radius: Vector3;
  86709. /** @hidden */
  86710. _retry: number;
  86711. private _velocity;
  86712. private _basePoint;
  86713. private _epsilon;
  86714. /** @hidden */
  86715. _velocityWorldLength: number;
  86716. /** @hidden */
  86717. _basePointWorld: Vector3;
  86718. private _velocityWorld;
  86719. private _normalizedVelocity;
  86720. /** @hidden */
  86721. _initialVelocity: Vector3;
  86722. /** @hidden */
  86723. _initialPosition: Vector3;
  86724. private _nearestDistance;
  86725. private _collisionMask;
  86726. get collisionMask(): number;
  86727. set collisionMask(mask: number);
  86728. /**
  86729. * Gets the plane normal used to compute the sliding response (in local space)
  86730. */
  86731. get slidePlaneNormal(): Vector3;
  86732. /** @hidden */
  86733. _initialize(source: Vector3, dir: Vector3, e: number): void;
  86734. /** @hidden */
  86735. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  86736. /** @hidden */
  86737. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  86738. /** @hidden */
  86739. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  86740. /** @hidden */
  86741. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  86742. /** @hidden */
  86743. _getResponse(pos: Vector3, vel: Vector3): void;
  86744. }
  86745. }
  86746. declare module BABYLON {
  86747. /**
  86748. * Interface for cullable objects
  86749. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  86750. */
  86751. export interface ICullable {
  86752. /**
  86753. * Checks if the object or part of the object is in the frustum
  86754. * @param frustumPlanes Camera near/planes
  86755. * @returns true if the object is in frustum otherwise false
  86756. */
  86757. isInFrustum(frustumPlanes: Plane[]): boolean;
  86758. /**
  86759. * Checks if a cullable object (mesh...) is in the camera frustum
  86760. * Unlike isInFrustum this cheks the full bounding box
  86761. * @param frustumPlanes Camera near/planes
  86762. * @returns true if the object is in frustum otherwise false
  86763. */
  86764. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  86765. }
  86766. /**
  86767. * Info for a bounding data of a mesh
  86768. */
  86769. export class BoundingInfo implements ICullable {
  86770. /**
  86771. * Bounding box for the mesh
  86772. */
  86773. readonly boundingBox: BoundingBox;
  86774. /**
  86775. * Bounding sphere for the mesh
  86776. */
  86777. readonly boundingSphere: BoundingSphere;
  86778. private _isLocked;
  86779. private static readonly TmpVector3;
  86780. /**
  86781. * Constructs bounding info
  86782. * @param minimum min vector of the bounding box/sphere
  86783. * @param maximum max vector of the bounding box/sphere
  86784. * @param worldMatrix defines the new world matrix
  86785. */
  86786. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86787. /**
  86788. * Recreates the entire bounding info from scratch as if we call the constructor in place
  86789. * @param min defines the new minimum vector (in local space)
  86790. * @param max defines the new maximum vector (in local space)
  86791. * @param worldMatrix defines the new world matrix
  86792. */
  86793. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86794. /**
  86795. * min vector of the bounding box/sphere
  86796. */
  86797. get minimum(): Vector3;
  86798. /**
  86799. * max vector of the bounding box/sphere
  86800. */
  86801. get maximum(): Vector3;
  86802. /**
  86803. * If the info is locked and won't be updated to avoid perf overhead
  86804. */
  86805. get isLocked(): boolean;
  86806. set isLocked(value: boolean);
  86807. /**
  86808. * Updates the bounding sphere and box
  86809. * @param world world matrix to be used to update
  86810. */
  86811. update(world: DeepImmutable<Matrix>): void;
  86812. /**
  86813. * Recreate the bounding info to be centered around a specific point given a specific extend.
  86814. * @param center New center of the bounding info
  86815. * @param extend New extend of the bounding info
  86816. * @returns the current bounding info
  86817. */
  86818. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  86819. /**
  86820. * Scale the current bounding info by applying a scale factor
  86821. * @param factor defines the scale factor to apply
  86822. * @returns the current bounding info
  86823. */
  86824. scale(factor: number): BoundingInfo;
  86825. /**
  86826. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  86827. * @param frustumPlanes defines the frustum to test
  86828. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  86829. * @returns true if the bounding info is in the frustum planes
  86830. */
  86831. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  86832. /**
  86833. * Gets the world distance between the min and max points of the bounding box
  86834. */
  86835. get diagonalLength(): number;
  86836. /**
  86837. * Checks if a cullable object (mesh...) is in the camera frustum
  86838. * Unlike isInFrustum this cheks the full bounding box
  86839. * @param frustumPlanes Camera near/planes
  86840. * @returns true if the object is in frustum otherwise false
  86841. */
  86842. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86843. /** @hidden */
  86844. _checkCollision(collider: Collider): boolean;
  86845. /**
  86846. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  86847. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  86848. * @param point the point to check intersection with
  86849. * @returns if the point intersects
  86850. */
  86851. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86852. /**
  86853. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  86854. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  86855. * @param boundingInfo the bounding info to check intersection with
  86856. * @param precise if the intersection should be done using OBB
  86857. * @returns if the bounding info intersects
  86858. */
  86859. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  86860. }
  86861. }
  86862. declare module BABYLON {
  86863. /**
  86864. * Extracts minimum and maximum values from a list of indexed positions
  86865. * @param positions defines the positions to use
  86866. * @param indices defines the indices to the positions
  86867. * @param indexStart defines the start index
  86868. * @param indexCount defines the end index
  86869. * @param bias defines bias value to add to the result
  86870. * @return minimum and maximum values
  86871. */
  86872. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  86873. minimum: Vector3;
  86874. maximum: Vector3;
  86875. };
  86876. /**
  86877. * Extracts minimum and maximum values from a list of positions
  86878. * @param positions defines the positions to use
  86879. * @param start defines the start index in the positions array
  86880. * @param count defines the number of positions to handle
  86881. * @param bias defines bias value to add to the result
  86882. * @param stride defines the stride size to use (distance between two positions in the positions array)
  86883. * @return minimum and maximum values
  86884. */
  86885. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  86886. minimum: Vector3;
  86887. maximum: Vector3;
  86888. };
  86889. }
  86890. declare module BABYLON {
  86891. /** @hidden */
  86892. export class WebGLDataBuffer extends DataBuffer {
  86893. private _buffer;
  86894. constructor(resource: WebGLBuffer);
  86895. get underlyingResource(): any;
  86896. }
  86897. }
  86898. declare module BABYLON {
  86899. /** @hidden */
  86900. export class WebGLPipelineContext implements IPipelineContext {
  86901. engine: ThinEngine;
  86902. program: Nullable<WebGLProgram>;
  86903. context?: WebGLRenderingContext;
  86904. vertexShader?: WebGLShader;
  86905. fragmentShader?: WebGLShader;
  86906. isParallelCompiled: boolean;
  86907. onCompiled?: () => void;
  86908. transformFeedback?: WebGLTransformFeedback | null;
  86909. vertexCompilationError: Nullable<string>;
  86910. fragmentCompilationError: Nullable<string>;
  86911. programLinkError: Nullable<string>;
  86912. programValidationError: Nullable<string>;
  86913. get isAsync(): boolean;
  86914. get isReady(): boolean;
  86915. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  86916. _getVertexShaderCode(): string | null;
  86917. _getFragmentShaderCode(): string | null;
  86918. }
  86919. }
  86920. declare module BABYLON {
  86921. interface ThinEngine {
  86922. /**
  86923. * Create an uniform buffer
  86924. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  86925. * @param elements defines the content of the uniform buffer
  86926. * @returns the webGL uniform buffer
  86927. */
  86928. createUniformBuffer(elements: FloatArray): DataBuffer;
  86929. /**
  86930. * Create a dynamic uniform buffer
  86931. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  86932. * @param elements defines the content of the uniform buffer
  86933. * @returns the webGL uniform buffer
  86934. */
  86935. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  86936. /**
  86937. * Update an existing uniform buffer
  86938. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  86939. * @param uniformBuffer defines the target uniform buffer
  86940. * @param elements defines the content to update
  86941. * @param offset defines the offset in the uniform buffer where update should start
  86942. * @param count defines the size of the data to update
  86943. */
  86944. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  86945. /**
  86946. * Bind an uniform buffer to the current webGL context
  86947. * @param buffer defines the buffer to bind
  86948. */
  86949. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  86950. /**
  86951. * Bind a buffer to the current webGL context at a given location
  86952. * @param buffer defines the buffer to bind
  86953. * @param location defines the index where to bind the buffer
  86954. */
  86955. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  86956. /**
  86957. * Bind a specific block at a given index in a specific shader program
  86958. * @param pipelineContext defines the pipeline context to use
  86959. * @param blockName defines the block name
  86960. * @param index defines the index where to bind the block
  86961. */
  86962. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  86963. }
  86964. }
  86965. declare module BABYLON {
  86966. /**
  86967. * Uniform buffer objects.
  86968. *
  86969. * Handles blocks of uniform on the GPU.
  86970. *
  86971. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  86972. *
  86973. * For more information, please refer to :
  86974. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  86975. */
  86976. export class UniformBuffer {
  86977. private _engine;
  86978. private _buffer;
  86979. private _data;
  86980. private _bufferData;
  86981. private _dynamic?;
  86982. private _uniformLocations;
  86983. private _uniformSizes;
  86984. private _uniformLocationPointer;
  86985. private _needSync;
  86986. private _noUBO;
  86987. private _currentEffect;
  86988. /** @hidden */
  86989. _alreadyBound: boolean;
  86990. private static _MAX_UNIFORM_SIZE;
  86991. private static _tempBuffer;
  86992. /**
  86993. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  86994. * This is dynamic to allow compat with webgl 1 and 2.
  86995. * You will need to pass the name of the uniform as well as the value.
  86996. */
  86997. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  86998. /**
  86999. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  87000. * This is dynamic to allow compat with webgl 1 and 2.
  87001. * You will need to pass the name of the uniform as well as the value.
  87002. */
  87003. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  87004. /**
  87005. * Lambda to Update a single float in a uniform buffer.
  87006. * This is dynamic to allow compat with webgl 1 and 2.
  87007. * You will need to pass the name of the uniform as well as the value.
  87008. */
  87009. updateFloat: (name: string, x: number) => void;
  87010. /**
  87011. * Lambda to Update a vec2 of float in a uniform buffer.
  87012. * This is dynamic to allow compat with webgl 1 and 2.
  87013. * You will need to pass the name of the uniform as well as the value.
  87014. */
  87015. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  87016. /**
  87017. * Lambda to Update a vec3 of float in a uniform buffer.
  87018. * This is dynamic to allow compat with webgl 1 and 2.
  87019. * You will need to pass the name of the uniform as well as the value.
  87020. */
  87021. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  87022. /**
  87023. * Lambda to Update a vec4 of float in a uniform buffer.
  87024. * This is dynamic to allow compat with webgl 1 and 2.
  87025. * You will need to pass the name of the uniform as well as the value.
  87026. */
  87027. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  87028. /**
  87029. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  87030. * This is dynamic to allow compat with webgl 1 and 2.
  87031. * You will need to pass the name of the uniform as well as the value.
  87032. */
  87033. updateMatrix: (name: string, mat: Matrix) => void;
  87034. /**
  87035. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  87036. * This is dynamic to allow compat with webgl 1 and 2.
  87037. * You will need to pass the name of the uniform as well as the value.
  87038. */
  87039. updateVector3: (name: string, vector: Vector3) => void;
  87040. /**
  87041. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  87042. * This is dynamic to allow compat with webgl 1 and 2.
  87043. * You will need to pass the name of the uniform as well as the value.
  87044. */
  87045. updateVector4: (name: string, vector: Vector4) => void;
  87046. /**
  87047. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  87048. * This is dynamic to allow compat with webgl 1 and 2.
  87049. * You will need to pass the name of the uniform as well as the value.
  87050. */
  87051. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  87052. /**
  87053. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  87054. * This is dynamic to allow compat with webgl 1 and 2.
  87055. * You will need to pass the name of the uniform as well as the value.
  87056. */
  87057. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  87058. /**
  87059. * Instantiates a new Uniform buffer objects.
  87060. *
  87061. * Handles blocks of uniform on the GPU.
  87062. *
  87063. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  87064. *
  87065. * For more information, please refer to :
  87066. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  87067. * @param engine Define the engine the buffer is associated with
  87068. * @param data Define the data contained in the buffer
  87069. * @param dynamic Define if the buffer is updatable
  87070. */
  87071. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  87072. /**
  87073. * Indicates if the buffer is using the WebGL2 UBO implementation,
  87074. * or just falling back on setUniformXXX calls.
  87075. */
  87076. get useUbo(): boolean;
  87077. /**
  87078. * Indicates if the WebGL underlying uniform buffer is in sync
  87079. * with the javascript cache data.
  87080. */
  87081. get isSync(): boolean;
  87082. /**
  87083. * Indicates if the WebGL underlying uniform buffer is dynamic.
  87084. * Also, a dynamic UniformBuffer will disable cache verification and always
  87085. * update the underlying WebGL uniform buffer to the GPU.
  87086. * @returns if Dynamic, otherwise false
  87087. */
  87088. isDynamic(): boolean;
  87089. /**
  87090. * The data cache on JS side.
  87091. * @returns the underlying data as a float array
  87092. */
  87093. getData(): Float32Array;
  87094. /**
  87095. * The underlying WebGL Uniform buffer.
  87096. * @returns the webgl buffer
  87097. */
  87098. getBuffer(): Nullable<DataBuffer>;
  87099. /**
  87100. * std140 layout specifies how to align data within an UBO structure.
  87101. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  87102. * for specs.
  87103. */
  87104. private _fillAlignment;
  87105. /**
  87106. * Adds an uniform in the buffer.
  87107. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  87108. * for the layout to be correct !
  87109. * @param name Name of the uniform, as used in the uniform block in the shader.
  87110. * @param size Data size, or data directly.
  87111. */
  87112. addUniform(name: string, size: number | number[]): void;
  87113. /**
  87114. * Adds a Matrix 4x4 to the uniform buffer.
  87115. * @param name Name of the uniform, as used in the uniform block in the shader.
  87116. * @param mat A 4x4 matrix.
  87117. */
  87118. addMatrix(name: string, mat: Matrix): void;
  87119. /**
  87120. * Adds a vec2 to the uniform buffer.
  87121. * @param name Name of the uniform, as used in the uniform block in the shader.
  87122. * @param x Define the x component value of the vec2
  87123. * @param y Define the y component value of the vec2
  87124. */
  87125. addFloat2(name: string, x: number, y: number): void;
  87126. /**
  87127. * Adds a vec3 to the uniform buffer.
  87128. * @param name Name of the uniform, as used in the uniform block in the shader.
  87129. * @param x Define the x component value of the vec3
  87130. * @param y Define the y component value of the vec3
  87131. * @param z Define the z component value of the vec3
  87132. */
  87133. addFloat3(name: string, x: number, y: number, z: number): void;
  87134. /**
  87135. * Adds a vec3 to the uniform buffer.
  87136. * @param name Name of the uniform, as used in the uniform block in the shader.
  87137. * @param color Define the vec3 from a Color
  87138. */
  87139. addColor3(name: string, color: Color3): void;
  87140. /**
  87141. * Adds a vec4 to the uniform buffer.
  87142. * @param name Name of the uniform, as used in the uniform block in the shader.
  87143. * @param color Define the rgb components from a Color
  87144. * @param alpha Define the a component of the vec4
  87145. */
  87146. addColor4(name: string, color: Color3, alpha: number): void;
  87147. /**
  87148. * Adds a vec3 to the uniform buffer.
  87149. * @param name Name of the uniform, as used in the uniform block in the shader.
  87150. * @param vector Define the vec3 components from a Vector
  87151. */
  87152. addVector3(name: string, vector: Vector3): void;
  87153. /**
  87154. * Adds a Matrix 3x3 to the uniform buffer.
  87155. * @param name Name of the uniform, as used in the uniform block in the shader.
  87156. */
  87157. addMatrix3x3(name: string): void;
  87158. /**
  87159. * Adds a Matrix 2x2 to the uniform buffer.
  87160. * @param name Name of the uniform, as used in the uniform block in the shader.
  87161. */
  87162. addMatrix2x2(name: string): void;
  87163. /**
  87164. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  87165. */
  87166. create(): void;
  87167. /** @hidden */
  87168. _rebuild(): void;
  87169. /**
  87170. * Updates the WebGL Uniform Buffer on the GPU.
  87171. * If the `dynamic` flag is set to true, no cache comparison is done.
  87172. * Otherwise, the buffer will be updated only if the cache differs.
  87173. */
  87174. update(): void;
  87175. /**
  87176. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  87177. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  87178. * @param data Define the flattened data
  87179. * @param size Define the size of the data.
  87180. */
  87181. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  87182. private _valueCache;
  87183. private _cacheMatrix;
  87184. private _updateMatrix3x3ForUniform;
  87185. private _updateMatrix3x3ForEffect;
  87186. private _updateMatrix2x2ForEffect;
  87187. private _updateMatrix2x2ForUniform;
  87188. private _updateFloatForEffect;
  87189. private _updateFloatForUniform;
  87190. private _updateFloat2ForEffect;
  87191. private _updateFloat2ForUniform;
  87192. private _updateFloat3ForEffect;
  87193. private _updateFloat3ForUniform;
  87194. private _updateFloat4ForEffect;
  87195. private _updateFloat4ForUniform;
  87196. private _updateMatrixForEffect;
  87197. private _updateMatrixForUniform;
  87198. private _updateVector3ForEffect;
  87199. private _updateVector3ForUniform;
  87200. private _updateVector4ForEffect;
  87201. private _updateVector4ForUniform;
  87202. private _updateColor3ForEffect;
  87203. private _updateColor3ForUniform;
  87204. private _updateColor4ForEffect;
  87205. private _updateColor4ForUniform;
  87206. /**
  87207. * Sets a sampler uniform on the effect.
  87208. * @param name Define the name of the sampler.
  87209. * @param texture Define the texture to set in the sampler
  87210. */
  87211. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  87212. /**
  87213. * Directly updates the value of the uniform in the cache AND on the GPU.
  87214. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  87215. * @param data Define the flattened data
  87216. */
  87217. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  87218. /**
  87219. * Binds this uniform buffer to an effect.
  87220. * @param effect Define the effect to bind the buffer to
  87221. * @param name Name of the uniform block in the shader.
  87222. */
  87223. bindToEffect(effect: Effect, name: string): void;
  87224. /**
  87225. * Disposes the uniform buffer.
  87226. */
  87227. dispose(): void;
  87228. }
  87229. }
  87230. declare module BABYLON {
  87231. /**
  87232. * Enum that determines the text-wrapping mode to use.
  87233. */
  87234. export enum InspectableType {
  87235. /**
  87236. * Checkbox for booleans
  87237. */
  87238. Checkbox = 0,
  87239. /**
  87240. * Sliders for numbers
  87241. */
  87242. Slider = 1,
  87243. /**
  87244. * Vector3
  87245. */
  87246. Vector3 = 2,
  87247. /**
  87248. * Quaternions
  87249. */
  87250. Quaternion = 3,
  87251. /**
  87252. * Color3
  87253. */
  87254. Color3 = 4,
  87255. /**
  87256. * String
  87257. */
  87258. String = 5
  87259. }
  87260. /**
  87261. * Interface used to define custom inspectable properties.
  87262. * This interface is used by the inspector to display custom property grids
  87263. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  87264. */
  87265. export interface IInspectable {
  87266. /**
  87267. * Gets the label to display
  87268. */
  87269. label: string;
  87270. /**
  87271. * Gets the name of the property to edit
  87272. */
  87273. propertyName: string;
  87274. /**
  87275. * Gets the type of the editor to use
  87276. */
  87277. type: InspectableType;
  87278. /**
  87279. * Gets the minimum value of the property when using in "slider" mode
  87280. */
  87281. min?: number;
  87282. /**
  87283. * Gets the maximum value of the property when using in "slider" mode
  87284. */
  87285. max?: number;
  87286. /**
  87287. * Gets the setp to use when using in "slider" mode
  87288. */
  87289. step?: number;
  87290. }
  87291. }
  87292. declare module BABYLON {
  87293. /**
  87294. * Class used to provide helper for timing
  87295. */
  87296. export class TimingTools {
  87297. /**
  87298. * Polyfill for setImmediate
  87299. * @param action defines the action to execute after the current execution block
  87300. */
  87301. static SetImmediate(action: () => void): void;
  87302. }
  87303. }
  87304. declare module BABYLON {
  87305. /**
  87306. * Class used to enable instatition of objects by class name
  87307. */
  87308. export class InstantiationTools {
  87309. /**
  87310. * Use this object to register external classes like custom textures or material
  87311. * to allow the laoders to instantiate them
  87312. */
  87313. static RegisteredExternalClasses: {
  87314. [key: string]: Object;
  87315. };
  87316. /**
  87317. * Tries to instantiate a new object from a given class name
  87318. * @param className defines the class name to instantiate
  87319. * @returns the new object or null if the system was not able to do the instantiation
  87320. */
  87321. static Instantiate(className: string): any;
  87322. }
  87323. }
  87324. declare module BABYLON {
  87325. /**
  87326. * Define options used to create a depth texture
  87327. */
  87328. export class DepthTextureCreationOptions {
  87329. /** Specifies whether or not a stencil should be allocated in the texture */
  87330. generateStencil?: boolean;
  87331. /** Specifies whether or not bilinear filtering is enable on the texture */
  87332. bilinearFiltering?: boolean;
  87333. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  87334. comparisonFunction?: number;
  87335. /** Specifies if the created texture is a cube texture */
  87336. isCube?: boolean;
  87337. }
  87338. }
  87339. declare module BABYLON {
  87340. interface ThinEngine {
  87341. /**
  87342. * Creates a depth stencil cube texture.
  87343. * This is only available in WebGL 2.
  87344. * @param size The size of face edge in the cube texture.
  87345. * @param options The options defining the cube texture.
  87346. * @returns The cube texture
  87347. */
  87348. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  87349. /**
  87350. * Creates a cube texture
  87351. * @param rootUrl defines the url where the files to load is located
  87352. * @param scene defines the current scene
  87353. * @param files defines the list of files to load (1 per face)
  87354. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87355. * @param onLoad defines an optional callback raised when the texture is loaded
  87356. * @param onError defines an optional callback raised if there is an issue to load the texture
  87357. * @param format defines the format of the data
  87358. * @param forcedExtension defines the extension to use to pick the right loader
  87359. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  87360. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87361. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87362. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  87363. * @returns the cube texture as an InternalTexture
  87364. */
  87365. 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;
  87366. /**
  87367. * Creates a cube texture
  87368. * @param rootUrl defines the url where the files to load is located
  87369. * @param scene defines the current scene
  87370. * @param files defines the list of files to load (1 per face)
  87371. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87372. * @param onLoad defines an optional callback raised when the texture is loaded
  87373. * @param onError defines an optional callback raised if there is an issue to load the texture
  87374. * @param format defines the format of the data
  87375. * @param forcedExtension defines the extension to use to pick the right loader
  87376. * @returns the cube texture as an InternalTexture
  87377. */
  87378. 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;
  87379. /**
  87380. * Creates a cube texture
  87381. * @param rootUrl defines the url where the files to load is located
  87382. * @param scene defines the current scene
  87383. * @param files defines the list of files to load (1 per face)
  87384. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87385. * @param onLoad defines an optional callback raised when the texture is loaded
  87386. * @param onError defines an optional callback raised if there is an issue to load the texture
  87387. * @param format defines the format of the data
  87388. * @param forcedExtension defines the extension to use to pick the right loader
  87389. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  87390. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87391. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87392. * @returns the cube texture as an InternalTexture
  87393. */
  87394. 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;
  87395. /** @hidden */
  87396. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  87397. /** @hidden */
  87398. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  87399. /** @hidden */
  87400. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  87401. /** @hidden */
  87402. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  87403. /**
  87404. * @hidden
  87405. */
  87406. _setCubeMapTextureParams(loadMipmap: boolean): void;
  87407. }
  87408. }
  87409. declare module BABYLON {
  87410. /**
  87411. * Class for creating a cube texture
  87412. */
  87413. export class CubeTexture extends BaseTexture {
  87414. private _delayedOnLoad;
  87415. /**
  87416. * Observable triggered once the texture has been loaded.
  87417. */
  87418. onLoadObservable: Observable<CubeTexture>;
  87419. /**
  87420. * The url of the texture
  87421. */
  87422. url: string;
  87423. /**
  87424. * Gets or sets the center of the bounding box associated with the cube texture.
  87425. * It must define where the camera used to render the texture was set
  87426. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  87427. */
  87428. boundingBoxPosition: Vector3;
  87429. private _boundingBoxSize;
  87430. /**
  87431. * Gets or sets the size of the bounding box associated with the cube texture
  87432. * When defined, the cubemap will switch to local mode
  87433. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  87434. * @example https://www.babylonjs-playground.com/#RNASML
  87435. */
  87436. set boundingBoxSize(value: Vector3);
  87437. /**
  87438. * Returns the bounding box size
  87439. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  87440. */
  87441. get boundingBoxSize(): Vector3;
  87442. protected _rotationY: number;
  87443. /**
  87444. * Sets texture matrix rotation angle around Y axis in radians.
  87445. */
  87446. set rotationY(value: number);
  87447. /**
  87448. * Gets texture matrix rotation angle around Y axis radians.
  87449. */
  87450. get rotationY(): number;
  87451. /**
  87452. * Are mip maps generated for this texture or not.
  87453. */
  87454. get noMipmap(): boolean;
  87455. private _noMipmap;
  87456. private _files;
  87457. protected _forcedExtension: Nullable<string>;
  87458. private _extensions;
  87459. private _textureMatrix;
  87460. private _format;
  87461. private _createPolynomials;
  87462. /**
  87463. * Creates a cube texture from an array of image urls
  87464. * @param files defines an array of image urls
  87465. * @param scene defines the hosting scene
  87466. * @param noMipmap specifies if mip maps are not used
  87467. * @returns a cube texture
  87468. */
  87469. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  87470. /**
  87471. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  87472. * @param url defines the url of the prefiltered texture
  87473. * @param scene defines the scene the texture is attached to
  87474. * @param forcedExtension defines the extension of the file if different from the url
  87475. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  87476. * @return the prefiltered texture
  87477. */
  87478. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  87479. /**
  87480. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  87481. * as prefiltered data.
  87482. * @param rootUrl defines the url of the texture or the root name of the six images
  87483. * @param null defines the scene or engine the texture is attached to
  87484. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  87485. * @param noMipmap defines if mipmaps should be created or not
  87486. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  87487. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  87488. * @param onError defines a callback triggered in case of error during load
  87489. * @param format defines the internal format to use for the texture once loaded
  87490. * @param prefiltered defines whether or not the texture is created from prefiltered data
  87491. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  87492. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  87493. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87494. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87495. * @return the cube texture
  87496. */
  87497. 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);
  87498. /**
  87499. * Get the current class name of the texture useful for serialization or dynamic coding.
  87500. * @returns "CubeTexture"
  87501. */
  87502. getClassName(): string;
  87503. /**
  87504. * Update the url (and optional buffer) of this texture if url was null during construction.
  87505. * @param url the url of the texture
  87506. * @param forcedExtension defines the extension to use
  87507. * @param onLoad callback called when the texture is loaded (defaults to null)
  87508. * @param prefiltered Defines whether the updated texture is prefiltered or not
  87509. */
  87510. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  87511. /**
  87512. * Delays loading of the cube texture
  87513. * @param forcedExtension defines the extension to use
  87514. */
  87515. delayLoad(forcedExtension?: string): void;
  87516. /**
  87517. * Returns the reflection texture matrix
  87518. * @returns the reflection texture matrix
  87519. */
  87520. getReflectionTextureMatrix(): Matrix;
  87521. /**
  87522. * Sets the reflection texture matrix
  87523. * @param value Reflection texture matrix
  87524. */
  87525. setReflectionTextureMatrix(value: Matrix): void;
  87526. /**
  87527. * Parses text to create a cube texture
  87528. * @param parsedTexture define the serialized text to read from
  87529. * @param scene defines the hosting scene
  87530. * @param rootUrl defines the root url of the cube texture
  87531. * @returns a cube texture
  87532. */
  87533. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  87534. /**
  87535. * Makes a clone, or deep copy, of the cube texture
  87536. * @returns a new cube texture
  87537. */
  87538. clone(): CubeTexture;
  87539. }
  87540. }
  87541. declare module BABYLON {
  87542. /**
  87543. * Manages the defines for the Material
  87544. */
  87545. export class MaterialDefines {
  87546. /** @hidden */
  87547. protected _keys: string[];
  87548. private _isDirty;
  87549. /** @hidden */
  87550. _renderId: number;
  87551. /** @hidden */
  87552. _areLightsDirty: boolean;
  87553. /** @hidden */
  87554. _areLightsDisposed: boolean;
  87555. /** @hidden */
  87556. _areAttributesDirty: boolean;
  87557. /** @hidden */
  87558. _areTexturesDirty: boolean;
  87559. /** @hidden */
  87560. _areFresnelDirty: boolean;
  87561. /** @hidden */
  87562. _areMiscDirty: boolean;
  87563. /** @hidden */
  87564. _areImageProcessingDirty: boolean;
  87565. /** @hidden */
  87566. _normals: boolean;
  87567. /** @hidden */
  87568. _uvs: boolean;
  87569. /** @hidden */
  87570. _needNormals: boolean;
  87571. /** @hidden */
  87572. _needUVs: boolean;
  87573. [id: string]: any;
  87574. /**
  87575. * Specifies if the material needs to be re-calculated
  87576. */
  87577. get isDirty(): boolean;
  87578. /**
  87579. * Marks the material to indicate that it has been re-calculated
  87580. */
  87581. markAsProcessed(): void;
  87582. /**
  87583. * Marks the material to indicate that it needs to be re-calculated
  87584. */
  87585. markAsUnprocessed(): void;
  87586. /**
  87587. * Marks the material to indicate all of its defines need to be re-calculated
  87588. */
  87589. markAllAsDirty(): void;
  87590. /**
  87591. * Marks the material to indicate that image processing needs to be re-calculated
  87592. */
  87593. markAsImageProcessingDirty(): void;
  87594. /**
  87595. * Marks the material to indicate the lights need to be re-calculated
  87596. * @param disposed Defines whether the light is dirty due to dispose or not
  87597. */
  87598. markAsLightDirty(disposed?: boolean): void;
  87599. /**
  87600. * Marks the attribute state as changed
  87601. */
  87602. markAsAttributesDirty(): void;
  87603. /**
  87604. * Marks the texture state as changed
  87605. */
  87606. markAsTexturesDirty(): void;
  87607. /**
  87608. * Marks the fresnel state as changed
  87609. */
  87610. markAsFresnelDirty(): void;
  87611. /**
  87612. * Marks the misc state as changed
  87613. */
  87614. markAsMiscDirty(): void;
  87615. /**
  87616. * Rebuilds the material defines
  87617. */
  87618. rebuild(): void;
  87619. /**
  87620. * Specifies if two material defines are equal
  87621. * @param other - A material define instance to compare to
  87622. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  87623. */
  87624. isEqual(other: MaterialDefines): boolean;
  87625. /**
  87626. * Clones this instance's defines to another instance
  87627. * @param other - material defines to clone values to
  87628. */
  87629. cloneTo(other: MaterialDefines): void;
  87630. /**
  87631. * Resets the material define values
  87632. */
  87633. reset(): void;
  87634. /**
  87635. * Converts the material define values to a string
  87636. * @returns - String of material define information
  87637. */
  87638. toString(): string;
  87639. }
  87640. }
  87641. declare module BABYLON {
  87642. /**
  87643. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  87644. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  87645. * 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;
  87646. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  87647. */
  87648. export class ColorCurves {
  87649. private _dirty;
  87650. private _tempColor;
  87651. private _globalCurve;
  87652. private _highlightsCurve;
  87653. private _midtonesCurve;
  87654. private _shadowsCurve;
  87655. private _positiveCurve;
  87656. private _negativeCurve;
  87657. private _globalHue;
  87658. private _globalDensity;
  87659. private _globalSaturation;
  87660. private _globalExposure;
  87661. /**
  87662. * Gets the global Hue value.
  87663. * 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).
  87664. */
  87665. get globalHue(): number;
  87666. /**
  87667. * Sets the global Hue value.
  87668. * 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).
  87669. */
  87670. set globalHue(value: number);
  87671. /**
  87672. * Gets the global Density value.
  87673. * 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.
  87674. * Values less than zero provide a filter of opposite hue.
  87675. */
  87676. get globalDensity(): number;
  87677. /**
  87678. * Sets the global Density value.
  87679. * 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.
  87680. * Values less than zero provide a filter of opposite hue.
  87681. */
  87682. set globalDensity(value: number);
  87683. /**
  87684. * Gets the global Saturation value.
  87685. * 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.
  87686. */
  87687. get globalSaturation(): number;
  87688. /**
  87689. * Sets the global Saturation value.
  87690. * 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.
  87691. */
  87692. set globalSaturation(value: number);
  87693. /**
  87694. * Gets the global Exposure value.
  87695. * 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.
  87696. */
  87697. get globalExposure(): number;
  87698. /**
  87699. * Sets the global Exposure value.
  87700. * 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.
  87701. */
  87702. set globalExposure(value: number);
  87703. private _highlightsHue;
  87704. private _highlightsDensity;
  87705. private _highlightsSaturation;
  87706. private _highlightsExposure;
  87707. /**
  87708. * Gets the highlights Hue value.
  87709. * 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).
  87710. */
  87711. get highlightsHue(): number;
  87712. /**
  87713. * Sets the highlights Hue value.
  87714. * 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).
  87715. */
  87716. set highlightsHue(value: number);
  87717. /**
  87718. * Gets the highlights Density value.
  87719. * 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.
  87720. * Values less than zero provide a filter of opposite hue.
  87721. */
  87722. get highlightsDensity(): number;
  87723. /**
  87724. * Sets the highlights Density value.
  87725. * 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.
  87726. * Values less than zero provide a filter of opposite hue.
  87727. */
  87728. set highlightsDensity(value: number);
  87729. /**
  87730. * Gets the highlights Saturation value.
  87731. * 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.
  87732. */
  87733. get highlightsSaturation(): number;
  87734. /**
  87735. * Sets the highlights Saturation value.
  87736. * 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.
  87737. */
  87738. set highlightsSaturation(value: number);
  87739. /**
  87740. * Gets the highlights Exposure value.
  87741. * 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.
  87742. */
  87743. get highlightsExposure(): number;
  87744. /**
  87745. * Sets the highlights Exposure value.
  87746. * 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.
  87747. */
  87748. set highlightsExposure(value: number);
  87749. private _midtonesHue;
  87750. private _midtonesDensity;
  87751. private _midtonesSaturation;
  87752. private _midtonesExposure;
  87753. /**
  87754. * Gets the midtones Hue value.
  87755. * 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).
  87756. */
  87757. get midtonesHue(): number;
  87758. /**
  87759. * Sets the midtones Hue value.
  87760. * 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).
  87761. */
  87762. set midtonesHue(value: number);
  87763. /**
  87764. * Gets the midtones Density value.
  87765. * 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.
  87766. * Values less than zero provide a filter of opposite hue.
  87767. */
  87768. get midtonesDensity(): number;
  87769. /**
  87770. * Sets the midtones Density value.
  87771. * 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.
  87772. * Values less than zero provide a filter of opposite hue.
  87773. */
  87774. set midtonesDensity(value: number);
  87775. /**
  87776. * Gets the midtones Saturation value.
  87777. * 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.
  87778. */
  87779. get midtonesSaturation(): number;
  87780. /**
  87781. * Sets the midtones Saturation value.
  87782. * 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.
  87783. */
  87784. set midtonesSaturation(value: number);
  87785. /**
  87786. * Gets the midtones Exposure value.
  87787. * 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.
  87788. */
  87789. get midtonesExposure(): number;
  87790. /**
  87791. * Sets the midtones Exposure value.
  87792. * 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.
  87793. */
  87794. set midtonesExposure(value: number);
  87795. private _shadowsHue;
  87796. private _shadowsDensity;
  87797. private _shadowsSaturation;
  87798. private _shadowsExposure;
  87799. /**
  87800. * Gets the shadows Hue value.
  87801. * 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).
  87802. */
  87803. get shadowsHue(): number;
  87804. /**
  87805. * Sets the shadows Hue value.
  87806. * 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).
  87807. */
  87808. set shadowsHue(value: number);
  87809. /**
  87810. * Gets the shadows Density value.
  87811. * 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.
  87812. * Values less than zero provide a filter of opposite hue.
  87813. */
  87814. get shadowsDensity(): number;
  87815. /**
  87816. * Sets the shadows Density value.
  87817. * 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.
  87818. * Values less than zero provide a filter of opposite hue.
  87819. */
  87820. set shadowsDensity(value: number);
  87821. /**
  87822. * Gets the shadows Saturation value.
  87823. * 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.
  87824. */
  87825. get shadowsSaturation(): number;
  87826. /**
  87827. * Sets the shadows Saturation value.
  87828. * 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.
  87829. */
  87830. set shadowsSaturation(value: number);
  87831. /**
  87832. * Gets the shadows Exposure value.
  87833. * 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.
  87834. */
  87835. get shadowsExposure(): number;
  87836. /**
  87837. * Sets the shadows Exposure value.
  87838. * 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.
  87839. */
  87840. set shadowsExposure(value: number);
  87841. /**
  87842. * Returns the class name
  87843. * @returns The class name
  87844. */
  87845. getClassName(): string;
  87846. /**
  87847. * Binds the color curves to the shader.
  87848. * @param colorCurves The color curve to bind
  87849. * @param effect The effect to bind to
  87850. * @param positiveUniform The positive uniform shader parameter
  87851. * @param neutralUniform The neutral uniform shader parameter
  87852. * @param negativeUniform The negative uniform shader parameter
  87853. */
  87854. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  87855. /**
  87856. * Prepare the list of uniforms associated with the ColorCurves effects.
  87857. * @param uniformsList The list of uniforms used in the effect
  87858. */
  87859. static PrepareUniforms(uniformsList: string[]): void;
  87860. /**
  87861. * Returns color grading data based on a hue, density, saturation and exposure value.
  87862. * @param filterHue The hue of the color filter.
  87863. * @param filterDensity The density of the color filter.
  87864. * @param saturation The saturation.
  87865. * @param exposure The exposure.
  87866. * @param result The result data container.
  87867. */
  87868. private getColorGradingDataToRef;
  87869. /**
  87870. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  87871. * @param value The input slider value in range [-100,100].
  87872. * @returns Adjusted value.
  87873. */
  87874. private static applyColorGradingSliderNonlinear;
  87875. /**
  87876. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  87877. * @param hue The hue (H) input.
  87878. * @param saturation The saturation (S) input.
  87879. * @param brightness The brightness (B) input.
  87880. * @result An RGBA color represented as Vector4.
  87881. */
  87882. private static fromHSBToRef;
  87883. /**
  87884. * Returns a value clamped between min and max
  87885. * @param value The value to clamp
  87886. * @param min The minimum of value
  87887. * @param max The maximum of value
  87888. * @returns The clamped value.
  87889. */
  87890. private static clamp;
  87891. /**
  87892. * Clones the current color curve instance.
  87893. * @return The cloned curves
  87894. */
  87895. clone(): ColorCurves;
  87896. /**
  87897. * Serializes the current color curve instance to a json representation.
  87898. * @return a JSON representation
  87899. */
  87900. serialize(): any;
  87901. /**
  87902. * Parses the color curve from a json representation.
  87903. * @param source the JSON source to parse
  87904. * @return The parsed curves
  87905. */
  87906. static Parse(source: any): ColorCurves;
  87907. }
  87908. }
  87909. declare module BABYLON {
  87910. /**
  87911. * Interface to follow in your material defines to integrate easily the
  87912. * Image proccessing functions.
  87913. * @hidden
  87914. */
  87915. export interface IImageProcessingConfigurationDefines {
  87916. IMAGEPROCESSING: boolean;
  87917. VIGNETTE: boolean;
  87918. VIGNETTEBLENDMODEMULTIPLY: boolean;
  87919. VIGNETTEBLENDMODEOPAQUE: boolean;
  87920. TONEMAPPING: boolean;
  87921. TONEMAPPING_ACES: boolean;
  87922. CONTRAST: boolean;
  87923. EXPOSURE: boolean;
  87924. COLORCURVES: boolean;
  87925. COLORGRADING: boolean;
  87926. COLORGRADING3D: boolean;
  87927. SAMPLER3DGREENDEPTH: boolean;
  87928. SAMPLER3DBGRMAP: boolean;
  87929. IMAGEPROCESSINGPOSTPROCESS: boolean;
  87930. }
  87931. /**
  87932. * @hidden
  87933. */
  87934. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  87935. IMAGEPROCESSING: boolean;
  87936. VIGNETTE: boolean;
  87937. VIGNETTEBLENDMODEMULTIPLY: boolean;
  87938. VIGNETTEBLENDMODEOPAQUE: boolean;
  87939. TONEMAPPING: boolean;
  87940. TONEMAPPING_ACES: boolean;
  87941. CONTRAST: boolean;
  87942. COLORCURVES: boolean;
  87943. COLORGRADING: boolean;
  87944. COLORGRADING3D: boolean;
  87945. SAMPLER3DGREENDEPTH: boolean;
  87946. SAMPLER3DBGRMAP: boolean;
  87947. IMAGEPROCESSINGPOSTPROCESS: boolean;
  87948. EXPOSURE: boolean;
  87949. constructor();
  87950. }
  87951. /**
  87952. * This groups together the common properties used for image processing either in direct forward pass
  87953. * or through post processing effect depending on the use of the image processing pipeline in your scene
  87954. * or not.
  87955. */
  87956. export class ImageProcessingConfiguration {
  87957. /**
  87958. * Default tone mapping applied in BabylonJS.
  87959. */
  87960. static readonly TONEMAPPING_STANDARD: number;
  87961. /**
  87962. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  87963. * to other engines rendering to increase portability.
  87964. */
  87965. static readonly TONEMAPPING_ACES: number;
  87966. /**
  87967. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  87968. */
  87969. colorCurves: Nullable<ColorCurves>;
  87970. private _colorCurvesEnabled;
  87971. /**
  87972. * Gets wether the color curves effect is enabled.
  87973. */
  87974. get colorCurvesEnabled(): boolean;
  87975. /**
  87976. * Sets wether the color curves effect is enabled.
  87977. */
  87978. set colorCurvesEnabled(value: boolean);
  87979. private _colorGradingTexture;
  87980. /**
  87981. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  87982. */
  87983. get colorGradingTexture(): Nullable<BaseTexture>;
  87984. /**
  87985. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  87986. */
  87987. set colorGradingTexture(value: Nullable<BaseTexture>);
  87988. private _colorGradingEnabled;
  87989. /**
  87990. * Gets wether the color grading effect is enabled.
  87991. */
  87992. get colorGradingEnabled(): boolean;
  87993. /**
  87994. * Sets wether the color grading effect is enabled.
  87995. */
  87996. set colorGradingEnabled(value: boolean);
  87997. private _colorGradingWithGreenDepth;
  87998. /**
  87999. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  88000. */
  88001. get colorGradingWithGreenDepth(): boolean;
  88002. /**
  88003. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  88004. */
  88005. set colorGradingWithGreenDepth(value: boolean);
  88006. private _colorGradingBGR;
  88007. /**
  88008. * Gets wether the color grading texture contains BGR values.
  88009. */
  88010. get colorGradingBGR(): boolean;
  88011. /**
  88012. * Sets wether the color grading texture contains BGR values.
  88013. */
  88014. set colorGradingBGR(value: boolean);
  88015. /** @hidden */
  88016. _exposure: number;
  88017. /**
  88018. * Gets the Exposure used in the effect.
  88019. */
  88020. get exposure(): number;
  88021. /**
  88022. * Sets the Exposure used in the effect.
  88023. */
  88024. set exposure(value: number);
  88025. private _toneMappingEnabled;
  88026. /**
  88027. * Gets wether the tone mapping effect is enabled.
  88028. */
  88029. get toneMappingEnabled(): boolean;
  88030. /**
  88031. * Sets wether the tone mapping effect is enabled.
  88032. */
  88033. set toneMappingEnabled(value: boolean);
  88034. private _toneMappingType;
  88035. /**
  88036. * Gets the type of tone mapping effect.
  88037. */
  88038. get toneMappingType(): number;
  88039. /**
  88040. * Sets the type of tone mapping effect used in BabylonJS.
  88041. */
  88042. set toneMappingType(value: number);
  88043. protected _contrast: number;
  88044. /**
  88045. * Gets the contrast used in the effect.
  88046. */
  88047. get contrast(): number;
  88048. /**
  88049. * Sets the contrast used in the effect.
  88050. */
  88051. set contrast(value: number);
  88052. /**
  88053. * Vignette stretch size.
  88054. */
  88055. vignetteStretch: number;
  88056. /**
  88057. * Vignette centre X Offset.
  88058. */
  88059. vignetteCentreX: number;
  88060. /**
  88061. * Vignette centre Y Offset.
  88062. */
  88063. vignetteCentreY: number;
  88064. /**
  88065. * Vignette weight or intensity of the vignette effect.
  88066. */
  88067. vignetteWeight: number;
  88068. /**
  88069. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  88070. * if vignetteEnabled is set to true.
  88071. */
  88072. vignetteColor: Color4;
  88073. /**
  88074. * Camera field of view used by the Vignette effect.
  88075. */
  88076. vignetteCameraFov: number;
  88077. private _vignetteBlendMode;
  88078. /**
  88079. * Gets the vignette blend mode allowing different kind of effect.
  88080. */
  88081. get vignetteBlendMode(): number;
  88082. /**
  88083. * Sets the vignette blend mode allowing different kind of effect.
  88084. */
  88085. set vignetteBlendMode(value: number);
  88086. private _vignetteEnabled;
  88087. /**
  88088. * Gets wether the vignette effect is enabled.
  88089. */
  88090. get vignetteEnabled(): boolean;
  88091. /**
  88092. * Sets wether the vignette effect is enabled.
  88093. */
  88094. set vignetteEnabled(value: boolean);
  88095. private _applyByPostProcess;
  88096. /**
  88097. * Gets wether the image processing is applied through a post process or not.
  88098. */
  88099. get applyByPostProcess(): boolean;
  88100. /**
  88101. * Sets wether the image processing is applied through a post process or not.
  88102. */
  88103. set applyByPostProcess(value: boolean);
  88104. private _isEnabled;
  88105. /**
  88106. * Gets wether the image processing is enabled or not.
  88107. */
  88108. get isEnabled(): boolean;
  88109. /**
  88110. * Sets wether the image processing is enabled or not.
  88111. */
  88112. set isEnabled(value: boolean);
  88113. /**
  88114. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  88115. */
  88116. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  88117. /**
  88118. * Method called each time the image processing information changes requires to recompile the effect.
  88119. */
  88120. protected _updateParameters(): void;
  88121. /**
  88122. * Gets the current class name.
  88123. * @return "ImageProcessingConfiguration"
  88124. */
  88125. getClassName(): string;
  88126. /**
  88127. * Prepare the list of uniforms associated with the Image Processing effects.
  88128. * @param uniforms The list of uniforms used in the effect
  88129. * @param defines the list of defines currently in use
  88130. */
  88131. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  88132. /**
  88133. * Prepare the list of samplers associated with the Image Processing effects.
  88134. * @param samplersList The list of uniforms used in the effect
  88135. * @param defines the list of defines currently in use
  88136. */
  88137. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  88138. /**
  88139. * Prepare the list of defines associated to the shader.
  88140. * @param defines the list of defines to complete
  88141. * @param forPostProcess Define if we are currently in post process mode or not
  88142. */
  88143. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  88144. /**
  88145. * Returns true if all the image processing information are ready.
  88146. * @returns True if ready, otherwise, false
  88147. */
  88148. isReady(): boolean;
  88149. /**
  88150. * Binds the image processing to the shader.
  88151. * @param effect The effect to bind to
  88152. * @param overrideAspectRatio Override the aspect ratio of the effect
  88153. */
  88154. bind(effect: Effect, overrideAspectRatio?: number): void;
  88155. /**
  88156. * Clones the current image processing instance.
  88157. * @return The cloned image processing
  88158. */
  88159. clone(): ImageProcessingConfiguration;
  88160. /**
  88161. * Serializes the current image processing instance to a json representation.
  88162. * @return a JSON representation
  88163. */
  88164. serialize(): any;
  88165. /**
  88166. * Parses the image processing from a json representation.
  88167. * @param source the JSON source to parse
  88168. * @return The parsed image processing
  88169. */
  88170. static Parse(source: any): ImageProcessingConfiguration;
  88171. private static _VIGNETTEMODE_MULTIPLY;
  88172. private static _VIGNETTEMODE_OPAQUE;
  88173. /**
  88174. * Used to apply the vignette as a mix with the pixel color.
  88175. */
  88176. static get VIGNETTEMODE_MULTIPLY(): number;
  88177. /**
  88178. * Used to apply the vignette as a replacement of the pixel color.
  88179. */
  88180. static get VIGNETTEMODE_OPAQUE(): number;
  88181. }
  88182. }
  88183. declare module BABYLON {
  88184. /** @hidden */
  88185. export var postprocessVertexShader: {
  88186. name: string;
  88187. shader: string;
  88188. };
  88189. }
  88190. declare module BABYLON {
  88191. interface ThinEngine {
  88192. /**
  88193. * Creates a new render target texture
  88194. * @param size defines the size of the texture
  88195. * @param options defines the options used to create the texture
  88196. * @returns a new render target texture stored in an InternalTexture
  88197. */
  88198. createRenderTargetTexture(size: number | {
  88199. width: number;
  88200. height: number;
  88201. layers?: number;
  88202. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  88203. /**
  88204. * Creates a depth stencil texture.
  88205. * This is only available in WebGL 2 or with the depth texture extension available.
  88206. * @param size The size of face edge in the texture.
  88207. * @param options The options defining the texture.
  88208. * @returns The texture
  88209. */
  88210. createDepthStencilTexture(size: number | {
  88211. width: number;
  88212. height: number;
  88213. layers?: number;
  88214. }, options: DepthTextureCreationOptions): InternalTexture;
  88215. /** @hidden */
  88216. _createDepthStencilTexture(size: number | {
  88217. width: number;
  88218. height: number;
  88219. layers?: number;
  88220. }, options: DepthTextureCreationOptions): InternalTexture;
  88221. }
  88222. }
  88223. declare module BABYLON {
  88224. /**
  88225. * Defines the kind of connection point for node based material
  88226. */
  88227. export enum NodeMaterialBlockConnectionPointTypes {
  88228. /** Float */
  88229. Float = 1,
  88230. /** Int */
  88231. Int = 2,
  88232. /** Vector2 */
  88233. Vector2 = 4,
  88234. /** Vector3 */
  88235. Vector3 = 8,
  88236. /** Vector4 */
  88237. Vector4 = 16,
  88238. /** Color3 */
  88239. Color3 = 32,
  88240. /** Color4 */
  88241. Color4 = 64,
  88242. /** Matrix */
  88243. Matrix = 128,
  88244. /** Custom object */
  88245. Object = 256,
  88246. /** Detect type based on connection */
  88247. AutoDetect = 1024,
  88248. /** Output type that will be defined by input type */
  88249. BasedOnInput = 2048
  88250. }
  88251. }
  88252. declare module BABYLON {
  88253. /**
  88254. * Enum used to define the target of a block
  88255. */
  88256. export enum NodeMaterialBlockTargets {
  88257. /** Vertex shader */
  88258. Vertex = 1,
  88259. /** Fragment shader */
  88260. Fragment = 2,
  88261. /** Neutral */
  88262. Neutral = 4,
  88263. /** Vertex and Fragment */
  88264. VertexAndFragment = 3
  88265. }
  88266. }
  88267. declare module BABYLON {
  88268. /**
  88269. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  88270. */
  88271. export enum NodeMaterialBlockConnectionPointMode {
  88272. /** Value is an uniform */
  88273. Uniform = 0,
  88274. /** Value is a mesh attribute */
  88275. Attribute = 1,
  88276. /** Value is a varying between vertex and fragment shaders */
  88277. Varying = 2,
  88278. /** Mode is undefined */
  88279. Undefined = 3
  88280. }
  88281. }
  88282. declare module BABYLON {
  88283. /**
  88284. * Enum used to define system values e.g. values automatically provided by the system
  88285. */
  88286. export enum NodeMaterialSystemValues {
  88287. /** World */
  88288. World = 1,
  88289. /** View */
  88290. View = 2,
  88291. /** Projection */
  88292. Projection = 3,
  88293. /** ViewProjection */
  88294. ViewProjection = 4,
  88295. /** WorldView */
  88296. WorldView = 5,
  88297. /** WorldViewProjection */
  88298. WorldViewProjection = 6,
  88299. /** CameraPosition */
  88300. CameraPosition = 7,
  88301. /** Fog Color */
  88302. FogColor = 8,
  88303. /** Delta time */
  88304. DeltaTime = 9
  88305. }
  88306. }
  88307. declare module BABYLON {
  88308. /** Defines supported spaces */
  88309. export enum Space {
  88310. /** Local (object) space */
  88311. LOCAL = 0,
  88312. /** World space */
  88313. WORLD = 1,
  88314. /** Bone space */
  88315. BONE = 2
  88316. }
  88317. /** Defines the 3 main axes */
  88318. export class Axis {
  88319. /** X axis */
  88320. static X: Vector3;
  88321. /** Y axis */
  88322. static Y: Vector3;
  88323. /** Z axis */
  88324. static Z: Vector3;
  88325. }
  88326. }
  88327. declare module BABYLON {
  88328. /**
  88329. * Represents a camera frustum
  88330. */
  88331. export class Frustum {
  88332. /**
  88333. * Gets the planes representing the frustum
  88334. * @param transform matrix to be applied to the returned planes
  88335. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  88336. */
  88337. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  88338. /**
  88339. * Gets the near frustum plane transformed by the transform matrix
  88340. * @param transform transformation matrix to be applied to the resulting frustum plane
  88341. * @param frustumPlane the resuling frustum plane
  88342. */
  88343. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88344. /**
  88345. * Gets the far frustum plane transformed by the transform matrix
  88346. * @param transform transformation matrix to be applied to the resulting frustum plane
  88347. * @param frustumPlane the resuling frustum plane
  88348. */
  88349. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88350. /**
  88351. * Gets the left frustum plane transformed by the transform matrix
  88352. * @param transform transformation matrix to be applied to the resulting frustum plane
  88353. * @param frustumPlane the resuling frustum plane
  88354. */
  88355. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88356. /**
  88357. * Gets the right frustum plane transformed by the transform matrix
  88358. * @param transform transformation matrix to be applied to the resulting frustum plane
  88359. * @param frustumPlane the resuling frustum plane
  88360. */
  88361. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88362. /**
  88363. * Gets the top frustum plane transformed by the transform matrix
  88364. * @param transform transformation matrix to be applied to the resulting frustum plane
  88365. * @param frustumPlane the resuling frustum plane
  88366. */
  88367. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88368. /**
  88369. * Gets the bottom frustum plane transformed by the transform matrix
  88370. * @param transform transformation matrix to be applied to the resulting frustum plane
  88371. * @param frustumPlane the resuling frustum plane
  88372. */
  88373. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88374. /**
  88375. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  88376. * @param transform transformation matrix to be applied to the resulting frustum planes
  88377. * @param frustumPlanes the resuling frustum planes
  88378. */
  88379. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  88380. }
  88381. }
  88382. declare module BABYLON {
  88383. /**
  88384. * Interface for the size containing width and height
  88385. */
  88386. export interface ISize {
  88387. /**
  88388. * Width
  88389. */
  88390. width: number;
  88391. /**
  88392. * Heighht
  88393. */
  88394. height: number;
  88395. }
  88396. /**
  88397. * Size containing widht and height
  88398. */
  88399. export class Size implements ISize {
  88400. /**
  88401. * Width
  88402. */
  88403. width: number;
  88404. /**
  88405. * Height
  88406. */
  88407. height: number;
  88408. /**
  88409. * Creates a Size object from the given width and height (floats).
  88410. * @param width width of the new size
  88411. * @param height height of the new size
  88412. */
  88413. constructor(width: number, height: number);
  88414. /**
  88415. * Returns a string with the Size width and height
  88416. * @returns a string with the Size width and height
  88417. */
  88418. toString(): string;
  88419. /**
  88420. * "Size"
  88421. * @returns the string "Size"
  88422. */
  88423. getClassName(): string;
  88424. /**
  88425. * Returns the Size hash code.
  88426. * @returns a hash code for a unique width and height
  88427. */
  88428. getHashCode(): number;
  88429. /**
  88430. * Updates the current size from the given one.
  88431. * @param src the given size
  88432. */
  88433. copyFrom(src: Size): void;
  88434. /**
  88435. * Updates in place the current Size from the given floats.
  88436. * @param width width of the new size
  88437. * @param height height of the new size
  88438. * @returns the updated Size.
  88439. */
  88440. copyFromFloats(width: number, height: number): Size;
  88441. /**
  88442. * Updates in place the current Size from the given floats.
  88443. * @param width width to set
  88444. * @param height height to set
  88445. * @returns the updated Size.
  88446. */
  88447. set(width: number, height: number): Size;
  88448. /**
  88449. * Multiplies the width and height by numbers
  88450. * @param w factor to multiple the width by
  88451. * @param h factor to multiple the height by
  88452. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  88453. */
  88454. multiplyByFloats(w: number, h: number): Size;
  88455. /**
  88456. * Clones the size
  88457. * @returns a new Size copied from the given one.
  88458. */
  88459. clone(): Size;
  88460. /**
  88461. * True if the current Size and the given one width and height are strictly equal.
  88462. * @param other the other size to compare against
  88463. * @returns True if the current Size and the given one width and height are strictly equal.
  88464. */
  88465. equals(other: Size): boolean;
  88466. /**
  88467. * The surface of the Size : width * height (float).
  88468. */
  88469. get surface(): number;
  88470. /**
  88471. * Create a new size of zero
  88472. * @returns a new Size set to (0.0, 0.0)
  88473. */
  88474. static Zero(): Size;
  88475. /**
  88476. * Sums the width and height of two sizes
  88477. * @param otherSize size to add to this size
  88478. * @returns a new Size set as the addition result of the current Size and the given one.
  88479. */
  88480. add(otherSize: Size): Size;
  88481. /**
  88482. * Subtracts the width and height of two
  88483. * @param otherSize size to subtract to this size
  88484. * @returns a new Size set as the subtraction result of the given one from the current Size.
  88485. */
  88486. subtract(otherSize: Size): Size;
  88487. /**
  88488. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  88489. * @param start starting size to lerp between
  88490. * @param end end size to lerp between
  88491. * @param amount amount to lerp between the start and end values
  88492. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  88493. */
  88494. static Lerp(start: Size, end: Size, amount: number): Size;
  88495. }
  88496. }
  88497. declare module BABYLON {
  88498. /**
  88499. * Contains position and normal vectors for a vertex
  88500. */
  88501. export class PositionNormalVertex {
  88502. /** the position of the vertex (defaut: 0,0,0) */
  88503. position: Vector3;
  88504. /** the normal of the vertex (defaut: 0,1,0) */
  88505. normal: Vector3;
  88506. /**
  88507. * Creates a PositionNormalVertex
  88508. * @param position the position of the vertex (defaut: 0,0,0)
  88509. * @param normal the normal of the vertex (defaut: 0,1,0)
  88510. */
  88511. constructor(
  88512. /** the position of the vertex (defaut: 0,0,0) */
  88513. position?: Vector3,
  88514. /** the normal of the vertex (defaut: 0,1,0) */
  88515. normal?: Vector3);
  88516. /**
  88517. * Clones the PositionNormalVertex
  88518. * @returns the cloned PositionNormalVertex
  88519. */
  88520. clone(): PositionNormalVertex;
  88521. }
  88522. /**
  88523. * Contains position, normal and uv vectors for a vertex
  88524. */
  88525. export class PositionNormalTextureVertex {
  88526. /** the position of the vertex (defaut: 0,0,0) */
  88527. position: Vector3;
  88528. /** the normal of the vertex (defaut: 0,1,0) */
  88529. normal: Vector3;
  88530. /** the uv of the vertex (default: 0,0) */
  88531. uv: Vector2;
  88532. /**
  88533. * Creates a PositionNormalTextureVertex
  88534. * @param position the position of the vertex (defaut: 0,0,0)
  88535. * @param normal the normal of the vertex (defaut: 0,1,0)
  88536. * @param uv the uv of the vertex (default: 0,0)
  88537. */
  88538. constructor(
  88539. /** the position of the vertex (defaut: 0,0,0) */
  88540. position?: Vector3,
  88541. /** the normal of the vertex (defaut: 0,1,0) */
  88542. normal?: Vector3,
  88543. /** the uv of the vertex (default: 0,0) */
  88544. uv?: Vector2);
  88545. /**
  88546. * Clones the PositionNormalTextureVertex
  88547. * @returns the cloned PositionNormalTextureVertex
  88548. */
  88549. clone(): PositionNormalTextureVertex;
  88550. }
  88551. }
  88552. declare module BABYLON {
  88553. /**
  88554. * Enum defining the type of animations supported by InputBlock
  88555. */
  88556. export enum AnimatedInputBlockTypes {
  88557. /** No animation */
  88558. None = 0,
  88559. /** Time based animation. Will only work for floats */
  88560. Time = 1
  88561. }
  88562. }
  88563. declare module BABYLON {
  88564. /**
  88565. * Interface describing all the common properties and methods a shadow light needs to implement.
  88566. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  88567. * as well as binding the different shadow properties to the effects.
  88568. */
  88569. export interface IShadowLight extends Light {
  88570. /**
  88571. * The light id in the scene (used in scene.findLighById for instance)
  88572. */
  88573. id: string;
  88574. /**
  88575. * The position the shdow will be casted from.
  88576. */
  88577. position: Vector3;
  88578. /**
  88579. * In 2d mode (needCube being false), the direction used to cast the shadow.
  88580. */
  88581. direction: Vector3;
  88582. /**
  88583. * The transformed position. Position of the light in world space taking parenting in account.
  88584. */
  88585. transformedPosition: Vector3;
  88586. /**
  88587. * The transformed direction. Direction of the light in world space taking parenting in account.
  88588. */
  88589. transformedDirection: Vector3;
  88590. /**
  88591. * The friendly name of the light in the scene.
  88592. */
  88593. name: string;
  88594. /**
  88595. * Defines the shadow projection clipping minimum z value.
  88596. */
  88597. shadowMinZ: number;
  88598. /**
  88599. * Defines the shadow projection clipping maximum z value.
  88600. */
  88601. shadowMaxZ: number;
  88602. /**
  88603. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  88604. * @returns true if the information has been computed, false if it does not need to (no parenting)
  88605. */
  88606. computeTransformedInformation(): boolean;
  88607. /**
  88608. * Gets the scene the light belongs to.
  88609. * @returns The scene
  88610. */
  88611. getScene(): Scene;
  88612. /**
  88613. * Callback defining a custom Projection Matrix Builder.
  88614. * This can be used to override the default projection matrix computation.
  88615. */
  88616. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  88617. /**
  88618. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  88619. * @param matrix The materix to updated with the projection information
  88620. * @param viewMatrix The transform matrix of the light
  88621. * @param renderList The list of mesh to render in the map
  88622. * @returns The current light
  88623. */
  88624. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  88625. /**
  88626. * Gets the current depth scale used in ESM.
  88627. * @returns The scale
  88628. */
  88629. getDepthScale(): number;
  88630. /**
  88631. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  88632. * @returns true if a cube texture needs to be use
  88633. */
  88634. needCube(): boolean;
  88635. /**
  88636. * Detects if the projection matrix requires to be recomputed this frame.
  88637. * @returns true if it requires to be recomputed otherwise, false.
  88638. */
  88639. needProjectionMatrixCompute(): boolean;
  88640. /**
  88641. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  88642. */
  88643. forceProjectionMatrixCompute(): void;
  88644. /**
  88645. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  88646. * @param faceIndex The index of the face we are computed the direction to generate shadow
  88647. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  88648. */
  88649. getShadowDirection(faceIndex?: number): Vector3;
  88650. /**
  88651. * Gets the minZ used for shadow according to both the scene and the light.
  88652. * @param activeCamera The camera we are returning the min for
  88653. * @returns the depth min z
  88654. */
  88655. getDepthMinZ(activeCamera: Camera): number;
  88656. /**
  88657. * Gets the maxZ used for shadow according to both the scene and the light.
  88658. * @param activeCamera The camera we are returning the max for
  88659. * @returns the depth max z
  88660. */
  88661. getDepthMaxZ(activeCamera: Camera): number;
  88662. }
  88663. /**
  88664. * Base implementation IShadowLight
  88665. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  88666. */
  88667. export abstract class ShadowLight extends Light implements IShadowLight {
  88668. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  88669. protected _position: Vector3;
  88670. protected _setPosition(value: Vector3): void;
  88671. /**
  88672. * Sets the position the shadow will be casted from. Also use as the light position for both
  88673. * point and spot lights.
  88674. */
  88675. get position(): Vector3;
  88676. /**
  88677. * Sets the position the shadow will be casted from. Also use as the light position for both
  88678. * point and spot lights.
  88679. */
  88680. set position(value: Vector3);
  88681. protected _direction: Vector3;
  88682. protected _setDirection(value: Vector3): void;
  88683. /**
  88684. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  88685. * Also use as the light direction on spot and directional lights.
  88686. */
  88687. get direction(): Vector3;
  88688. /**
  88689. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  88690. * Also use as the light direction on spot and directional lights.
  88691. */
  88692. set direction(value: Vector3);
  88693. protected _shadowMinZ: number;
  88694. /**
  88695. * Gets the shadow projection clipping minimum z value.
  88696. */
  88697. get shadowMinZ(): number;
  88698. /**
  88699. * Sets the shadow projection clipping minimum z value.
  88700. */
  88701. set shadowMinZ(value: number);
  88702. protected _shadowMaxZ: number;
  88703. /**
  88704. * Sets the shadow projection clipping maximum z value.
  88705. */
  88706. get shadowMaxZ(): number;
  88707. /**
  88708. * Gets the shadow projection clipping maximum z value.
  88709. */
  88710. set shadowMaxZ(value: number);
  88711. /**
  88712. * Callback defining a custom Projection Matrix Builder.
  88713. * This can be used to override the default projection matrix computation.
  88714. */
  88715. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  88716. /**
  88717. * The transformed position. Position of the light in world space taking parenting in account.
  88718. */
  88719. transformedPosition: Vector3;
  88720. /**
  88721. * The transformed direction. Direction of the light in world space taking parenting in account.
  88722. */
  88723. transformedDirection: Vector3;
  88724. private _needProjectionMatrixCompute;
  88725. /**
  88726. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  88727. * @returns true if the information has been computed, false if it does not need to (no parenting)
  88728. */
  88729. computeTransformedInformation(): boolean;
  88730. /**
  88731. * Return the depth scale used for the shadow map.
  88732. * @returns the depth scale.
  88733. */
  88734. getDepthScale(): number;
  88735. /**
  88736. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  88737. * @param faceIndex The index of the face we are computed the direction to generate shadow
  88738. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  88739. */
  88740. getShadowDirection(faceIndex?: number): Vector3;
  88741. /**
  88742. * Returns the ShadowLight absolute position in the World.
  88743. * @returns the position vector in world space
  88744. */
  88745. getAbsolutePosition(): Vector3;
  88746. /**
  88747. * Sets the ShadowLight direction toward the passed target.
  88748. * @param target The point to target in local space
  88749. * @returns the updated ShadowLight direction
  88750. */
  88751. setDirectionToTarget(target: Vector3): Vector3;
  88752. /**
  88753. * Returns the light rotation in euler definition.
  88754. * @returns the x y z rotation in local space.
  88755. */
  88756. getRotation(): Vector3;
  88757. /**
  88758. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  88759. * @returns true if a cube texture needs to be use
  88760. */
  88761. needCube(): boolean;
  88762. /**
  88763. * Detects if the projection matrix requires to be recomputed this frame.
  88764. * @returns true if it requires to be recomputed otherwise, false.
  88765. */
  88766. needProjectionMatrixCompute(): boolean;
  88767. /**
  88768. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  88769. */
  88770. forceProjectionMatrixCompute(): void;
  88771. /** @hidden */
  88772. _initCache(): void;
  88773. /** @hidden */
  88774. _isSynchronized(): boolean;
  88775. /**
  88776. * Computes the world matrix of the node
  88777. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  88778. * @returns the world matrix
  88779. */
  88780. computeWorldMatrix(force?: boolean): Matrix;
  88781. /**
  88782. * Gets the minZ used for shadow according to both the scene and the light.
  88783. * @param activeCamera The camera we are returning the min for
  88784. * @returns the depth min z
  88785. */
  88786. getDepthMinZ(activeCamera: Camera): number;
  88787. /**
  88788. * Gets the maxZ used for shadow according to both the scene and the light.
  88789. * @param activeCamera The camera we are returning the max for
  88790. * @returns the depth max z
  88791. */
  88792. getDepthMaxZ(activeCamera: Camera): number;
  88793. /**
  88794. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  88795. * @param matrix The materix to updated with the projection information
  88796. * @param viewMatrix The transform matrix of the light
  88797. * @param renderList The list of mesh to render in the map
  88798. * @returns The current light
  88799. */
  88800. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  88801. }
  88802. }
  88803. declare module BABYLON {
  88804. /** @hidden */
  88805. export var packingFunctions: {
  88806. name: string;
  88807. shader: string;
  88808. };
  88809. }
  88810. declare module BABYLON {
  88811. /** @hidden */
  88812. export var bayerDitherFunctions: {
  88813. name: string;
  88814. shader: string;
  88815. };
  88816. }
  88817. declare module BABYLON {
  88818. /** @hidden */
  88819. export var shadowMapFragmentDeclaration: {
  88820. name: string;
  88821. shader: string;
  88822. };
  88823. }
  88824. declare module BABYLON {
  88825. /** @hidden */
  88826. export var clipPlaneFragmentDeclaration: {
  88827. name: string;
  88828. shader: string;
  88829. };
  88830. }
  88831. declare module BABYLON {
  88832. /** @hidden */
  88833. export var clipPlaneFragment: {
  88834. name: string;
  88835. shader: string;
  88836. };
  88837. }
  88838. declare module BABYLON {
  88839. /** @hidden */
  88840. export var shadowMapFragment: {
  88841. name: string;
  88842. shader: string;
  88843. };
  88844. }
  88845. declare module BABYLON {
  88846. /** @hidden */
  88847. export var shadowMapPixelShader: {
  88848. name: string;
  88849. shader: string;
  88850. };
  88851. }
  88852. declare module BABYLON {
  88853. /** @hidden */
  88854. export var bonesDeclaration: {
  88855. name: string;
  88856. shader: string;
  88857. };
  88858. }
  88859. declare module BABYLON {
  88860. /** @hidden */
  88861. export var morphTargetsVertexGlobalDeclaration: {
  88862. name: string;
  88863. shader: string;
  88864. };
  88865. }
  88866. declare module BABYLON {
  88867. /** @hidden */
  88868. export var morphTargetsVertexDeclaration: {
  88869. name: string;
  88870. shader: string;
  88871. };
  88872. }
  88873. declare module BABYLON {
  88874. /** @hidden */
  88875. export var instancesDeclaration: {
  88876. name: string;
  88877. shader: string;
  88878. };
  88879. }
  88880. declare module BABYLON {
  88881. /** @hidden */
  88882. export var helperFunctions: {
  88883. name: string;
  88884. shader: string;
  88885. };
  88886. }
  88887. declare module BABYLON {
  88888. /** @hidden */
  88889. export var shadowMapVertexDeclaration: {
  88890. name: string;
  88891. shader: string;
  88892. };
  88893. }
  88894. declare module BABYLON {
  88895. /** @hidden */
  88896. export var clipPlaneVertexDeclaration: {
  88897. name: string;
  88898. shader: string;
  88899. };
  88900. }
  88901. declare module BABYLON {
  88902. /** @hidden */
  88903. export var morphTargetsVertex: {
  88904. name: string;
  88905. shader: string;
  88906. };
  88907. }
  88908. declare module BABYLON {
  88909. /** @hidden */
  88910. export var instancesVertex: {
  88911. name: string;
  88912. shader: string;
  88913. };
  88914. }
  88915. declare module BABYLON {
  88916. /** @hidden */
  88917. export var bonesVertex: {
  88918. name: string;
  88919. shader: string;
  88920. };
  88921. }
  88922. declare module BABYLON {
  88923. /** @hidden */
  88924. export var shadowMapVertexNormalBias: {
  88925. name: string;
  88926. shader: string;
  88927. };
  88928. }
  88929. declare module BABYLON {
  88930. /** @hidden */
  88931. export var shadowMapVertexMetric: {
  88932. name: string;
  88933. shader: string;
  88934. };
  88935. }
  88936. declare module BABYLON {
  88937. /** @hidden */
  88938. export var clipPlaneVertex: {
  88939. name: string;
  88940. shader: string;
  88941. };
  88942. }
  88943. declare module BABYLON {
  88944. /** @hidden */
  88945. export var shadowMapVertexShader: {
  88946. name: string;
  88947. shader: string;
  88948. };
  88949. }
  88950. declare module BABYLON {
  88951. /** @hidden */
  88952. export var depthBoxBlurPixelShader: {
  88953. name: string;
  88954. shader: string;
  88955. };
  88956. }
  88957. declare module BABYLON {
  88958. /** @hidden */
  88959. export var shadowMapFragmentSoftTransparentShadow: {
  88960. name: string;
  88961. shader: string;
  88962. };
  88963. }
  88964. declare module BABYLON {
  88965. /**
  88966. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  88967. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  88968. */
  88969. export class EffectFallbacks implements IEffectFallbacks {
  88970. private _defines;
  88971. private _currentRank;
  88972. private _maxRank;
  88973. private _mesh;
  88974. /**
  88975. * Removes the fallback from the bound mesh.
  88976. */
  88977. unBindMesh(): void;
  88978. /**
  88979. * Adds a fallback on the specified property.
  88980. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  88981. * @param define The name of the define in the shader
  88982. */
  88983. addFallback(rank: number, define: string): void;
  88984. /**
  88985. * Sets the mesh to use CPU skinning when needing to fallback.
  88986. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  88987. * @param mesh The mesh to use the fallbacks.
  88988. */
  88989. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  88990. /**
  88991. * Checks to see if more fallbacks are still availible.
  88992. */
  88993. get hasMoreFallbacks(): boolean;
  88994. /**
  88995. * Removes the defines that should be removed when falling back.
  88996. * @param currentDefines defines the current define statements for the shader.
  88997. * @param effect defines the current effect we try to compile
  88998. * @returns The resulting defines with defines of the current rank removed.
  88999. */
  89000. reduce(currentDefines: string, effect: Effect): string;
  89001. }
  89002. }
  89003. declare module BABYLON {
  89004. /**
  89005. * Interface used to define Action
  89006. */
  89007. export interface IAction {
  89008. /**
  89009. * Trigger for the action
  89010. */
  89011. trigger: number;
  89012. /** Options of the trigger */
  89013. triggerOptions: any;
  89014. /**
  89015. * Gets the trigger parameters
  89016. * @returns the trigger parameters
  89017. */
  89018. getTriggerParameter(): any;
  89019. /**
  89020. * Internal only - executes current action event
  89021. * @hidden
  89022. */
  89023. _executeCurrent(evt?: ActionEvent): void;
  89024. /**
  89025. * Serialize placeholder for child classes
  89026. * @param parent of child
  89027. * @returns the serialized object
  89028. */
  89029. serialize(parent: any): any;
  89030. /**
  89031. * Internal only
  89032. * @hidden
  89033. */
  89034. _prepare(): void;
  89035. /**
  89036. * Internal only - manager for action
  89037. * @hidden
  89038. */
  89039. _actionManager: Nullable<AbstractActionManager>;
  89040. /**
  89041. * Adds action to chain of actions, may be a DoNothingAction
  89042. * @param action defines the next action to execute
  89043. * @returns The action passed in
  89044. * @see https://www.babylonjs-playground.com/#1T30HR#0
  89045. */
  89046. then(action: IAction): IAction;
  89047. }
  89048. /**
  89049. * The action to be carried out following a trigger
  89050. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  89051. */
  89052. export class Action implements IAction {
  89053. /** the trigger, with or without parameters, for the action */
  89054. triggerOptions: any;
  89055. /**
  89056. * Trigger for the action
  89057. */
  89058. trigger: number;
  89059. /**
  89060. * Internal only - manager for action
  89061. * @hidden
  89062. */
  89063. _actionManager: ActionManager;
  89064. private _nextActiveAction;
  89065. private _child;
  89066. private _condition?;
  89067. private _triggerParameter;
  89068. /**
  89069. * An event triggered prior to action being executed.
  89070. */
  89071. onBeforeExecuteObservable: Observable<Action>;
  89072. /**
  89073. * Creates a new Action
  89074. * @param triggerOptions the trigger, with or without parameters, for the action
  89075. * @param condition an optional determinant of action
  89076. */
  89077. constructor(
  89078. /** the trigger, with or without parameters, for the action */
  89079. triggerOptions: any, condition?: Condition);
  89080. /**
  89081. * Internal only
  89082. * @hidden
  89083. */
  89084. _prepare(): void;
  89085. /**
  89086. * Gets the trigger parameters
  89087. * @returns the trigger parameters
  89088. */
  89089. getTriggerParameter(): any;
  89090. /**
  89091. * Internal only - executes current action event
  89092. * @hidden
  89093. */
  89094. _executeCurrent(evt?: ActionEvent): void;
  89095. /**
  89096. * Execute placeholder for child classes
  89097. * @param evt optional action event
  89098. */
  89099. execute(evt?: ActionEvent): void;
  89100. /**
  89101. * Skips to next active action
  89102. */
  89103. skipToNextActiveAction(): void;
  89104. /**
  89105. * Adds action to chain of actions, may be a DoNothingAction
  89106. * @param action defines the next action to execute
  89107. * @returns The action passed in
  89108. * @see https://www.babylonjs-playground.com/#1T30HR#0
  89109. */
  89110. then(action: Action): Action;
  89111. /**
  89112. * Internal only
  89113. * @hidden
  89114. */
  89115. _getProperty(propertyPath: string): string;
  89116. /**
  89117. * Internal only
  89118. * @hidden
  89119. */
  89120. _getEffectiveTarget(target: any, propertyPath: string): any;
  89121. /**
  89122. * Serialize placeholder for child classes
  89123. * @param parent of child
  89124. * @returns the serialized object
  89125. */
  89126. serialize(parent: any): any;
  89127. /**
  89128. * Internal only called by serialize
  89129. * @hidden
  89130. */
  89131. protected _serialize(serializedAction: any, parent?: any): any;
  89132. /**
  89133. * Internal only
  89134. * @hidden
  89135. */
  89136. static _SerializeValueAsString: (value: any) => string;
  89137. /**
  89138. * Internal only
  89139. * @hidden
  89140. */
  89141. static _GetTargetProperty: (target: Scene | Node) => {
  89142. name: string;
  89143. targetType: string;
  89144. value: string;
  89145. };
  89146. }
  89147. }
  89148. declare module BABYLON {
  89149. /**
  89150. * A Condition applied to an Action
  89151. */
  89152. export class Condition {
  89153. /**
  89154. * Internal only - manager for action
  89155. * @hidden
  89156. */
  89157. _actionManager: ActionManager;
  89158. /**
  89159. * Internal only
  89160. * @hidden
  89161. */
  89162. _evaluationId: number;
  89163. /**
  89164. * Internal only
  89165. * @hidden
  89166. */
  89167. _currentResult: boolean;
  89168. /**
  89169. * Creates a new Condition
  89170. * @param actionManager the manager of the action the condition is applied to
  89171. */
  89172. constructor(actionManager: ActionManager);
  89173. /**
  89174. * Check if the current condition is valid
  89175. * @returns a boolean
  89176. */
  89177. isValid(): boolean;
  89178. /**
  89179. * Internal only
  89180. * @hidden
  89181. */
  89182. _getProperty(propertyPath: string): string;
  89183. /**
  89184. * Internal only
  89185. * @hidden
  89186. */
  89187. _getEffectiveTarget(target: any, propertyPath: string): any;
  89188. /**
  89189. * Serialize placeholder for child classes
  89190. * @returns the serialized object
  89191. */
  89192. serialize(): any;
  89193. /**
  89194. * Internal only
  89195. * @hidden
  89196. */
  89197. protected _serialize(serializedCondition: any): any;
  89198. }
  89199. /**
  89200. * Defines specific conditional operators as extensions of Condition
  89201. */
  89202. export class ValueCondition extends Condition {
  89203. /** path to specify the property of the target the conditional operator uses */
  89204. propertyPath: string;
  89205. /** the value compared by the conditional operator against the current value of the property */
  89206. value: any;
  89207. /** the conditional operator, default ValueCondition.IsEqual */
  89208. operator: number;
  89209. /**
  89210. * Internal only
  89211. * @hidden
  89212. */
  89213. private static _IsEqual;
  89214. /**
  89215. * Internal only
  89216. * @hidden
  89217. */
  89218. private static _IsDifferent;
  89219. /**
  89220. * Internal only
  89221. * @hidden
  89222. */
  89223. private static _IsGreater;
  89224. /**
  89225. * Internal only
  89226. * @hidden
  89227. */
  89228. private static _IsLesser;
  89229. /**
  89230. * returns the number for IsEqual
  89231. */
  89232. static get IsEqual(): number;
  89233. /**
  89234. * Returns the number for IsDifferent
  89235. */
  89236. static get IsDifferent(): number;
  89237. /**
  89238. * Returns the number for IsGreater
  89239. */
  89240. static get IsGreater(): number;
  89241. /**
  89242. * Returns the number for IsLesser
  89243. */
  89244. static get IsLesser(): number;
  89245. /**
  89246. * Internal only The action manager for the condition
  89247. * @hidden
  89248. */
  89249. _actionManager: ActionManager;
  89250. /**
  89251. * Internal only
  89252. * @hidden
  89253. */
  89254. private _target;
  89255. /**
  89256. * Internal only
  89257. * @hidden
  89258. */
  89259. private _effectiveTarget;
  89260. /**
  89261. * Internal only
  89262. * @hidden
  89263. */
  89264. private _property;
  89265. /**
  89266. * Creates a new ValueCondition
  89267. * @param actionManager manager for the action the condition applies to
  89268. * @param target for the action
  89269. * @param propertyPath path to specify the property of the target the conditional operator uses
  89270. * @param value the value compared by the conditional operator against the current value of the property
  89271. * @param operator the conditional operator, default ValueCondition.IsEqual
  89272. */
  89273. constructor(actionManager: ActionManager, target: any,
  89274. /** path to specify the property of the target the conditional operator uses */
  89275. propertyPath: string,
  89276. /** the value compared by the conditional operator against the current value of the property */
  89277. value: any,
  89278. /** the conditional operator, default ValueCondition.IsEqual */
  89279. operator?: number);
  89280. /**
  89281. * Compares the given value with the property value for the specified conditional operator
  89282. * @returns the result of the comparison
  89283. */
  89284. isValid(): boolean;
  89285. /**
  89286. * Serialize the ValueCondition into a JSON compatible object
  89287. * @returns serialization object
  89288. */
  89289. serialize(): any;
  89290. /**
  89291. * Gets the name of the conditional operator for the ValueCondition
  89292. * @param operator the conditional operator
  89293. * @returns the name
  89294. */
  89295. static GetOperatorName(operator: number): string;
  89296. }
  89297. /**
  89298. * Defines a predicate condition as an extension of Condition
  89299. */
  89300. export class PredicateCondition extends Condition {
  89301. /** defines the predicate function used to validate the condition */
  89302. predicate: () => boolean;
  89303. /**
  89304. * Internal only - manager for action
  89305. * @hidden
  89306. */
  89307. _actionManager: ActionManager;
  89308. /**
  89309. * Creates a new PredicateCondition
  89310. * @param actionManager manager for the action the condition applies to
  89311. * @param predicate defines the predicate function used to validate the condition
  89312. */
  89313. constructor(actionManager: ActionManager,
  89314. /** defines the predicate function used to validate the condition */
  89315. predicate: () => boolean);
  89316. /**
  89317. * @returns the validity of the predicate condition
  89318. */
  89319. isValid(): boolean;
  89320. }
  89321. /**
  89322. * Defines a state condition as an extension of Condition
  89323. */
  89324. export class StateCondition extends Condition {
  89325. /** Value to compare with target state */
  89326. value: string;
  89327. /**
  89328. * Internal only - manager for action
  89329. * @hidden
  89330. */
  89331. _actionManager: ActionManager;
  89332. /**
  89333. * Internal only
  89334. * @hidden
  89335. */
  89336. private _target;
  89337. /**
  89338. * Creates a new StateCondition
  89339. * @param actionManager manager for the action the condition applies to
  89340. * @param target of the condition
  89341. * @param value to compare with target state
  89342. */
  89343. constructor(actionManager: ActionManager, target: any,
  89344. /** Value to compare with target state */
  89345. value: string);
  89346. /**
  89347. * Gets a boolean indicating if the current condition is met
  89348. * @returns the validity of the state
  89349. */
  89350. isValid(): boolean;
  89351. /**
  89352. * Serialize the StateCondition into a JSON compatible object
  89353. * @returns serialization object
  89354. */
  89355. serialize(): any;
  89356. }
  89357. }
  89358. declare module BABYLON {
  89359. /**
  89360. * This defines an action responsible to toggle a boolean once triggered.
  89361. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89362. */
  89363. export class SwitchBooleanAction extends Action {
  89364. /**
  89365. * The path to the boolean property in the target object
  89366. */
  89367. propertyPath: string;
  89368. private _target;
  89369. private _effectiveTarget;
  89370. private _property;
  89371. /**
  89372. * Instantiate the action
  89373. * @param triggerOptions defines the trigger options
  89374. * @param target defines the object containing the boolean
  89375. * @param propertyPath defines the path to the boolean property in the target object
  89376. * @param condition defines the trigger related conditions
  89377. */
  89378. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  89379. /** @hidden */
  89380. _prepare(): void;
  89381. /**
  89382. * Execute the action toggle the boolean value.
  89383. */
  89384. execute(): void;
  89385. /**
  89386. * Serializes the actions and its related information.
  89387. * @param parent defines the object to serialize in
  89388. * @returns the serialized object
  89389. */
  89390. serialize(parent: any): any;
  89391. }
  89392. /**
  89393. * This defines an action responsible to set a the state field of the target
  89394. * to a desired value once triggered.
  89395. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89396. */
  89397. export class SetStateAction extends Action {
  89398. /**
  89399. * The value to store in the state field.
  89400. */
  89401. value: string;
  89402. private _target;
  89403. /**
  89404. * Instantiate the action
  89405. * @param triggerOptions defines the trigger options
  89406. * @param target defines the object containing the state property
  89407. * @param value defines the value to store in the state field
  89408. * @param condition defines the trigger related conditions
  89409. */
  89410. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  89411. /**
  89412. * Execute the action and store the value on the target state property.
  89413. */
  89414. execute(): void;
  89415. /**
  89416. * Serializes the actions and its related information.
  89417. * @param parent defines the object to serialize in
  89418. * @returns the serialized object
  89419. */
  89420. serialize(parent: any): any;
  89421. }
  89422. /**
  89423. * This defines an action responsible to set a property of the target
  89424. * to a desired value once triggered.
  89425. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89426. */
  89427. export class SetValueAction extends Action {
  89428. /**
  89429. * The path of the property to set in the target.
  89430. */
  89431. propertyPath: string;
  89432. /**
  89433. * The value to set in the property
  89434. */
  89435. value: any;
  89436. private _target;
  89437. private _effectiveTarget;
  89438. private _property;
  89439. /**
  89440. * Instantiate the action
  89441. * @param triggerOptions defines the trigger options
  89442. * @param target defines the object containing the property
  89443. * @param propertyPath defines the path of the property to set in the target
  89444. * @param value defines the value to set in the property
  89445. * @param condition defines the trigger related conditions
  89446. */
  89447. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  89448. /** @hidden */
  89449. _prepare(): void;
  89450. /**
  89451. * Execute the action and set the targetted property to the desired value.
  89452. */
  89453. execute(): void;
  89454. /**
  89455. * Serializes the actions and its related information.
  89456. * @param parent defines the object to serialize in
  89457. * @returns the serialized object
  89458. */
  89459. serialize(parent: any): any;
  89460. }
  89461. /**
  89462. * This defines an action responsible to increment the target value
  89463. * to a desired value once triggered.
  89464. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89465. */
  89466. export class IncrementValueAction extends Action {
  89467. /**
  89468. * The path of the property to increment in the target.
  89469. */
  89470. propertyPath: string;
  89471. /**
  89472. * The value we should increment the property by.
  89473. */
  89474. value: any;
  89475. private _target;
  89476. private _effectiveTarget;
  89477. private _property;
  89478. /**
  89479. * Instantiate the action
  89480. * @param triggerOptions defines the trigger options
  89481. * @param target defines the object containing the property
  89482. * @param propertyPath defines the path of the property to increment in the target
  89483. * @param value defines the value value we should increment the property by
  89484. * @param condition defines the trigger related conditions
  89485. */
  89486. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  89487. /** @hidden */
  89488. _prepare(): void;
  89489. /**
  89490. * Execute the action and increment the target of the value amount.
  89491. */
  89492. execute(): void;
  89493. /**
  89494. * Serializes the actions and its related information.
  89495. * @param parent defines the object to serialize in
  89496. * @returns the serialized object
  89497. */
  89498. serialize(parent: any): any;
  89499. }
  89500. /**
  89501. * This defines an action responsible to start an animation once triggered.
  89502. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89503. */
  89504. export class PlayAnimationAction extends Action {
  89505. /**
  89506. * Where the animation should start (animation frame)
  89507. */
  89508. from: number;
  89509. /**
  89510. * Where the animation should stop (animation frame)
  89511. */
  89512. to: number;
  89513. /**
  89514. * Define if the animation should loop or stop after the first play.
  89515. */
  89516. loop?: boolean;
  89517. private _target;
  89518. /**
  89519. * Instantiate the action
  89520. * @param triggerOptions defines the trigger options
  89521. * @param target defines the target animation or animation name
  89522. * @param from defines from where the animation should start (animation frame)
  89523. * @param end defines where the animation should stop (animation frame)
  89524. * @param loop defines if the animation should loop or stop after the first play
  89525. * @param condition defines the trigger related conditions
  89526. */
  89527. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  89528. /** @hidden */
  89529. _prepare(): void;
  89530. /**
  89531. * Execute the action and play the animation.
  89532. */
  89533. execute(): void;
  89534. /**
  89535. * Serializes the actions and its related information.
  89536. * @param parent defines the object to serialize in
  89537. * @returns the serialized object
  89538. */
  89539. serialize(parent: any): any;
  89540. }
  89541. /**
  89542. * This defines an action responsible to stop an animation once triggered.
  89543. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89544. */
  89545. export class StopAnimationAction extends Action {
  89546. private _target;
  89547. /**
  89548. * Instantiate the action
  89549. * @param triggerOptions defines the trigger options
  89550. * @param target defines the target animation or animation name
  89551. * @param condition defines the trigger related conditions
  89552. */
  89553. constructor(triggerOptions: any, target: any, condition?: Condition);
  89554. /** @hidden */
  89555. _prepare(): void;
  89556. /**
  89557. * Execute the action and stop the animation.
  89558. */
  89559. execute(): void;
  89560. /**
  89561. * Serializes the actions and its related information.
  89562. * @param parent defines the object to serialize in
  89563. * @returns the serialized object
  89564. */
  89565. serialize(parent: any): any;
  89566. }
  89567. /**
  89568. * This defines an action responsible that does nothing once triggered.
  89569. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89570. */
  89571. export class DoNothingAction extends Action {
  89572. /**
  89573. * Instantiate the action
  89574. * @param triggerOptions defines the trigger options
  89575. * @param condition defines the trigger related conditions
  89576. */
  89577. constructor(triggerOptions?: any, condition?: Condition);
  89578. /**
  89579. * Execute the action and do nothing.
  89580. */
  89581. execute(): void;
  89582. /**
  89583. * Serializes the actions and its related information.
  89584. * @param parent defines the object to serialize in
  89585. * @returns the serialized object
  89586. */
  89587. serialize(parent: any): any;
  89588. }
  89589. /**
  89590. * This defines an action responsible to trigger several actions once triggered.
  89591. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89592. */
  89593. export class CombineAction extends Action {
  89594. /**
  89595. * The list of aggregated animations to run.
  89596. */
  89597. children: Action[];
  89598. /**
  89599. * Instantiate the action
  89600. * @param triggerOptions defines the trigger options
  89601. * @param children defines the list of aggregated animations to run
  89602. * @param condition defines the trigger related conditions
  89603. */
  89604. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  89605. /** @hidden */
  89606. _prepare(): void;
  89607. /**
  89608. * Execute the action and executes all the aggregated actions.
  89609. */
  89610. execute(evt: ActionEvent): void;
  89611. /**
  89612. * Serializes the actions and its related information.
  89613. * @param parent defines the object to serialize in
  89614. * @returns the serialized object
  89615. */
  89616. serialize(parent: any): any;
  89617. }
  89618. /**
  89619. * This defines an action responsible to run code (external event) once triggered.
  89620. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89621. */
  89622. export class ExecuteCodeAction extends Action {
  89623. /**
  89624. * The callback function to run.
  89625. */
  89626. func: (evt: ActionEvent) => void;
  89627. /**
  89628. * Instantiate the action
  89629. * @param triggerOptions defines the trigger options
  89630. * @param func defines the callback function to run
  89631. * @param condition defines the trigger related conditions
  89632. */
  89633. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  89634. /**
  89635. * Execute the action and run the attached code.
  89636. */
  89637. execute(evt: ActionEvent): void;
  89638. }
  89639. /**
  89640. * This defines an action responsible to set the parent property of the target once triggered.
  89641. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89642. */
  89643. export class SetParentAction extends Action {
  89644. private _parent;
  89645. private _target;
  89646. /**
  89647. * Instantiate the action
  89648. * @param triggerOptions defines the trigger options
  89649. * @param target defines the target containing the parent property
  89650. * @param parent defines from where the animation should start (animation frame)
  89651. * @param condition defines the trigger related conditions
  89652. */
  89653. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  89654. /** @hidden */
  89655. _prepare(): void;
  89656. /**
  89657. * Execute the action and set the parent property.
  89658. */
  89659. execute(): void;
  89660. /**
  89661. * Serializes the actions and its related information.
  89662. * @param parent defines the object to serialize in
  89663. * @returns the serialized object
  89664. */
  89665. serialize(parent: any): any;
  89666. }
  89667. }
  89668. declare module BABYLON {
  89669. /**
  89670. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  89671. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  89672. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89673. */
  89674. export class ActionManager extends AbstractActionManager {
  89675. /**
  89676. * Nothing
  89677. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89678. */
  89679. static readonly NothingTrigger: number;
  89680. /**
  89681. * On pick
  89682. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89683. */
  89684. static readonly OnPickTrigger: number;
  89685. /**
  89686. * On left pick
  89687. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89688. */
  89689. static readonly OnLeftPickTrigger: number;
  89690. /**
  89691. * On right pick
  89692. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89693. */
  89694. static readonly OnRightPickTrigger: number;
  89695. /**
  89696. * On center pick
  89697. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89698. */
  89699. static readonly OnCenterPickTrigger: number;
  89700. /**
  89701. * On pick down
  89702. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89703. */
  89704. static readonly OnPickDownTrigger: number;
  89705. /**
  89706. * On double pick
  89707. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89708. */
  89709. static readonly OnDoublePickTrigger: number;
  89710. /**
  89711. * On pick up
  89712. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89713. */
  89714. static readonly OnPickUpTrigger: number;
  89715. /**
  89716. * On pick out.
  89717. * This trigger will only be raised if you also declared a OnPickDown
  89718. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89719. */
  89720. static readonly OnPickOutTrigger: number;
  89721. /**
  89722. * On long press
  89723. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89724. */
  89725. static readonly OnLongPressTrigger: number;
  89726. /**
  89727. * On pointer over
  89728. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89729. */
  89730. static readonly OnPointerOverTrigger: number;
  89731. /**
  89732. * On pointer out
  89733. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89734. */
  89735. static readonly OnPointerOutTrigger: number;
  89736. /**
  89737. * On every frame
  89738. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89739. */
  89740. static readonly OnEveryFrameTrigger: number;
  89741. /**
  89742. * On intersection enter
  89743. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89744. */
  89745. static readonly OnIntersectionEnterTrigger: number;
  89746. /**
  89747. * On intersection exit
  89748. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89749. */
  89750. static readonly OnIntersectionExitTrigger: number;
  89751. /**
  89752. * On key down
  89753. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89754. */
  89755. static readonly OnKeyDownTrigger: number;
  89756. /**
  89757. * On key up
  89758. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89759. */
  89760. static readonly OnKeyUpTrigger: number;
  89761. private _scene;
  89762. /**
  89763. * Creates a new action manager
  89764. * @param scene defines the hosting scene
  89765. */
  89766. constructor(scene: Scene);
  89767. /**
  89768. * Releases all associated resources
  89769. */
  89770. dispose(): void;
  89771. /**
  89772. * Gets hosting scene
  89773. * @returns the hosting scene
  89774. */
  89775. getScene(): Scene;
  89776. /**
  89777. * Does this action manager handles actions of any of the given triggers
  89778. * @param triggers defines the triggers to be tested
  89779. * @return a boolean indicating whether one (or more) of the triggers is handled
  89780. */
  89781. hasSpecificTriggers(triggers: number[]): boolean;
  89782. /**
  89783. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  89784. * speed.
  89785. * @param triggerA defines the trigger to be tested
  89786. * @param triggerB defines the trigger to be tested
  89787. * @return a boolean indicating whether one (or more) of the triggers is handled
  89788. */
  89789. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  89790. /**
  89791. * Does this action manager handles actions of a given trigger
  89792. * @param trigger defines the trigger to be tested
  89793. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  89794. * @return whether the trigger is handled
  89795. */
  89796. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  89797. /**
  89798. * Does this action manager has pointer triggers
  89799. */
  89800. get hasPointerTriggers(): boolean;
  89801. /**
  89802. * Does this action manager has pick triggers
  89803. */
  89804. get hasPickTriggers(): boolean;
  89805. /**
  89806. * Registers an action to this action manager
  89807. * @param action defines the action to be registered
  89808. * @return the action amended (prepared) after registration
  89809. */
  89810. registerAction(action: IAction): Nullable<IAction>;
  89811. /**
  89812. * Unregisters an action to this action manager
  89813. * @param action defines the action to be unregistered
  89814. * @return a boolean indicating whether the action has been unregistered
  89815. */
  89816. unregisterAction(action: IAction): Boolean;
  89817. /**
  89818. * Process a specific trigger
  89819. * @param trigger defines the trigger to process
  89820. * @param evt defines the event details to be processed
  89821. */
  89822. processTrigger(trigger: number, evt?: IActionEvent): void;
  89823. /** @hidden */
  89824. _getEffectiveTarget(target: any, propertyPath: string): any;
  89825. /** @hidden */
  89826. _getProperty(propertyPath: string): string;
  89827. /**
  89828. * Serialize this manager to a JSON object
  89829. * @param name defines the property name to store this manager
  89830. * @returns a JSON representation of this manager
  89831. */
  89832. serialize(name: string): any;
  89833. /**
  89834. * Creates a new ActionManager from a JSON data
  89835. * @param parsedActions defines the JSON data to read from
  89836. * @param object defines the hosting mesh
  89837. * @param scene defines the hosting scene
  89838. */
  89839. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  89840. /**
  89841. * Get a trigger name by index
  89842. * @param trigger defines the trigger index
  89843. * @returns a trigger name
  89844. */
  89845. static GetTriggerName(trigger: number): string;
  89846. }
  89847. }
  89848. declare module BABYLON {
  89849. /**
  89850. * Class used to represent a sprite
  89851. * @see https://doc.babylonjs.com/babylon101/sprites
  89852. */
  89853. export class Sprite implements IAnimatable {
  89854. /** defines the name */
  89855. name: string;
  89856. /** Gets or sets the current world position */
  89857. position: Vector3;
  89858. /** Gets or sets the main color */
  89859. color: Color4;
  89860. /** Gets or sets the width */
  89861. width: number;
  89862. /** Gets or sets the height */
  89863. height: number;
  89864. /** Gets or sets rotation angle */
  89865. angle: number;
  89866. /** Gets or sets the cell index in the sprite sheet */
  89867. cellIndex: number;
  89868. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  89869. cellRef: string;
  89870. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  89871. invertU: boolean;
  89872. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  89873. invertV: boolean;
  89874. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  89875. disposeWhenFinishedAnimating: boolean;
  89876. /** Gets the list of attached animations */
  89877. animations: Nullable<Array<Animation>>;
  89878. /** Gets or sets a boolean indicating if the sprite can be picked */
  89879. isPickable: boolean;
  89880. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  89881. useAlphaForPicking: boolean;
  89882. /** @hidden */
  89883. _xOffset: number;
  89884. /** @hidden */
  89885. _yOffset: number;
  89886. /** @hidden */
  89887. _xSize: number;
  89888. /** @hidden */
  89889. _ySize: number;
  89890. /**
  89891. * Gets or sets the associated action manager
  89892. */
  89893. actionManager: Nullable<ActionManager>;
  89894. /**
  89895. * An event triggered when the control has been disposed
  89896. */
  89897. onDisposeObservable: Observable<Sprite>;
  89898. private _animationStarted;
  89899. private _loopAnimation;
  89900. private _fromIndex;
  89901. private _toIndex;
  89902. private _delay;
  89903. private _direction;
  89904. private _manager;
  89905. private _time;
  89906. private _onAnimationEnd;
  89907. /**
  89908. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  89909. */
  89910. isVisible: boolean;
  89911. /**
  89912. * Gets or sets the sprite size
  89913. */
  89914. get size(): number;
  89915. set size(value: number);
  89916. /**
  89917. * Returns a boolean indicating if the animation is started
  89918. */
  89919. get animationStarted(): boolean;
  89920. /**
  89921. * Gets or sets the unique id of the sprite
  89922. */
  89923. uniqueId: number;
  89924. /**
  89925. * Gets the manager of this sprite
  89926. */
  89927. get manager(): ISpriteManager;
  89928. /**
  89929. * Creates a new Sprite
  89930. * @param name defines the name
  89931. * @param manager defines the manager
  89932. */
  89933. constructor(
  89934. /** defines the name */
  89935. name: string, manager: ISpriteManager);
  89936. /**
  89937. * Returns the string "Sprite"
  89938. * @returns "Sprite"
  89939. */
  89940. getClassName(): string;
  89941. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  89942. get fromIndex(): number;
  89943. set fromIndex(value: number);
  89944. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  89945. get toIndex(): number;
  89946. set toIndex(value: number);
  89947. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  89948. get loopAnimation(): boolean;
  89949. set loopAnimation(value: boolean);
  89950. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  89951. get delay(): number;
  89952. set delay(value: number);
  89953. /**
  89954. * Starts an animation
  89955. * @param from defines the initial key
  89956. * @param to defines the end key
  89957. * @param loop defines if the animation must loop
  89958. * @param delay defines the start delay (in ms)
  89959. * @param onAnimationEnd defines a callback to call when animation ends
  89960. */
  89961. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  89962. /** Stops current animation (if any) */
  89963. stopAnimation(): void;
  89964. /** @hidden */
  89965. _animate(deltaTime: number): void;
  89966. /** Release associated resources */
  89967. dispose(): void;
  89968. /**
  89969. * Serializes the sprite to a JSON object
  89970. * @returns the JSON object
  89971. */
  89972. serialize(): any;
  89973. /**
  89974. * Parses a JSON object to create a new sprite
  89975. * @param parsedSprite The JSON object to parse
  89976. * @param manager defines the hosting manager
  89977. * @returns the new sprite
  89978. */
  89979. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  89980. }
  89981. }
  89982. declare module BABYLON {
  89983. /**
  89984. * Information about the result of picking within a scene
  89985. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  89986. */
  89987. export class PickingInfo {
  89988. /** @hidden */
  89989. _pickingUnavailable: boolean;
  89990. /**
  89991. * If the pick collided with an object
  89992. */
  89993. hit: boolean;
  89994. /**
  89995. * Distance away where the pick collided
  89996. */
  89997. distance: number;
  89998. /**
  89999. * The location of pick collision
  90000. */
  90001. pickedPoint: Nullable<Vector3>;
  90002. /**
  90003. * The mesh corresponding the the pick collision
  90004. */
  90005. pickedMesh: Nullable<AbstractMesh>;
  90006. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  90007. bu: number;
  90008. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  90009. bv: number;
  90010. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  90011. faceId: number;
  90012. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  90013. subMeshFaceId: number;
  90014. /** Id of the the submesh that was picked */
  90015. subMeshId: number;
  90016. /** If a sprite was picked, this will be the sprite the pick collided with */
  90017. pickedSprite: Nullable<Sprite>;
  90018. /** If we are pikcing a mesh with thin instance, this will give you the picked thin instance */
  90019. thinInstanceIndex: number;
  90020. /**
  90021. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  90022. */
  90023. originMesh: Nullable<AbstractMesh>;
  90024. /**
  90025. * The ray that was used to perform the picking.
  90026. */
  90027. ray: Nullable<Ray>;
  90028. /**
  90029. * Gets the normal correspodning to the face the pick collided with
  90030. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  90031. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  90032. * @returns The normal correspodning to the face the pick collided with
  90033. */
  90034. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  90035. /**
  90036. * Gets the texture coordinates of where the pick occured
  90037. * @returns the vector containing the coordnates of the texture
  90038. */
  90039. getTextureCoordinates(): Nullable<Vector2>;
  90040. }
  90041. }
  90042. declare module BABYLON {
  90043. /**
  90044. * Class representing a ray with position and direction
  90045. */
  90046. export class Ray {
  90047. /** origin point */
  90048. origin: Vector3;
  90049. /** direction */
  90050. direction: Vector3;
  90051. /** length of the ray */
  90052. length: number;
  90053. private static readonly _TmpVector3;
  90054. private _tmpRay;
  90055. /**
  90056. * Creates a new ray
  90057. * @param origin origin point
  90058. * @param direction direction
  90059. * @param length length of the ray
  90060. */
  90061. constructor(
  90062. /** origin point */
  90063. origin: Vector3,
  90064. /** direction */
  90065. direction: Vector3,
  90066. /** length of the ray */
  90067. length?: number);
  90068. /**
  90069. * Checks if the ray intersects a box
  90070. * This does not account for the ray lenght by design to improve perfs.
  90071. * @param minimum bound of the box
  90072. * @param maximum bound of the box
  90073. * @param intersectionTreshold extra extend to be added to the box in all direction
  90074. * @returns if the box was hit
  90075. */
  90076. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  90077. /**
  90078. * Checks if the ray intersects a box
  90079. * This does not account for the ray lenght by design to improve perfs.
  90080. * @param box the bounding box to check
  90081. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  90082. * @returns if the box was hit
  90083. */
  90084. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  90085. /**
  90086. * If the ray hits a sphere
  90087. * @param sphere the bounding sphere to check
  90088. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  90089. * @returns true if it hits the sphere
  90090. */
  90091. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  90092. /**
  90093. * If the ray hits a triange
  90094. * @param vertex0 triangle vertex
  90095. * @param vertex1 triangle vertex
  90096. * @param vertex2 triangle vertex
  90097. * @returns intersection information if hit
  90098. */
  90099. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  90100. /**
  90101. * Checks if ray intersects a plane
  90102. * @param plane the plane to check
  90103. * @returns the distance away it was hit
  90104. */
  90105. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  90106. /**
  90107. * Calculate the intercept of a ray on a given axis
  90108. * @param axis to check 'x' | 'y' | 'z'
  90109. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  90110. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  90111. */
  90112. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  90113. /**
  90114. * Checks if ray intersects a mesh
  90115. * @param mesh the mesh to check
  90116. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90117. * @returns picking info of the intersecton
  90118. */
  90119. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  90120. /**
  90121. * Checks if ray intersects a mesh
  90122. * @param meshes the meshes to check
  90123. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90124. * @param results array to store result in
  90125. * @returns Array of picking infos
  90126. */
  90127. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  90128. private _comparePickingInfo;
  90129. private static smallnum;
  90130. private static rayl;
  90131. /**
  90132. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  90133. * @param sega the first point of the segment to test the intersection against
  90134. * @param segb the second point of the segment to test the intersection against
  90135. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  90136. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  90137. */
  90138. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  90139. /**
  90140. * Update the ray from viewport position
  90141. * @param x position
  90142. * @param y y position
  90143. * @param viewportWidth viewport width
  90144. * @param viewportHeight viewport height
  90145. * @param world world matrix
  90146. * @param view view matrix
  90147. * @param projection projection matrix
  90148. * @returns this ray updated
  90149. */
  90150. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  90151. /**
  90152. * Creates a ray with origin and direction of 0,0,0
  90153. * @returns the new ray
  90154. */
  90155. static Zero(): Ray;
  90156. /**
  90157. * Creates a new ray from screen space and viewport
  90158. * @param x position
  90159. * @param y y position
  90160. * @param viewportWidth viewport width
  90161. * @param viewportHeight viewport height
  90162. * @param world world matrix
  90163. * @param view view matrix
  90164. * @param projection projection matrix
  90165. * @returns new ray
  90166. */
  90167. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  90168. /**
  90169. * 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
  90170. * transformed to the given world matrix.
  90171. * @param origin The origin point
  90172. * @param end The end point
  90173. * @param world a matrix to transform the ray to. Default is the identity matrix.
  90174. * @returns the new ray
  90175. */
  90176. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  90177. /**
  90178. * Transforms a ray by a matrix
  90179. * @param ray ray to transform
  90180. * @param matrix matrix to apply
  90181. * @returns the resulting new ray
  90182. */
  90183. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  90184. /**
  90185. * Transforms a ray by a matrix
  90186. * @param ray ray to transform
  90187. * @param matrix matrix to apply
  90188. * @param result ray to store result in
  90189. */
  90190. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  90191. /**
  90192. * Unproject a ray from screen space to object space
  90193. * @param sourceX defines the screen space x coordinate to use
  90194. * @param sourceY defines the screen space y coordinate to use
  90195. * @param viewportWidth defines the current width of the viewport
  90196. * @param viewportHeight defines the current height of the viewport
  90197. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  90198. * @param view defines the view matrix to use
  90199. * @param projection defines the projection matrix to use
  90200. */
  90201. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  90202. }
  90203. /**
  90204. * Type used to define predicate used to select faces when a mesh intersection is detected
  90205. */
  90206. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  90207. interface Scene {
  90208. /** @hidden */
  90209. _tempPickingRay: Nullable<Ray>;
  90210. /** @hidden */
  90211. _cachedRayForTransform: Ray;
  90212. /** @hidden */
  90213. _pickWithRayInverseMatrix: Matrix;
  90214. /** @hidden */
  90215. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  90216. /** @hidden */
  90217. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  90218. /** @hidden */
  90219. _internalPickForMesh(pickingInfo: Nullable<PickingInfo>, rayFunction: (world: Matrix) => Ray, mesh: AbstractMesh, world: Matrix, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  90220. }
  90221. }
  90222. declare module BABYLON {
  90223. /**
  90224. * Groups all the scene component constants in one place to ease maintenance.
  90225. * @hidden
  90226. */
  90227. export class SceneComponentConstants {
  90228. static readonly NAME_EFFECTLAYER: string;
  90229. static readonly NAME_LAYER: string;
  90230. static readonly NAME_LENSFLARESYSTEM: string;
  90231. static readonly NAME_BOUNDINGBOXRENDERER: string;
  90232. static readonly NAME_PARTICLESYSTEM: string;
  90233. static readonly NAME_GAMEPAD: string;
  90234. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  90235. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  90236. static readonly NAME_PREPASSRENDERER: string;
  90237. static readonly NAME_DEPTHRENDERER: string;
  90238. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  90239. static readonly NAME_SPRITE: string;
  90240. static readonly NAME_OUTLINERENDERER: string;
  90241. static readonly NAME_PROCEDURALTEXTURE: string;
  90242. static readonly NAME_SHADOWGENERATOR: string;
  90243. static readonly NAME_OCTREE: string;
  90244. static readonly NAME_PHYSICSENGINE: string;
  90245. static readonly NAME_AUDIO: string;
  90246. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  90247. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  90248. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  90249. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  90250. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  90251. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  90252. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  90253. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  90254. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  90255. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  90256. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  90257. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  90258. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  90259. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  90260. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  90261. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  90262. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  90263. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  90264. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  90265. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  90266. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  90267. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  90268. static readonly STEP_AFTERRENDER_AUDIO: number;
  90269. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  90270. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  90271. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  90272. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  90273. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  90274. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  90275. static readonly STEP_POINTERMOVE_SPRITE: number;
  90276. static readonly STEP_POINTERDOWN_SPRITE: number;
  90277. static readonly STEP_POINTERUP_SPRITE: number;
  90278. }
  90279. /**
  90280. * This represents a scene component.
  90281. *
  90282. * This is used to decouple the dependency the scene is having on the different workloads like
  90283. * layers, post processes...
  90284. */
  90285. export interface ISceneComponent {
  90286. /**
  90287. * The name of the component. Each component must have a unique name.
  90288. */
  90289. name: string;
  90290. /**
  90291. * The scene the component belongs to.
  90292. */
  90293. scene: Scene;
  90294. /**
  90295. * Register the component to one instance of a scene.
  90296. */
  90297. register(): void;
  90298. /**
  90299. * Rebuilds the elements related to this component in case of
  90300. * context lost for instance.
  90301. */
  90302. rebuild(): void;
  90303. /**
  90304. * Disposes the component and the associated ressources.
  90305. */
  90306. dispose(): void;
  90307. }
  90308. /**
  90309. * This represents a SERIALIZABLE scene component.
  90310. *
  90311. * This extends Scene Component to add Serialization methods on top.
  90312. */
  90313. export interface ISceneSerializableComponent extends ISceneComponent {
  90314. /**
  90315. * Adds all the elements from the container to the scene
  90316. * @param container the container holding the elements
  90317. */
  90318. addFromContainer(container: AbstractScene): void;
  90319. /**
  90320. * Removes all the elements in the container from the scene
  90321. * @param container contains the elements to remove
  90322. * @param dispose if the removed element should be disposed (default: false)
  90323. */
  90324. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  90325. /**
  90326. * Serializes the component data to the specified json object
  90327. * @param serializationObject The object to serialize to
  90328. */
  90329. serialize(serializationObject: any): void;
  90330. }
  90331. /**
  90332. * Strong typing of a Mesh related stage step action
  90333. */
  90334. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  90335. /**
  90336. * Strong typing of a Evaluate Sub Mesh related stage step action
  90337. */
  90338. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  90339. /**
  90340. * Strong typing of a Active Mesh related stage step action
  90341. */
  90342. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  90343. /**
  90344. * Strong typing of a Camera related stage step action
  90345. */
  90346. export type CameraStageAction = (camera: Camera) => void;
  90347. /**
  90348. * Strong typing of a Camera Frame buffer related stage step action
  90349. */
  90350. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  90351. /**
  90352. * Strong typing of a Render Target related stage step action
  90353. */
  90354. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  90355. /**
  90356. * Strong typing of a RenderingGroup related stage step action
  90357. */
  90358. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  90359. /**
  90360. * Strong typing of a Mesh Render related stage step action
  90361. */
  90362. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  90363. /**
  90364. * Strong typing of a simple stage step action
  90365. */
  90366. export type SimpleStageAction = () => void;
  90367. /**
  90368. * Strong typing of a render target action.
  90369. */
  90370. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  90371. /**
  90372. * Strong typing of a pointer move action.
  90373. */
  90374. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  90375. /**
  90376. * Strong typing of a pointer up/down action.
  90377. */
  90378. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  90379. /**
  90380. * Representation of a stage in the scene (Basically a list of ordered steps)
  90381. * @hidden
  90382. */
  90383. export class Stage<T extends Function> extends Array<{
  90384. index: number;
  90385. component: ISceneComponent;
  90386. action: T;
  90387. }> {
  90388. /**
  90389. * Hide ctor from the rest of the world.
  90390. * @param items The items to add.
  90391. */
  90392. private constructor();
  90393. /**
  90394. * Creates a new Stage.
  90395. * @returns A new instance of a Stage
  90396. */
  90397. static Create<T extends Function>(): Stage<T>;
  90398. /**
  90399. * Registers a step in an ordered way in the targeted stage.
  90400. * @param index Defines the position to register the step in
  90401. * @param component Defines the component attached to the step
  90402. * @param action Defines the action to launch during the step
  90403. */
  90404. registerStep(index: number, component: ISceneComponent, action: T): void;
  90405. /**
  90406. * Clears all the steps from the stage.
  90407. */
  90408. clear(): void;
  90409. }
  90410. }
  90411. declare module BABYLON {
  90412. interface Scene {
  90413. /** @hidden */
  90414. _pointerOverSprite: Nullable<Sprite>;
  90415. /** @hidden */
  90416. _pickedDownSprite: Nullable<Sprite>;
  90417. /** @hidden */
  90418. _tempSpritePickingRay: Nullable<Ray>;
  90419. /**
  90420. * All of the sprite managers added to this scene
  90421. * @see https://doc.babylonjs.com/babylon101/sprites
  90422. */
  90423. spriteManagers: Array<ISpriteManager>;
  90424. /**
  90425. * An event triggered when sprites rendering is about to start
  90426. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  90427. */
  90428. onBeforeSpritesRenderingObservable: Observable<Scene>;
  90429. /**
  90430. * An event triggered when sprites rendering is done
  90431. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  90432. */
  90433. onAfterSpritesRenderingObservable: Observable<Scene>;
  90434. /** @hidden */
  90435. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90436. /** Launch a ray to try to pick a sprite in the scene
  90437. * @param x position on screen
  90438. * @param y position on screen
  90439. * @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
  90440. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90441. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  90442. * @returns a PickingInfo
  90443. */
  90444. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90445. /** Use the given ray to pick a sprite in the scene
  90446. * @param ray The ray (in world space) to use to pick meshes
  90447. * @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
  90448. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90449. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  90450. * @returns a PickingInfo
  90451. */
  90452. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90453. /** @hidden */
  90454. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90455. /** Launch a ray to try to pick sprites in the scene
  90456. * @param x position on screen
  90457. * @param y position on screen
  90458. * @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
  90459. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  90460. * @returns a PickingInfo array
  90461. */
  90462. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90463. /** Use the given ray to pick sprites in the scene
  90464. * @param ray The ray (in world space) to use to pick meshes
  90465. * @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
  90466. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  90467. * @returns a PickingInfo array
  90468. */
  90469. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90470. /**
  90471. * Force the sprite under the pointer
  90472. * @param sprite defines the sprite to use
  90473. */
  90474. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  90475. /**
  90476. * Gets the sprite under the pointer
  90477. * @returns a Sprite or null if no sprite is under the pointer
  90478. */
  90479. getPointerOverSprite(): Nullable<Sprite>;
  90480. }
  90481. /**
  90482. * Defines the sprite scene component responsible to manage sprites
  90483. * in a given scene.
  90484. */
  90485. export class SpriteSceneComponent implements ISceneComponent {
  90486. /**
  90487. * The component name helpfull to identify the component in the list of scene components.
  90488. */
  90489. readonly name: string;
  90490. /**
  90491. * The scene the component belongs to.
  90492. */
  90493. scene: Scene;
  90494. /** @hidden */
  90495. private _spritePredicate;
  90496. /**
  90497. * Creates a new instance of the component for the given scene
  90498. * @param scene Defines the scene to register the component in
  90499. */
  90500. constructor(scene: Scene);
  90501. /**
  90502. * Registers the component in a given scene
  90503. */
  90504. register(): void;
  90505. /**
  90506. * Rebuilds the elements related to this component in case of
  90507. * context lost for instance.
  90508. */
  90509. rebuild(): void;
  90510. /**
  90511. * Disposes the component and the associated ressources.
  90512. */
  90513. dispose(): void;
  90514. private _pickSpriteButKeepRay;
  90515. private _pointerMove;
  90516. private _pointerDown;
  90517. private _pointerUp;
  90518. }
  90519. }
  90520. declare module BABYLON {
  90521. /** @hidden */
  90522. export var fogFragmentDeclaration: {
  90523. name: string;
  90524. shader: string;
  90525. };
  90526. }
  90527. declare module BABYLON {
  90528. /** @hidden */
  90529. export var fogFragment: {
  90530. name: string;
  90531. shader: string;
  90532. };
  90533. }
  90534. declare module BABYLON {
  90535. /** @hidden */
  90536. export var spritesPixelShader: {
  90537. name: string;
  90538. shader: string;
  90539. };
  90540. }
  90541. declare module BABYLON {
  90542. /** @hidden */
  90543. export var fogVertexDeclaration: {
  90544. name: string;
  90545. shader: string;
  90546. };
  90547. }
  90548. declare module BABYLON {
  90549. /** @hidden */
  90550. export var spritesVertexShader: {
  90551. name: string;
  90552. shader: string;
  90553. };
  90554. }
  90555. declare module BABYLON {
  90556. /**
  90557. * Defines the minimum interface to fullfil in order to be a sprite manager.
  90558. */
  90559. export interface ISpriteManager extends IDisposable {
  90560. /**
  90561. * Gets manager's name
  90562. */
  90563. name: string;
  90564. /**
  90565. * Restricts the camera to viewing objects with the same layerMask.
  90566. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  90567. */
  90568. layerMask: number;
  90569. /**
  90570. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  90571. */
  90572. isPickable: boolean;
  90573. /**
  90574. * Gets the hosting scene
  90575. */
  90576. scene: Scene;
  90577. /**
  90578. * Specifies the rendering group id for this mesh (0 by default)
  90579. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  90580. */
  90581. renderingGroupId: number;
  90582. /**
  90583. * Defines the list of sprites managed by the manager.
  90584. */
  90585. sprites: Array<Sprite>;
  90586. /**
  90587. * Gets or sets the spritesheet texture
  90588. */
  90589. texture: Texture;
  90590. /** Defines the default width of a cell in the spritesheet */
  90591. cellWidth: number;
  90592. /** Defines the default height of a cell in the spritesheet */
  90593. cellHeight: number;
  90594. /**
  90595. * Tests the intersection of a sprite with a specific ray.
  90596. * @param ray The ray we are sending to test the collision
  90597. * @param camera The camera space we are sending rays in
  90598. * @param predicate A predicate allowing excluding sprites from the list of object to test
  90599. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90600. * @returns picking info or null.
  90601. */
  90602. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  90603. /**
  90604. * Intersects the sprites with a ray
  90605. * @param ray defines the ray to intersect with
  90606. * @param camera defines the current active camera
  90607. * @param predicate defines a predicate used to select candidate sprites
  90608. * @returns null if no hit or a PickingInfo array
  90609. */
  90610. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  90611. /**
  90612. * Renders the list of sprites on screen.
  90613. */
  90614. render(): void;
  90615. }
  90616. /**
  90617. * Class used to manage multiple sprites on the same spritesheet
  90618. * @see https://doc.babylonjs.com/babylon101/sprites
  90619. */
  90620. export class SpriteManager implements ISpriteManager {
  90621. /** defines the manager's name */
  90622. name: string;
  90623. /** Define the Url to load snippets */
  90624. static SnippetUrl: string;
  90625. /** Snippet ID if the manager was created from the snippet server */
  90626. snippetId: string;
  90627. /** Gets the list of sprites */
  90628. sprites: Sprite[];
  90629. /** Gets or sets the rendering group id (0 by default) */
  90630. renderingGroupId: number;
  90631. /** Gets or sets camera layer mask */
  90632. layerMask: number;
  90633. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  90634. fogEnabled: boolean;
  90635. /** Gets or sets a boolean indicating if the sprites are pickable */
  90636. isPickable: boolean;
  90637. /** Defines the default width of a cell in the spritesheet */
  90638. cellWidth: number;
  90639. /** Defines the default height of a cell in the spritesheet */
  90640. cellHeight: number;
  90641. /** Associative array from JSON sprite data file */
  90642. private _cellData;
  90643. /** Array of sprite names from JSON sprite data file */
  90644. private _spriteMap;
  90645. /** True when packed cell data from JSON file is ready*/
  90646. private _packedAndReady;
  90647. private _textureContent;
  90648. private _useInstancing;
  90649. /**
  90650. * An event triggered when the manager is disposed.
  90651. */
  90652. onDisposeObservable: Observable<SpriteManager>;
  90653. private _onDisposeObserver;
  90654. /**
  90655. * Callback called when the manager is disposed
  90656. */
  90657. set onDispose(callback: () => void);
  90658. private _capacity;
  90659. private _fromPacked;
  90660. private _spriteTexture;
  90661. private _epsilon;
  90662. private _scene;
  90663. private _vertexData;
  90664. private _buffer;
  90665. private _vertexBuffers;
  90666. private _spriteBuffer;
  90667. private _indexBuffer;
  90668. private _effectBase;
  90669. private _effectFog;
  90670. private _vertexBufferSize;
  90671. /**
  90672. * Gets or sets the unique id of the sprite
  90673. */
  90674. uniqueId: number;
  90675. /**
  90676. * Gets the array of sprites
  90677. */
  90678. get children(): Sprite[];
  90679. /**
  90680. * Gets the hosting scene
  90681. */
  90682. get scene(): Scene;
  90683. /**
  90684. * Gets the capacity of the manager
  90685. */
  90686. get capacity(): number;
  90687. /**
  90688. * Gets or sets the spritesheet texture
  90689. */
  90690. get texture(): Texture;
  90691. set texture(value: Texture);
  90692. private _blendMode;
  90693. /**
  90694. * Blend mode use to render the particle, it can be any of
  90695. * the static Constants.ALPHA_x properties provided in this class.
  90696. * Default value is Constants.ALPHA_COMBINE
  90697. */
  90698. get blendMode(): number;
  90699. set blendMode(blendMode: number);
  90700. /** Disables writing to the depth buffer when rendering the sprites.
  90701. * It can be handy to disable depth writing when using textures without alpha channel
  90702. * and setting some specific blend modes.
  90703. */
  90704. disableDepthWrite: boolean;
  90705. /**
  90706. * Creates a new sprite manager
  90707. * @param name defines the manager's name
  90708. * @param imgUrl defines the sprite sheet url
  90709. * @param capacity defines the maximum allowed number of sprites
  90710. * @param cellSize defines the size of a sprite cell
  90711. * @param scene defines the hosting scene
  90712. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  90713. * @param samplingMode defines the smapling mode to use with spritesheet
  90714. * @param fromPacked set to false; do not alter
  90715. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  90716. */
  90717. constructor(
  90718. /** defines the manager's name */
  90719. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  90720. /**
  90721. * Returns the string "SpriteManager"
  90722. * @returns "SpriteManager"
  90723. */
  90724. getClassName(): string;
  90725. private _makePacked;
  90726. private _appendSpriteVertex;
  90727. private _checkTextureAlpha;
  90728. /**
  90729. * Intersects the sprites with a ray
  90730. * @param ray defines the ray to intersect with
  90731. * @param camera defines the current active camera
  90732. * @param predicate defines a predicate used to select candidate sprites
  90733. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  90734. * @returns null if no hit or a PickingInfo
  90735. */
  90736. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  90737. /**
  90738. * Intersects the sprites with a ray
  90739. * @param ray defines the ray to intersect with
  90740. * @param camera defines the current active camera
  90741. * @param predicate defines a predicate used to select candidate sprites
  90742. * @returns null if no hit or a PickingInfo array
  90743. */
  90744. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  90745. /**
  90746. * Render all child sprites
  90747. */
  90748. render(): void;
  90749. /**
  90750. * Release associated resources
  90751. */
  90752. dispose(): void;
  90753. /**
  90754. * Serializes the sprite manager to a JSON object
  90755. * @param serializeTexture defines if the texture must be serialized as well
  90756. * @returns the JSON object
  90757. */
  90758. serialize(serializeTexture?: boolean): any;
  90759. /**
  90760. * Parses a JSON object to create a new sprite manager.
  90761. * @param parsedManager The JSON object to parse
  90762. * @param scene The scene to create the sprite managerin
  90763. * @param rootUrl The root url to use to load external dependencies like texture
  90764. * @returns the new sprite manager
  90765. */
  90766. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  90767. /**
  90768. * Creates a sprite manager from a snippet saved in a remote file
  90769. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  90770. * @param url defines the url to load from
  90771. * @param scene defines the hosting scene
  90772. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  90773. * @returns a promise that will resolve to the new sprite manager
  90774. */
  90775. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  90776. /**
  90777. * Creates a sprite manager from a snippet saved by the sprite editor
  90778. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  90779. * @param scene defines the hosting scene
  90780. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  90781. * @returns a promise that will resolve to the new sprite manager
  90782. */
  90783. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  90784. }
  90785. }
  90786. declare module BABYLON {
  90787. /** Interface used by value gradients (color, factor, ...) */
  90788. export interface IValueGradient {
  90789. /**
  90790. * Gets or sets the gradient value (between 0 and 1)
  90791. */
  90792. gradient: number;
  90793. }
  90794. /** Class used to store color4 gradient */
  90795. export class ColorGradient implements IValueGradient {
  90796. /**
  90797. * Gets or sets the gradient value (between 0 and 1)
  90798. */
  90799. gradient: number;
  90800. /**
  90801. * Gets or sets first associated color
  90802. */
  90803. color1: Color4;
  90804. /**
  90805. * Gets or sets second associated color
  90806. */
  90807. color2?: Color4 | undefined;
  90808. /**
  90809. * Creates a new color4 gradient
  90810. * @param gradient gets or sets the gradient value (between 0 and 1)
  90811. * @param color1 gets or sets first associated color
  90812. * @param color2 gets or sets first second color
  90813. */
  90814. constructor(
  90815. /**
  90816. * Gets or sets the gradient value (between 0 and 1)
  90817. */
  90818. gradient: number,
  90819. /**
  90820. * Gets or sets first associated color
  90821. */
  90822. color1: Color4,
  90823. /**
  90824. * Gets or sets second associated color
  90825. */
  90826. color2?: Color4 | undefined);
  90827. /**
  90828. * Will get a color picked randomly between color1 and color2.
  90829. * If color2 is undefined then color1 will be used
  90830. * @param result defines the target Color4 to store the result in
  90831. */
  90832. getColorToRef(result: Color4): void;
  90833. }
  90834. /** Class used to store color 3 gradient */
  90835. export class Color3Gradient implements IValueGradient {
  90836. /**
  90837. * Gets or sets the gradient value (between 0 and 1)
  90838. */
  90839. gradient: number;
  90840. /**
  90841. * Gets or sets the associated color
  90842. */
  90843. color: Color3;
  90844. /**
  90845. * Creates a new color3 gradient
  90846. * @param gradient gets or sets the gradient value (between 0 and 1)
  90847. * @param color gets or sets associated color
  90848. */
  90849. constructor(
  90850. /**
  90851. * Gets or sets the gradient value (between 0 and 1)
  90852. */
  90853. gradient: number,
  90854. /**
  90855. * Gets or sets the associated color
  90856. */
  90857. color: Color3);
  90858. }
  90859. /** Class used to store factor gradient */
  90860. export class FactorGradient implements IValueGradient {
  90861. /**
  90862. * Gets or sets the gradient value (between 0 and 1)
  90863. */
  90864. gradient: number;
  90865. /**
  90866. * Gets or sets first associated factor
  90867. */
  90868. factor1: number;
  90869. /**
  90870. * Gets or sets second associated factor
  90871. */
  90872. factor2?: number | undefined;
  90873. /**
  90874. * Creates a new factor gradient
  90875. * @param gradient gets or sets the gradient value (between 0 and 1)
  90876. * @param factor1 gets or sets first associated factor
  90877. * @param factor2 gets or sets second associated factor
  90878. */
  90879. constructor(
  90880. /**
  90881. * Gets or sets the gradient value (between 0 and 1)
  90882. */
  90883. gradient: number,
  90884. /**
  90885. * Gets or sets first associated factor
  90886. */
  90887. factor1: number,
  90888. /**
  90889. * Gets or sets second associated factor
  90890. */
  90891. factor2?: number | undefined);
  90892. /**
  90893. * Will get a number picked randomly between factor1 and factor2.
  90894. * If factor2 is undefined then factor1 will be used
  90895. * @returns the picked number
  90896. */
  90897. getFactor(): number;
  90898. }
  90899. /**
  90900. * Helper used to simplify some generic gradient tasks
  90901. */
  90902. export class GradientHelper {
  90903. /**
  90904. * Gets the current gradient from an array of IValueGradient
  90905. * @param ratio defines the current ratio to get
  90906. * @param gradients defines the array of IValueGradient
  90907. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  90908. */
  90909. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  90910. }
  90911. }
  90912. declare module BABYLON {
  90913. interface ThinEngine {
  90914. /**
  90915. * Creates a raw texture
  90916. * @param data defines the data to store in the texture
  90917. * @param width defines the width of the texture
  90918. * @param height defines the height of the texture
  90919. * @param format defines the format of the data
  90920. * @param generateMipMaps defines if the engine should generate the mip levels
  90921. * @param invertY defines if data must be stored with Y axis inverted
  90922. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  90923. * @param compression defines the compression used (null by default)
  90924. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90925. * @returns the raw texture inside an InternalTexture
  90926. */
  90927. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  90928. /**
  90929. * Update a raw texture
  90930. * @param texture defines the texture to update
  90931. * @param data defines the data to store in the texture
  90932. * @param format defines the format of the data
  90933. * @param invertY defines if data must be stored with Y axis inverted
  90934. */
  90935. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  90936. /**
  90937. * Update a raw texture
  90938. * @param texture defines the texture to update
  90939. * @param data defines the data to store in the texture
  90940. * @param format defines the format of the data
  90941. * @param invertY defines if data must be stored with Y axis inverted
  90942. * @param compression defines the compression used (null by default)
  90943. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90944. */
  90945. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  90946. /**
  90947. * Creates a new raw cube texture
  90948. * @param data defines the array of data to use to create each face
  90949. * @param size defines the size of the textures
  90950. * @param format defines the format of the data
  90951. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  90952. * @param generateMipMaps defines if the engine should generate the mip levels
  90953. * @param invertY defines if data must be stored with Y axis inverted
  90954. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  90955. * @param compression defines the compression used (null by default)
  90956. * @returns the cube texture as an InternalTexture
  90957. */
  90958. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  90959. /**
  90960. * Update a raw cube texture
  90961. * @param texture defines the texture to udpdate
  90962. * @param data defines the data to store
  90963. * @param format defines the data format
  90964. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90965. * @param invertY defines if data must be stored with Y axis inverted
  90966. */
  90967. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  90968. /**
  90969. * Update a raw cube texture
  90970. * @param texture defines the texture to udpdate
  90971. * @param data defines the data to store
  90972. * @param format defines the data format
  90973. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90974. * @param invertY defines if data must be stored with Y axis inverted
  90975. * @param compression defines the compression used (null by default)
  90976. */
  90977. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  90978. /**
  90979. * Update a raw cube texture
  90980. * @param texture defines the texture to udpdate
  90981. * @param data defines the data to store
  90982. * @param format defines the data format
  90983. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90984. * @param invertY defines if data must be stored with Y axis inverted
  90985. * @param compression defines the compression used (null by default)
  90986. * @param level defines which level of the texture to update
  90987. */
  90988. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  90989. /**
  90990. * Creates a new raw cube texture from a specified url
  90991. * @param url defines the url where the data is located
  90992. * @param scene defines the current scene
  90993. * @param size defines the size of the textures
  90994. * @param format defines the format of the data
  90995. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  90996. * @param noMipmap defines if the engine should avoid generating the mip levels
  90997. * @param callback defines a callback used to extract texture data from loaded data
  90998. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  90999. * @param onLoad defines a callback called when texture is loaded
  91000. * @param onError defines a callback called if there is an error
  91001. * @returns the cube texture as an InternalTexture
  91002. */
  91003. 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;
  91004. /**
  91005. * Creates a new raw cube texture from a specified url
  91006. * @param url defines the url where the data is located
  91007. * @param scene defines the current scene
  91008. * @param size defines the size of the textures
  91009. * @param format defines the format of the data
  91010. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  91011. * @param noMipmap defines if the engine should avoid generating the mip levels
  91012. * @param callback defines a callback used to extract texture data from loaded data
  91013. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  91014. * @param onLoad defines a callback called when texture is loaded
  91015. * @param onError defines a callback called if there is an error
  91016. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91017. * @param invertY defines if data must be stored with Y axis inverted
  91018. * @returns the cube texture as an InternalTexture
  91019. */
  91020. 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;
  91021. /**
  91022. * Creates a new raw 3D texture
  91023. * @param data defines the data used to create the texture
  91024. * @param width defines the width of the texture
  91025. * @param height defines the height of the texture
  91026. * @param depth defines the depth of the texture
  91027. * @param format defines the format of the texture
  91028. * @param generateMipMaps defines if the engine must generate mip levels
  91029. * @param invertY defines if data must be stored with Y axis inverted
  91030. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91031. * @param compression defines the compressed used (can be null)
  91032. * @param textureType defines the compressed used (can be null)
  91033. * @returns a new raw 3D texture (stored in an InternalTexture)
  91034. */
  91035. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  91036. /**
  91037. * Update a raw 3D texture
  91038. * @param texture defines the texture to update
  91039. * @param data defines the data to store
  91040. * @param format defines the data format
  91041. * @param invertY defines if data must be stored with Y axis inverted
  91042. */
  91043. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  91044. /**
  91045. * Update a raw 3D texture
  91046. * @param texture defines the texture to update
  91047. * @param data defines the data to store
  91048. * @param format defines the data format
  91049. * @param invertY defines if data must be stored with Y axis inverted
  91050. * @param compression defines the used compression (can be null)
  91051. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  91052. */
  91053. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  91054. /**
  91055. * Creates a new raw 2D array texture
  91056. * @param data defines the data used to create the texture
  91057. * @param width defines the width of the texture
  91058. * @param height defines the height of the texture
  91059. * @param depth defines the number of layers of the texture
  91060. * @param format defines the format of the texture
  91061. * @param generateMipMaps defines if the engine must generate mip levels
  91062. * @param invertY defines if data must be stored with Y axis inverted
  91063. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91064. * @param compression defines the compressed used (can be null)
  91065. * @param textureType defines the compressed used (can be null)
  91066. * @returns a new raw 2D array texture (stored in an InternalTexture)
  91067. */
  91068. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  91069. /**
  91070. * Update a raw 2D array texture
  91071. * @param texture defines the texture to update
  91072. * @param data defines the data to store
  91073. * @param format defines the data format
  91074. * @param invertY defines if data must be stored with Y axis inverted
  91075. */
  91076. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  91077. /**
  91078. * Update a raw 2D array texture
  91079. * @param texture defines the texture to update
  91080. * @param data defines the data to store
  91081. * @param format defines the data format
  91082. * @param invertY defines if data must be stored with Y axis inverted
  91083. * @param compression defines the used compression (can be null)
  91084. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  91085. */
  91086. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  91087. }
  91088. }
  91089. declare module BABYLON {
  91090. /**
  91091. * Raw texture can help creating a texture directly from an array of data.
  91092. * This can be super useful if you either get the data from an uncompressed source or
  91093. * if you wish to create your texture pixel by pixel.
  91094. */
  91095. export class RawTexture extends Texture {
  91096. /**
  91097. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91098. */
  91099. format: number;
  91100. /**
  91101. * Instantiates a new RawTexture.
  91102. * Raw texture can help creating a texture directly from an array of data.
  91103. * This can be super useful if you either get the data from an uncompressed source or
  91104. * if you wish to create your texture pixel by pixel.
  91105. * @param data define the array of data to use to create the texture
  91106. * @param width define the width of the texture
  91107. * @param height define the height of the texture
  91108. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91109. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91110. * @param generateMipMaps define whether mip maps should be generated or not
  91111. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91112. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91113. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91114. */
  91115. constructor(data: ArrayBufferView, width: number, height: number,
  91116. /**
  91117. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91118. */
  91119. format: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  91120. /**
  91121. * Updates the texture underlying data.
  91122. * @param data Define the new data of the texture
  91123. */
  91124. update(data: ArrayBufferView): void;
  91125. /**
  91126. * Creates a luminance texture from some data.
  91127. * @param data Define the texture data
  91128. * @param width Define the width of the texture
  91129. * @param height Define the height of the texture
  91130. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91131. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91132. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91133. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91134. * @returns the luminance texture
  91135. */
  91136. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91137. /**
  91138. * Creates a luminance alpha texture from some data.
  91139. * @param data Define the texture data
  91140. * @param width Define the width of the texture
  91141. * @param height Define the height of the texture
  91142. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91143. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91144. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91145. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91146. * @returns the luminance alpha texture
  91147. */
  91148. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91149. /**
  91150. * Creates an alpha texture from some data.
  91151. * @param data Define the texture data
  91152. * @param width Define the width of the texture
  91153. * @param height Define the height of the texture
  91154. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91155. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91156. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91157. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91158. * @returns the alpha texture
  91159. */
  91160. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91161. /**
  91162. * Creates a RGB texture from some data.
  91163. * @param data Define the texture data
  91164. * @param width Define the width of the texture
  91165. * @param height Define the height of the texture
  91166. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91167. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91168. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91169. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91170. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91171. * @returns the RGB alpha texture
  91172. */
  91173. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91174. /**
  91175. * Creates a RGBA texture from some data.
  91176. * @param data Define the texture data
  91177. * @param width Define the width of the texture
  91178. * @param height Define the height of the texture
  91179. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91180. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91181. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91182. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91183. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91184. * @returns the RGBA texture
  91185. */
  91186. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91187. /**
  91188. * Creates a R texture from some data.
  91189. * @param data Define the texture data
  91190. * @param width Define the width of the texture
  91191. * @param height Define the height of the texture
  91192. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91193. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91194. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91195. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91196. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91197. * @returns the R texture
  91198. */
  91199. static CreateRTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91200. }
  91201. }
  91202. declare module BABYLON {
  91203. interface ThinEngine {
  91204. /**
  91205. * Update a dynamic index buffer
  91206. * @param indexBuffer defines the target index buffer
  91207. * @param indices defines the data to update
  91208. * @param offset defines the offset in the target index buffer where update should start
  91209. */
  91210. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  91211. /**
  91212. * Updates a dynamic vertex buffer.
  91213. * @param vertexBuffer the vertex buffer to update
  91214. * @param data the data used to update the vertex buffer
  91215. * @param byteOffset the byte offset of the data
  91216. * @param byteLength the byte length of the data
  91217. */
  91218. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  91219. }
  91220. }
  91221. declare module BABYLON {
  91222. interface AbstractScene {
  91223. /**
  91224. * The list of procedural textures added to the scene
  91225. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91226. */
  91227. proceduralTextures: Array<ProceduralTexture>;
  91228. }
  91229. /**
  91230. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  91231. * in a given scene.
  91232. */
  91233. export class ProceduralTextureSceneComponent implements ISceneComponent {
  91234. /**
  91235. * The component name helpfull to identify the component in the list of scene components.
  91236. */
  91237. readonly name: string;
  91238. /**
  91239. * The scene the component belongs to.
  91240. */
  91241. scene: Scene;
  91242. /**
  91243. * Creates a new instance of the component for the given scene
  91244. * @param scene Defines the scene to register the component in
  91245. */
  91246. constructor(scene: Scene);
  91247. /**
  91248. * Registers the component in a given scene
  91249. */
  91250. register(): void;
  91251. /**
  91252. * Rebuilds the elements related to this component in case of
  91253. * context lost for instance.
  91254. */
  91255. rebuild(): void;
  91256. /**
  91257. * Disposes the component and the associated ressources.
  91258. */
  91259. dispose(): void;
  91260. private _beforeClear;
  91261. }
  91262. }
  91263. declare module BABYLON {
  91264. interface ThinEngine {
  91265. /**
  91266. * Creates a new render target cube texture
  91267. * @param size defines the size of the texture
  91268. * @param options defines the options used to create the texture
  91269. * @returns a new render target cube texture stored in an InternalTexture
  91270. */
  91271. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  91272. }
  91273. }
  91274. declare module BABYLON {
  91275. /** @hidden */
  91276. export var proceduralVertexShader: {
  91277. name: string;
  91278. shader: string;
  91279. };
  91280. }
  91281. declare module BABYLON {
  91282. /**
  91283. * 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.
  91284. * This is the base class of any Procedural texture and contains most of the shareable code.
  91285. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91286. */
  91287. export class ProceduralTexture extends Texture {
  91288. /**
  91289. * Define if the texture is enabled or not (disabled texture will not render)
  91290. */
  91291. isEnabled: boolean;
  91292. /**
  91293. * Define if the texture must be cleared before rendering (default is true)
  91294. */
  91295. autoClear: boolean;
  91296. /**
  91297. * Callback called when the texture is generated
  91298. */
  91299. onGenerated: () => void;
  91300. /**
  91301. * Event raised when the texture is generated
  91302. */
  91303. onGeneratedObservable: Observable<ProceduralTexture>;
  91304. /** @hidden */
  91305. _generateMipMaps: boolean;
  91306. /** @hidden **/
  91307. _effect: Effect;
  91308. /** @hidden */
  91309. _textures: {
  91310. [key: string]: Texture;
  91311. };
  91312. /** @hidden */
  91313. protected _fallbackTexture: Nullable<Texture>;
  91314. private _size;
  91315. private _currentRefreshId;
  91316. private _frameId;
  91317. private _refreshRate;
  91318. private _vertexBuffers;
  91319. private _indexBuffer;
  91320. private _uniforms;
  91321. private _samplers;
  91322. private _fragment;
  91323. private _floats;
  91324. private _ints;
  91325. private _floatsArrays;
  91326. private _colors3;
  91327. private _colors4;
  91328. private _vectors2;
  91329. private _vectors3;
  91330. private _matrices;
  91331. private _fallbackTextureUsed;
  91332. private _fullEngine;
  91333. private _cachedDefines;
  91334. private _contentUpdateId;
  91335. private _contentData;
  91336. /**
  91337. * Instantiates a new procedural texture.
  91338. * 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.
  91339. * This is the base class of any Procedural texture and contains most of the shareable code.
  91340. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91341. * @param name Define the name of the texture
  91342. * @param size Define the size of the texture to create
  91343. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  91344. * @param scene Define the scene the texture belongs to
  91345. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  91346. * @param generateMipMaps Define if the texture should creates mip maps or not
  91347. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  91348. */
  91349. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  91350. /**
  91351. * The effect that is created when initializing the post process.
  91352. * @returns The created effect corresponding the the postprocess.
  91353. */
  91354. getEffect(): Effect;
  91355. /**
  91356. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  91357. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  91358. */
  91359. getContent(): Nullable<ArrayBufferView>;
  91360. private _createIndexBuffer;
  91361. /** @hidden */
  91362. _rebuild(): void;
  91363. /**
  91364. * Resets the texture in order to recreate its associated resources.
  91365. * This can be called in case of context loss
  91366. */
  91367. reset(): void;
  91368. protected _getDefines(): string;
  91369. /**
  91370. * Is the texture ready to be used ? (rendered at least once)
  91371. * @returns true if ready, otherwise, false.
  91372. */
  91373. isReady(): boolean;
  91374. /**
  91375. * Resets the refresh counter of the texture and start bak from scratch.
  91376. * Could be useful to regenerate the texture if it is setup to render only once.
  91377. */
  91378. resetRefreshCounter(): void;
  91379. /**
  91380. * Set the fragment shader to use in order to render the texture.
  91381. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  91382. */
  91383. setFragment(fragment: any): void;
  91384. /**
  91385. * Define the refresh rate of the texture or the rendering frequency.
  91386. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  91387. */
  91388. get refreshRate(): number;
  91389. set refreshRate(value: number);
  91390. /** @hidden */
  91391. _shouldRender(): boolean;
  91392. /**
  91393. * Get the size the texture is rendering at.
  91394. * @returns the size (texture is always squared)
  91395. */
  91396. getRenderSize(): number;
  91397. /**
  91398. * Resize the texture to new value.
  91399. * @param size Define the new size the texture should have
  91400. * @param generateMipMaps Define whether the new texture should create mip maps
  91401. */
  91402. resize(size: number, generateMipMaps: boolean): void;
  91403. private _checkUniform;
  91404. /**
  91405. * Set a texture in the shader program used to render.
  91406. * @param name Define the name of the uniform samplers as defined in the shader
  91407. * @param texture Define the texture to bind to this sampler
  91408. * @return the texture itself allowing "fluent" like uniform updates
  91409. */
  91410. setTexture(name: string, texture: Texture): ProceduralTexture;
  91411. /**
  91412. * Set a float in the shader.
  91413. * @param name Define the name of the uniform as defined in the shader
  91414. * @param value Define the value to give to the uniform
  91415. * @return the texture itself allowing "fluent" like uniform updates
  91416. */
  91417. setFloat(name: string, value: number): ProceduralTexture;
  91418. /**
  91419. * Set a int in the shader.
  91420. * @param name Define the name of the uniform as defined in the shader
  91421. * @param value Define the value to give to the uniform
  91422. * @return the texture itself allowing "fluent" like uniform updates
  91423. */
  91424. setInt(name: string, value: number): ProceduralTexture;
  91425. /**
  91426. * Set an array of floats in the shader.
  91427. * @param name Define the name of the uniform as defined in the shader
  91428. * @param value Define the value to give to the uniform
  91429. * @return the texture itself allowing "fluent" like uniform updates
  91430. */
  91431. setFloats(name: string, value: number[]): ProceduralTexture;
  91432. /**
  91433. * Set a vec3 in the shader from a Color3.
  91434. * @param name Define the name of the uniform as defined in the shader
  91435. * @param value Define the value to give to the uniform
  91436. * @return the texture itself allowing "fluent" like uniform updates
  91437. */
  91438. setColor3(name: string, value: Color3): ProceduralTexture;
  91439. /**
  91440. * Set a vec4 in the shader from a Color4.
  91441. * @param name Define the name of the uniform as defined in the shader
  91442. * @param value Define the value to give to the uniform
  91443. * @return the texture itself allowing "fluent" like uniform updates
  91444. */
  91445. setColor4(name: string, value: Color4): ProceduralTexture;
  91446. /**
  91447. * Set a vec2 in the shader from a Vector2.
  91448. * @param name Define the name of the uniform as defined in the shader
  91449. * @param value Define the value to give to the uniform
  91450. * @return the texture itself allowing "fluent" like uniform updates
  91451. */
  91452. setVector2(name: string, value: Vector2): ProceduralTexture;
  91453. /**
  91454. * Set a vec3 in the shader from a Vector3.
  91455. * @param name Define the name of the uniform as defined in the shader
  91456. * @param value Define the value to give to the uniform
  91457. * @return the texture itself allowing "fluent" like uniform updates
  91458. */
  91459. setVector3(name: string, value: Vector3): ProceduralTexture;
  91460. /**
  91461. * Set a mat4 in the shader from a MAtrix.
  91462. * @param name Define the name of the uniform as defined in the shader
  91463. * @param value Define the value to give to the uniform
  91464. * @return the texture itself allowing "fluent" like uniform updates
  91465. */
  91466. setMatrix(name: string, value: Matrix): ProceduralTexture;
  91467. /**
  91468. * Render the texture to its associated render target.
  91469. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  91470. */
  91471. render(useCameraPostProcess?: boolean): void;
  91472. /**
  91473. * Clone the texture.
  91474. * @returns the cloned texture
  91475. */
  91476. clone(): ProceduralTexture;
  91477. /**
  91478. * Dispose the texture and release its asoociated resources.
  91479. */
  91480. dispose(): void;
  91481. }
  91482. }
  91483. declare module BABYLON {
  91484. /**
  91485. * This represents the base class for particle system in Babylon.
  91486. * 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.
  91487. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  91488. * @example https://doc.babylonjs.com/babylon101/particles
  91489. */
  91490. export class BaseParticleSystem {
  91491. /**
  91492. * Source color is added to the destination color without alpha affecting the result
  91493. */
  91494. static BLENDMODE_ONEONE: number;
  91495. /**
  91496. * Blend current color and particle color using particle’s alpha
  91497. */
  91498. static BLENDMODE_STANDARD: number;
  91499. /**
  91500. * Add current color and particle color multiplied by particle’s alpha
  91501. */
  91502. static BLENDMODE_ADD: number;
  91503. /**
  91504. * Multiply current color with particle color
  91505. */
  91506. static BLENDMODE_MULTIPLY: number;
  91507. /**
  91508. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  91509. */
  91510. static BLENDMODE_MULTIPLYADD: number;
  91511. /**
  91512. * List of animations used by the particle system.
  91513. */
  91514. animations: Animation[];
  91515. /**
  91516. * Gets or sets the unique id of the particle system
  91517. */
  91518. uniqueId: number;
  91519. /**
  91520. * The id of the Particle system.
  91521. */
  91522. id: string;
  91523. /**
  91524. * The friendly name of the Particle system.
  91525. */
  91526. name: string;
  91527. /**
  91528. * Snippet ID if the particle system was created from the snippet server
  91529. */
  91530. snippetId: string;
  91531. /**
  91532. * The rendering group used by the Particle system to chose when to render.
  91533. */
  91534. renderingGroupId: number;
  91535. /**
  91536. * The emitter represents the Mesh or position we are attaching the particle system to.
  91537. */
  91538. emitter: Nullable<AbstractMesh | Vector3>;
  91539. /**
  91540. * The maximum number of particles to emit per frame
  91541. */
  91542. emitRate: number;
  91543. /**
  91544. * If you want to launch only a few particles at once, that can be done, as well.
  91545. */
  91546. manualEmitCount: number;
  91547. /**
  91548. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  91549. */
  91550. updateSpeed: number;
  91551. /**
  91552. * The amount of time the particle system is running (depends of the overall update speed).
  91553. */
  91554. targetStopDuration: number;
  91555. /**
  91556. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  91557. */
  91558. disposeOnStop: boolean;
  91559. /**
  91560. * Minimum power of emitting particles.
  91561. */
  91562. minEmitPower: number;
  91563. /**
  91564. * Maximum power of emitting particles.
  91565. */
  91566. maxEmitPower: number;
  91567. /**
  91568. * Minimum life time of emitting particles.
  91569. */
  91570. minLifeTime: number;
  91571. /**
  91572. * Maximum life time of emitting particles.
  91573. */
  91574. maxLifeTime: number;
  91575. /**
  91576. * Minimum Size of emitting particles.
  91577. */
  91578. minSize: number;
  91579. /**
  91580. * Maximum Size of emitting particles.
  91581. */
  91582. maxSize: number;
  91583. /**
  91584. * Minimum scale of emitting particles on X axis.
  91585. */
  91586. minScaleX: number;
  91587. /**
  91588. * Maximum scale of emitting particles on X axis.
  91589. */
  91590. maxScaleX: number;
  91591. /**
  91592. * Minimum scale of emitting particles on Y axis.
  91593. */
  91594. minScaleY: number;
  91595. /**
  91596. * Maximum scale of emitting particles on Y axis.
  91597. */
  91598. maxScaleY: number;
  91599. /**
  91600. * Gets or sets the minimal initial rotation in radians.
  91601. */
  91602. minInitialRotation: number;
  91603. /**
  91604. * Gets or sets the maximal initial rotation in radians.
  91605. */
  91606. maxInitialRotation: number;
  91607. /**
  91608. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  91609. */
  91610. minAngularSpeed: number;
  91611. /**
  91612. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  91613. */
  91614. maxAngularSpeed: number;
  91615. /**
  91616. * The texture used to render each particle. (this can be a spritesheet)
  91617. */
  91618. particleTexture: Nullable<BaseTexture>;
  91619. /**
  91620. * The layer mask we are rendering the particles through.
  91621. */
  91622. layerMask: number;
  91623. /**
  91624. * This can help using your own shader to render the particle system.
  91625. * The according effect will be created
  91626. */
  91627. customShader: any;
  91628. /**
  91629. * By default particle system starts as soon as they are created. This prevents the
  91630. * automatic start to happen and let you decide when to start emitting particles.
  91631. */
  91632. preventAutoStart: boolean;
  91633. private _noiseTexture;
  91634. /**
  91635. * Gets or sets a texture used to add random noise to particle positions
  91636. */
  91637. get noiseTexture(): Nullable<ProceduralTexture>;
  91638. set noiseTexture(value: Nullable<ProceduralTexture>);
  91639. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  91640. noiseStrength: Vector3;
  91641. /**
  91642. * Callback triggered when the particle animation is ending.
  91643. */
  91644. onAnimationEnd: Nullable<() => void>;
  91645. /**
  91646. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  91647. */
  91648. blendMode: number;
  91649. /**
  91650. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  91651. * to override the particles.
  91652. */
  91653. forceDepthWrite: boolean;
  91654. /** 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 */
  91655. preWarmCycles: number;
  91656. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  91657. preWarmStepOffset: number;
  91658. /**
  91659. * 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)
  91660. */
  91661. spriteCellChangeSpeed: number;
  91662. /**
  91663. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  91664. */
  91665. startSpriteCellID: number;
  91666. /**
  91667. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  91668. */
  91669. endSpriteCellID: number;
  91670. /**
  91671. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  91672. */
  91673. spriteCellWidth: number;
  91674. /**
  91675. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  91676. */
  91677. spriteCellHeight: number;
  91678. /**
  91679. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  91680. */
  91681. spriteRandomStartCell: boolean;
  91682. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  91683. translationPivot: Vector2;
  91684. /** @hidden */
  91685. protected _isAnimationSheetEnabled: boolean;
  91686. /**
  91687. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  91688. */
  91689. beginAnimationOnStart: boolean;
  91690. /**
  91691. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  91692. */
  91693. beginAnimationFrom: number;
  91694. /**
  91695. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  91696. */
  91697. beginAnimationTo: number;
  91698. /**
  91699. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  91700. */
  91701. beginAnimationLoop: boolean;
  91702. /**
  91703. * Gets or sets a world offset applied to all particles
  91704. */
  91705. worldOffset: Vector3;
  91706. /**
  91707. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  91708. */
  91709. get isAnimationSheetEnabled(): boolean;
  91710. set isAnimationSheetEnabled(value: boolean);
  91711. /**
  91712. * Get hosting scene
  91713. * @returns the scene
  91714. */
  91715. getScene(): Nullable<Scene>;
  91716. /**
  91717. * You can use gravity if you want to give an orientation to your particles.
  91718. */
  91719. gravity: Vector3;
  91720. protected _colorGradients: Nullable<Array<ColorGradient>>;
  91721. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  91722. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  91723. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  91724. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  91725. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  91726. protected _dragGradients: Nullable<Array<FactorGradient>>;
  91727. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  91728. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  91729. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  91730. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  91731. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  91732. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  91733. /**
  91734. * Defines the delay in milliseconds before starting the system (0 by default)
  91735. */
  91736. startDelay: number;
  91737. /**
  91738. * Gets the current list of drag gradients.
  91739. * You must use addDragGradient and removeDragGradient to udpate this list
  91740. * @returns the list of drag gradients
  91741. */
  91742. getDragGradients(): Nullable<Array<FactorGradient>>;
  91743. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  91744. limitVelocityDamping: number;
  91745. /**
  91746. * Gets the current list of limit velocity gradients.
  91747. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  91748. * @returns the list of limit velocity gradients
  91749. */
  91750. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  91751. /**
  91752. * Gets the current list of color gradients.
  91753. * You must use addColorGradient and removeColorGradient to udpate this list
  91754. * @returns the list of color gradients
  91755. */
  91756. getColorGradients(): Nullable<Array<ColorGradient>>;
  91757. /**
  91758. * Gets the current list of size gradients.
  91759. * You must use addSizeGradient and removeSizeGradient to udpate this list
  91760. * @returns the list of size gradients
  91761. */
  91762. getSizeGradients(): Nullable<Array<FactorGradient>>;
  91763. /**
  91764. * Gets the current list of color remap gradients.
  91765. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  91766. * @returns the list of color remap gradients
  91767. */
  91768. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  91769. /**
  91770. * Gets the current list of alpha remap gradients.
  91771. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  91772. * @returns the list of alpha remap gradients
  91773. */
  91774. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  91775. /**
  91776. * Gets the current list of life time gradients.
  91777. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  91778. * @returns the list of life time gradients
  91779. */
  91780. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  91781. /**
  91782. * Gets the current list of angular speed gradients.
  91783. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  91784. * @returns the list of angular speed gradients
  91785. */
  91786. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  91787. /**
  91788. * Gets the current list of velocity gradients.
  91789. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  91790. * @returns the list of velocity gradients
  91791. */
  91792. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  91793. /**
  91794. * Gets the current list of start size gradients.
  91795. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  91796. * @returns the list of start size gradients
  91797. */
  91798. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  91799. /**
  91800. * Gets the current list of emit rate gradients.
  91801. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  91802. * @returns the list of emit rate gradients
  91803. */
  91804. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  91805. /**
  91806. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91807. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91808. */
  91809. get direction1(): Vector3;
  91810. set direction1(value: Vector3);
  91811. /**
  91812. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91813. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91814. */
  91815. get direction2(): Vector3;
  91816. set direction2(value: Vector3);
  91817. /**
  91818. * 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.
  91819. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91820. */
  91821. get minEmitBox(): Vector3;
  91822. set minEmitBox(value: Vector3);
  91823. /**
  91824. * 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.
  91825. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91826. */
  91827. get maxEmitBox(): Vector3;
  91828. set maxEmitBox(value: Vector3);
  91829. /**
  91830. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  91831. */
  91832. color1: Color4;
  91833. /**
  91834. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  91835. */
  91836. color2: Color4;
  91837. /**
  91838. * Color the particle will have at the end of its lifetime
  91839. */
  91840. colorDead: Color4;
  91841. /**
  91842. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  91843. */
  91844. textureMask: Color4;
  91845. /**
  91846. * The particle emitter type defines the emitter used by the particle system.
  91847. * It can be for example box, sphere, or cone...
  91848. */
  91849. particleEmitterType: IParticleEmitterType;
  91850. /** @hidden */
  91851. _isSubEmitter: boolean;
  91852. /**
  91853. * Gets or sets the billboard mode to use when isBillboardBased = true.
  91854. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  91855. */
  91856. billboardMode: number;
  91857. protected _isBillboardBased: boolean;
  91858. /**
  91859. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  91860. */
  91861. get isBillboardBased(): boolean;
  91862. set isBillboardBased(value: boolean);
  91863. /**
  91864. * The scene the particle system belongs to.
  91865. */
  91866. protected _scene: Nullable<Scene>;
  91867. /**
  91868. * The engine the particle system belongs to.
  91869. */
  91870. protected _engine: ThinEngine;
  91871. /**
  91872. * Local cache of defines for image processing.
  91873. */
  91874. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  91875. /**
  91876. * Default configuration related to image processing available in the standard Material.
  91877. */
  91878. protected _imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  91879. /**
  91880. * Gets the image processing configuration used either in this material.
  91881. */
  91882. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  91883. /**
  91884. * Sets the Default image processing configuration used either in the this material.
  91885. *
  91886. * If sets to null, the scene one is in use.
  91887. */
  91888. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  91889. /**
  91890. * Attaches a new image processing configuration to the Standard Material.
  91891. * @param configuration
  91892. */
  91893. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  91894. /** @hidden */
  91895. protected _reset(): void;
  91896. /** @hidden */
  91897. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  91898. /**
  91899. * Instantiates a particle system.
  91900. * 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.
  91901. * @param name The name of the particle system
  91902. */
  91903. constructor(name: string);
  91904. /**
  91905. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  91906. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  91907. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  91908. * @returns the emitter
  91909. */
  91910. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  91911. /**
  91912. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  91913. * @param radius The radius of the hemisphere to emit from
  91914. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  91915. * @returns the emitter
  91916. */
  91917. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  91918. /**
  91919. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  91920. * @param radius The radius of the sphere to emit from
  91921. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  91922. * @returns the emitter
  91923. */
  91924. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  91925. /**
  91926. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  91927. * @param radius The radius of the sphere to emit from
  91928. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  91929. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  91930. * @returns the emitter
  91931. */
  91932. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  91933. /**
  91934. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  91935. * @param radius The radius of the emission cylinder
  91936. * @param height The height of the emission cylinder
  91937. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  91938. * @param directionRandomizer How much to randomize the particle direction [0-1]
  91939. * @returns the emitter
  91940. */
  91941. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  91942. /**
  91943. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  91944. * @param radius The radius of the cylinder to emit from
  91945. * @param height The height of the emission cylinder
  91946. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  91947. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  91948. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  91949. * @returns the emitter
  91950. */
  91951. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  91952. /**
  91953. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  91954. * @param radius The radius of the cone to emit from
  91955. * @param angle The base angle of the cone
  91956. * @returns the emitter
  91957. */
  91958. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  91959. /**
  91960. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  91961. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  91962. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  91963. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  91964. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  91965. * @returns the emitter
  91966. */
  91967. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  91968. }
  91969. }
  91970. declare module BABYLON {
  91971. /**
  91972. * Type of sub emitter
  91973. */
  91974. export enum SubEmitterType {
  91975. /**
  91976. * Attached to the particle over it's lifetime
  91977. */
  91978. ATTACHED = 0,
  91979. /**
  91980. * Created when the particle dies
  91981. */
  91982. END = 1
  91983. }
  91984. /**
  91985. * Sub emitter class used to emit particles from an existing particle
  91986. */
  91987. export class SubEmitter {
  91988. /**
  91989. * the particle system to be used by the sub emitter
  91990. */
  91991. particleSystem: ParticleSystem;
  91992. /**
  91993. * Type of the submitter (Default: END)
  91994. */
  91995. type: SubEmitterType;
  91996. /**
  91997. * 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)
  91998. * Note: This only is supported when using an emitter of type Mesh
  91999. */
  92000. inheritDirection: boolean;
  92001. /**
  92002. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  92003. */
  92004. inheritedVelocityAmount: number;
  92005. /**
  92006. * Creates a sub emitter
  92007. * @param particleSystem the particle system to be used by the sub emitter
  92008. */
  92009. constructor(
  92010. /**
  92011. * the particle system to be used by the sub emitter
  92012. */
  92013. particleSystem: ParticleSystem);
  92014. /**
  92015. * Clones the sub emitter
  92016. * @returns the cloned sub emitter
  92017. */
  92018. clone(): SubEmitter;
  92019. /**
  92020. * Serialize current object to a JSON object
  92021. * @returns the serialized object
  92022. */
  92023. serialize(): any;
  92024. /** @hidden */
  92025. static _ParseParticleSystem(system: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): ParticleSystem;
  92026. /**
  92027. * Creates a new SubEmitter from a serialized JSON version
  92028. * @param serializationObject defines the JSON object to read from
  92029. * @param sceneOrEngine defines the hosting scene or the hosting engine
  92030. * @param rootUrl defines the rootUrl for data loading
  92031. * @returns a new SubEmitter
  92032. */
  92033. static Parse(serializationObject: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): SubEmitter;
  92034. /** Release associated resources */
  92035. dispose(): void;
  92036. }
  92037. }
  92038. declare module BABYLON {
  92039. /** @hidden */
  92040. export var imageProcessingDeclaration: {
  92041. name: string;
  92042. shader: string;
  92043. };
  92044. }
  92045. declare module BABYLON {
  92046. /** @hidden */
  92047. export var imageProcessingFunctions: {
  92048. name: string;
  92049. shader: string;
  92050. };
  92051. }
  92052. declare module BABYLON {
  92053. /** @hidden */
  92054. export var particlesPixelShader: {
  92055. name: string;
  92056. shader: string;
  92057. };
  92058. }
  92059. declare module BABYLON {
  92060. /** @hidden */
  92061. export var particlesVertexShader: {
  92062. name: string;
  92063. shader: string;
  92064. };
  92065. }
  92066. declare module BABYLON {
  92067. /**
  92068. * Interface used to define entities containing multiple clip planes
  92069. */
  92070. export interface IClipPlanesHolder {
  92071. /**
  92072. * Gets or sets the active clipplane 1
  92073. */
  92074. clipPlane: Nullable<Plane>;
  92075. /**
  92076. * Gets or sets the active clipplane 2
  92077. */
  92078. clipPlane2: Nullable<Plane>;
  92079. /**
  92080. * Gets or sets the active clipplane 3
  92081. */
  92082. clipPlane3: Nullable<Plane>;
  92083. /**
  92084. * Gets or sets the active clipplane 4
  92085. */
  92086. clipPlane4: Nullable<Plane>;
  92087. /**
  92088. * Gets or sets the active clipplane 5
  92089. */
  92090. clipPlane5: Nullable<Plane>;
  92091. /**
  92092. * Gets or sets the active clipplane 6
  92093. */
  92094. clipPlane6: Nullable<Plane>;
  92095. }
  92096. }
  92097. declare module BABYLON {
  92098. /**
  92099. * "Static Class" containing a few commonly used helper while dealing with material for rendering purpose.
  92100. *
  92101. * It is complementary with MaterialHelper but provides completely independent functions (for tree shaking sake)
  92102. *
  92103. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  92104. */
  92105. export class ThinMaterialHelper {
  92106. /**
  92107. * Binds the clip plane information from the holder to the effect.
  92108. * @param effect The effect we are binding the data to
  92109. * @param holder The entity containing the clip plane information
  92110. */
  92111. static BindClipPlane(effect: Effect, holder: IClipPlanesHolder): void;
  92112. }
  92113. }
  92114. declare module BABYLON {
  92115. interface ThinEngine {
  92116. /**
  92117. * Sets alpha constants used by some alpha blending modes
  92118. * @param r defines the red component
  92119. * @param g defines the green component
  92120. * @param b defines the blue component
  92121. * @param a defines the alpha component
  92122. */
  92123. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  92124. /**
  92125. * Sets the current alpha mode
  92126. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  92127. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  92128. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  92129. */
  92130. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  92131. /**
  92132. * Gets the current alpha mode
  92133. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  92134. * @returns the current alpha mode
  92135. */
  92136. getAlphaMode(): number;
  92137. /**
  92138. * Sets the current alpha equation
  92139. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  92140. */
  92141. setAlphaEquation(equation: number): void;
  92142. /**
  92143. * Gets the current alpha equation.
  92144. * @returns the current alpha equation
  92145. */
  92146. getAlphaEquation(): number;
  92147. }
  92148. }
  92149. declare module BABYLON {
  92150. /**
  92151. * This represents a particle system in Babylon.
  92152. * 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.
  92153. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  92154. * @example https://doc.babylonjs.com/babylon101/particles
  92155. */
  92156. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  92157. /**
  92158. * Billboard mode will only apply to Y axis
  92159. */
  92160. static readonly BILLBOARDMODE_Y: number;
  92161. /**
  92162. * Billboard mode will apply to all axes
  92163. */
  92164. static readonly BILLBOARDMODE_ALL: number;
  92165. /**
  92166. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  92167. */
  92168. static readonly BILLBOARDMODE_STRETCHED: number;
  92169. /**
  92170. * This function can be defined to provide custom update for active particles.
  92171. * This function will be called instead of regular update (age, position, color, etc.).
  92172. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  92173. */
  92174. updateFunction: (particles: Particle[]) => void;
  92175. private _emitterWorldMatrix;
  92176. /**
  92177. * This function can be defined to specify initial direction for every new particle.
  92178. * It by default use the emitterType defined function
  92179. */
  92180. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  92181. /**
  92182. * This function can be defined to specify initial position for every new particle.
  92183. * It by default use the emitterType defined function
  92184. */
  92185. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  92186. /**
  92187. * @hidden
  92188. */
  92189. _inheritedVelocityOffset: Vector3;
  92190. /**
  92191. * An event triggered when the system is disposed
  92192. */
  92193. onDisposeObservable: Observable<IParticleSystem>;
  92194. private _onDisposeObserver;
  92195. /**
  92196. * Sets a callback that will be triggered when the system is disposed
  92197. */
  92198. set onDispose(callback: () => void);
  92199. private _particles;
  92200. private _epsilon;
  92201. private _capacity;
  92202. private _stockParticles;
  92203. private _newPartsExcess;
  92204. private _vertexData;
  92205. private _vertexBuffer;
  92206. private _vertexBuffers;
  92207. private _spriteBuffer;
  92208. private _indexBuffer;
  92209. private _effect;
  92210. private _customEffect;
  92211. private _cachedDefines;
  92212. private _scaledColorStep;
  92213. private _colorDiff;
  92214. private _scaledDirection;
  92215. private _scaledGravity;
  92216. private _currentRenderId;
  92217. private _alive;
  92218. private _useInstancing;
  92219. private _started;
  92220. private _stopped;
  92221. private _actualFrame;
  92222. private _scaledUpdateSpeed;
  92223. private _vertexBufferSize;
  92224. /** @hidden */
  92225. _currentEmitRateGradient: Nullable<FactorGradient>;
  92226. /** @hidden */
  92227. _currentEmitRate1: number;
  92228. /** @hidden */
  92229. _currentEmitRate2: number;
  92230. /** @hidden */
  92231. _currentStartSizeGradient: Nullable<FactorGradient>;
  92232. /** @hidden */
  92233. _currentStartSize1: number;
  92234. /** @hidden */
  92235. _currentStartSize2: number;
  92236. private readonly _rawTextureWidth;
  92237. private _rampGradientsTexture;
  92238. private _useRampGradients;
  92239. /** Gets or sets a matrix to use to compute projection */
  92240. defaultProjectionMatrix: Matrix;
  92241. /** Gets or sets a matrix to use to compute view */
  92242. defaultViewMatrix: Matrix;
  92243. /** Gets or sets a boolean indicating that ramp gradients must be used
  92244. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  92245. */
  92246. get useRampGradients(): boolean;
  92247. set useRampGradients(value: boolean);
  92248. /**
  92249. * 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.
  92250. * 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: [])
  92251. */
  92252. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  92253. private _subEmitters;
  92254. /**
  92255. * @hidden
  92256. * If the particle systems emitter should be disposed when the particle system is disposed
  92257. */
  92258. _disposeEmitterOnDispose: boolean;
  92259. /**
  92260. * The current active Sub-systems, this property is used by the root particle system only.
  92261. */
  92262. activeSubSystems: Array<ParticleSystem>;
  92263. /**
  92264. * Specifies if the particles are updated in emitter local space or world space
  92265. */
  92266. isLocal: boolean;
  92267. private _rootParticleSystem;
  92268. /**
  92269. * Gets the current list of active particles
  92270. */
  92271. get particles(): Particle[];
  92272. /**
  92273. * Gets the number of particles active at the same time.
  92274. * @returns The number of active particles.
  92275. */
  92276. getActiveCount(): number;
  92277. /**
  92278. * Returns the string "ParticleSystem"
  92279. * @returns a string containing the class name
  92280. */
  92281. getClassName(): string;
  92282. /**
  92283. * Gets a boolean indicating that the system is stopping
  92284. * @returns true if the system is currently stopping
  92285. */
  92286. isStopping(): boolean;
  92287. /**
  92288. * Gets the custom effect used to render the particles
  92289. * @param blendMode Blend mode for which the effect should be retrieved
  92290. * @returns The effect
  92291. */
  92292. getCustomEffect(blendMode?: number): Nullable<Effect>;
  92293. /**
  92294. * Sets the custom effect used to render the particles
  92295. * @param effect The effect to set
  92296. * @param blendMode Blend mode for which the effect should be set
  92297. */
  92298. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  92299. /** @hidden */
  92300. private _onBeforeDrawParticlesObservable;
  92301. /**
  92302. * Observable that will be called just before the particles are drawn
  92303. */
  92304. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  92305. /**
  92306. * Gets the name of the particle vertex shader
  92307. */
  92308. get vertexShaderName(): string;
  92309. /**
  92310. * Instantiates a particle system.
  92311. * 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.
  92312. * @param name The name of the particle system
  92313. * @param capacity The max number of particles alive at the same time
  92314. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  92315. * @param customEffect a custom effect used to change the way particles are rendered by default
  92316. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  92317. * @param epsilon Offset used to render the particles
  92318. */
  92319. constructor(name: string, capacity: number, sceneOrEngine: Scene | ThinEngine, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  92320. private _addFactorGradient;
  92321. private _removeFactorGradient;
  92322. /**
  92323. * Adds a new life time gradient
  92324. * @param gradient defines the gradient to use (between 0 and 1)
  92325. * @param factor defines the life time factor to affect to the specified gradient
  92326. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92327. * @returns the current particle system
  92328. */
  92329. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92330. /**
  92331. * Remove a specific life time gradient
  92332. * @param gradient defines the gradient to remove
  92333. * @returns the current particle system
  92334. */
  92335. removeLifeTimeGradient(gradient: number): IParticleSystem;
  92336. /**
  92337. * Adds a new size gradient
  92338. * @param gradient defines the gradient to use (between 0 and 1)
  92339. * @param factor defines the size factor to affect to the specified gradient
  92340. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92341. * @returns the current particle system
  92342. */
  92343. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92344. /**
  92345. * Remove a specific size gradient
  92346. * @param gradient defines the gradient to remove
  92347. * @returns the current particle system
  92348. */
  92349. removeSizeGradient(gradient: number): IParticleSystem;
  92350. /**
  92351. * Adds a new color remap gradient
  92352. * @param gradient defines the gradient to use (between 0 and 1)
  92353. * @param min defines the color remap minimal range
  92354. * @param max defines the color remap maximal range
  92355. * @returns the current particle system
  92356. */
  92357. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  92358. /**
  92359. * Remove a specific color remap gradient
  92360. * @param gradient defines the gradient to remove
  92361. * @returns the current particle system
  92362. */
  92363. removeColorRemapGradient(gradient: number): IParticleSystem;
  92364. /**
  92365. * Adds a new alpha remap gradient
  92366. * @param gradient defines the gradient to use (between 0 and 1)
  92367. * @param min defines the alpha remap minimal range
  92368. * @param max defines the alpha remap maximal range
  92369. * @returns the current particle system
  92370. */
  92371. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  92372. /**
  92373. * Remove a specific alpha remap gradient
  92374. * @param gradient defines the gradient to remove
  92375. * @returns the current particle system
  92376. */
  92377. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  92378. /**
  92379. * Adds a new angular speed gradient
  92380. * @param gradient defines the gradient to use (between 0 and 1)
  92381. * @param factor defines the angular speed to affect to the specified gradient
  92382. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92383. * @returns the current particle system
  92384. */
  92385. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92386. /**
  92387. * Remove a specific angular speed gradient
  92388. * @param gradient defines the gradient to remove
  92389. * @returns the current particle system
  92390. */
  92391. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  92392. /**
  92393. * Adds a new velocity gradient
  92394. * @param gradient defines the gradient to use (between 0 and 1)
  92395. * @param factor defines the velocity to affect to the specified gradient
  92396. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92397. * @returns the current particle system
  92398. */
  92399. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92400. /**
  92401. * Remove a specific velocity gradient
  92402. * @param gradient defines the gradient to remove
  92403. * @returns the current particle system
  92404. */
  92405. removeVelocityGradient(gradient: number): IParticleSystem;
  92406. /**
  92407. * Adds a new limit velocity gradient
  92408. * @param gradient defines the gradient to use (between 0 and 1)
  92409. * @param factor defines the limit velocity value to affect to the specified gradient
  92410. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92411. * @returns the current particle system
  92412. */
  92413. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92414. /**
  92415. * Remove a specific limit velocity gradient
  92416. * @param gradient defines the gradient to remove
  92417. * @returns the current particle system
  92418. */
  92419. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  92420. /**
  92421. * Adds a new drag gradient
  92422. * @param gradient defines the gradient to use (between 0 and 1)
  92423. * @param factor defines the drag value to affect to the specified gradient
  92424. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92425. * @returns the current particle system
  92426. */
  92427. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92428. /**
  92429. * Remove a specific drag gradient
  92430. * @param gradient defines the gradient to remove
  92431. * @returns the current particle system
  92432. */
  92433. removeDragGradient(gradient: number): IParticleSystem;
  92434. /**
  92435. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  92436. * @param gradient defines the gradient to use (between 0 and 1)
  92437. * @param factor defines the emit rate value to affect to the specified gradient
  92438. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92439. * @returns the current particle system
  92440. */
  92441. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92442. /**
  92443. * Remove a specific emit rate gradient
  92444. * @param gradient defines the gradient to remove
  92445. * @returns the current particle system
  92446. */
  92447. removeEmitRateGradient(gradient: number): IParticleSystem;
  92448. /**
  92449. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  92450. * @param gradient defines the gradient to use (between 0 and 1)
  92451. * @param factor defines the start size value to affect to the specified gradient
  92452. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92453. * @returns the current particle system
  92454. */
  92455. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92456. /**
  92457. * Remove a specific start size gradient
  92458. * @param gradient defines the gradient to remove
  92459. * @returns the current particle system
  92460. */
  92461. removeStartSizeGradient(gradient: number): IParticleSystem;
  92462. private _createRampGradientTexture;
  92463. /**
  92464. * Gets the current list of ramp gradients.
  92465. * You must use addRampGradient and removeRampGradient to udpate this list
  92466. * @returns the list of ramp gradients
  92467. */
  92468. getRampGradients(): Nullable<Array<Color3Gradient>>;
  92469. /** Force the system to rebuild all gradients that need to be resync */
  92470. forceRefreshGradients(): void;
  92471. private _syncRampGradientTexture;
  92472. /**
  92473. * Adds a new ramp gradient used to remap particle colors
  92474. * @param gradient defines the gradient to use (between 0 and 1)
  92475. * @param color defines the color to affect to the specified gradient
  92476. * @returns the current particle system
  92477. */
  92478. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  92479. /**
  92480. * Remove a specific ramp gradient
  92481. * @param gradient defines the gradient to remove
  92482. * @returns the current particle system
  92483. */
  92484. removeRampGradient(gradient: number): ParticleSystem;
  92485. /**
  92486. * Adds a new color gradient
  92487. * @param gradient defines the gradient to use (between 0 and 1)
  92488. * @param color1 defines the color to affect to the specified gradient
  92489. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  92490. * @returns this particle system
  92491. */
  92492. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  92493. /**
  92494. * Remove a specific color gradient
  92495. * @param gradient defines the gradient to remove
  92496. * @returns this particle system
  92497. */
  92498. removeColorGradient(gradient: number): IParticleSystem;
  92499. private _fetchR;
  92500. protected _reset(): void;
  92501. private _resetEffect;
  92502. private _createVertexBuffers;
  92503. private _createIndexBuffer;
  92504. /**
  92505. * Gets the maximum number of particles active at the same time.
  92506. * @returns The max number of active particles.
  92507. */
  92508. getCapacity(): number;
  92509. /**
  92510. * Gets whether there are still active particles in the system.
  92511. * @returns True if it is alive, otherwise false.
  92512. */
  92513. isAlive(): boolean;
  92514. /**
  92515. * Gets if the system has been started. (Note: this will still be true after stop is called)
  92516. * @returns True if it has been started, otherwise false.
  92517. */
  92518. isStarted(): boolean;
  92519. private _prepareSubEmitterInternalArray;
  92520. /**
  92521. * Starts the particle system and begins to emit
  92522. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  92523. */
  92524. start(delay?: number): void;
  92525. /**
  92526. * Stops the particle system.
  92527. * @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.
  92528. */
  92529. stop(stopSubEmitters?: boolean): void;
  92530. /**
  92531. * Remove all active particles
  92532. */
  92533. reset(): void;
  92534. /**
  92535. * @hidden (for internal use only)
  92536. */
  92537. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  92538. /**
  92539. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  92540. * Its lifetime will start back at 0.
  92541. */
  92542. recycleParticle: (particle: Particle) => void;
  92543. private _stopSubEmitters;
  92544. private _createParticle;
  92545. private _removeFromRoot;
  92546. private _emitFromParticle;
  92547. private _update;
  92548. /** @hidden */
  92549. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  92550. /** @hidden */
  92551. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  92552. /**
  92553. * Fill the defines array according to the current settings of the particle system
  92554. * @param defines Array to be updated
  92555. * @param blendMode blend mode to take into account when updating the array
  92556. */
  92557. fillDefines(defines: Array<string>, blendMode: number): void;
  92558. /**
  92559. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  92560. * @param uniforms Uniforms array to fill
  92561. * @param attributes Attributes array to fill
  92562. * @param samplers Samplers array to fill
  92563. */
  92564. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  92565. /** @hidden */
  92566. private _getEffect;
  92567. /**
  92568. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  92569. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  92570. */
  92571. animate(preWarmOnly?: boolean): void;
  92572. private _appendParticleVertices;
  92573. /**
  92574. * Rebuilds the particle system.
  92575. */
  92576. rebuild(): void;
  92577. /**
  92578. * Is this system ready to be used/rendered
  92579. * @return true if the system is ready
  92580. */
  92581. isReady(): boolean;
  92582. private _render;
  92583. /**
  92584. * Renders the particle system in its current state.
  92585. * @returns the current number of particles
  92586. */
  92587. render(): number;
  92588. /**
  92589. * Disposes the particle system and free the associated resources
  92590. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  92591. */
  92592. dispose(disposeTexture?: boolean): void;
  92593. /**
  92594. * Clones the particle system.
  92595. * @param name The name of the cloned object
  92596. * @param newEmitter The new emitter to use
  92597. * @returns the cloned particle system
  92598. */
  92599. clone(name: string, newEmitter: any): ParticleSystem;
  92600. /**
  92601. * Serializes the particle system to a JSON object
  92602. * @param serializeTexture defines if the texture must be serialized as well
  92603. * @returns the JSON object
  92604. */
  92605. serialize(serializeTexture?: boolean): any;
  92606. /** @hidden */
  92607. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  92608. /** @hidden */
  92609. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, sceneOrEngine: Scene | ThinEngine, rootUrl: string): void;
  92610. /**
  92611. * Parses a JSON object to create a particle system.
  92612. * @param parsedParticleSystem The JSON object to parse
  92613. * @param sceneOrEngine The scene or the engine to create the particle system in
  92614. * @param rootUrl The root url to use to load external dependencies like texture
  92615. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  92616. * @returns the Parsed particle system
  92617. */
  92618. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  92619. }
  92620. }
  92621. declare module BABYLON {
  92622. /**
  92623. * A particle represents one of the element emitted by a particle system.
  92624. * This is mainly define by its coordinates, direction, velocity and age.
  92625. */
  92626. export class Particle {
  92627. /**
  92628. * The particle system the particle belongs to.
  92629. */
  92630. particleSystem: ParticleSystem;
  92631. private static _Count;
  92632. /**
  92633. * Unique ID of the particle
  92634. */
  92635. id: number;
  92636. /**
  92637. * The world position of the particle in the scene.
  92638. */
  92639. position: Vector3;
  92640. /**
  92641. * The world direction of the particle in the scene.
  92642. */
  92643. direction: Vector3;
  92644. /**
  92645. * The color of the particle.
  92646. */
  92647. color: Color4;
  92648. /**
  92649. * The color change of the particle per step.
  92650. */
  92651. colorStep: Color4;
  92652. /**
  92653. * Defines how long will the life of the particle be.
  92654. */
  92655. lifeTime: number;
  92656. /**
  92657. * The current age of the particle.
  92658. */
  92659. age: number;
  92660. /**
  92661. * The current size of the particle.
  92662. */
  92663. size: number;
  92664. /**
  92665. * The current scale of the particle.
  92666. */
  92667. scale: Vector2;
  92668. /**
  92669. * The current angle of the particle.
  92670. */
  92671. angle: number;
  92672. /**
  92673. * Defines how fast is the angle changing.
  92674. */
  92675. angularSpeed: number;
  92676. /**
  92677. * Defines the cell index used by the particle to be rendered from a sprite.
  92678. */
  92679. cellIndex: number;
  92680. /**
  92681. * The information required to support color remapping
  92682. */
  92683. remapData: Vector4;
  92684. /** @hidden */
  92685. _randomCellOffset?: number;
  92686. /** @hidden */
  92687. _initialDirection: Nullable<Vector3>;
  92688. /** @hidden */
  92689. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  92690. /** @hidden */
  92691. _initialStartSpriteCellID: number;
  92692. /** @hidden */
  92693. _initialEndSpriteCellID: number;
  92694. /** @hidden */
  92695. _currentColorGradient: Nullable<ColorGradient>;
  92696. /** @hidden */
  92697. _currentColor1: Color4;
  92698. /** @hidden */
  92699. _currentColor2: Color4;
  92700. /** @hidden */
  92701. _currentSizeGradient: Nullable<FactorGradient>;
  92702. /** @hidden */
  92703. _currentSize1: number;
  92704. /** @hidden */
  92705. _currentSize2: number;
  92706. /** @hidden */
  92707. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  92708. /** @hidden */
  92709. _currentAngularSpeed1: number;
  92710. /** @hidden */
  92711. _currentAngularSpeed2: number;
  92712. /** @hidden */
  92713. _currentVelocityGradient: Nullable<FactorGradient>;
  92714. /** @hidden */
  92715. _currentVelocity1: number;
  92716. /** @hidden */
  92717. _currentVelocity2: number;
  92718. /** @hidden */
  92719. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  92720. /** @hidden */
  92721. _currentLimitVelocity1: number;
  92722. /** @hidden */
  92723. _currentLimitVelocity2: number;
  92724. /** @hidden */
  92725. _currentDragGradient: Nullable<FactorGradient>;
  92726. /** @hidden */
  92727. _currentDrag1: number;
  92728. /** @hidden */
  92729. _currentDrag2: number;
  92730. /** @hidden */
  92731. _randomNoiseCoordinates1: Vector3;
  92732. /** @hidden */
  92733. _randomNoiseCoordinates2: Vector3;
  92734. /** @hidden */
  92735. _localPosition?: Vector3;
  92736. /**
  92737. * Creates a new instance Particle
  92738. * @param particleSystem the particle system the particle belongs to
  92739. */
  92740. constructor(
  92741. /**
  92742. * The particle system the particle belongs to.
  92743. */
  92744. particleSystem: ParticleSystem);
  92745. private updateCellInfoFromSystem;
  92746. /**
  92747. * Defines how the sprite cell index is updated for the particle
  92748. */
  92749. updateCellIndex(): void;
  92750. /** @hidden */
  92751. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  92752. /** @hidden */
  92753. _inheritParticleInfoToSubEmitters(): void;
  92754. /** @hidden */
  92755. _reset(): void;
  92756. /**
  92757. * Copy the properties of particle to another one.
  92758. * @param other the particle to copy the information to.
  92759. */
  92760. copyTo(other: Particle): void;
  92761. }
  92762. }
  92763. declare module BABYLON {
  92764. /**
  92765. * Particle emitter represents a volume emitting particles.
  92766. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  92767. */
  92768. export interface IParticleEmitterType {
  92769. /**
  92770. * Called by the particle System when the direction is computed for the created particle.
  92771. * @param worldMatrix is the world matrix of the particle system
  92772. * @param directionToUpdate is the direction vector to update with the result
  92773. * @param particle is the particle we are computed the direction for
  92774. * @param isLocal defines if the direction should be set in local space
  92775. */
  92776. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92777. /**
  92778. * Called by the particle System when the position is computed for the created particle.
  92779. * @param worldMatrix is the world matrix of the particle system
  92780. * @param positionToUpdate is the position vector to update with the result
  92781. * @param particle is the particle we are computed the position for
  92782. * @param isLocal defines if the position should be set in local space
  92783. */
  92784. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92785. /**
  92786. * Clones the current emitter and returns a copy of it
  92787. * @returns the new emitter
  92788. */
  92789. clone(): IParticleEmitterType;
  92790. /**
  92791. * Called by the GPUParticleSystem to setup the update shader
  92792. * @param effect defines the update shader
  92793. */
  92794. applyToShader(effect: Effect): void;
  92795. /**
  92796. * Returns a string to use to update the GPU particles update shader
  92797. * @returns the effect defines string
  92798. */
  92799. getEffectDefines(): string;
  92800. /**
  92801. * Returns a string representing the class name
  92802. * @returns a string containing the class name
  92803. */
  92804. getClassName(): string;
  92805. /**
  92806. * Serializes the particle system to a JSON object.
  92807. * @returns the JSON object
  92808. */
  92809. serialize(): any;
  92810. /**
  92811. * Parse properties from a JSON object
  92812. * @param serializationObject defines the JSON object
  92813. * @param scene defines the hosting scene
  92814. */
  92815. parse(serializationObject: any, scene: Nullable<Scene>): void;
  92816. }
  92817. }
  92818. declare module BABYLON {
  92819. /**
  92820. * Particle emitter emitting particles from the inside of a box.
  92821. * It emits the particles randomly between 2 given directions.
  92822. */
  92823. export class BoxParticleEmitter implements IParticleEmitterType {
  92824. /**
  92825. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92826. */
  92827. direction1: Vector3;
  92828. /**
  92829. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92830. */
  92831. direction2: Vector3;
  92832. /**
  92833. * 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.
  92834. */
  92835. minEmitBox: Vector3;
  92836. /**
  92837. * 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.
  92838. */
  92839. maxEmitBox: Vector3;
  92840. /**
  92841. * Creates a new instance BoxParticleEmitter
  92842. */
  92843. constructor();
  92844. /**
  92845. * Called by the particle System when the direction is computed for the created particle.
  92846. * @param worldMatrix is the world matrix of the particle system
  92847. * @param directionToUpdate is the direction vector to update with the result
  92848. * @param particle is the particle we are computed the direction for
  92849. * @param isLocal defines if the direction should be set in local space
  92850. */
  92851. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92852. /**
  92853. * Called by the particle System when the position is computed for the created particle.
  92854. * @param worldMatrix is the world matrix of the particle system
  92855. * @param positionToUpdate is the position vector to update with the result
  92856. * @param particle is the particle we are computed the position for
  92857. * @param isLocal defines if the position should be set in local space
  92858. */
  92859. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92860. /**
  92861. * Clones the current emitter and returns a copy of it
  92862. * @returns the new emitter
  92863. */
  92864. clone(): BoxParticleEmitter;
  92865. /**
  92866. * Called by the GPUParticleSystem to setup the update shader
  92867. * @param effect defines the update shader
  92868. */
  92869. applyToShader(effect: Effect): void;
  92870. /**
  92871. * Returns a string to use to update the GPU particles update shader
  92872. * @returns a string containng the defines string
  92873. */
  92874. getEffectDefines(): string;
  92875. /**
  92876. * Returns the string "BoxParticleEmitter"
  92877. * @returns a string containing the class name
  92878. */
  92879. getClassName(): string;
  92880. /**
  92881. * Serializes the particle system to a JSON object.
  92882. * @returns the JSON object
  92883. */
  92884. serialize(): any;
  92885. /**
  92886. * Parse properties from a JSON object
  92887. * @param serializationObject defines the JSON object
  92888. */
  92889. parse(serializationObject: any): void;
  92890. }
  92891. }
  92892. declare module BABYLON {
  92893. /**
  92894. * Particle emitter emitting particles from the inside of a cone.
  92895. * It emits the particles alongside the cone volume from the base to the particle.
  92896. * The emission direction might be randomized.
  92897. */
  92898. export class ConeParticleEmitter implements IParticleEmitterType {
  92899. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  92900. directionRandomizer: number;
  92901. private _radius;
  92902. private _angle;
  92903. private _height;
  92904. /**
  92905. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  92906. */
  92907. radiusRange: number;
  92908. /**
  92909. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  92910. */
  92911. heightRange: number;
  92912. /**
  92913. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  92914. */
  92915. emitFromSpawnPointOnly: boolean;
  92916. /**
  92917. * Gets or sets the radius of the emission cone
  92918. */
  92919. get radius(): number;
  92920. set radius(value: number);
  92921. /**
  92922. * Gets or sets the angle of the emission cone
  92923. */
  92924. get angle(): number;
  92925. set angle(value: number);
  92926. private _buildHeight;
  92927. /**
  92928. * Creates a new instance ConeParticleEmitter
  92929. * @param radius the radius of the emission cone (1 by default)
  92930. * @param angle the cone base angle (PI by default)
  92931. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  92932. */
  92933. constructor(radius?: number, angle?: number,
  92934. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  92935. directionRandomizer?: number);
  92936. /**
  92937. * Called by the particle System when the direction is computed for the created particle.
  92938. * @param worldMatrix is the world matrix of the particle system
  92939. * @param directionToUpdate is the direction vector to update with the result
  92940. * @param particle is the particle we are computed the direction for
  92941. * @param isLocal defines if the direction should be set in local space
  92942. */
  92943. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92944. /**
  92945. * Called by the particle System when the position is computed for the created particle.
  92946. * @param worldMatrix is the world matrix of the particle system
  92947. * @param positionToUpdate is the position vector to update with the result
  92948. * @param particle is the particle we are computed the position for
  92949. * @param isLocal defines if the position should be set in local space
  92950. */
  92951. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92952. /**
  92953. * Clones the current emitter and returns a copy of it
  92954. * @returns the new emitter
  92955. */
  92956. clone(): ConeParticleEmitter;
  92957. /**
  92958. * Called by the GPUParticleSystem to setup the update shader
  92959. * @param effect defines the update shader
  92960. */
  92961. applyToShader(effect: Effect): void;
  92962. /**
  92963. * Returns a string to use to update the GPU particles update shader
  92964. * @returns a string containng the defines string
  92965. */
  92966. getEffectDefines(): string;
  92967. /**
  92968. * Returns the string "ConeParticleEmitter"
  92969. * @returns a string containing the class name
  92970. */
  92971. getClassName(): string;
  92972. /**
  92973. * Serializes the particle system to a JSON object.
  92974. * @returns the JSON object
  92975. */
  92976. serialize(): any;
  92977. /**
  92978. * Parse properties from a JSON object
  92979. * @param serializationObject defines the JSON object
  92980. */
  92981. parse(serializationObject: any): void;
  92982. }
  92983. }
  92984. declare module BABYLON {
  92985. /**
  92986. * Particle emitter emitting particles from the inside of a cylinder.
  92987. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  92988. */
  92989. export class CylinderParticleEmitter implements IParticleEmitterType {
  92990. /**
  92991. * The radius of the emission cylinder.
  92992. */
  92993. radius: number;
  92994. /**
  92995. * The height of the emission cylinder.
  92996. */
  92997. height: number;
  92998. /**
  92999. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93000. */
  93001. radiusRange: number;
  93002. /**
  93003. * How much to randomize the particle direction [0-1].
  93004. */
  93005. directionRandomizer: number;
  93006. /**
  93007. * Creates a new instance CylinderParticleEmitter
  93008. * @param radius the radius of the emission cylinder (1 by default)
  93009. * @param height the height of the emission cylinder (1 by default)
  93010. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93011. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93012. */
  93013. constructor(
  93014. /**
  93015. * The radius of the emission cylinder.
  93016. */
  93017. radius?: number,
  93018. /**
  93019. * The height of the emission cylinder.
  93020. */
  93021. height?: number,
  93022. /**
  93023. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93024. */
  93025. radiusRange?: number,
  93026. /**
  93027. * How much to randomize the particle direction [0-1].
  93028. */
  93029. directionRandomizer?: number);
  93030. /**
  93031. * Called by the particle System when the direction is computed for the created particle.
  93032. * @param worldMatrix is the world matrix of the particle system
  93033. * @param directionToUpdate is the direction vector to update with the result
  93034. * @param particle is the particle we are computed the direction for
  93035. * @param isLocal defines if the direction should be set in local space
  93036. */
  93037. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93038. /**
  93039. * Called by the particle System when the position is computed for the created particle.
  93040. * @param worldMatrix is the world matrix of the particle system
  93041. * @param positionToUpdate is the position vector to update with the result
  93042. * @param particle is the particle we are computed the position for
  93043. * @param isLocal defines if the position should be set in local space
  93044. */
  93045. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93046. /**
  93047. * Clones the current emitter and returns a copy of it
  93048. * @returns the new emitter
  93049. */
  93050. clone(): CylinderParticleEmitter;
  93051. /**
  93052. * Called by the GPUParticleSystem to setup the update shader
  93053. * @param effect defines the update shader
  93054. */
  93055. applyToShader(effect: Effect): void;
  93056. /**
  93057. * Returns a string to use to update the GPU particles update shader
  93058. * @returns a string containng the defines string
  93059. */
  93060. getEffectDefines(): string;
  93061. /**
  93062. * Returns the string "CylinderParticleEmitter"
  93063. * @returns a string containing the class name
  93064. */
  93065. getClassName(): string;
  93066. /**
  93067. * Serializes the particle system to a JSON object.
  93068. * @returns the JSON object
  93069. */
  93070. serialize(): any;
  93071. /**
  93072. * Parse properties from a JSON object
  93073. * @param serializationObject defines the JSON object
  93074. */
  93075. parse(serializationObject: any): void;
  93076. }
  93077. /**
  93078. * Particle emitter emitting particles from the inside of a cylinder.
  93079. * It emits the particles randomly between two vectors.
  93080. */
  93081. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  93082. /**
  93083. * The min limit of the emission direction.
  93084. */
  93085. direction1: Vector3;
  93086. /**
  93087. * The max limit of the emission direction.
  93088. */
  93089. direction2: Vector3;
  93090. /**
  93091. * Creates a new instance CylinderDirectedParticleEmitter
  93092. * @param radius the radius of the emission cylinder (1 by default)
  93093. * @param height the height of the emission cylinder (1 by default)
  93094. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93095. * @param direction1 the min limit of the emission direction (up vector by default)
  93096. * @param direction2 the max limit of the emission direction (up vector by default)
  93097. */
  93098. constructor(radius?: number, height?: number, radiusRange?: number,
  93099. /**
  93100. * The min limit of the emission direction.
  93101. */
  93102. direction1?: Vector3,
  93103. /**
  93104. * The max limit of the emission direction.
  93105. */
  93106. direction2?: Vector3);
  93107. /**
  93108. * Called by the particle System when the direction is computed for the created particle.
  93109. * @param worldMatrix is the world matrix of the particle system
  93110. * @param directionToUpdate is the direction vector to update with the result
  93111. * @param particle is the particle we are computed the direction for
  93112. */
  93113. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  93114. /**
  93115. * Clones the current emitter and returns a copy of it
  93116. * @returns the new emitter
  93117. */
  93118. clone(): CylinderDirectedParticleEmitter;
  93119. /**
  93120. * Called by the GPUParticleSystem to setup the update shader
  93121. * @param effect defines the update shader
  93122. */
  93123. applyToShader(effect: Effect): void;
  93124. /**
  93125. * Returns a string to use to update the GPU particles update shader
  93126. * @returns a string containng the defines string
  93127. */
  93128. getEffectDefines(): string;
  93129. /**
  93130. * Returns the string "CylinderDirectedParticleEmitter"
  93131. * @returns a string containing the class name
  93132. */
  93133. getClassName(): string;
  93134. /**
  93135. * Serializes the particle system to a JSON object.
  93136. * @returns the JSON object
  93137. */
  93138. serialize(): any;
  93139. /**
  93140. * Parse properties from a JSON object
  93141. * @param serializationObject defines the JSON object
  93142. */
  93143. parse(serializationObject: any): void;
  93144. }
  93145. }
  93146. declare module BABYLON {
  93147. /**
  93148. * Particle emitter emitting particles from the inside of a hemisphere.
  93149. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  93150. */
  93151. export class HemisphericParticleEmitter implements IParticleEmitterType {
  93152. /**
  93153. * The radius of the emission hemisphere.
  93154. */
  93155. radius: number;
  93156. /**
  93157. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93158. */
  93159. radiusRange: number;
  93160. /**
  93161. * How much to randomize the particle direction [0-1].
  93162. */
  93163. directionRandomizer: number;
  93164. /**
  93165. * Creates a new instance HemisphericParticleEmitter
  93166. * @param radius the radius of the emission hemisphere (1 by default)
  93167. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93168. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93169. */
  93170. constructor(
  93171. /**
  93172. * The radius of the emission hemisphere.
  93173. */
  93174. radius?: number,
  93175. /**
  93176. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93177. */
  93178. radiusRange?: number,
  93179. /**
  93180. * How much to randomize the particle direction [0-1].
  93181. */
  93182. directionRandomizer?: number);
  93183. /**
  93184. * Called by the particle System when the direction is computed for the created particle.
  93185. * @param worldMatrix is the world matrix of the particle system
  93186. * @param directionToUpdate is the direction vector to update with the result
  93187. * @param particle is the particle we are computed the direction for
  93188. * @param isLocal defines if the direction should be set in local space
  93189. */
  93190. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93191. /**
  93192. * Called by the particle System when the position is computed for the created particle.
  93193. * @param worldMatrix is the world matrix of the particle system
  93194. * @param positionToUpdate is the position vector to update with the result
  93195. * @param particle is the particle we are computed the position for
  93196. * @param isLocal defines if the position should be set in local space
  93197. */
  93198. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93199. /**
  93200. * Clones the current emitter and returns a copy of it
  93201. * @returns the new emitter
  93202. */
  93203. clone(): HemisphericParticleEmitter;
  93204. /**
  93205. * Called by the GPUParticleSystem to setup the update shader
  93206. * @param effect defines the update shader
  93207. */
  93208. applyToShader(effect: Effect): void;
  93209. /**
  93210. * Returns a string to use to update the GPU particles update shader
  93211. * @returns a string containng the defines string
  93212. */
  93213. getEffectDefines(): string;
  93214. /**
  93215. * Returns the string "HemisphericParticleEmitter"
  93216. * @returns a string containing the class name
  93217. */
  93218. getClassName(): string;
  93219. /**
  93220. * Serializes the particle system to a JSON object.
  93221. * @returns the JSON object
  93222. */
  93223. serialize(): any;
  93224. /**
  93225. * Parse properties from a JSON object
  93226. * @param serializationObject defines the JSON object
  93227. */
  93228. parse(serializationObject: any): void;
  93229. }
  93230. }
  93231. declare module BABYLON {
  93232. /**
  93233. * Particle emitter emitting particles from a point.
  93234. * It emits the particles randomly between 2 given directions.
  93235. */
  93236. export class PointParticleEmitter implements IParticleEmitterType {
  93237. /**
  93238. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93239. */
  93240. direction1: Vector3;
  93241. /**
  93242. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93243. */
  93244. direction2: Vector3;
  93245. /**
  93246. * Creates a new instance PointParticleEmitter
  93247. */
  93248. constructor();
  93249. /**
  93250. * Called by the particle System when the direction is computed for the created particle.
  93251. * @param worldMatrix is the world matrix of the particle system
  93252. * @param directionToUpdate is the direction vector to update with the result
  93253. * @param particle is the particle we are computed the direction for
  93254. * @param isLocal defines if the direction should be set in local space
  93255. */
  93256. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93257. /**
  93258. * Called by the particle System when the position is computed for the created particle.
  93259. * @param worldMatrix is the world matrix of the particle system
  93260. * @param positionToUpdate is the position vector to update with the result
  93261. * @param particle is the particle we are computed the position for
  93262. * @param isLocal defines if the position should be set in local space
  93263. */
  93264. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93265. /**
  93266. * Clones the current emitter and returns a copy of it
  93267. * @returns the new emitter
  93268. */
  93269. clone(): PointParticleEmitter;
  93270. /**
  93271. * Called by the GPUParticleSystem to setup the update shader
  93272. * @param effect defines the update shader
  93273. */
  93274. applyToShader(effect: Effect): void;
  93275. /**
  93276. * Returns a string to use to update the GPU particles update shader
  93277. * @returns a string containng the defines string
  93278. */
  93279. getEffectDefines(): string;
  93280. /**
  93281. * Returns the string "PointParticleEmitter"
  93282. * @returns a string containing the class name
  93283. */
  93284. getClassName(): string;
  93285. /**
  93286. * Serializes the particle system to a JSON object.
  93287. * @returns the JSON object
  93288. */
  93289. serialize(): any;
  93290. /**
  93291. * Parse properties from a JSON object
  93292. * @param serializationObject defines the JSON object
  93293. */
  93294. parse(serializationObject: any): void;
  93295. }
  93296. }
  93297. declare module BABYLON {
  93298. /**
  93299. * Particle emitter emitting particles from the inside of a sphere.
  93300. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  93301. */
  93302. export class SphereParticleEmitter implements IParticleEmitterType {
  93303. /**
  93304. * The radius of the emission sphere.
  93305. */
  93306. radius: number;
  93307. /**
  93308. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93309. */
  93310. radiusRange: number;
  93311. /**
  93312. * How much to randomize the particle direction [0-1].
  93313. */
  93314. directionRandomizer: number;
  93315. /**
  93316. * Creates a new instance SphereParticleEmitter
  93317. * @param radius the radius of the emission sphere (1 by default)
  93318. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93319. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93320. */
  93321. constructor(
  93322. /**
  93323. * The radius of the emission sphere.
  93324. */
  93325. radius?: number,
  93326. /**
  93327. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93328. */
  93329. radiusRange?: number,
  93330. /**
  93331. * How much to randomize the particle direction [0-1].
  93332. */
  93333. directionRandomizer?: number);
  93334. /**
  93335. * Called by the particle System when the direction is computed for the created particle.
  93336. * @param worldMatrix is the world matrix of the particle system
  93337. * @param directionToUpdate is the direction vector to update with the result
  93338. * @param particle is the particle we are computed the direction for
  93339. * @param isLocal defines if the direction should be set in local space
  93340. */
  93341. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93342. /**
  93343. * Called by the particle System when the position is computed for the created particle.
  93344. * @param worldMatrix is the world matrix of the particle system
  93345. * @param positionToUpdate is the position vector to update with the result
  93346. * @param particle is the particle we are computed the position for
  93347. * @param isLocal defines if the position should be set in local space
  93348. */
  93349. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93350. /**
  93351. * Clones the current emitter and returns a copy of it
  93352. * @returns the new emitter
  93353. */
  93354. clone(): SphereParticleEmitter;
  93355. /**
  93356. * Called by the GPUParticleSystem to setup the update shader
  93357. * @param effect defines the update shader
  93358. */
  93359. applyToShader(effect: Effect): void;
  93360. /**
  93361. * Returns a string to use to update the GPU particles update shader
  93362. * @returns a string containng the defines string
  93363. */
  93364. getEffectDefines(): string;
  93365. /**
  93366. * Returns the string "SphereParticleEmitter"
  93367. * @returns a string containing the class name
  93368. */
  93369. getClassName(): string;
  93370. /**
  93371. * Serializes the particle system to a JSON object.
  93372. * @returns the JSON object
  93373. */
  93374. serialize(): any;
  93375. /**
  93376. * Parse properties from a JSON object
  93377. * @param serializationObject defines the JSON object
  93378. */
  93379. parse(serializationObject: any): void;
  93380. }
  93381. /**
  93382. * Particle emitter emitting particles from the inside of a sphere.
  93383. * It emits the particles randomly between two vectors.
  93384. */
  93385. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  93386. /**
  93387. * The min limit of the emission direction.
  93388. */
  93389. direction1: Vector3;
  93390. /**
  93391. * The max limit of the emission direction.
  93392. */
  93393. direction2: Vector3;
  93394. /**
  93395. * Creates a new instance SphereDirectedParticleEmitter
  93396. * @param radius the radius of the emission sphere (1 by default)
  93397. * @param direction1 the min limit of the emission direction (up vector by default)
  93398. * @param direction2 the max limit of the emission direction (up vector by default)
  93399. */
  93400. constructor(radius?: number,
  93401. /**
  93402. * The min limit of the emission direction.
  93403. */
  93404. direction1?: Vector3,
  93405. /**
  93406. * The max limit of the emission direction.
  93407. */
  93408. direction2?: Vector3);
  93409. /**
  93410. * Called by the particle System when the direction is computed for the created particle.
  93411. * @param worldMatrix is the world matrix of the particle system
  93412. * @param directionToUpdate is the direction vector to update with the result
  93413. * @param particle is the particle we are computed the direction for
  93414. */
  93415. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  93416. /**
  93417. * Clones the current emitter and returns a copy of it
  93418. * @returns the new emitter
  93419. */
  93420. clone(): SphereDirectedParticleEmitter;
  93421. /**
  93422. * Called by the GPUParticleSystem to setup the update shader
  93423. * @param effect defines the update shader
  93424. */
  93425. applyToShader(effect: Effect): void;
  93426. /**
  93427. * Returns a string to use to update the GPU particles update shader
  93428. * @returns a string containng the defines string
  93429. */
  93430. getEffectDefines(): string;
  93431. /**
  93432. * Returns the string "SphereDirectedParticleEmitter"
  93433. * @returns a string containing the class name
  93434. */
  93435. getClassName(): string;
  93436. /**
  93437. * Serializes the particle system to a JSON object.
  93438. * @returns the JSON object
  93439. */
  93440. serialize(): any;
  93441. /**
  93442. * Parse properties from a JSON object
  93443. * @param serializationObject defines the JSON object
  93444. */
  93445. parse(serializationObject: any): void;
  93446. }
  93447. }
  93448. declare module BABYLON {
  93449. /**
  93450. * Particle emitter emitting particles from a custom list of positions.
  93451. */
  93452. export class CustomParticleEmitter implements IParticleEmitterType {
  93453. /**
  93454. * Gets or sets the position generator that will create the inital position of each particle.
  93455. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  93456. */
  93457. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  93458. /**
  93459. * Gets or sets the destination generator that will create the final destination of each particle.
  93460. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  93461. */
  93462. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  93463. /**
  93464. * Creates a new instance CustomParticleEmitter
  93465. */
  93466. constructor();
  93467. /**
  93468. * Called by the particle System when the direction is computed for the created particle.
  93469. * @param worldMatrix is the world matrix of the particle system
  93470. * @param directionToUpdate is the direction vector to update with the result
  93471. * @param particle is the particle we are computed the direction for
  93472. * @param isLocal defines if the direction should be set in local space
  93473. */
  93474. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93475. /**
  93476. * Called by the particle System when the position is computed for the created particle.
  93477. * @param worldMatrix is the world matrix of the particle system
  93478. * @param positionToUpdate is the position vector to update with the result
  93479. * @param particle is the particle we are computed the position for
  93480. * @param isLocal defines if the position should be set in local space
  93481. */
  93482. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93483. /**
  93484. * Clones the current emitter and returns a copy of it
  93485. * @returns the new emitter
  93486. */
  93487. clone(): CustomParticleEmitter;
  93488. /**
  93489. * Called by the GPUParticleSystem to setup the update shader
  93490. * @param effect defines the update shader
  93491. */
  93492. applyToShader(effect: Effect): void;
  93493. /**
  93494. * Returns a string to use to update the GPU particles update shader
  93495. * @returns a string containng the defines string
  93496. */
  93497. getEffectDefines(): string;
  93498. /**
  93499. * Returns the string "PointParticleEmitter"
  93500. * @returns a string containing the class name
  93501. */
  93502. getClassName(): string;
  93503. /**
  93504. * Serializes the particle system to a JSON object.
  93505. * @returns the JSON object
  93506. */
  93507. serialize(): any;
  93508. /**
  93509. * Parse properties from a JSON object
  93510. * @param serializationObject defines the JSON object
  93511. */
  93512. parse(serializationObject: any): void;
  93513. }
  93514. }
  93515. declare module BABYLON {
  93516. /**
  93517. * Particle emitter emitting particles from the inside of a box.
  93518. * It emits the particles randomly between 2 given directions.
  93519. */
  93520. export class MeshParticleEmitter implements IParticleEmitterType {
  93521. private _indices;
  93522. private _positions;
  93523. private _normals;
  93524. private _storedNormal;
  93525. private _mesh;
  93526. /**
  93527. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93528. */
  93529. direction1: Vector3;
  93530. /**
  93531. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93532. */
  93533. direction2: Vector3;
  93534. /**
  93535. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  93536. */
  93537. useMeshNormalsForDirection: boolean;
  93538. /** Defines the mesh to use as source */
  93539. get mesh(): Nullable<AbstractMesh>;
  93540. set mesh(value: Nullable<AbstractMesh>);
  93541. /**
  93542. * Creates a new instance MeshParticleEmitter
  93543. * @param mesh defines the mesh to use as source
  93544. */
  93545. constructor(mesh?: Nullable<AbstractMesh>);
  93546. /**
  93547. * Called by the particle System when the direction is computed for the created particle.
  93548. * @param worldMatrix is the world matrix of the particle system
  93549. * @param directionToUpdate is the direction vector to update with the result
  93550. * @param particle is the particle we are computed the direction for
  93551. * @param isLocal defines if the direction should be set in local space
  93552. */
  93553. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93554. /**
  93555. * Called by the particle System when the position is computed for the created particle.
  93556. * @param worldMatrix is the world matrix of the particle system
  93557. * @param positionToUpdate is the position vector to update with the result
  93558. * @param particle is the particle we are computed the position for
  93559. * @param isLocal defines if the position should be set in local space
  93560. */
  93561. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93562. /**
  93563. * Clones the current emitter and returns a copy of it
  93564. * @returns the new emitter
  93565. */
  93566. clone(): MeshParticleEmitter;
  93567. /**
  93568. * Called by the GPUParticleSystem to setup the update shader
  93569. * @param effect defines the update shader
  93570. */
  93571. applyToShader(effect: Effect): void;
  93572. /**
  93573. * Returns a string to use to update the GPU particles update shader
  93574. * @returns a string containng the defines string
  93575. */
  93576. getEffectDefines(): string;
  93577. /**
  93578. * Returns the string "BoxParticleEmitter"
  93579. * @returns a string containing the class name
  93580. */
  93581. getClassName(): string;
  93582. /**
  93583. * Serializes the particle system to a JSON object.
  93584. * @returns the JSON object
  93585. */
  93586. serialize(): any;
  93587. /**
  93588. * Parse properties from a JSON object
  93589. * @param serializationObject defines the JSON object
  93590. * @param scene defines the hosting scene
  93591. */
  93592. parse(serializationObject: any, scene: Nullable<Scene>): void;
  93593. }
  93594. }
  93595. declare module BABYLON {
  93596. /**
  93597. * Interface representing a particle system in Babylon.js.
  93598. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  93599. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  93600. */
  93601. export interface IParticleSystem {
  93602. /**
  93603. * List of animations used by the particle system.
  93604. */
  93605. animations: Animation[];
  93606. /**
  93607. * The id of the Particle system.
  93608. */
  93609. id: string;
  93610. /**
  93611. * The name of the Particle system.
  93612. */
  93613. name: string;
  93614. /**
  93615. * The emitter represents the Mesh or position we are attaching the particle system to.
  93616. */
  93617. emitter: Nullable<AbstractMesh | Vector3>;
  93618. /**
  93619. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  93620. */
  93621. isBillboardBased: boolean;
  93622. /**
  93623. * The rendering group used by the Particle system to chose when to render.
  93624. */
  93625. renderingGroupId: number;
  93626. /**
  93627. * The layer mask we are rendering the particles through.
  93628. */
  93629. layerMask: number;
  93630. /**
  93631. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  93632. */
  93633. updateSpeed: number;
  93634. /**
  93635. * The amount of time the particle system is running (depends of the overall update speed).
  93636. */
  93637. targetStopDuration: number;
  93638. /**
  93639. * The texture used to render each particle. (this can be a spritesheet)
  93640. */
  93641. particleTexture: Nullable<BaseTexture>;
  93642. /**
  93643. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  93644. */
  93645. blendMode: number;
  93646. /**
  93647. * Minimum life time of emitting particles.
  93648. */
  93649. minLifeTime: number;
  93650. /**
  93651. * Maximum life time of emitting particles.
  93652. */
  93653. maxLifeTime: number;
  93654. /**
  93655. * Minimum Size of emitting particles.
  93656. */
  93657. minSize: number;
  93658. /**
  93659. * Maximum Size of emitting particles.
  93660. */
  93661. maxSize: number;
  93662. /**
  93663. * Minimum scale of emitting particles on X axis.
  93664. */
  93665. minScaleX: number;
  93666. /**
  93667. * Maximum scale of emitting particles on X axis.
  93668. */
  93669. maxScaleX: number;
  93670. /**
  93671. * Minimum scale of emitting particles on Y axis.
  93672. */
  93673. minScaleY: number;
  93674. /**
  93675. * Maximum scale of emitting particles on Y axis.
  93676. */
  93677. maxScaleY: number;
  93678. /**
  93679. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  93680. */
  93681. color1: Color4;
  93682. /**
  93683. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  93684. */
  93685. color2: Color4;
  93686. /**
  93687. * Color the particle will have at the end of its lifetime.
  93688. */
  93689. colorDead: Color4;
  93690. /**
  93691. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  93692. */
  93693. emitRate: number;
  93694. /**
  93695. * You can use gravity if you want to give an orientation to your particles.
  93696. */
  93697. gravity: Vector3;
  93698. /**
  93699. * Minimum power of emitting particles.
  93700. */
  93701. minEmitPower: number;
  93702. /**
  93703. * Maximum power of emitting particles.
  93704. */
  93705. maxEmitPower: number;
  93706. /**
  93707. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  93708. */
  93709. minAngularSpeed: number;
  93710. /**
  93711. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  93712. */
  93713. maxAngularSpeed: number;
  93714. /**
  93715. * Gets or sets the minimal initial rotation in radians.
  93716. */
  93717. minInitialRotation: number;
  93718. /**
  93719. * Gets or sets the maximal initial rotation in radians.
  93720. */
  93721. maxInitialRotation: number;
  93722. /**
  93723. * The particle emitter type defines the emitter used by the particle system.
  93724. * It can be for example box, sphere, or cone...
  93725. */
  93726. particleEmitterType: Nullable<IParticleEmitterType>;
  93727. /**
  93728. * Defines the delay in milliseconds before starting the system (0 by default)
  93729. */
  93730. startDelay: number;
  93731. /**
  93732. * 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
  93733. */
  93734. preWarmCycles: number;
  93735. /**
  93736. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  93737. */
  93738. preWarmStepOffset: number;
  93739. /**
  93740. * 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)
  93741. */
  93742. spriteCellChangeSpeed: number;
  93743. /**
  93744. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  93745. */
  93746. startSpriteCellID: number;
  93747. /**
  93748. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  93749. */
  93750. endSpriteCellID: number;
  93751. /**
  93752. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  93753. */
  93754. spriteCellWidth: number;
  93755. /**
  93756. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  93757. */
  93758. spriteCellHeight: number;
  93759. /**
  93760. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  93761. */
  93762. spriteRandomStartCell: boolean;
  93763. /**
  93764. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  93765. */
  93766. isAnimationSheetEnabled: boolean;
  93767. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  93768. translationPivot: Vector2;
  93769. /**
  93770. * Gets or sets a texture used to add random noise to particle positions
  93771. */
  93772. noiseTexture: Nullable<BaseTexture>;
  93773. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  93774. noiseStrength: Vector3;
  93775. /**
  93776. * Gets or sets the billboard mode to use when isBillboardBased = true.
  93777. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  93778. */
  93779. billboardMode: number;
  93780. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  93781. limitVelocityDamping: number;
  93782. /**
  93783. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  93784. */
  93785. beginAnimationOnStart: boolean;
  93786. /**
  93787. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  93788. */
  93789. beginAnimationFrom: number;
  93790. /**
  93791. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  93792. */
  93793. beginAnimationTo: number;
  93794. /**
  93795. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  93796. */
  93797. beginAnimationLoop: boolean;
  93798. /**
  93799. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  93800. */
  93801. disposeOnStop: boolean;
  93802. /**
  93803. * Specifies if the particles are updated in emitter local space or world space
  93804. */
  93805. isLocal: boolean;
  93806. /** Snippet ID if the particle system was created from the snippet server */
  93807. snippetId: string;
  93808. /** Gets or sets a matrix to use to compute projection */
  93809. defaultProjectionMatrix: Matrix;
  93810. /**
  93811. * Gets the maximum number of particles active at the same time.
  93812. * @returns The max number of active particles.
  93813. */
  93814. getCapacity(): number;
  93815. /**
  93816. * Gets the number of particles active at the same time.
  93817. * @returns The number of active particles.
  93818. */
  93819. getActiveCount(): number;
  93820. /**
  93821. * Gets if the system has been started. (Note: this will still be true after stop is called)
  93822. * @returns True if it has been started, otherwise false.
  93823. */
  93824. isStarted(): boolean;
  93825. /**
  93826. * Animates the particle system for this frame.
  93827. */
  93828. animate(): void;
  93829. /**
  93830. * Renders the particle system in its current state.
  93831. * @returns the current number of particles
  93832. */
  93833. render(): number;
  93834. /**
  93835. * Dispose the particle system and frees its associated resources.
  93836. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  93837. */
  93838. dispose(disposeTexture?: boolean): void;
  93839. /**
  93840. * An event triggered when the system is disposed
  93841. */
  93842. onDisposeObservable: Observable<IParticleSystem>;
  93843. /**
  93844. * Clones the particle system.
  93845. * @param name The name of the cloned object
  93846. * @param newEmitter The new emitter to use
  93847. * @returns the cloned particle system
  93848. */
  93849. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  93850. /**
  93851. * Serializes the particle system to a JSON object
  93852. * @param serializeTexture defines if the texture must be serialized as well
  93853. * @returns the JSON object
  93854. */
  93855. serialize(serializeTexture: boolean): any;
  93856. /**
  93857. * Rebuild the particle system
  93858. */
  93859. rebuild(): void;
  93860. /** Force the system to rebuild all gradients that need to be resync */
  93861. forceRefreshGradients(): void;
  93862. /**
  93863. * Starts the particle system and begins to emit
  93864. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  93865. */
  93866. start(delay?: number): void;
  93867. /**
  93868. * Stops the particle system.
  93869. */
  93870. stop(): void;
  93871. /**
  93872. * Remove all active particles
  93873. */
  93874. reset(): void;
  93875. /**
  93876. * Gets a boolean indicating that the system is stopping
  93877. * @returns true if the system is currently stopping
  93878. */
  93879. isStopping(): boolean;
  93880. /**
  93881. * Is this system ready to be used/rendered
  93882. * @return true if the system is ready
  93883. */
  93884. isReady(): boolean;
  93885. /**
  93886. * Returns the string "ParticleSystem"
  93887. * @returns a string containing the class name
  93888. */
  93889. getClassName(): string;
  93890. /**
  93891. * Gets the custom effect used to render the particles
  93892. * @param blendMode Blend mode for which the effect should be retrieved
  93893. * @returns The effect
  93894. */
  93895. getCustomEffect(blendMode: number): Nullable<Effect>;
  93896. /**
  93897. * Sets the custom effect used to render the particles
  93898. * @param effect The effect to set
  93899. * @param blendMode Blend mode for which the effect should be set
  93900. */
  93901. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  93902. /**
  93903. * Fill the defines array according to the current settings of the particle system
  93904. * @param defines Array to be updated
  93905. * @param blendMode blend mode to take into account when updating the array
  93906. */
  93907. fillDefines(defines: Array<string>, blendMode: number): void;
  93908. /**
  93909. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  93910. * @param uniforms Uniforms array to fill
  93911. * @param attributes Attributes array to fill
  93912. * @param samplers Samplers array to fill
  93913. */
  93914. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  93915. /**
  93916. * Observable that will be called just before the particles are drawn
  93917. */
  93918. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  93919. /**
  93920. * Gets the name of the particle vertex shader
  93921. */
  93922. vertexShaderName: string;
  93923. /**
  93924. * Adds a new color gradient
  93925. * @param gradient defines the gradient to use (between 0 and 1)
  93926. * @param color1 defines the color to affect to the specified gradient
  93927. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  93928. * @returns the current particle system
  93929. */
  93930. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  93931. /**
  93932. * Remove a specific color gradient
  93933. * @param gradient defines the gradient to remove
  93934. * @returns the current particle system
  93935. */
  93936. removeColorGradient(gradient: number): IParticleSystem;
  93937. /**
  93938. * Adds a new size gradient
  93939. * @param gradient defines the gradient to use (between 0 and 1)
  93940. * @param factor defines the size factor to affect to the specified gradient
  93941. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93942. * @returns the current particle system
  93943. */
  93944. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93945. /**
  93946. * Remove a specific size gradient
  93947. * @param gradient defines the gradient to remove
  93948. * @returns the current particle system
  93949. */
  93950. removeSizeGradient(gradient: number): IParticleSystem;
  93951. /**
  93952. * Gets the current list of color gradients.
  93953. * You must use addColorGradient and removeColorGradient to udpate this list
  93954. * @returns the list of color gradients
  93955. */
  93956. getColorGradients(): Nullable<Array<ColorGradient>>;
  93957. /**
  93958. * Gets the current list of size gradients.
  93959. * You must use addSizeGradient and removeSizeGradient to udpate this list
  93960. * @returns the list of size gradients
  93961. */
  93962. getSizeGradients(): Nullable<Array<FactorGradient>>;
  93963. /**
  93964. * Gets the current list of angular speed gradients.
  93965. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  93966. * @returns the list of angular speed gradients
  93967. */
  93968. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  93969. /**
  93970. * Adds a new angular speed gradient
  93971. * @param gradient defines the gradient to use (between 0 and 1)
  93972. * @param factor defines the angular speed to affect to the specified gradient
  93973. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93974. * @returns the current particle system
  93975. */
  93976. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93977. /**
  93978. * Remove a specific angular speed gradient
  93979. * @param gradient defines the gradient to remove
  93980. * @returns the current particle system
  93981. */
  93982. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  93983. /**
  93984. * Gets the current list of velocity gradients.
  93985. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  93986. * @returns the list of velocity gradients
  93987. */
  93988. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  93989. /**
  93990. * Adds a new velocity gradient
  93991. * @param gradient defines the gradient to use (between 0 and 1)
  93992. * @param factor defines the velocity to affect to the specified gradient
  93993. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93994. * @returns the current particle system
  93995. */
  93996. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93997. /**
  93998. * Remove a specific velocity gradient
  93999. * @param gradient defines the gradient to remove
  94000. * @returns the current particle system
  94001. */
  94002. removeVelocityGradient(gradient: number): IParticleSystem;
  94003. /**
  94004. * Gets the current list of limit velocity gradients.
  94005. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  94006. * @returns the list of limit velocity gradients
  94007. */
  94008. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  94009. /**
  94010. * Adds a new limit velocity gradient
  94011. * @param gradient defines the gradient to use (between 0 and 1)
  94012. * @param factor defines the limit velocity to affect to the specified gradient
  94013. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94014. * @returns the current particle system
  94015. */
  94016. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94017. /**
  94018. * Remove a specific limit velocity gradient
  94019. * @param gradient defines the gradient to remove
  94020. * @returns the current particle system
  94021. */
  94022. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  94023. /**
  94024. * Adds a new drag gradient
  94025. * @param gradient defines the gradient to use (between 0 and 1)
  94026. * @param factor defines the drag to affect to the specified gradient
  94027. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94028. * @returns the current particle system
  94029. */
  94030. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94031. /**
  94032. * Remove a specific drag gradient
  94033. * @param gradient defines the gradient to remove
  94034. * @returns the current particle system
  94035. */
  94036. removeDragGradient(gradient: number): IParticleSystem;
  94037. /**
  94038. * Gets the current list of drag gradients.
  94039. * You must use addDragGradient and removeDragGradient to udpate this list
  94040. * @returns the list of drag gradients
  94041. */
  94042. getDragGradients(): Nullable<Array<FactorGradient>>;
  94043. /**
  94044. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  94045. * @param gradient defines the gradient to use (between 0 and 1)
  94046. * @param factor defines the emit rate to affect to the specified gradient
  94047. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94048. * @returns the current particle system
  94049. */
  94050. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94051. /**
  94052. * Remove a specific emit rate gradient
  94053. * @param gradient defines the gradient to remove
  94054. * @returns the current particle system
  94055. */
  94056. removeEmitRateGradient(gradient: number): IParticleSystem;
  94057. /**
  94058. * Gets the current list of emit rate gradients.
  94059. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  94060. * @returns the list of emit rate gradients
  94061. */
  94062. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  94063. /**
  94064. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  94065. * @param gradient defines the gradient to use (between 0 and 1)
  94066. * @param factor defines the start size to affect to the specified gradient
  94067. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94068. * @returns the current particle system
  94069. */
  94070. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94071. /**
  94072. * Remove a specific start size gradient
  94073. * @param gradient defines the gradient to remove
  94074. * @returns the current particle system
  94075. */
  94076. removeStartSizeGradient(gradient: number): IParticleSystem;
  94077. /**
  94078. * Gets the current list of start size gradients.
  94079. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  94080. * @returns the list of start size gradients
  94081. */
  94082. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  94083. /**
  94084. * Adds a new life time gradient
  94085. * @param gradient defines the gradient to use (between 0 and 1)
  94086. * @param factor defines the life time factor to affect to the specified gradient
  94087. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94088. * @returns the current particle system
  94089. */
  94090. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94091. /**
  94092. * Remove a specific life time gradient
  94093. * @param gradient defines the gradient to remove
  94094. * @returns the current particle system
  94095. */
  94096. removeLifeTimeGradient(gradient: number): IParticleSystem;
  94097. /**
  94098. * Gets the current list of life time gradients.
  94099. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  94100. * @returns the list of life time gradients
  94101. */
  94102. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  94103. /**
  94104. * Gets the current list of color gradients.
  94105. * You must use addColorGradient and removeColorGradient to udpate this list
  94106. * @returns the list of color gradients
  94107. */
  94108. getColorGradients(): Nullable<Array<ColorGradient>>;
  94109. /**
  94110. * Adds a new ramp gradient used to remap particle colors
  94111. * @param gradient defines the gradient to use (between 0 and 1)
  94112. * @param color defines the color to affect to the specified gradient
  94113. * @returns the current particle system
  94114. */
  94115. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  94116. /**
  94117. * Gets the current list of ramp gradients.
  94118. * You must use addRampGradient and removeRampGradient to udpate this list
  94119. * @returns the list of ramp gradients
  94120. */
  94121. getRampGradients(): Nullable<Array<Color3Gradient>>;
  94122. /** Gets or sets a boolean indicating that ramp gradients must be used
  94123. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  94124. */
  94125. useRampGradients: boolean;
  94126. /**
  94127. * Adds a new color remap gradient
  94128. * @param gradient defines the gradient to use (between 0 and 1)
  94129. * @param min defines the color remap minimal range
  94130. * @param max defines the color remap maximal range
  94131. * @returns the current particle system
  94132. */
  94133. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  94134. /**
  94135. * Gets the current list of color remap gradients.
  94136. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  94137. * @returns the list of color remap gradients
  94138. */
  94139. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  94140. /**
  94141. * Adds a new alpha remap gradient
  94142. * @param gradient defines the gradient to use (between 0 and 1)
  94143. * @param min defines the alpha remap minimal range
  94144. * @param max defines the alpha remap maximal range
  94145. * @returns the current particle system
  94146. */
  94147. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  94148. /**
  94149. * Gets the current list of alpha remap gradients.
  94150. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  94151. * @returns the list of alpha remap gradients
  94152. */
  94153. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  94154. /**
  94155. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  94156. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  94157. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  94158. * @returns the emitter
  94159. */
  94160. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  94161. /**
  94162. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  94163. * @param radius The radius of the hemisphere to emit from
  94164. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  94165. * @returns the emitter
  94166. */
  94167. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  94168. /**
  94169. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  94170. * @param radius The radius of the sphere to emit from
  94171. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  94172. * @returns the emitter
  94173. */
  94174. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  94175. /**
  94176. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  94177. * @param radius The radius of the sphere to emit from
  94178. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  94179. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  94180. * @returns the emitter
  94181. */
  94182. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  94183. /**
  94184. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  94185. * @param radius The radius of the emission cylinder
  94186. * @param height The height of the emission cylinder
  94187. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  94188. * @param directionRandomizer How much to randomize the particle direction [0-1]
  94189. * @returns the emitter
  94190. */
  94191. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  94192. /**
  94193. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  94194. * @param radius The radius of the cylinder to emit from
  94195. * @param height The height of the emission cylinder
  94196. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  94197. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  94198. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  94199. * @returns the emitter
  94200. */
  94201. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  94202. /**
  94203. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  94204. * @param radius The radius of the cone to emit from
  94205. * @param angle The base angle of the cone
  94206. * @returns the emitter
  94207. */
  94208. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  94209. /**
  94210. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  94211. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  94212. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  94213. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  94214. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  94215. * @returns the emitter
  94216. */
  94217. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  94218. /**
  94219. * Get hosting scene
  94220. * @returns the scene
  94221. */
  94222. getScene(): Nullable<Scene>;
  94223. }
  94224. }
  94225. declare module BABYLON {
  94226. /**
  94227. * 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.
  94228. * @see https://doc.babylonjs.com/how_to/transformnode
  94229. */
  94230. export class TransformNode extends Node {
  94231. /**
  94232. * Object will not rotate to face the camera
  94233. */
  94234. static BILLBOARDMODE_NONE: number;
  94235. /**
  94236. * Object will rotate to face the camera but only on the x axis
  94237. */
  94238. static BILLBOARDMODE_X: number;
  94239. /**
  94240. * Object will rotate to face the camera but only on the y axis
  94241. */
  94242. static BILLBOARDMODE_Y: number;
  94243. /**
  94244. * Object will rotate to face the camera but only on the z axis
  94245. */
  94246. static BILLBOARDMODE_Z: number;
  94247. /**
  94248. * Object will rotate to face the camera
  94249. */
  94250. static BILLBOARDMODE_ALL: number;
  94251. /**
  94252. * Object will rotate to face the camera's position instead of orientation
  94253. */
  94254. static BILLBOARDMODE_USE_POSITION: number;
  94255. private static _TmpRotation;
  94256. private static _TmpScaling;
  94257. private static _TmpTranslation;
  94258. private _forward;
  94259. private _forwardInverted;
  94260. private _up;
  94261. private _right;
  94262. private _rightInverted;
  94263. private _position;
  94264. private _rotation;
  94265. private _rotationQuaternion;
  94266. protected _scaling: Vector3;
  94267. protected _isDirty: boolean;
  94268. private _transformToBoneReferal;
  94269. private _isAbsoluteSynced;
  94270. private _billboardMode;
  94271. /**
  94272. * Gets or sets the billboard mode. Default is 0.
  94273. *
  94274. * | Value | Type | Description |
  94275. * | --- | --- | --- |
  94276. * | 0 | BILLBOARDMODE_NONE | |
  94277. * | 1 | BILLBOARDMODE_X | |
  94278. * | 2 | BILLBOARDMODE_Y | |
  94279. * | 4 | BILLBOARDMODE_Z | |
  94280. * | 7 | BILLBOARDMODE_ALL | |
  94281. *
  94282. */
  94283. get billboardMode(): number;
  94284. set billboardMode(value: number);
  94285. private _preserveParentRotationForBillboard;
  94286. /**
  94287. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  94288. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  94289. */
  94290. get preserveParentRotationForBillboard(): boolean;
  94291. set preserveParentRotationForBillboard(value: boolean);
  94292. /**
  94293. * 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
  94294. */
  94295. scalingDeterminant: number;
  94296. private _infiniteDistance;
  94297. /**
  94298. * Gets or sets the distance of the object to max, often used by skybox
  94299. */
  94300. get infiniteDistance(): boolean;
  94301. set infiniteDistance(value: boolean);
  94302. /**
  94303. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  94304. * By default the system will update normals to compensate
  94305. */
  94306. ignoreNonUniformScaling: boolean;
  94307. /**
  94308. * 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
  94309. */
  94310. reIntegrateRotationIntoRotationQuaternion: boolean;
  94311. /** @hidden */
  94312. _poseMatrix: Nullable<Matrix>;
  94313. /** @hidden */
  94314. _localMatrix: Matrix;
  94315. private _usePivotMatrix;
  94316. private _absolutePosition;
  94317. private _absoluteScaling;
  94318. private _absoluteRotationQuaternion;
  94319. private _pivotMatrix;
  94320. private _pivotMatrixInverse;
  94321. protected _postMultiplyPivotMatrix: boolean;
  94322. protected _isWorldMatrixFrozen: boolean;
  94323. /** @hidden */
  94324. _indexInSceneTransformNodesArray: number;
  94325. /**
  94326. * An event triggered after the world matrix is updated
  94327. */
  94328. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  94329. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  94330. /**
  94331. * Gets a string identifying the name of the class
  94332. * @returns "TransformNode" string
  94333. */
  94334. getClassName(): string;
  94335. /**
  94336. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  94337. */
  94338. get position(): Vector3;
  94339. set position(newPosition: Vector3);
  94340. /**
  94341. * 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)).
  94342. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  94343. */
  94344. get rotation(): Vector3;
  94345. set rotation(newRotation: Vector3);
  94346. /**
  94347. * 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)).
  94348. */
  94349. get scaling(): Vector3;
  94350. set scaling(newScaling: Vector3);
  94351. /**
  94352. * 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).
  94353. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  94354. */
  94355. get rotationQuaternion(): Nullable<Quaternion>;
  94356. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  94357. /**
  94358. * The forward direction of that transform in world space.
  94359. */
  94360. get forward(): Vector3;
  94361. /**
  94362. * The up direction of that transform in world space.
  94363. */
  94364. get up(): Vector3;
  94365. /**
  94366. * The right direction of that transform in world space.
  94367. */
  94368. get right(): Vector3;
  94369. /**
  94370. * Copies the parameter passed Matrix into the mesh Pose matrix.
  94371. * @param matrix the matrix to copy the pose from
  94372. * @returns this TransformNode.
  94373. */
  94374. updatePoseMatrix(matrix: Matrix): TransformNode;
  94375. /**
  94376. * Returns the mesh Pose matrix.
  94377. * @returns the pose matrix
  94378. */
  94379. getPoseMatrix(): Matrix;
  94380. /** @hidden */
  94381. _isSynchronized(): boolean;
  94382. /** @hidden */
  94383. _initCache(): void;
  94384. /**
  94385. * Flag the transform node as dirty (Forcing it to update everything)
  94386. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  94387. * @returns this transform node
  94388. */
  94389. markAsDirty(property: string): TransformNode;
  94390. /**
  94391. * Returns the current mesh absolute position.
  94392. * Returns a Vector3.
  94393. */
  94394. get absolutePosition(): Vector3;
  94395. /**
  94396. * Returns the current mesh absolute scaling.
  94397. * Returns a Vector3.
  94398. */
  94399. get absoluteScaling(): Vector3;
  94400. /**
  94401. * Returns the current mesh absolute rotation.
  94402. * Returns a Quaternion.
  94403. */
  94404. get absoluteRotationQuaternion(): Quaternion;
  94405. /**
  94406. * Sets a new matrix to apply before all other transformation
  94407. * @param matrix defines the transform matrix
  94408. * @returns the current TransformNode
  94409. */
  94410. setPreTransformMatrix(matrix: Matrix): TransformNode;
  94411. /**
  94412. * Sets a new pivot matrix to the current node
  94413. * @param matrix defines the new pivot matrix to use
  94414. * @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
  94415. * @returns the current TransformNode
  94416. */
  94417. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  94418. /**
  94419. * Returns the mesh pivot matrix.
  94420. * Default : Identity.
  94421. * @returns the matrix
  94422. */
  94423. getPivotMatrix(): Matrix;
  94424. /**
  94425. * Instantiate (when possible) or clone that node with its hierarchy
  94426. * @param newParent defines the new parent to use for the instance (or clone)
  94427. * @param options defines options to configure how copy is done
  94428. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  94429. * @returns an instance (or a clone) of the current node with its hiearchy
  94430. */
  94431. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  94432. doNotInstantiate: boolean;
  94433. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  94434. /**
  94435. * Prevents the World matrix to be computed any longer
  94436. * @param newWorldMatrix defines an optional matrix to use as world matrix
  94437. * @returns the TransformNode.
  94438. */
  94439. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  94440. /**
  94441. * Allows back the World matrix computation.
  94442. * @returns the TransformNode.
  94443. */
  94444. unfreezeWorldMatrix(): this;
  94445. /**
  94446. * True if the World matrix has been frozen.
  94447. */
  94448. get isWorldMatrixFrozen(): boolean;
  94449. /**
  94450. * Retuns the mesh absolute position in the World.
  94451. * @returns a Vector3.
  94452. */
  94453. getAbsolutePosition(): Vector3;
  94454. /**
  94455. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  94456. * @param absolutePosition the absolute position to set
  94457. * @returns the TransformNode.
  94458. */
  94459. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  94460. /**
  94461. * Sets the mesh position in its local space.
  94462. * @param vector3 the position to set in localspace
  94463. * @returns the TransformNode.
  94464. */
  94465. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  94466. /**
  94467. * Returns the mesh position in the local space from the current World matrix values.
  94468. * @returns a new Vector3.
  94469. */
  94470. getPositionExpressedInLocalSpace(): Vector3;
  94471. /**
  94472. * Translates the mesh along the passed Vector3 in its local space.
  94473. * @param vector3 the distance to translate in localspace
  94474. * @returns the TransformNode.
  94475. */
  94476. locallyTranslate(vector3: Vector3): TransformNode;
  94477. private static _lookAtVectorCache;
  94478. /**
  94479. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  94480. * @param targetPoint the position (must be in same space as current mesh) to look at
  94481. * @param yawCor optional yaw (y-axis) correction in radians
  94482. * @param pitchCor optional pitch (x-axis) correction in radians
  94483. * @param rollCor optional roll (z-axis) correction in radians
  94484. * @param space the choosen space of the target
  94485. * @returns the TransformNode.
  94486. */
  94487. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  94488. /**
  94489. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  94490. * This Vector3 is expressed in the World space.
  94491. * @param localAxis axis to rotate
  94492. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  94493. */
  94494. getDirection(localAxis: Vector3): Vector3;
  94495. /**
  94496. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  94497. * localAxis is expressed in the mesh local space.
  94498. * result is computed in the Wordl space from the mesh World matrix.
  94499. * @param localAxis axis to rotate
  94500. * @param result the resulting transformnode
  94501. * @returns this TransformNode.
  94502. */
  94503. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  94504. /**
  94505. * Sets this transform node rotation to the given local axis.
  94506. * @param localAxis the axis in local space
  94507. * @param yawCor optional yaw (y-axis) correction in radians
  94508. * @param pitchCor optional pitch (x-axis) correction in radians
  94509. * @param rollCor optional roll (z-axis) correction in radians
  94510. * @returns this TransformNode
  94511. */
  94512. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  94513. /**
  94514. * Sets a new pivot point to the current node
  94515. * @param point defines the new pivot point to use
  94516. * @param space defines if the point is in world or local space (local by default)
  94517. * @returns the current TransformNode
  94518. */
  94519. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  94520. /**
  94521. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  94522. * @returns the pivot point
  94523. */
  94524. getPivotPoint(): Vector3;
  94525. /**
  94526. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  94527. * @param result the vector3 to store the result
  94528. * @returns this TransformNode.
  94529. */
  94530. getPivotPointToRef(result: Vector3): TransformNode;
  94531. /**
  94532. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  94533. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  94534. */
  94535. getAbsolutePivotPoint(): Vector3;
  94536. /**
  94537. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  94538. * @param result vector3 to store the result
  94539. * @returns this TransformNode.
  94540. */
  94541. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  94542. /**
  94543. * Defines the passed node as the parent of the current node.
  94544. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  94545. * @see https://doc.babylonjs.com/how_to/parenting
  94546. * @param node the node ot set as the parent
  94547. * @returns this TransformNode.
  94548. */
  94549. setParent(node: Nullable<Node>): TransformNode;
  94550. private _nonUniformScaling;
  94551. /**
  94552. * True if the scaling property of this object is non uniform eg. (1,2,1)
  94553. */
  94554. get nonUniformScaling(): boolean;
  94555. /** @hidden */
  94556. _updateNonUniformScalingState(value: boolean): boolean;
  94557. /**
  94558. * Attach the current TransformNode to another TransformNode associated with a bone
  94559. * @param bone Bone affecting the TransformNode
  94560. * @param affectedTransformNode TransformNode associated with the bone
  94561. * @returns this object
  94562. */
  94563. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  94564. /**
  94565. * Detach the transform node if its associated with a bone
  94566. * @returns this object
  94567. */
  94568. detachFromBone(): TransformNode;
  94569. private static _rotationAxisCache;
  94570. /**
  94571. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  94572. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  94573. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  94574. * The passed axis is also normalized.
  94575. * @param axis the axis to rotate around
  94576. * @param amount the amount to rotate in radians
  94577. * @param space Space to rotate in (Default: local)
  94578. * @returns the TransformNode.
  94579. */
  94580. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  94581. /**
  94582. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  94583. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  94584. * The passed axis is also normalized. .
  94585. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  94586. * @param point the point to rotate around
  94587. * @param axis the axis to rotate around
  94588. * @param amount the amount to rotate in radians
  94589. * @returns the TransformNode
  94590. */
  94591. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  94592. /**
  94593. * Translates the mesh along the axis vector for the passed distance in the given space.
  94594. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  94595. * @param axis the axis to translate in
  94596. * @param distance the distance to translate
  94597. * @param space Space to rotate in (Default: local)
  94598. * @returns the TransformNode.
  94599. */
  94600. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  94601. /**
  94602. * Adds a rotation step to the mesh current rotation.
  94603. * x, y, z are Euler angles expressed in radians.
  94604. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  94605. * This means this rotation is made in the mesh local space only.
  94606. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  94607. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  94608. * ```javascript
  94609. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  94610. * ```
  94611. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  94612. * 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.
  94613. * @param x Rotation to add
  94614. * @param y Rotation to add
  94615. * @param z Rotation to add
  94616. * @returns the TransformNode.
  94617. */
  94618. addRotation(x: number, y: number, z: number): TransformNode;
  94619. /**
  94620. * @hidden
  94621. */
  94622. protected _getEffectiveParent(): Nullable<Node>;
  94623. /**
  94624. * Computes the world matrix of the node
  94625. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  94626. * @returns the world matrix
  94627. */
  94628. computeWorldMatrix(force?: boolean): Matrix;
  94629. /**
  94630. * Resets this nodeTransform's local matrix to Matrix.Identity().
  94631. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  94632. */
  94633. resetLocalMatrix(independentOfChildren?: boolean): void;
  94634. protected _afterComputeWorldMatrix(): void;
  94635. /**
  94636. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  94637. * @param func callback function to add
  94638. *
  94639. * @returns the TransformNode.
  94640. */
  94641. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  94642. /**
  94643. * Removes a registered callback function.
  94644. * @param func callback function to remove
  94645. * @returns the TransformNode.
  94646. */
  94647. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  94648. /**
  94649. * Gets the position of the current mesh in camera space
  94650. * @param camera defines the camera to use
  94651. * @returns a position
  94652. */
  94653. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  94654. /**
  94655. * Returns the distance from the mesh to the active camera
  94656. * @param camera defines the camera to use
  94657. * @returns the distance
  94658. */
  94659. getDistanceToCamera(camera?: Nullable<Camera>): number;
  94660. /**
  94661. * Clone the current transform node
  94662. * @param name Name of the new clone
  94663. * @param newParent New parent for the clone
  94664. * @param doNotCloneChildren Do not clone children hierarchy
  94665. * @returns the new transform node
  94666. */
  94667. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  94668. /**
  94669. * Serializes the objects information.
  94670. * @param currentSerializationObject defines the object to serialize in
  94671. * @returns the serialized object
  94672. */
  94673. serialize(currentSerializationObject?: any): any;
  94674. /**
  94675. * Returns a new TransformNode object parsed from the source provided.
  94676. * @param parsedTransformNode is the source.
  94677. * @param scene the scne the object belongs to
  94678. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  94679. * @returns a new TransformNode object parsed from the source provided.
  94680. */
  94681. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  94682. /**
  94683. * Get all child-transformNodes of this node
  94684. * @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
  94685. * @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
  94686. * @returns an array of TransformNode
  94687. */
  94688. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  94689. /**
  94690. * Releases resources associated with this transform node.
  94691. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  94692. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  94693. */
  94694. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  94695. /**
  94696. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  94697. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  94698. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  94699. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  94700. * @returns the current mesh
  94701. */
  94702. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  94703. private _syncAbsoluteScalingAndRotation;
  94704. }
  94705. }
  94706. declare module BABYLON {
  94707. /**
  94708. * Class used to override all child animations of a given target
  94709. */
  94710. export class AnimationPropertiesOverride {
  94711. /**
  94712. * Gets or sets a value indicating if animation blending must be used
  94713. */
  94714. enableBlending: boolean;
  94715. /**
  94716. * Gets or sets the blending speed to use when enableBlending is true
  94717. */
  94718. blendingSpeed: number;
  94719. /**
  94720. * Gets or sets the default loop mode to use
  94721. */
  94722. loopMode: number;
  94723. }
  94724. }
  94725. declare module BABYLON {
  94726. /**
  94727. * Class used to store bone information
  94728. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  94729. */
  94730. export class Bone extends Node {
  94731. /**
  94732. * defines the bone name
  94733. */
  94734. name: string;
  94735. private static _tmpVecs;
  94736. private static _tmpQuat;
  94737. private static _tmpMats;
  94738. /**
  94739. * Gets the list of child bones
  94740. */
  94741. children: Bone[];
  94742. /** Gets the animations associated with this bone */
  94743. animations: Animation[];
  94744. /**
  94745. * Gets or sets bone length
  94746. */
  94747. length: number;
  94748. /**
  94749. * @hidden Internal only
  94750. * Set this value to map this bone to a different index in the transform matrices
  94751. * Set this value to -1 to exclude the bone from the transform matrices
  94752. */
  94753. _index: Nullable<number>;
  94754. private _skeleton;
  94755. private _localMatrix;
  94756. private _restPose;
  94757. private _bindPose;
  94758. private _baseMatrix;
  94759. private _absoluteTransform;
  94760. private _invertedAbsoluteTransform;
  94761. private _parent;
  94762. private _scalingDeterminant;
  94763. private _worldTransform;
  94764. private _localScaling;
  94765. private _localRotation;
  94766. private _localPosition;
  94767. private _needToDecompose;
  94768. private _needToCompose;
  94769. /** @hidden */
  94770. _linkedTransformNode: Nullable<TransformNode>;
  94771. /** @hidden */
  94772. _waitingTransformNodeId: Nullable<string>;
  94773. /** @hidden */
  94774. get _matrix(): Matrix;
  94775. /** @hidden */
  94776. set _matrix(value: Matrix);
  94777. /**
  94778. * Create a new bone
  94779. * @param name defines the bone name
  94780. * @param skeleton defines the parent skeleton
  94781. * @param parentBone defines the parent (can be null if the bone is the root)
  94782. * @param localMatrix defines the local matrix
  94783. * @param restPose defines the rest pose matrix
  94784. * @param baseMatrix defines the base matrix
  94785. * @param index defines index of the bone in the hiearchy
  94786. */
  94787. constructor(
  94788. /**
  94789. * defines the bone name
  94790. */
  94791. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  94792. /**
  94793. * Gets the current object class name.
  94794. * @return the class name
  94795. */
  94796. getClassName(): string;
  94797. /**
  94798. * Gets the parent skeleton
  94799. * @returns a skeleton
  94800. */
  94801. getSkeleton(): Skeleton;
  94802. /**
  94803. * Gets parent bone
  94804. * @returns a bone or null if the bone is the root of the bone hierarchy
  94805. */
  94806. getParent(): Nullable<Bone>;
  94807. /**
  94808. * Returns an array containing the root bones
  94809. * @returns an array containing the root bones
  94810. */
  94811. getChildren(): Array<Bone>;
  94812. /**
  94813. * Gets the node index in matrix array generated for rendering
  94814. * @returns the node index
  94815. */
  94816. getIndex(): number;
  94817. /**
  94818. * Sets the parent bone
  94819. * @param parent defines the parent (can be null if the bone is the root)
  94820. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  94821. */
  94822. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  94823. /**
  94824. * Gets the local matrix
  94825. * @returns a matrix
  94826. */
  94827. getLocalMatrix(): Matrix;
  94828. /**
  94829. * Gets the base matrix (initial matrix which remains unchanged)
  94830. * @returns a matrix
  94831. */
  94832. getBaseMatrix(): Matrix;
  94833. /**
  94834. * Gets the rest pose matrix
  94835. * @returns a matrix
  94836. */
  94837. getRestPose(): Matrix;
  94838. /**
  94839. * Sets the rest pose matrix
  94840. * @param matrix the local-space rest pose to set for this bone
  94841. */
  94842. setRestPose(matrix: Matrix): void;
  94843. /**
  94844. * Gets the bind pose matrix
  94845. * @returns the bind pose matrix
  94846. */
  94847. getBindPose(): Matrix;
  94848. /**
  94849. * Sets the bind pose matrix
  94850. * @param matrix the local-space bind pose to set for this bone
  94851. */
  94852. setBindPose(matrix: Matrix): void;
  94853. /**
  94854. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  94855. */
  94856. getWorldMatrix(): Matrix;
  94857. /**
  94858. * Sets the local matrix to rest pose matrix
  94859. */
  94860. returnToRest(): void;
  94861. /**
  94862. * Gets the inverse of the absolute transform matrix.
  94863. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  94864. * @returns a matrix
  94865. */
  94866. getInvertedAbsoluteTransform(): Matrix;
  94867. /**
  94868. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  94869. * @returns a matrix
  94870. */
  94871. getAbsoluteTransform(): Matrix;
  94872. /**
  94873. * Links with the given transform node.
  94874. * The local matrix of this bone is copied from the transform node every frame.
  94875. * @param transformNode defines the transform node to link to
  94876. */
  94877. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  94878. /**
  94879. * Gets the node used to drive the bone's transformation
  94880. * @returns a transform node or null
  94881. */
  94882. getTransformNode(): Nullable<TransformNode>;
  94883. /** Gets or sets current position (in local space) */
  94884. get position(): Vector3;
  94885. set position(newPosition: Vector3);
  94886. /** Gets or sets current rotation (in local space) */
  94887. get rotation(): Vector3;
  94888. set rotation(newRotation: Vector3);
  94889. /** Gets or sets current rotation quaternion (in local space) */
  94890. get rotationQuaternion(): Quaternion;
  94891. set rotationQuaternion(newRotation: Quaternion);
  94892. /** Gets or sets current scaling (in local space) */
  94893. get scaling(): Vector3;
  94894. set scaling(newScaling: Vector3);
  94895. /**
  94896. * Gets the animation properties override
  94897. */
  94898. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  94899. private _decompose;
  94900. private _compose;
  94901. /**
  94902. * Update the base and local matrices
  94903. * @param matrix defines the new base or local matrix
  94904. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  94905. * @param updateLocalMatrix defines if the local matrix should be updated
  94906. */
  94907. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  94908. /** @hidden */
  94909. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  94910. /**
  94911. * Flag the bone as dirty (Forcing it to update everything)
  94912. */
  94913. markAsDirty(): void;
  94914. /** @hidden */
  94915. _markAsDirtyAndCompose(): void;
  94916. private _markAsDirtyAndDecompose;
  94917. /**
  94918. * Translate the bone in local or world space
  94919. * @param vec The amount to translate the bone
  94920. * @param space The space that the translation is in
  94921. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94922. */
  94923. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  94924. /**
  94925. * Set the postion of the bone in local or world space
  94926. * @param position The position to set the bone
  94927. * @param space The space that the position is in
  94928. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94929. */
  94930. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  94931. /**
  94932. * Set the absolute position of the bone (world space)
  94933. * @param position The position to set the bone
  94934. * @param mesh The mesh that this bone is attached to
  94935. */
  94936. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  94937. /**
  94938. * Scale the bone on the x, y and z axes (in local space)
  94939. * @param x The amount to scale the bone on the x axis
  94940. * @param y The amount to scale the bone on the y axis
  94941. * @param z The amount to scale the bone on the z axis
  94942. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  94943. */
  94944. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  94945. /**
  94946. * Set the bone scaling in local space
  94947. * @param scale defines the scaling vector
  94948. */
  94949. setScale(scale: Vector3): void;
  94950. /**
  94951. * Gets the current scaling in local space
  94952. * @returns the current scaling vector
  94953. */
  94954. getScale(): Vector3;
  94955. /**
  94956. * Gets the current scaling in local space and stores it in a target vector
  94957. * @param result defines the target vector
  94958. */
  94959. getScaleToRef(result: Vector3): void;
  94960. /**
  94961. * Set the yaw, pitch, and roll of the bone in local or world space
  94962. * @param yaw The rotation of the bone on the y axis
  94963. * @param pitch The rotation of the bone on the x axis
  94964. * @param roll The rotation of the bone on the z axis
  94965. * @param space The space that the axes of rotation are in
  94966. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94967. */
  94968. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  94969. /**
  94970. * Add a rotation to the bone on an axis in local or world space
  94971. * @param axis The axis to rotate the bone on
  94972. * @param amount The amount to rotate the bone
  94973. * @param space The space that the axis is in
  94974. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94975. */
  94976. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  94977. /**
  94978. * Set the rotation of the bone to a particular axis angle in local or world space
  94979. * @param axis The axis to rotate the bone on
  94980. * @param angle The angle that the bone should be rotated to
  94981. * @param space The space that the axis is in
  94982. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94983. */
  94984. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  94985. /**
  94986. * Set the euler rotation of the bone in local of world space
  94987. * @param rotation The euler rotation that the bone should be set to
  94988. * @param space The space that the rotation is in
  94989. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94990. */
  94991. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  94992. /**
  94993. * Set the quaternion rotation of the bone in local of world space
  94994. * @param quat The quaternion rotation that the bone should be set to
  94995. * @param space The space that the rotation is in
  94996. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94997. */
  94998. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  94999. /**
  95000. * Set the rotation matrix of the bone in local of world space
  95001. * @param rotMat The rotation matrix that the bone should be set to
  95002. * @param space The space that the rotation is in
  95003. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95004. */
  95005. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  95006. private _rotateWithMatrix;
  95007. private _getNegativeRotationToRef;
  95008. /**
  95009. * Get the position of the bone in local or world space
  95010. * @param space The space that the returned position is in
  95011. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95012. * @returns The position of the bone
  95013. */
  95014. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  95015. /**
  95016. * Copy the position of the bone to a vector3 in local or world space
  95017. * @param space The space that the returned position is in
  95018. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95019. * @param result The vector3 to copy the position to
  95020. */
  95021. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  95022. /**
  95023. * Get the absolute position of the bone (world space)
  95024. * @param mesh The mesh that this bone is attached to
  95025. * @returns The absolute position of the bone
  95026. */
  95027. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  95028. /**
  95029. * Copy the absolute position of the bone (world space) to the result param
  95030. * @param mesh The mesh that this bone is attached to
  95031. * @param result The vector3 to copy the absolute position to
  95032. */
  95033. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  95034. /**
  95035. * Compute the absolute transforms of this bone and its children
  95036. */
  95037. computeAbsoluteTransforms(): void;
  95038. /**
  95039. * Get the world direction from an axis that is in the local space of the bone
  95040. * @param localAxis The local direction that is used to compute the world direction
  95041. * @param mesh The mesh that this bone is attached to
  95042. * @returns The world direction
  95043. */
  95044. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95045. /**
  95046. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  95047. * @param localAxis The local direction that is used to compute the world direction
  95048. * @param mesh The mesh that this bone is attached to
  95049. * @param result The vector3 that the world direction will be copied to
  95050. */
  95051. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95052. /**
  95053. * Get the euler rotation of the bone in local or world space
  95054. * @param space The space that the rotation should be in
  95055. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95056. * @returns The euler rotation
  95057. */
  95058. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  95059. /**
  95060. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  95061. * @param space The space that the rotation should be in
  95062. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95063. * @param result The vector3 that the rotation should be copied to
  95064. */
  95065. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95066. /**
  95067. * Get the quaternion rotation of the bone in either local or world space
  95068. * @param space The space that the rotation should be in
  95069. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95070. * @returns The quaternion rotation
  95071. */
  95072. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  95073. /**
  95074. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  95075. * @param space The space that the rotation should be in
  95076. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95077. * @param result The quaternion that the rotation should be copied to
  95078. */
  95079. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  95080. /**
  95081. * Get the rotation matrix of the bone in local or world space
  95082. * @param space The space that the rotation should be in
  95083. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95084. * @returns The rotation matrix
  95085. */
  95086. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  95087. /**
  95088. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  95089. * @param space The space that the rotation should be in
  95090. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95091. * @param result The quaternion that the rotation should be copied to
  95092. */
  95093. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  95094. /**
  95095. * Get the world position of a point that is in the local space of the bone
  95096. * @param position The local position
  95097. * @param mesh The mesh that this bone is attached to
  95098. * @returns The world position
  95099. */
  95100. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95101. /**
  95102. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  95103. * @param position The local position
  95104. * @param mesh The mesh that this bone is attached to
  95105. * @param result The vector3 that the world position should be copied to
  95106. */
  95107. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95108. /**
  95109. * Get the local position of a point that is in world space
  95110. * @param position The world position
  95111. * @param mesh The mesh that this bone is attached to
  95112. * @returns The local position
  95113. */
  95114. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95115. /**
  95116. * Get the local position of a point that is in world space and copy it to the result param
  95117. * @param position The world position
  95118. * @param mesh The mesh that this bone is attached to
  95119. * @param result The vector3 that the local position should be copied to
  95120. */
  95121. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95122. }
  95123. }
  95124. declare module BABYLON {
  95125. /**
  95126. * Defines a runtime animation
  95127. */
  95128. export class RuntimeAnimation {
  95129. private _events;
  95130. /**
  95131. * The current frame of the runtime animation
  95132. */
  95133. private _currentFrame;
  95134. /**
  95135. * The animation used by the runtime animation
  95136. */
  95137. private _animation;
  95138. /**
  95139. * The target of the runtime animation
  95140. */
  95141. private _target;
  95142. /**
  95143. * The initiating animatable
  95144. */
  95145. private _host;
  95146. /**
  95147. * The original value of the runtime animation
  95148. */
  95149. private _originalValue;
  95150. /**
  95151. * The original blend value of the runtime animation
  95152. */
  95153. private _originalBlendValue;
  95154. /**
  95155. * The offsets cache of the runtime animation
  95156. */
  95157. private _offsetsCache;
  95158. /**
  95159. * The high limits cache of the runtime animation
  95160. */
  95161. private _highLimitsCache;
  95162. /**
  95163. * Specifies if the runtime animation has been stopped
  95164. */
  95165. private _stopped;
  95166. /**
  95167. * The blending factor of the runtime animation
  95168. */
  95169. private _blendingFactor;
  95170. /**
  95171. * The BabylonJS scene
  95172. */
  95173. private _scene;
  95174. /**
  95175. * The current value of the runtime animation
  95176. */
  95177. private _currentValue;
  95178. /** @hidden */
  95179. _animationState: _IAnimationState;
  95180. /**
  95181. * The active target of the runtime animation
  95182. */
  95183. private _activeTargets;
  95184. private _currentActiveTarget;
  95185. private _directTarget;
  95186. /**
  95187. * The target path of the runtime animation
  95188. */
  95189. private _targetPath;
  95190. /**
  95191. * The weight of the runtime animation
  95192. */
  95193. private _weight;
  95194. /**
  95195. * The ratio offset of the runtime animation
  95196. */
  95197. private _ratioOffset;
  95198. /**
  95199. * The previous delay of the runtime animation
  95200. */
  95201. private _previousDelay;
  95202. /**
  95203. * The previous ratio of the runtime animation
  95204. */
  95205. private _previousRatio;
  95206. private _enableBlending;
  95207. private _keys;
  95208. private _minFrame;
  95209. private _maxFrame;
  95210. private _minValue;
  95211. private _maxValue;
  95212. private _targetIsArray;
  95213. /**
  95214. * Gets the current frame of the runtime animation
  95215. */
  95216. get currentFrame(): number;
  95217. /**
  95218. * Gets the weight of the runtime animation
  95219. */
  95220. get weight(): number;
  95221. /**
  95222. * Gets the current value of the runtime animation
  95223. */
  95224. get currentValue(): any;
  95225. /**
  95226. * Gets the target path of the runtime animation
  95227. */
  95228. get targetPath(): string;
  95229. /**
  95230. * Gets the actual target of the runtime animation
  95231. */
  95232. get target(): any;
  95233. /**
  95234. * Gets the additive state of the runtime animation
  95235. */
  95236. get isAdditive(): boolean;
  95237. /** @hidden */
  95238. _onLoop: () => void;
  95239. /**
  95240. * Create a new RuntimeAnimation object
  95241. * @param target defines the target of the animation
  95242. * @param animation defines the source animation object
  95243. * @param scene defines the hosting scene
  95244. * @param host defines the initiating Animatable
  95245. */
  95246. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  95247. private _preparePath;
  95248. /**
  95249. * Gets the animation from the runtime animation
  95250. */
  95251. get animation(): Animation;
  95252. /**
  95253. * Resets the runtime animation to the beginning
  95254. * @param restoreOriginal defines whether to restore the target property to the original value
  95255. */
  95256. reset(restoreOriginal?: boolean): void;
  95257. /**
  95258. * Specifies if the runtime animation is stopped
  95259. * @returns Boolean specifying if the runtime animation is stopped
  95260. */
  95261. isStopped(): boolean;
  95262. /**
  95263. * Disposes of the runtime animation
  95264. */
  95265. dispose(): void;
  95266. /**
  95267. * Apply the interpolated value to the target
  95268. * @param currentValue defines the value computed by the animation
  95269. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  95270. */
  95271. setValue(currentValue: any, weight: number): void;
  95272. private _getOriginalValues;
  95273. private _setValue;
  95274. /**
  95275. * Gets the loop pmode of the runtime animation
  95276. * @returns Loop Mode
  95277. */
  95278. private _getCorrectLoopMode;
  95279. /**
  95280. * Move the current animation to a given frame
  95281. * @param frame defines the frame to move to
  95282. */
  95283. goToFrame(frame: number): void;
  95284. /**
  95285. * @hidden Internal use only
  95286. */
  95287. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  95288. /**
  95289. * Execute the current animation
  95290. * @param delay defines the delay to add to the current frame
  95291. * @param from defines the lower bound of the animation range
  95292. * @param to defines the upper bound of the animation range
  95293. * @param loop defines if the current animation must loop
  95294. * @param speedRatio defines the current speed ratio
  95295. * @param weight defines the weight of the animation (default is -1 so no weight)
  95296. * @param onLoop optional callback called when animation loops
  95297. * @returns a boolean indicating if the animation is running
  95298. */
  95299. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  95300. }
  95301. }
  95302. declare module BABYLON {
  95303. /**
  95304. * Class used to store an actual running animation
  95305. */
  95306. export class Animatable {
  95307. /** defines the target object */
  95308. target: any;
  95309. /** defines the starting frame number (default is 0) */
  95310. fromFrame: number;
  95311. /** defines the ending frame number (default is 100) */
  95312. toFrame: number;
  95313. /** defines if the animation must loop (default is false) */
  95314. loopAnimation: boolean;
  95315. /** defines a callback to call when animation ends if it is not looping */
  95316. onAnimationEnd?: (() => void) | null | undefined;
  95317. /** defines a callback to call when animation loops */
  95318. onAnimationLoop?: (() => void) | null | undefined;
  95319. /** defines whether the animation should be evaluated additively */
  95320. isAdditive: boolean;
  95321. private _localDelayOffset;
  95322. private _pausedDelay;
  95323. private _runtimeAnimations;
  95324. private _paused;
  95325. private _scene;
  95326. private _speedRatio;
  95327. private _weight;
  95328. private _syncRoot;
  95329. /**
  95330. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  95331. * This will only apply for non looping animation (default is true)
  95332. */
  95333. disposeOnEnd: boolean;
  95334. /**
  95335. * Gets a boolean indicating if the animation has started
  95336. */
  95337. animationStarted: boolean;
  95338. /**
  95339. * Observer raised when the animation ends
  95340. */
  95341. onAnimationEndObservable: Observable<Animatable>;
  95342. /**
  95343. * Observer raised when the animation loops
  95344. */
  95345. onAnimationLoopObservable: Observable<Animatable>;
  95346. /**
  95347. * Gets the root Animatable used to synchronize and normalize animations
  95348. */
  95349. get syncRoot(): Nullable<Animatable>;
  95350. /**
  95351. * Gets the current frame of the first RuntimeAnimation
  95352. * Used to synchronize Animatables
  95353. */
  95354. get masterFrame(): number;
  95355. /**
  95356. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  95357. */
  95358. get weight(): number;
  95359. set weight(value: number);
  95360. /**
  95361. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  95362. */
  95363. get speedRatio(): number;
  95364. set speedRatio(value: number);
  95365. /**
  95366. * Creates a new Animatable
  95367. * @param scene defines the hosting scene
  95368. * @param target defines the target object
  95369. * @param fromFrame defines the starting frame number (default is 0)
  95370. * @param toFrame defines the ending frame number (default is 100)
  95371. * @param loopAnimation defines if the animation must loop (default is false)
  95372. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  95373. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  95374. * @param animations defines a group of animation to add to the new Animatable
  95375. * @param onAnimationLoop defines a callback to call when animation loops
  95376. * @param isAdditive defines whether the animation should be evaluated additively
  95377. */
  95378. constructor(scene: Scene,
  95379. /** defines the target object */
  95380. target: any,
  95381. /** defines the starting frame number (default is 0) */
  95382. fromFrame?: number,
  95383. /** defines the ending frame number (default is 100) */
  95384. toFrame?: number,
  95385. /** defines if the animation must loop (default is false) */
  95386. loopAnimation?: boolean, speedRatio?: number,
  95387. /** defines a callback to call when animation ends if it is not looping */
  95388. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  95389. /** defines a callback to call when animation loops */
  95390. onAnimationLoop?: (() => void) | null | undefined,
  95391. /** defines whether the animation should be evaluated additively */
  95392. isAdditive?: boolean);
  95393. /**
  95394. * Synchronize and normalize current Animatable with a source Animatable
  95395. * This is useful when using animation weights and when animations are not of the same length
  95396. * @param root defines the root Animatable to synchronize with
  95397. * @returns the current Animatable
  95398. */
  95399. syncWith(root: Animatable): Animatable;
  95400. /**
  95401. * Gets the list of runtime animations
  95402. * @returns an array of RuntimeAnimation
  95403. */
  95404. getAnimations(): RuntimeAnimation[];
  95405. /**
  95406. * Adds more animations to the current animatable
  95407. * @param target defines the target of the animations
  95408. * @param animations defines the new animations to add
  95409. */
  95410. appendAnimations(target: any, animations: Animation[]): void;
  95411. /**
  95412. * Gets the source animation for a specific property
  95413. * @param property defines the propertyu to look for
  95414. * @returns null or the source animation for the given property
  95415. */
  95416. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  95417. /**
  95418. * Gets the runtime animation for a specific property
  95419. * @param property defines the propertyu to look for
  95420. * @returns null or the runtime animation for the given property
  95421. */
  95422. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  95423. /**
  95424. * Resets the animatable to its original state
  95425. */
  95426. reset(): void;
  95427. /**
  95428. * Allows the animatable to blend with current running animations
  95429. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95430. * @param blendingSpeed defines the blending speed to use
  95431. */
  95432. enableBlending(blendingSpeed: number): void;
  95433. /**
  95434. * Disable animation blending
  95435. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95436. */
  95437. disableBlending(): void;
  95438. /**
  95439. * Jump directly to a given frame
  95440. * @param frame defines the frame to jump to
  95441. */
  95442. goToFrame(frame: number): void;
  95443. /**
  95444. * Pause the animation
  95445. */
  95446. pause(): void;
  95447. /**
  95448. * Restart the animation
  95449. */
  95450. restart(): void;
  95451. private _raiseOnAnimationEnd;
  95452. /**
  95453. * Stop and delete the current animation
  95454. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  95455. * @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)
  95456. */
  95457. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  95458. /**
  95459. * Wait asynchronously for the animation to end
  95460. * @returns a promise which will be fullfilled when the animation ends
  95461. */
  95462. waitAsync(): Promise<Animatable>;
  95463. /** @hidden */
  95464. _animate(delay: number): boolean;
  95465. }
  95466. interface Scene {
  95467. /** @hidden */
  95468. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  95469. /** @hidden */
  95470. _processLateAnimationBindingsForMatrices(holder: {
  95471. totalWeight: number;
  95472. totalAdditiveWeight: number;
  95473. animations: RuntimeAnimation[];
  95474. additiveAnimations: RuntimeAnimation[];
  95475. originalValue: Matrix;
  95476. }): any;
  95477. /** @hidden */
  95478. _processLateAnimationBindingsForQuaternions(holder: {
  95479. totalWeight: number;
  95480. totalAdditiveWeight: number;
  95481. animations: RuntimeAnimation[];
  95482. additiveAnimations: RuntimeAnimation[];
  95483. originalValue: Quaternion;
  95484. }, refQuaternion: Quaternion): Quaternion;
  95485. /** @hidden */
  95486. _processLateAnimationBindings(): void;
  95487. /**
  95488. * Will start the animation sequence of a given target
  95489. * @param target defines the target
  95490. * @param from defines from which frame should animation start
  95491. * @param to defines until which frame should animation run.
  95492. * @param weight defines the weight to apply to the animation (1.0 by default)
  95493. * @param loop defines if the animation loops
  95494. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95495. * @param onAnimationEnd defines the function to be executed when the animation ends
  95496. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95497. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  95498. * @param onAnimationLoop defines the callback to call when an animation loops
  95499. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95500. * @returns the animatable object created for this animation
  95501. */
  95502. 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;
  95503. /**
  95504. * Will start the animation sequence of a given target
  95505. * @param target defines the target
  95506. * @param from defines from which frame should animation start
  95507. * @param to defines until which frame should animation run.
  95508. * @param loop defines if the animation loops
  95509. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95510. * @param onAnimationEnd defines the function to be executed when the animation ends
  95511. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95512. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  95513. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  95514. * @param onAnimationLoop defines the callback to call when an animation loops
  95515. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95516. * @returns the animatable object created for this animation
  95517. */
  95518. 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;
  95519. /**
  95520. * Will start the animation sequence of a given target and its hierarchy
  95521. * @param target defines the target
  95522. * @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.
  95523. * @param from defines from which frame should animation start
  95524. * @param to defines until which frame should animation run.
  95525. * @param loop defines if the animation loops
  95526. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95527. * @param onAnimationEnd defines the function to be executed when the animation ends
  95528. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95529. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  95530. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  95531. * @param onAnimationLoop defines the callback to call when an animation loops
  95532. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95533. * @returns the list of created animatables
  95534. */
  95535. 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[];
  95536. /**
  95537. * Begin a new animation on a given node
  95538. * @param target defines the target where the animation will take place
  95539. * @param animations defines the list of animations to start
  95540. * @param from defines the initial value
  95541. * @param to defines the final value
  95542. * @param loop defines if you want animation to loop (off by default)
  95543. * @param speedRatio defines the speed ratio to apply to all animations
  95544. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  95545. * @param onAnimationLoop defines the callback to call when an animation loops
  95546. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95547. * @returns the list of created animatables
  95548. */
  95549. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  95550. /**
  95551. * Begin a new animation on a given node and its hierarchy
  95552. * @param target defines the root node where the animation will take place
  95553. * @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.
  95554. * @param animations defines the list of animations to start
  95555. * @param from defines the initial value
  95556. * @param to defines the final value
  95557. * @param loop defines if you want animation to loop (off by default)
  95558. * @param speedRatio defines the speed ratio to apply to all animations
  95559. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  95560. * @param onAnimationLoop defines the callback to call when an animation loops
  95561. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95562. * @returns the list of animatables created for all nodes
  95563. */
  95564. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  95565. /**
  95566. * Gets the animatable associated with a specific target
  95567. * @param target defines the target of the animatable
  95568. * @returns the required animatable if found
  95569. */
  95570. getAnimatableByTarget(target: any): Nullable<Animatable>;
  95571. /**
  95572. * Gets all animatables associated with a given target
  95573. * @param target defines the target to look animatables for
  95574. * @returns an array of Animatables
  95575. */
  95576. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  95577. /**
  95578. * Stops and removes all animations that have been applied to the scene
  95579. */
  95580. stopAllAnimations(): void;
  95581. /**
  95582. * Gets the current delta time used by animation engine
  95583. */
  95584. deltaTime: number;
  95585. }
  95586. interface Bone {
  95587. /**
  95588. * Copy an animation range from another bone
  95589. * @param source defines the source bone
  95590. * @param rangeName defines the range name to copy
  95591. * @param frameOffset defines the frame offset
  95592. * @param rescaleAsRequired defines if rescaling must be applied if required
  95593. * @param skelDimensionsRatio defines the scaling ratio
  95594. * @returns true if operation was successful
  95595. */
  95596. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  95597. }
  95598. }
  95599. declare module BABYLON {
  95600. /**
  95601. * Class used to handle skinning animations
  95602. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  95603. */
  95604. export class Skeleton implements IAnimatable {
  95605. /** defines the skeleton name */
  95606. name: string;
  95607. /** defines the skeleton Id */
  95608. id: string;
  95609. /**
  95610. * Defines the list of child bones
  95611. */
  95612. bones: Bone[];
  95613. /**
  95614. * Defines an estimate of the dimension of the skeleton at rest
  95615. */
  95616. dimensionsAtRest: Vector3;
  95617. /**
  95618. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  95619. */
  95620. needInitialSkinMatrix: boolean;
  95621. /**
  95622. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  95623. */
  95624. overrideMesh: Nullable<AbstractMesh>;
  95625. /**
  95626. * Gets the list of animations attached to this skeleton
  95627. */
  95628. animations: Array<Animation>;
  95629. private _scene;
  95630. private _isDirty;
  95631. private _transformMatrices;
  95632. private _transformMatrixTexture;
  95633. private _meshesWithPoseMatrix;
  95634. private _animatables;
  95635. private _identity;
  95636. private _synchronizedWithMesh;
  95637. private _ranges;
  95638. private _lastAbsoluteTransformsUpdateId;
  95639. private _canUseTextureForBones;
  95640. private _uniqueId;
  95641. /** @hidden */
  95642. _numBonesWithLinkedTransformNode: number;
  95643. /** @hidden */
  95644. _hasWaitingData: Nullable<boolean>;
  95645. /**
  95646. * Specifies if the skeleton should be serialized
  95647. */
  95648. doNotSerialize: boolean;
  95649. private _useTextureToStoreBoneMatrices;
  95650. /**
  95651. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  95652. * Please note that this option is not available if the hardware does not support it
  95653. */
  95654. get useTextureToStoreBoneMatrices(): boolean;
  95655. set useTextureToStoreBoneMatrices(value: boolean);
  95656. private _animationPropertiesOverride;
  95657. /**
  95658. * Gets or sets the animation properties override
  95659. */
  95660. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  95661. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  95662. /**
  95663. * List of inspectable custom properties (used by the Inspector)
  95664. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  95665. */
  95666. inspectableCustomProperties: IInspectable[];
  95667. /**
  95668. * An observable triggered before computing the skeleton's matrices
  95669. */
  95670. onBeforeComputeObservable: Observable<Skeleton>;
  95671. /**
  95672. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  95673. */
  95674. get isUsingTextureForMatrices(): boolean;
  95675. /**
  95676. * Gets the unique ID of this skeleton
  95677. */
  95678. get uniqueId(): number;
  95679. /**
  95680. * Creates a new skeleton
  95681. * @param name defines the skeleton name
  95682. * @param id defines the skeleton Id
  95683. * @param scene defines the hosting scene
  95684. */
  95685. constructor(
  95686. /** defines the skeleton name */
  95687. name: string,
  95688. /** defines the skeleton Id */
  95689. id: string, scene: Scene);
  95690. /**
  95691. * Gets the current object class name.
  95692. * @return the class name
  95693. */
  95694. getClassName(): string;
  95695. /**
  95696. * Returns an array containing the root bones
  95697. * @returns an array containing the root bones
  95698. */
  95699. getChildren(): Array<Bone>;
  95700. /**
  95701. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  95702. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  95703. * @returns a Float32Array containing matrices data
  95704. */
  95705. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  95706. /**
  95707. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  95708. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  95709. * @returns a raw texture containing the data
  95710. */
  95711. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  95712. /**
  95713. * Gets the current hosting scene
  95714. * @returns a scene object
  95715. */
  95716. getScene(): Scene;
  95717. /**
  95718. * Gets a string representing the current skeleton data
  95719. * @param fullDetails defines a boolean indicating if we want a verbose version
  95720. * @returns a string representing the current skeleton data
  95721. */
  95722. toString(fullDetails?: boolean): string;
  95723. /**
  95724. * Get bone's index searching by name
  95725. * @param name defines bone's name to search for
  95726. * @return the indice of the bone. Returns -1 if not found
  95727. */
  95728. getBoneIndexByName(name: string): number;
  95729. /**
  95730. * Creater a new animation range
  95731. * @param name defines the name of the range
  95732. * @param from defines the start key
  95733. * @param to defines the end key
  95734. */
  95735. createAnimationRange(name: string, from: number, to: number): void;
  95736. /**
  95737. * Delete a specific animation range
  95738. * @param name defines the name of the range
  95739. * @param deleteFrames defines if frames must be removed as well
  95740. */
  95741. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  95742. /**
  95743. * Gets a specific animation range
  95744. * @param name defines the name of the range to look for
  95745. * @returns the requested animation range or null if not found
  95746. */
  95747. getAnimationRange(name: string): Nullable<AnimationRange>;
  95748. /**
  95749. * Gets the list of all animation ranges defined on this skeleton
  95750. * @returns an array
  95751. */
  95752. getAnimationRanges(): Nullable<AnimationRange>[];
  95753. /**
  95754. * Copy animation range from a source skeleton.
  95755. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  95756. * @param source defines the source skeleton
  95757. * @param name defines the name of the range to copy
  95758. * @param rescaleAsRequired defines if rescaling must be applied if required
  95759. * @returns true if operation was successful
  95760. */
  95761. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  95762. /**
  95763. * Forces the skeleton to go to rest pose
  95764. */
  95765. returnToRest(): void;
  95766. private _getHighestAnimationFrame;
  95767. /**
  95768. * Begin a specific animation range
  95769. * @param name defines the name of the range to start
  95770. * @param loop defines if looping must be turned on (false by default)
  95771. * @param speedRatio defines the speed ratio to apply (1 by default)
  95772. * @param onAnimationEnd defines a callback which will be called when animation will end
  95773. * @returns a new animatable
  95774. */
  95775. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  95776. /**
  95777. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  95778. * @param skeleton defines the Skeleton containing the animation range to convert
  95779. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  95780. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  95781. * @returns the original skeleton
  95782. */
  95783. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  95784. /** @hidden */
  95785. _markAsDirty(): void;
  95786. /** @hidden */
  95787. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  95788. /** @hidden */
  95789. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  95790. private _computeTransformMatrices;
  95791. /**
  95792. * Build all resources required to render a skeleton
  95793. */
  95794. prepare(): void;
  95795. /**
  95796. * Gets the list of animatables currently running for this skeleton
  95797. * @returns an array of animatables
  95798. */
  95799. getAnimatables(): IAnimatable[];
  95800. /**
  95801. * Clone the current skeleton
  95802. * @param name defines the name of the new skeleton
  95803. * @param id defines the id of the new skeleton
  95804. * @returns the new skeleton
  95805. */
  95806. clone(name: string, id?: string): Skeleton;
  95807. /**
  95808. * Enable animation blending for this skeleton
  95809. * @param blendingSpeed defines the blending speed to apply
  95810. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95811. */
  95812. enableBlending(blendingSpeed?: number): void;
  95813. /**
  95814. * Releases all resources associated with the current skeleton
  95815. */
  95816. dispose(): void;
  95817. /**
  95818. * Serialize the skeleton in a JSON object
  95819. * @returns a JSON object
  95820. */
  95821. serialize(): any;
  95822. /**
  95823. * Creates a new skeleton from serialized data
  95824. * @param parsedSkeleton defines the serialized data
  95825. * @param scene defines the hosting scene
  95826. * @returns a new skeleton
  95827. */
  95828. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  95829. /**
  95830. * Compute all node absolute transforms
  95831. * @param forceUpdate defines if computation must be done even if cache is up to date
  95832. */
  95833. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  95834. /**
  95835. * Gets the root pose matrix
  95836. * @returns a matrix
  95837. */
  95838. getPoseMatrix(): Nullable<Matrix>;
  95839. /**
  95840. * Sorts bones per internal index
  95841. */
  95842. sortBones(): void;
  95843. private _sortBones;
  95844. }
  95845. }
  95846. declare module BABYLON {
  95847. /**
  95848. * Creates an instance based on a source mesh.
  95849. */
  95850. export class InstancedMesh extends AbstractMesh {
  95851. private _sourceMesh;
  95852. private _currentLOD;
  95853. /** @hidden */
  95854. _indexInSourceMeshInstanceArray: number;
  95855. constructor(name: string, source: Mesh);
  95856. /**
  95857. * Returns the string "InstancedMesh".
  95858. */
  95859. getClassName(): string;
  95860. /** Gets the list of lights affecting that mesh */
  95861. get lightSources(): Light[];
  95862. _resyncLightSources(): void;
  95863. _resyncLightSource(light: Light): void;
  95864. _removeLightSource(light: Light, dispose: boolean): void;
  95865. /**
  95866. * If the source mesh receives shadows
  95867. */
  95868. get receiveShadows(): boolean;
  95869. /**
  95870. * The material of the source mesh
  95871. */
  95872. get material(): Nullable<Material>;
  95873. /**
  95874. * Visibility of the source mesh
  95875. */
  95876. get visibility(): number;
  95877. /**
  95878. * Skeleton of the source mesh
  95879. */
  95880. get skeleton(): Nullable<Skeleton>;
  95881. /**
  95882. * Rendering ground id of the source mesh
  95883. */
  95884. get renderingGroupId(): number;
  95885. set renderingGroupId(value: number);
  95886. /**
  95887. * Returns the total number of vertices (integer).
  95888. */
  95889. getTotalVertices(): number;
  95890. /**
  95891. * Returns a positive integer : the total number of indices in this mesh geometry.
  95892. * @returns the numner of indices or zero if the mesh has no geometry.
  95893. */
  95894. getTotalIndices(): number;
  95895. /**
  95896. * The source mesh of the instance
  95897. */
  95898. get sourceMesh(): Mesh;
  95899. /**
  95900. * Creates a new InstancedMesh object from the mesh model.
  95901. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  95902. * @param name defines the name of the new instance
  95903. * @returns a new InstancedMesh
  95904. */
  95905. createInstance(name: string): InstancedMesh;
  95906. /**
  95907. * Is this node ready to be used/rendered
  95908. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  95909. * @return {boolean} is it ready
  95910. */
  95911. isReady(completeCheck?: boolean): boolean;
  95912. /**
  95913. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  95914. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  95915. * @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.
  95916. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  95917. */
  95918. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  95919. /**
  95920. * Sets the vertex data of the mesh geometry for the requested `kind`.
  95921. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  95922. * The `data` are either a numeric array either a Float32Array.
  95923. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  95924. * 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).
  95925. * Note that a new underlying VertexBuffer object is created each call.
  95926. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  95927. *
  95928. * Possible `kind` values :
  95929. * - VertexBuffer.PositionKind
  95930. * - VertexBuffer.UVKind
  95931. * - VertexBuffer.UV2Kind
  95932. * - VertexBuffer.UV3Kind
  95933. * - VertexBuffer.UV4Kind
  95934. * - VertexBuffer.UV5Kind
  95935. * - VertexBuffer.UV6Kind
  95936. * - VertexBuffer.ColorKind
  95937. * - VertexBuffer.MatricesIndicesKind
  95938. * - VertexBuffer.MatricesIndicesExtraKind
  95939. * - VertexBuffer.MatricesWeightsKind
  95940. * - VertexBuffer.MatricesWeightsExtraKind
  95941. *
  95942. * Returns the Mesh.
  95943. */
  95944. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  95945. /**
  95946. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  95947. * If the mesh has no geometry, it is simply returned as it is.
  95948. * The `data` are either a numeric array either a Float32Array.
  95949. * No new underlying VertexBuffer object is created.
  95950. * 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.
  95951. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  95952. *
  95953. * Possible `kind` values :
  95954. * - VertexBuffer.PositionKind
  95955. * - VertexBuffer.UVKind
  95956. * - VertexBuffer.UV2Kind
  95957. * - VertexBuffer.UV3Kind
  95958. * - VertexBuffer.UV4Kind
  95959. * - VertexBuffer.UV5Kind
  95960. * - VertexBuffer.UV6Kind
  95961. * - VertexBuffer.ColorKind
  95962. * - VertexBuffer.MatricesIndicesKind
  95963. * - VertexBuffer.MatricesIndicesExtraKind
  95964. * - VertexBuffer.MatricesWeightsKind
  95965. * - VertexBuffer.MatricesWeightsExtraKind
  95966. *
  95967. * Returns the Mesh.
  95968. */
  95969. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  95970. /**
  95971. * Sets the mesh indices.
  95972. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  95973. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  95974. * This method creates a new index buffer each call.
  95975. * Returns the Mesh.
  95976. */
  95977. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  95978. /**
  95979. * Boolean : True if the mesh owns the requested kind of data.
  95980. */
  95981. isVerticesDataPresent(kind: string): boolean;
  95982. /**
  95983. * Returns an array of indices (IndicesArray).
  95984. */
  95985. getIndices(): Nullable<IndicesArray>;
  95986. get _positions(): Nullable<Vector3[]>;
  95987. /**
  95988. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  95989. * This means the mesh underlying bounding box and sphere are recomputed.
  95990. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  95991. * @returns the current mesh
  95992. */
  95993. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  95994. /** @hidden */
  95995. _preActivate(): InstancedMesh;
  95996. /** @hidden */
  95997. _activate(renderId: number, intermediateRendering: boolean): boolean;
  95998. /** @hidden */
  95999. _postActivate(): void;
  96000. getWorldMatrix(): Matrix;
  96001. get isAnInstance(): boolean;
  96002. /**
  96003. * Returns the current associated LOD AbstractMesh.
  96004. */
  96005. getLOD(camera: Camera): AbstractMesh;
  96006. /** @hidden */
  96007. _preActivateForIntermediateRendering(renderId: number): Mesh;
  96008. /** @hidden */
  96009. _syncSubMeshes(): InstancedMesh;
  96010. /** @hidden */
  96011. _generatePointsArray(): boolean;
  96012. /** @hidden */
  96013. _updateBoundingInfo(): AbstractMesh;
  96014. /**
  96015. * Creates a new InstancedMesh from the current mesh.
  96016. * - name (string) : the cloned mesh name
  96017. * - newParent (optional Node) : the optional Node to parent the clone to.
  96018. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  96019. *
  96020. * Returns the clone.
  96021. */
  96022. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  96023. /**
  96024. * Disposes the InstancedMesh.
  96025. * Returns nothing.
  96026. */
  96027. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  96028. }
  96029. interface Mesh {
  96030. /**
  96031. * Register a custom buffer that will be instanced
  96032. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  96033. * @param kind defines the buffer kind
  96034. * @param stride defines the stride in floats
  96035. */
  96036. registerInstancedBuffer(kind: string, stride: number): void;
  96037. /**
  96038. * true to use the edge renderer for all instances of this mesh
  96039. */
  96040. edgesShareWithInstances: boolean;
  96041. /** @hidden */
  96042. _userInstancedBuffersStorage: {
  96043. data: {
  96044. [key: string]: Float32Array;
  96045. };
  96046. sizes: {
  96047. [key: string]: number;
  96048. };
  96049. vertexBuffers: {
  96050. [key: string]: Nullable<VertexBuffer>;
  96051. };
  96052. strides: {
  96053. [key: string]: number;
  96054. };
  96055. };
  96056. }
  96057. interface AbstractMesh {
  96058. /**
  96059. * Object used to store instanced buffers defined by user
  96060. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  96061. */
  96062. instancedBuffers: {
  96063. [key: string]: any;
  96064. };
  96065. }
  96066. }
  96067. declare module BABYLON {
  96068. /**
  96069. * Defines the options associated with the creation of a shader material.
  96070. */
  96071. export interface IShaderMaterialOptions {
  96072. /**
  96073. * Does the material work in alpha blend mode
  96074. */
  96075. needAlphaBlending: boolean;
  96076. /**
  96077. * Does the material work in alpha test mode
  96078. */
  96079. needAlphaTesting: boolean;
  96080. /**
  96081. * The list of attribute names used in the shader
  96082. */
  96083. attributes: string[];
  96084. /**
  96085. * The list of unifrom names used in the shader
  96086. */
  96087. uniforms: string[];
  96088. /**
  96089. * The list of UBO names used in the shader
  96090. */
  96091. uniformBuffers: string[];
  96092. /**
  96093. * The list of sampler names used in the shader
  96094. */
  96095. samplers: string[];
  96096. /**
  96097. * The list of defines used in the shader
  96098. */
  96099. defines: string[];
  96100. }
  96101. /**
  96102. * 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.
  96103. *
  96104. * This returned material effects how the mesh will look based on the code in the shaders.
  96105. *
  96106. * @see https://doc.babylonjs.com/how_to/shader_material
  96107. */
  96108. export class ShaderMaterial extends Material {
  96109. private _shaderPath;
  96110. private _options;
  96111. private _textures;
  96112. private _textureArrays;
  96113. private _floats;
  96114. private _ints;
  96115. private _floatsArrays;
  96116. private _colors3;
  96117. private _colors3Arrays;
  96118. private _colors4;
  96119. private _colors4Arrays;
  96120. private _vectors2;
  96121. private _vectors3;
  96122. private _vectors4;
  96123. private _matrices;
  96124. private _matrixArrays;
  96125. private _matrices3x3;
  96126. private _matrices2x2;
  96127. private _vectors2Arrays;
  96128. private _vectors3Arrays;
  96129. private _vectors4Arrays;
  96130. private _cachedWorldViewMatrix;
  96131. private _cachedWorldViewProjectionMatrix;
  96132. private _renderId;
  96133. private _multiview;
  96134. private _cachedDefines;
  96135. /** Define the Url to load snippets */
  96136. static SnippetUrl: string;
  96137. /** Snippet ID if the material was created from the snippet server */
  96138. snippetId: string;
  96139. /**
  96140. * Instantiate a new shader material.
  96141. * 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.
  96142. * This returned material effects how the mesh will look based on the code in the shaders.
  96143. * @see https://doc.babylonjs.com/how_to/shader_material
  96144. * @param name Define the name of the material in the scene
  96145. * @param scene Define the scene the material belongs to
  96146. * @param shaderPath Defines the route to the shader code in one of three ways:
  96147. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  96148. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  96149. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  96150. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  96151. * @param options Define the options used to create the shader
  96152. */
  96153. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  96154. /**
  96155. * Gets the shader path used to define the shader code
  96156. * It can be modified to trigger a new compilation
  96157. */
  96158. get shaderPath(): any;
  96159. /**
  96160. * Sets the shader path used to define the shader code
  96161. * It can be modified to trigger a new compilation
  96162. */
  96163. set shaderPath(shaderPath: any);
  96164. /**
  96165. * Gets the options used to compile the shader.
  96166. * They can be modified to trigger a new compilation
  96167. */
  96168. get options(): IShaderMaterialOptions;
  96169. /**
  96170. * Gets the current class name of the material e.g. "ShaderMaterial"
  96171. * Mainly use in serialization.
  96172. * @returns the class name
  96173. */
  96174. getClassName(): string;
  96175. /**
  96176. * Specifies if the material will require alpha blending
  96177. * @returns a boolean specifying if alpha blending is needed
  96178. */
  96179. needAlphaBlending(): boolean;
  96180. /**
  96181. * Specifies if this material should be rendered in alpha test mode
  96182. * @returns a boolean specifying if an alpha test is needed.
  96183. */
  96184. needAlphaTesting(): boolean;
  96185. private _checkUniform;
  96186. /**
  96187. * Set a texture in the shader.
  96188. * @param name Define the name of the uniform samplers as defined in the shader
  96189. * @param texture Define the texture to bind to this sampler
  96190. * @return the material itself allowing "fluent" like uniform updates
  96191. */
  96192. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  96193. /**
  96194. * Set a texture array in the shader.
  96195. * @param name Define the name of the uniform sampler array as defined in the shader
  96196. * @param textures Define the list of textures to bind to this sampler
  96197. * @return the material itself allowing "fluent" like uniform updates
  96198. */
  96199. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  96200. /**
  96201. * Set a float in the shader.
  96202. * @param name Define the name of the uniform as defined in the shader
  96203. * @param value Define the value to give to the uniform
  96204. * @return the material itself allowing "fluent" like uniform updates
  96205. */
  96206. setFloat(name: string, value: number): ShaderMaterial;
  96207. /**
  96208. * Set a int in the shader.
  96209. * @param name Define the name of the uniform as defined in the shader
  96210. * @param value Define the value to give to the uniform
  96211. * @return the material itself allowing "fluent" like uniform updates
  96212. */
  96213. setInt(name: string, value: number): ShaderMaterial;
  96214. /**
  96215. * Set an array of floats in the shader.
  96216. * @param name Define the name of the uniform as defined in the shader
  96217. * @param value Define the value to give to the uniform
  96218. * @return the material itself allowing "fluent" like uniform updates
  96219. */
  96220. setFloats(name: string, value: number[]): ShaderMaterial;
  96221. /**
  96222. * Set a vec3 in the shader from a Color3.
  96223. * @param name Define the name of the uniform as defined in the shader
  96224. * @param value Define the value to give to the uniform
  96225. * @return the material itself allowing "fluent" like uniform updates
  96226. */
  96227. setColor3(name: string, value: Color3): ShaderMaterial;
  96228. /**
  96229. * Set a vec3 array in the shader from a Color3 array.
  96230. * @param name Define the name of the uniform as defined in the shader
  96231. * @param value Define the value to give to the uniform
  96232. * @return the material itself allowing "fluent" like uniform updates
  96233. */
  96234. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  96235. /**
  96236. * Set a vec4 in the shader from a Color4.
  96237. * @param name Define the name of the uniform as defined in the shader
  96238. * @param value Define the value to give to the uniform
  96239. * @return the material itself allowing "fluent" like uniform updates
  96240. */
  96241. setColor4(name: string, value: Color4): ShaderMaterial;
  96242. /**
  96243. * Set a vec4 array in the shader from a Color4 array.
  96244. * @param name Define the name of the uniform as defined in the shader
  96245. * @param value Define the value to give to the uniform
  96246. * @return the material itself allowing "fluent" like uniform updates
  96247. */
  96248. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  96249. /**
  96250. * Set a vec2 in the shader from a Vector2.
  96251. * @param name Define the name of the uniform as defined in the shader
  96252. * @param value Define the value to give to the uniform
  96253. * @return the material itself allowing "fluent" like uniform updates
  96254. */
  96255. setVector2(name: string, value: Vector2): ShaderMaterial;
  96256. /**
  96257. * Set a vec3 in the shader from a Vector3.
  96258. * @param name Define the name of the uniform as defined in the shader
  96259. * @param value Define the value to give to the uniform
  96260. * @return the material itself allowing "fluent" like uniform updates
  96261. */
  96262. setVector3(name: string, value: Vector3): ShaderMaterial;
  96263. /**
  96264. * Set a vec4 in the shader from a Vector4.
  96265. * @param name Define the name of the uniform as defined in the shader
  96266. * @param value Define the value to give to the uniform
  96267. * @return the material itself allowing "fluent" like uniform updates
  96268. */
  96269. setVector4(name: string, value: Vector4): ShaderMaterial;
  96270. /**
  96271. * Set a mat4 in the shader from a Matrix.
  96272. * @param name Define the name of the uniform as defined in the shader
  96273. * @param value Define the value to give to the uniform
  96274. * @return the material itself allowing "fluent" like uniform updates
  96275. */
  96276. setMatrix(name: string, value: Matrix): ShaderMaterial;
  96277. /**
  96278. * Set a float32Array in the shader from a matrix array.
  96279. * @param name Define the name of the uniform as defined in the shader
  96280. * @param value Define the value to give to the uniform
  96281. * @return the material itself allowing "fluent" like uniform updates
  96282. */
  96283. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  96284. /**
  96285. * Set a mat3 in the shader from a Float32Array.
  96286. * @param name Define the name of the uniform as defined in the shader
  96287. * @param value Define the value to give to the uniform
  96288. * @return the material itself allowing "fluent" like uniform updates
  96289. */
  96290. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  96291. /**
  96292. * Set a mat2 in the shader from a Float32Array.
  96293. * @param name Define the name of the uniform as defined in the shader
  96294. * @param value Define the value to give to the uniform
  96295. * @return the material itself allowing "fluent" like uniform updates
  96296. */
  96297. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  96298. /**
  96299. * Set a vec2 array in the shader from a number array.
  96300. * @param name Define the name of the uniform as defined in the shader
  96301. * @param value Define the value to give to the uniform
  96302. * @return the material itself allowing "fluent" like uniform updates
  96303. */
  96304. setArray2(name: string, value: number[]): ShaderMaterial;
  96305. /**
  96306. * Set a vec3 array in the shader from a number array.
  96307. * @param name Define the name of the uniform as defined in the shader
  96308. * @param value Define the value to give to the uniform
  96309. * @return the material itself allowing "fluent" like uniform updates
  96310. */
  96311. setArray3(name: string, value: number[]): ShaderMaterial;
  96312. /**
  96313. * Set a vec4 array in the shader from a number array.
  96314. * @param name Define the name of the uniform as defined in the shader
  96315. * @param value Define the value to give to the uniform
  96316. * @return the material itself allowing "fluent" like uniform updates
  96317. */
  96318. setArray4(name: string, value: number[]): ShaderMaterial;
  96319. private _checkCache;
  96320. /**
  96321. * Specifies that the submesh is ready to be used
  96322. * @param mesh defines the mesh to check
  96323. * @param subMesh defines which submesh to check
  96324. * @param useInstances specifies that instances should be used
  96325. * @returns a boolean indicating that the submesh is ready or not
  96326. */
  96327. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  96328. /**
  96329. * Checks if the material is ready to render the requested mesh
  96330. * @param mesh Define the mesh to render
  96331. * @param useInstances Define whether or not the material is used with instances
  96332. * @returns true if ready, otherwise false
  96333. */
  96334. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  96335. /**
  96336. * Binds the world matrix to the material
  96337. * @param world defines the world transformation matrix
  96338. * @param effectOverride - If provided, use this effect instead of internal effect
  96339. */
  96340. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  96341. /**
  96342. * Binds the submesh to this material by preparing the effect and shader to draw
  96343. * @param world defines the world transformation matrix
  96344. * @param mesh defines the mesh containing the submesh
  96345. * @param subMesh defines the submesh to bind the material to
  96346. */
  96347. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  96348. /**
  96349. * Binds the material to the mesh
  96350. * @param world defines the world transformation matrix
  96351. * @param mesh defines the mesh to bind the material to
  96352. * @param effectOverride - If provided, use this effect instead of internal effect
  96353. */
  96354. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  96355. protected _afterBind(mesh?: Mesh): void;
  96356. /**
  96357. * Gets the active textures from the material
  96358. * @returns an array of textures
  96359. */
  96360. getActiveTextures(): BaseTexture[];
  96361. /**
  96362. * Specifies if the material uses a texture
  96363. * @param texture defines the texture to check against the material
  96364. * @returns a boolean specifying if the material uses the texture
  96365. */
  96366. hasTexture(texture: BaseTexture): boolean;
  96367. /**
  96368. * Makes a duplicate of the material, and gives it a new name
  96369. * @param name defines the new name for the duplicated material
  96370. * @returns the cloned material
  96371. */
  96372. clone(name: string): ShaderMaterial;
  96373. /**
  96374. * Disposes the material
  96375. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  96376. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  96377. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  96378. */
  96379. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  96380. /**
  96381. * Serializes this material in a JSON representation
  96382. * @returns the serialized material object
  96383. */
  96384. serialize(): any;
  96385. /**
  96386. * Creates a shader material from parsed shader material data
  96387. * @param source defines the JSON represnetation of the material
  96388. * @param scene defines the hosting scene
  96389. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96390. * @returns a new material
  96391. */
  96392. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  96393. /**
  96394. * Creates a new ShaderMaterial from a snippet saved in a remote file
  96395. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  96396. * @param url defines the url to load from
  96397. * @param scene defines the hosting scene
  96398. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96399. * @returns a promise that will resolve to the new ShaderMaterial
  96400. */
  96401. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  96402. /**
  96403. * Creates a ShaderMaterial from a snippet saved by the Inspector
  96404. * @param snippetId defines the snippet to load
  96405. * @param scene defines the hosting scene
  96406. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96407. * @returns a promise that will resolve to the new ShaderMaterial
  96408. */
  96409. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  96410. }
  96411. }
  96412. declare module BABYLON {
  96413. /** @hidden */
  96414. export var colorPixelShader: {
  96415. name: string;
  96416. shader: string;
  96417. };
  96418. }
  96419. declare module BABYLON {
  96420. /** @hidden */
  96421. export var colorVertexShader: {
  96422. name: string;
  96423. shader: string;
  96424. };
  96425. }
  96426. declare module BABYLON {
  96427. /**
  96428. * Line mesh
  96429. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  96430. */
  96431. export class LinesMesh extends Mesh {
  96432. /**
  96433. * If vertex color should be applied to the mesh
  96434. */
  96435. readonly useVertexColor?: boolean | undefined;
  96436. /**
  96437. * If vertex alpha should be applied to the mesh
  96438. */
  96439. readonly useVertexAlpha?: boolean | undefined;
  96440. /**
  96441. * Color of the line (Default: White)
  96442. */
  96443. color: Color3;
  96444. /**
  96445. * Alpha of the line (Default: 1)
  96446. */
  96447. alpha: number;
  96448. /**
  96449. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  96450. * This margin is expressed in world space coordinates, so its value may vary.
  96451. * Default value is 0.1
  96452. */
  96453. intersectionThreshold: number;
  96454. private _colorShader;
  96455. private color4;
  96456. /**
  96457. * Creates a new LinesMesh
  96458. * @param name defines the name
  96459. * @param scene defines the hosting scene
  96460. * @param parent defines the parent mesh if any
  96461. * @param source defines the optional source LinesMesh used to clone data from
  96462. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  96463. * When false, achieved by calling a clone(), also passing False.
  96464. * This will make creation of children, recursive.
  96465. * @param useVertexColor defines if this LinesMesh supports vertex color
  96466. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  96467. */
  96468. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  96469. /**
  96470. * If vertex color should be applied to the mesh
  96471. */
  96472. useVertexColor?: boolean | undefined,
  96473. /**
  96474. * If vertex alpha should be applied to the mesh
  96475. */
  96476. useVertexAlpha?: boolean | undefined);
  96477. private _addClipPlaneDefine;
  96478. private _removeClipPlaneDefine;
  96479. isReady(): boolean;
  96480. /**
  96481. * Returns the string "LineMesh"
  96482. */
  96483. getClassName(): string;
  96484. /**
  96485. * @hidden
  96486. */
  96487. get material(): Material;
  96488. /**
  96489. * @hidden
  96490. */
  96491. set material(value: Material);
  96492. /**
  96493. * @hidden
  96494. */
  96495. get checkCollisions(): boolean;
  96496. /** @hidden */
  96497. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  96498. /** @hidden */
  96499. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  96500. /**
  96501. * Disposes of the line mesh
  96502. * @param doNotRecurse If children should be disposed
  96503. */
  96504. dispose(doNotRecurse?: boolean): void;
  96505. /**
  96506. * Returns a new LineMesh object cloned from the current one.
  96507. */
  96508. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  96509. /**
  96510. * Creates a new InstancedLinesMesh object from the mesh model.
  96511. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  96512. * @param name defines the name of the new instance
  96513. * @returns a new InstancedLinesMesh
  96514. */
  96515. createInstance(name: string): InstancedLinesMesh;
  96516. }
  96517. /**
  96518. * Creates an instance based on a source LinesMesh
  96519. */
  96520. export class InstancedLinesMesh extends InstancedMesh {
  96521. /**
  96522. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  96523. * This margin is expressed in world space coordinates, so its value may vary.
  96524. * Initilized with the intersectionThreshold value of the source LinesMesh
  96525. */
  96526. intersectionThreshold: number;
  96527. constructor(name: string, source: LinesMesh);
  96528. /**
  96529. * Returns the string "InstancedLinesMesh".
  96530. */
  96531. getClassName(): string;
  96532. }
  96533. }
  96534. declare module BABYLON {
  96535. /** @hidden */
  96536. export var linePixelShader: {
  96537. name: string;
  96538. shader: string;
  96539. };
  96540. }
  96541. declare module BABYLON {
  96542. /** @hidden */
  96543. export var lineVertexShader: {
  96544. name: string;
  96545. shader: string;
  96546. };
  96547. }
  96548. declare module BABYLON {
  96549. interface Scene {
  96550. /** @hidden */
  96551. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  96552. }
  96553. interface AbstractMesh {
  96554. /**
  96555. * Gets the edgesRenderer associated with the mesh
  96556. */
  96557. edgesRenderer: Nullable<EdgesRenderer>;
  96558. }
  96559. interface LinesMesh {
  96560. /**
  96561. * Enables the edge rendering mode on the mesh.
  96562. * This mode makes the mesh edges visible
  96563. * @param epsilon defines the maximal distance between two angles to detect a face
  96564. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  96565. * @returns the currentAbstractMesh
  96566. * @see https://www.babylonjs-playground.com/#19O9TU#0
  96567. */
  96568. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  96569. }
  96570. interface InstancedLinesMesh {
  96571. /**
  96572. * Enables the edge rendering mode on the mesh.
  96573. * This mode makes the mesh edges visible
  96574. * @param epsilon defines the maximal distance between two angles to detect a face
  96575. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  96576. * @returns the current InstancedLinesMesh
  96577. * @see https://www.babylonjs-playground.com/#19O9TU#0
  96578. */
  96579. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  96580. }
  96581. /**
  96582. * Defines the minimum contract an Edges renderer should follow.
  96583. */
  96584. export interface IEdgesRenderer extends IDisposable {
  96585. /**
  96586. * Gets or sets a boolean indicating if the edgesRenderer is active
  96587. */
  96588. isEnabled: boolean;
  96589. /**
  96590. * Renders the edges of the attached mesh,
  96591. */
  96592. render(): void;
  96593. /**
  96594. * Checks wether or not the edges renderer is ready to render.
  96595. * @return true if ready, otherwise false.
  96596. */
  96597. isReady(): boolean;
  96598. /**
  96599. * List of instances to render in case the source mesh has instances
  96600. */
  96601. customInstances: SmartArray<Matrix>;
  96602. }
  96603. /**
  96604. * Defines the additional options of the edges renderer
  96605. */
  96606. export interface IEdgesRendererOptions {
  96607. /**
  96608. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  96609. * If not defined, the default value is true
  96610. */
  96611. useAlternateEdgeFinder?: boolean;
  96612. /**
  96613. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  96614. * If not defined, the default value is true.
  96615. * 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)
  96616. * This option is used only if useAlternateEdgeFinder = true
  96617. */
  96618. useFastVertexMerger?: boolean;
  96619. /**
  96620. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  96621. * The default value is 1e-6
  96622. * This option is used only if useAlternateEdgeFinder = true
  96623. */
  96624. epsilonVertexMerge?: number;
  96625. /**
  96626. * 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
  96627. * 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.
  96628. * This option is used only if useAlternateEdgeFinder = true
  96629. */
  96630. applyTessellation?: boolean;
  96631. /**
  96632. * 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
  96633. * The default value is 1e-6
  96634. * This option is used only if useAlternateEdgeFinder = true
  96635. */
  96636. epsilonVertexAligned?: number;
  96637. }
  96638. /**
  96639. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  96640. */
  96641. export class EdgesRenderer implements IEdgesRenderer {
  96642. /**
  96643. * Define the size of the edges with an orthographic camera
  96644. */
  96645. edgesWidthScalerForOrthographic: number;
  96646. /**
  96647. * Define the size of the edges with a perspective camera
  96648. */
  96649. edgesWidthScalerForPerspective: number;
  96650. protected _source: AbstractMesh;
  96651. protected _linesPositions: number[];
  96652. protected _linesNormals: number[];
  96653. protected _linesIndices: number[];
  96654. protected _epsilon: number;
  96655. protected _indicesCount: number;
  96656. protected _lineShader: ShaderMaterial;
  96657. protected _ib: DataBuffer;
  96658. protected _buffers: {
  96659. [key: string]: Nullable<VertexBuffer>;
  96660. };
  96661. protected _buffersForInstances: {
  96662. [key: string]: Nullable<VertexBuffer>;
  96663. };
  96664. protected _checkVerticesInsteadOfIndices: boolean;
  96665. protected _options: Nullable<IEdgesRendererOptions>;
  96666. private _meshRebuildObserver;
  96667. private _meshDisposeObserver;
  96668. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  96669. isEnabled: boolean;
  96670. /**
  96671. * List of instances to render in case the source mesh has instances
  96672. */
  96673. customInstances: SmartArray<Matrix>;
  96674. private static GetShader;
  96675. /**
  96676. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  96677. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  96678. * @param source Mesh used to create edges
  96679. * @param epsilon sum of angles in adjacency to check for edge
  96680. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  96681. * @param generateEdgesLines - should generate Lines or only prepare resources.
  96682. * @param options The options to apply when generating the edges
  96683. */
  96684. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  96685. protected _prepareRessources(): void;
  96686. /** @hidden */
  96687. _rebuild(): void;
  96688. /**
  96689. * Releases the required resources for the edges renderer
  96690. */
  96691. dispose(): void;
  96692. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  96693. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  96694. /**
  96695. * Checks if the pair of p0 and p1 is en edge
  96696. * @param faceIndex
  96697. * @param edge
  96698. * @param faceNormals
  96699. * @param p0
  96700. * @param p1
  96701. * @private
  96702. */
  96703. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  96704. /**
  96705. * push line into the position, normal and index buffer
  96706. * @protected
  96707. */
  96708. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  96709. /**
  96710. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  96711. */
  96712. private _tessellateTriangle;
  96713. private _generateEdgesLinesAlternate;
  96714. /**
  96715. * Generates lines edges from adjacencjes
  96716. * @private
  96717. */
  96718. _generateEdgesLines(): void;
  96719. /**
  96720. * Checks wether or not the edges renderer is ready to render.
  96721. * @return true if ready, otherwise false.
  96722. */
  96723. isReady(): boolean;
  96724. /**
  96725. * Renders the edges of the attached mesh,
  96726. */
  96727. render(): void;
  96728. }
  96729. /**
  96730. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  96731. */
  96732. export class LineEdgesRenderer extends EdgesRenderer {
  96733. /**
  96734. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  96735. * @param source LineMesh used to generate edges
  96736. * @param epsilon not important (specified angle for edge detection)
  96737. * @param checkVerticesInsteadOfIndices not important for LineMesh
  96738. */
  96739. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  96740. /**
  96741. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  96742. */
  96743. _generateEdgesLines(): void;
  96744. }
  96745. }
  96746. declare module BABYLON {
  96747. /**
  96748. * This represents the object necessary to create a rendering group.
  96749. * This is exclusively used and created by the rendering manager.
  96750. * To modify the behavior, you use the available helpers in your scene or meshes.
  96751. * @hidden
  96752. */
  96753. export class RenderingGroup {
  96754. index: number;
  96755. private static _zeroVector;
  96756. private _scene;
  96757. private _opaqueSubMeshes;
  96758. private _transparentSubMeshes;
  96759. private _alphaTestSubMeshes;
  96760. private _depthOnlySubMeshes;
  96761. private _particleSystems;
  96762. private _spriteManagers;
  96763. private _opaqueSortCompareFn;
  96764. private _alphaTestSortCompareFn;
  96765. private _transparentSortCompareFn;
  96766. private _renderOpaque;
  96767. private _renderAlphaTest;
  96768. private _renderTransparent;
  96769. /** @hidden */
  96770. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  96771. onBeforeTransparentRendering: () => void;
  96772. /**
  96773. * Set the opaque sort comparison function.
  96774. * If null the sub meshes will be render in the order they were created
  96775. */
  96776. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96777. /**
  96778. * Set the alpha test sort comparison function.
  96779. * If null the sub meshes will be render in the order they were created
  96780. */
  96781. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96782. /**
  96783. * Set the transparent sort comparison function.
  96784. * If null the sub meshes will be render in the order they were created
  96785. */
  96786. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96787. /**
  96788. * Creates a new rendering group.
  96789. * @param index The rendering group index
  96790. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  96791. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  96792. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  96793. */
  96794. 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>);
  96795. /**
  96796. * Render all the sub meshes contained in the group.
  96797. * @param customRenderFunction Used to override the default render behaviour of the group.
  96798. * @returns true if rendered some submeshes.
  96799. */
  96800. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  96801. /**
  96802. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  96803. * @param subMeshes The submeshes to render
  96804. */
  96805. private renderOpaqueSorted;
  96806. /**
  96807. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  96808. * @param subMeshes The submeshes to render
  96809. */
  96810. private renderAlphaTestSorted;
  96811. /**
  96812. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  96813. * @param subMeshes The submeshes to render
  96814. */
  96815. private renderTransparentSorted;
  96816. /**
  96817. * Renders the submeshes in a specified order.
  96818. * @param subMeshes The submeshes to sort before render
  96819. * @param sortCompareFn The comparison function use to sort
  96820. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  96821. * @param transparent Specifies to activate blending if true
  96822. */
  96823. private static renderSorted;
  96824. /**
  96825. * Renders the submeshes in the order they were dispatched (no sort applied).
  96826. * @param subMeshes The submeshes to render
  96827. */
  96828. private static renderUnsorted;
  96829. /**
  96830. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  96831. * are rendered back to front if in the same alpha index.
  96832. *
  96833. * @param a The first submesh
  96834. * @param b The second submesh
  96835. * @returns The result of the comparison
  96836. */
  96837. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  96838. /**
  96839. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  96840. * are rendered back to front.
  96841. *
  96842. * @param a The first submesh
  96843. * @param b The second submesh
  96844. * @returns The result of the comparison
  96845. */
  96846. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  96847. /**
  96848. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  96849. * are rendered front to back (prevent overdraw).
  96850. *
  96851. * @param a The first submesh
  96852. * @param b The second submesh
  96853. * @returns The result of the comparison
  96854. */
  96855. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  96856. /**
  96857. * Resets the different lists of submeshes to prepare a new frame.
  96858. */
  96859. prepare(): void;
  96860. dispose(): void;
  96861. /**
  96862. * Inserts the submesh in its correct queue depending on its material.
  96863. * @param subMesh The submesh to dispatch
  96864. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  96865. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  96866. */
  96867. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  96868. dispatchSprites(spriteManager: ISpriteManager): void;
  96869. dispatchParticles(particleSystem: IParticleSystem): void;
  96870. private _renderParticles;
  96871. private _renderSprites;
  96872. }
  96873. }
  96874. declare module BABYLON {
  96875. /**
  96876. * Interface describing the different options available in the rendering manager
  96877. * regarding Auto Clear between groups.
  96878. */
  96879. export interface IRenderingManagerAutoClearSetup {
  96880. /**
  96881. * Defines whether or not autoclear is enable.
  96882. */
  96883. autoClear: boolean;
  96884. /**
  96885. * Defines whether or not to autoclear the depth buffer.
  96886. */
  96887. depth: boolean;
  96888. /**
  96889. * Defines whether or not to autoclear the stencil buffer.
  96890. */
  96891. stencil: boolean;
  96892. }
  96893. /**
  96894. * This class is used by the onRenderingGroupObservable
  96895. */
  96896. export class RenderingGroupInfo {
  96897. /**
  96898. * The Scene that being rendered
  96899. */
  96900. scene: Scene;
  96901. /**
  96902. * The camera currently used for the rendering pass
  96903. */
  96904. camera: Nullable<Camera>;
  96905. /**
  96906. * The ID of the renderingGroup being processed
  96907. */
  96908. renderingGroupId: number;
  96909. }
  96910. /**
  96911. * This is the manager responsible of all the rendering for meshes sprites and particles.
  96912. * It is enable to manage the different groups as well as the different necessary sort functions.
  96913. * This should not be used directly aside of the few static configurations
  96914. */
  96915. export class RenderingManager {
  96916. /**
  96917. * The max id used for rendering groups (not included)
  96918. */
  96919. static MAX_RENDERINGGROUPS: number;
  96920. /**
  96921. * The min id used for rendering groups (included)
  96922. */
  96923. static MIN_RENDERINGGROUPS: number;
  96924. /**
  96925. * Used to globally prevent autoclearing scenes.
  96926. */
  96927. static AUTOCLEAR: boolean;
  96928. /**
  96929. * @hidden
  96930. */
  96931. _useSceneAutoClearSetup: boolean;
  96932. private _scene;
  96933. private _renderingGroups;
  96934. private _depthStencilBufferAlreadyCleaned;
  96935. private _autoClearDepthStencil;
  96936. private _customOpaqueSortCompareFn;
  96937. private _customAlphaTestSortCompareFn;
  96938. private _customTransparentSortCompareFn;
  96939. private _renderingGroupInfo;
  96940. /**
  96941. * Instantiates a new rendering group for a particular scene
  96942. * @param scene Defines the scene the groups belongs to
  96943. */
  96944. constructor(scene: Scene);
  96945. private _clearDepthStencilBuffer;
  96946. /**
  96947. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  96948. * @hidden
  96949. */
  96950. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  96951. /**
  96952. * Resets the different information of the group to prepare a new frame
  96953. * @hidden
  96954. */
  96955. reset(): void;
  96956. /**
  96957. * Dispose and release the group and its associated resources.
  96958. * @hidden
  96959. */
  96960. dispose(): void;
  96961. /**
  96962. * Clear the info related to rendering groups preventing retention points during dispose.
  96963. */
  96964. freeRenderingGroups(): void;
  96965. private _prepareRenderingGroup;
  96966. /**
  96967. * Add a sprite manager to the rendering manager in order to render it this frame.
  96968. * @param spriteManager Define the sprite manager to render
  96969. */
  96970. dispatchSprites(spriteManager: ISpriteManager): void;
  96971. /**
  96972. * Add a particle system to the rendering manager in order to render it this frame.
  96973. * @param particleSystem Define the particle system to render
  96974. */
  96975. dispatchParticles(particleSystem: IParticleSystem): void;
  96976. /**
  96977. * Add a submesh to the manager in order to render it this frame
  96978. * @param subMesh The submesh to dispatch
  96979. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  96980. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  96981. */
  96982. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  96983. /**
  96984. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  96985. * This allowed control for front to back rendering or reversly depending of the special needs.
  96986. *
  96987. * @param renderingGroupId The rendering group id corresponding to its index
  96988. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  96989. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  96990. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  96991. */
  96992. 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;
  96993. /**
  96994. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  96995. *
  96996. * @param renderingGroupId The rendering group id corresponding to its index
  96997. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  96998. * @param depth Automatically clears depth between groups if true and autoClear is true.
  96999. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  97000. */
  97001. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  97002. /**
  97003. * Gets the current auto clear configuration for one rendering group of the rendering
  97004. * manager.
  97005. * @param index the rendering group index to get the information for
  97006. * @returns The auto clear setup for the requested rendering group
  97007. */
  97008. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  97009. }
  97010. }
  97011. declare module BABYLON {
  97012. /**
  97013. * Defines the options associated with the creation of a custom shader for a shadow generator.
  97014. */
  97015. export interface ICustomShaderOptions {
  97016. /**
  97017. * Gets or sets the custom shader name to use
  97018. */
  97019. shaderName: string;
  97020. /**
  97021. * The list of attribute names used in the shader
  97022. */
  97023. attributes?: string[];
  97024. /**
  97025. * The list of unifrom names used in the shader
  97026. */
  97027. uniforms?: string[];
  97028. /**
  97029. * The list of sampler names used in the shader
  97030. */
  97031. samplers?: string[];
  97032. /**
  97033. * The list of defines used in the shader
  97034. */
  97035. defines?: string[];
  97036. }
  97037. /**
  97038. * Interface to implement to create a shadow generator compatible with BJS.
  97039. */
  97040. export interface IShadowGenerator {
  97041. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  97042. id: string;
  97043. /**
  97044. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  97045. * @returns The render target texture if present otherwise, null
  97046. */
  97047. getShadowMap(): Nullable<RenderTargetTexture>;
  97048. /**
  97049. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  97050. * @param subMesh The submesh we want to render in the shadow map
  97051. * @param useInstances Defines wether will draw in the map using instances
  97052. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  97053. * @returns true if ready otherwise, false
  97054. */
  97055. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  97056. /**
  97057. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  97058. * @param defines Defines of the material we want to update
  97059. * @param lightIndex Index of the light in the enabled light list of the material
  97060. */
  97061. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  97062. /**
  97063. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  97064. * defined in the generator but impacting the effect).
  97065. * It implies the unifroms available on the materials are the standard BJS ones.
  97066. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  97067. * @param effect The effect we are binfing the information for
  97068. */
  97069. bindShadowLight(lightIndex: string, effect: Effect): void;
  97070. /**
  97071. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  97072. * (eq to shadow prjection matrix * light transform matrix)
  97073. * @returns The transform matrix used to create the shadow map
  97074. */
  97075. getTransformMatrix(): Matrix;
  97076. /**
  97077. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  97078. * Cube and 2D textures for instance.
  97079. */
  97080. recreateShadowMap(): void;
  97081. /**
  97082. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97083. * @param onCompiled Callback triggered at the and of the effects compilation
  97084. * @param options Sets of optional options forcing the compilation with different modes
  97085. */
  97086. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  97087. useInstances: boolean;
  97088. }>): void;
  97089. /**
  97090. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97091. * @param options Sets of optional options forcing the compilation with different modes
  97092. * @returns A promise that resolves when the compilation completes
  97093. */
  97094. forceCompilationAsync(options?: Partial<{
  97095. useInstances: boolean;
  97096. }>): Promise<void>;
  97097. /**
  97098. * Serializes the shadow generator setup to a json object.
  97099. * @returns The serialized JSON object
  97100. */
  97101. serialize(): any;
  97102. /**
  97103. * Disposes the Shadow map and related Textures and effects.
  97104. */
  97105. dispose(): void;
  97106. }
  97107. /**
  97108. * Default implementation IShadowGenerator.
  97109. * This is the main object responsible of generating shadows in the framework.
  97110. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  97111. */
  97112. export class ShadowGenerator implements IShadowGenerator {
  97113. /**
  97114. * Name of the shadow generator class
  97115. */
  97116. static CLASSNAME: string;
  97117. /**
  97118. * Shadow generator mode None: no filtering applied.
  97119. */
  97120. static readonly FILTER_NONE: number;
  97121. /**
  97122. * Shadow generator mode ESM: Exponential Shadow Mapping.
  97123. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97124. */
  97125. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  97126. /**
  97127. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  97128. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  97129. */
  97130. static readonly FILTER_POISSONSAMPLING: number;
  97131. /**
  97132. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  97133. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97134. */
  97135. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  97136. /**
  97137. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  97138. * edge artifacts on steep falloff.
  97139. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97140. */
  97141. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  97142. /**
  97143. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  97144. * edge artifacts on steep falloff.
  97145. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97146. */
  97147. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  97148. /**
  97149. * Shadow generator mode PCF: Percentage Closer Filtering
  97150. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  97151. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  97152. */
  97153. static readonly FILTER_PCF: number;
  97154. /**
  97155. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  97156. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  97157. * Contact Hardening
  97158. */
  97159. static readonly FILTER_PCSS: number;
  97160. /**
  97161. * Reserved for PCF and PCSS
  97162. * Highest Quality.
  97163. *
  97164. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  97165. *
  97166. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  97167. */
  97168. static readonly QUALITY_HIGH: number;
  97169. /**
  97170. * Reserved for PCF and PCSS
  97171. * Good tradeoff for quality/perf cross devices
  97172. *
  97173. * Execute PCF on a 3*3 kernel.
  97174. *
  97175. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  97176. */
  97177. static readonly QUALITY_MEDIUM: number;
  97178. /**
  97179. * Reserved for PCF and PCSS
  97180. * The lowest quality but the fastest.
  97181. *
  97182. * Execute PCF on a 1*1 kernel.
  97183. *
  97184. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  97185. */
  97186. static readonly QUALITY_LOW: number;
  97187. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  97188. id: string;
  97189. /** Gets or sets the custom shader name to use */
  97190. customShaderOptions: ICustomShaderOptions;
  97191. /**
  97192. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  97193. */
  97194. onBeforeShadowMapRenderObservable: Observable<Effect>;
  97195. /**
  97196. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  97197. */
  97198. onAfterShadowMapRenderObservable: Observable<Effect>;
  97199. /**
  97200. * Observable triggered before a mesh is rendered in the shadow map.
  97201. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  97202. */
  97203. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  97204. /**
  97205. * Observable triggered after a mesh is rendered in the shadow map.
  97206. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  97207. */
  97208. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  97209. protected _bias: number;
  97210. /**
  97211. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  97212. */
  97213. get bias(): number;
  97214. /**
  97215. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  97216. */
  97217. set bias(bias: number);
  97218. protected _normalBias: number;
  97219. /**
  97220. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  97221. */
  97222. get normalBias(): number;
  97223. /**
  97224. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  97225. */
  97226. set normalBias(normalBias: number);
  97227. protected _blurBoxOffset: number;
  97228. /**
  97229. * Gets the blur box offset: offset applied during the blur pass.
  97230. * Only useful if useKernelBlur = false
  97231. */
  97232. get blurBoxOffset(): number;
  97233. /**
  97234. * Sets the blur box offset: offset applied during the blur pass.
  97235. * Only useful if useKernelBlur = false
  97236. */
  97237. set blurBoxOffset(value: number);
  97238. protected _blurScale: number;
  97239. /**
  97240. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  97241. * 2 means half of the size.
  97242. */
  97243. get blurScale(): number;
  97244. /**
  97245. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  97246. * 2 means half of the size.
  97247. */
  97248. set blurScale(value: number);
  97249. protected _blurKernel: number;
  97250. /**
  97251. * Gets the blur kernel: kernel size of the blur pass.
  97252. * Only useful if useKernelBlur = true
  97253. */
  97254. get blurKernel(): number;
  97255. /**
  97256. * Sets the blur kernel: kernel size of the blur pass.
  97257. * Only useful if useKernelBlur = true
  97258. */
  97259. set blurKernel(value: number);
  97260. protected _useKernelBlur: boolean;
  97261. /**
  97262. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  97263. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  97264. */
  97265. get useKernelBlur(): boolean;
  97266. /**
  97267. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  97268. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  97269. */
  97270. set useKernelBlur(value: boolean);
  97271. protected _depthScale: number;
  97272. /**
  97273. * Gets the depth scale used in ESM mode.
  97274. */
  97275. get depthScale(): number;
  97276. /**
  97277. * Sets the depth scale used in ESM mode.
  97278. * This can override the scale stored on the light.
  97279. */
  97280. set depthScale(value: number);
  97281. protected _validateFilter(filter: number): number;
  97282. protected _filter: number;
  97283. /**
  97284. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  97285. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  97286. */
  97287. get filter(): number;
  97288. /**
  97289. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  97290. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  97291. */
  97292. set filter(value: number);
  97293. /**
  97294. * Gets if the current filter is set to Poisson Sampling.
  97295. */
  97296. get usePoissonSampling(): boolean;
  97297. /**
  97298. * Sets the current filter to Poisson Sampling.
  97299. */
  97300. set usePoissonSampling(value: boolean);
  97301. /**
  97302. * Gets if the current filter is set to ESM.
  97303. */
  97304. get useExponentialShadowMap(): boolean;
  97305. /**
  97306. * Sets the current filter is to ESM.
  97307. */
  97308. set useExponentialShadowMap(value: boolean);
  97309. /**
  97310. * Gets if the current filter is set to filtered ESM.
  97311. */
  97312. get useBlurExponentialShadowMap(): boolean;
  97313. /**
  97314. * Gets if the current filter is set to filtered ESM.
  97315. */
  97316. set useBlurExponentialShadowMap(value: boolean);
  97317. /**
  97318. * Gets if the current filter is set to "close ESM" (using the inverse of the
  97319. * exponential to prevent steep falloff artifacts).
  97320. */
  97321. get useCloseExponentialShadowMap(): boolean;
  97322. /**
  97323. * Sets the current filter to "close ESM" (using the inverse of the
  97324. * exponential to prevent steep falloff artifacts).
  97325. */
  97326. set useCloseExponentialShadowMap(value: boolean);
  97327. /**
  97328. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  97329. * exponential to prevent steep falloff artifacts).
  97330. */
  97331. get useBlurCloseExponentialShadowMap(): boolean;
  97332. /**
  97333. * Sets the current filter to filtered "close ESM" (using the inverse of the
  97334. * exponential to prevent steep falloff artifacts).
  97335. */
  97336. set useBlurCloseExponentialShadowMap(value: boolean);
  97337. /**
  97338. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  97339. */
  97340. get usePercentageCloserFiltering(): boolean;
  97341. /**
  97342. * Sets the current filter to "PCF" (percentage closer filtering).
  97343. */
  97344. set usePercentageCloserFiltering(value: boolean);
  97345. protected _filteringQuality: number;
  97346. /**
  97347. * Gets the PCF or PCSS Quality.
  97348. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  97349. */
  97350. get filteringQuality(): number;
  97351. /**
  97352. * Sets the PCF or PCSS Quality.
  97353. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  97354. */
  97355. set filteringQuality(filteringQuality: number);
  97356. /**
  97357. * Gets if the current filter is set to "PCSS" (contact hardening).
  97358. */
  97359. get useContactHardeningShadow(): boolean;
  97360. /**
  97361. * Sets the current filter to "PCSS" (contact hardening).
  97362. */
  97363. set useContactHardeningShadow(value: boolean);
  97364. protected _contactHardeningLightSizeUVRatio: number;
  97365. /**
  97366. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  97367. * Using a ratio helps keeping shape stability independently of the map size.
  97368. *
  97369. * It does not account for the light projection as it was having too much
  97370. * instability during the light setup or during light position changes.
  97371. *
  97372. * Only valid if useContactHardeningShadow is true.
  97373. */
  97374. get contactHardeningLightSizeUVRatio(): number;
  97375. /**
  97376. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  97377. * Using a ratio helps keeping shape stability independently of the map size.
  97378. *
  97379. * It does not account for the light projection as it was having too much
  97380. * instability during the light setup or during light position changes.
  97381. *
  97382. * Only valid if useContactHardeningShadow is true.
  97383. */
  97384. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  97385. protected _darkness: number;
  97386. /** Gets or sets the actual darkness of a shadow */
  97387. get darkness(): number;
  97388. set darkness(value: number);
  97389. /**
  97390. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  97391. * 0 means strongest and 1 would means no shadow.
  97392. * @returns the darkness.
  97393. */
  97394. getDarkness(): number;
  97395. /**
  97396. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  97397. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  97398. * @returns the shadow generator allowing fluent coding.
  97399. */
  97400. setDarkness(darkness: number): ShadowGenerator;
  97401. protected _transparencyShadow: boolean;
  97402. /** Gets or sets the ability to have transparent shadow */
  97403. get transparencyShadow(): boolean;
  97404. set transparencyShadow(value: boolean);
  97405. /**
  97406. * Sets the ability to have transparent shadow (boolean).
  97407. * @param transparent True if transparent else False
  97408. * @returns the shadow generator allowing fluent coding
  97409. */
  97410. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  97411. /**
  97412. * Enables or disables shadows with varying strength based on the transparency
  97413. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  97414. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  97415. * mesh.visibility * alphaTexture.a
  97416. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  97417. */
  97418. enableSoftTransparentShadow: boolean;
  97419. protected _shadowMap: Nullable<RenderTargetTexture>;
  97420. protected _shadowMap2: Nullable<RenderTargetTexture>;
  97421. /**
  97422. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  97423. * @returns The render target texture if present otherwise, null
  97424. */
  97425. getShadowMap(): Nullable<RenderTargetTexture>;
  97426. /**
  97427. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  97428. * @returns The render target texture if the shadow map is present otherwise, null
  97429. */
  97430. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  97431. /**
  97432. * Gets the class name of that object
  97433. * @returns "ShadowGenerator"
  97434. */
  97435. getClassName(): string;
  97436. /**
  97437. * Helper function to add a mesh and its descendants to the list of shadow casters.
  97438. * @param mesh Mesh to add
  97439. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  97440. * @returns the Shadow Generator itself
  97441. */
  97442. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  97443. /**
  97444. * Helper function to remove a mesh and its descendants from the list of shadow casters
  97445. * @param mesh Mesh to remove
  97446. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  97447. * @returns the Shadow Generator itself
  97448. */
  97449. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  97450. /**
  97451. * Controls the extent to which the shadows fade out at the edge of the frustum
  97452. */
  97453. frustumEdgeFalloff: number;
  97454. protected _light: IShadowLight;
  97455. /**
  97456. * Returns the associated light object.
  97457. * @returns the light generating the shadow
  97458. */
  97459. getLight(): IShadowLight;
  97460. /**
  97461. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  97462. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  97463. * It might on the other hand introduce peter panning.
  97464. */
  97465. forceBackFacesOnly: boolean;
  97466. protected _scene: Scene;
  97467. protected _lightDirection: Vector3;
  97468. protected _effect: Effect;
  97469. protected _viewMatrix: Matrix;
  97470. protected _projectionMatrix: Matrix;
  97471. protected _transformMatrix: Matrix;
  97472. protected _cachedPosition: Vector3;
  97473. protected _cachedDirection: Vector3;
  97474. protected _cachedDefines: string;
  97475. protected _currentRenderID: number;
  97476. protected _boxBlurPostprocess: Nullable<PostProcess>;
  97477. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  97478. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  97479. protected _blurPostProcesses: PostProcess[];
  97480. protected _mapSize: number;
  97481. protected _currentFaceIndex: number;
  97482. protected _currentFaceIndexCache: number;
  97483. protected _textureType: number;
  97484. protected _defaultTextureMatrix: Matrix;
  97485. protected _storedUniqueId: Nullable<number>;
  97486. /** @hidden */
  97487. static _SceneComponentInitialization: (scene: Scene) => void;
  97488. /**
  97489. * Creates a ShadowGenerator object.
  97490. * A ShadowGenerator is the required tool to use the shadows.
  97491. * Each light casting shadows needs to use its own ShadowGenerator.
  97492. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  97493. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  97494. * @param light The light object generating the shadows.
  97495. * @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.
  97496. */
  97497. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  97498. protected _initializeGenerator(): void;
  97499. protected _createTargetRenderTexture(): void;
  97500. protected _initializeShadowMap(): void;
  97501. protected _initializeBlurRTTAndPostProcesses(): void;
  97502. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  97503. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  97504. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  97505. protected _applyFilterValues(): void;
  97506. /**
  97507. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97508. * @param onCompiled Callback triggered at the and of the effects compilation
  97509. * @param options Sets of optional options forcing the compilation with different modes
  97510. */
  97511. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  97512. useInstances: boolean;
  97513. }>): void;
  97514. /**
  97515. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97516. * @param options Sets of optional options forcing the compilation with different modes
  97517. * @returns A promise that resolves when the compilation completes
  97518. */
  97519. forceCompilationAsync(options?: Partial<{
  97520. useInstances: boolean;
  97521. }>): Promise<void>;
  97522. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  97523. private _prepareShadowDefines;
  97524. /**
  97525. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  97526. * @param subMesh The submesh we want to render in the shadow map
  97527. * @param useInstances Defines wether will draw in the map using instances
  97528. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  97529. * @returns true if ready otherwise, false
  97530. */
  97531. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  97532. /**
  97533. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  97534. * @param defines Defines of the material we want to update
  97535. * @param lightIndex Index of the light in the enabled light list of the material
  97536. */
  97537. prepareDefines(defines: any, lightIndex: number): void;
  97538. /**
  97539. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  97540. * defined in the generator but impacting the effect).
  97541. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  97542. * @param effect The effect we are binfing the information for
  97543. */
  97544. bindShadowLight(lightIndex: string, effect: Effect): void;
  97545. /**
  97546. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  97547. * (eq to shadow prjection matrix * light transform matrix)
  97548. * @returns The transform matrix used to create the shadow map
  97549. */
  97550. getTransformMatrix(): Matrix;
  97551. /**
  97552. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  97553. * Cube and 2D textures for instance.
  97554. */
  97555. recreateShadowMap(): void;
  97556. protected _disposeBlurPostProcesses(): void;
  97557. protected _disposeRTTandPostProcesses(): void;
  97558. /**
  97559. * Disposes the ShadowGenerator.
  97560. * Returns nothing.
  97561. */
  97562. dispose(): void;
  97563. /**
  97564. * Serializes the shadow generator setup to a json object.
  97565. * @returns The serialized JSON object
  97566. */
  97567. serialize(): any;
  97568. /**
  97569. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  97570. * @param parsedShadowGenerator The JSON object to parse
  97571. * @param scene The scene to create the shadow map for
  97572. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  97573. * @returns The parsed shadow generator
  97574. */
  97575. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  97576. }
  97577. }
  97578. declare module BABYLON {
  97579. /**
  97580. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  97581. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  97582. * 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.
  97583. */
  97584. export abstract class Light extends Node {
  97585. /**
  97586. * Falloff Default: light is falling off following the material specification:
  97587. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  97588. */
  97589. static readonly FALLOFF_DEFAULT: number;
  97590. /**
  97591. * Falloff Physical: light is falling off following the inverse squared distance law.
  97592. */
  97593. static readonly FALLOFF_PHYSICAL: number;
  97594. /**
  97595. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  97596. * to enhance interoperability with other engines.
  97597. */
  97598. static readonly FALLOFF_GLTF: number;
  97599. /**
  97600. * Falloff Standard: light is falling off like in the standard material
  97601. * to enhance interoperability with other materials.
  97602. */
  97603. static readonly FALLOFF_STANDARD: number;
  97604. /**
  97605. * If every light affecting the material is in this lightmapMode,
  97606. * material.lightmapTexture adds or multiplies
  97607. * (depends on material.useLightmapAsShadowmap)
  97608. * after every other light calculations.
  97609. */
  97610. static readonly LIGHTMAP_DEFAULT: number;
  97611. /**
  97612. * material.lightmapTexture as only diffuse lighting from this light
  97613. * adds only specular lighting from this light
  97614. * adds dynamic shadows
  97615. */
  97616. static readonly LIGHTMAP_SPECULAR: number;
  97617. /**
  97618. * material.lightmapTexture as only lighting
  97619. * no light calculation from this light
  97620. * only adds dynamic shadows from this light
  97621. */
  97622. static readonly LIGHTMAP_SHADOWSONLY: number;
  97623. /**
  97624. * Each light type uses the default quantity according to its type:
  97625. * point/spot lights use luminous intensity
  97626. * directional lights use illuminance
  97627. */
  97628. static readonly INTENSITYMODE_AUTOMATIC: number;
  97629. /**
  97630. * lumen (lm)
  97631. */
  97632. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  97633. /**
  97634. * candela (lm/sr)
  97635. */
  97636. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  97637. /**
  97638. * lux (lm/m^2)
  97639. */
  97640. static readonly INTENSITYMODE_ILLUMINANCE: number;
  97641. /**
  97642. * nit (cd/m^2)
  97643. */
  97644. static readonly INTENSITYMODE_LUMINANCE: number;
  97645. /**
  97646. * Light type const id of the point light.
  97647. */
  97648. static readonly LIGHTTYPEID_POINTLIGHT: number;
  97649. /**
  97650. * Light type const id of the directional light.
  97651. */
  97652. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  97653. /**
  97654. * Light type const id of the spot light.
  97655. */
  97656. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  97657. /**
  97658. * Light type const id of the hemispheric light.
  97659. */
  97660. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  97661. /**
  97662. * Diffuse gives the basic color to an object.
  97663. */
  97664. diffuse: Color3;
  97665. /**
  97666. * Specular produces a highlight color on an object.
  97667. * Note: This is note affecting PBR materials.
  97668. */
  97669. specular: Color3;
  97670. /**
  97671. * Defines the falloff type for this light. This lets overrriding how punctual light are
  97672. * falling off base on range or angle.
  97673. * This can be set to any values in Light.FALLOFF_x.
  97674. *
  97675. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  97676. * other types of materials.
  97677. */
  97678. falloffType: number;
  97679. /**
  97680. * Strength of the light.
  97681. * Note: By default it is define in the framework own unit.
  97682. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  97683. */
  97684. intensity: number;
  97685. private _range;
  97686. protected _inverseSquaredRange: number;
  97687. /**
  97688. * Defines how far from the source the light is impacting in scene units.
  97689. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  97690. */
  97691. get range(): number;
  97692. /**
  97693. * Defines how far from the source the light is impacting in scene units.
  97694. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  97695. */
  97696. set range(value: number);
  97697. /**
  97698. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  97699. * of light.
  97700. */
  97701. private _photometricScale;
  97702. private _intensityMode;
  97703. /**
  97704. * Gets the photometric scale used to interpret the intensity.
  97705. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  97706. */
  97707. get intensityMode(): number;
  97708. /**
  97709. * Sets the photometric scale used to interpret the intensity.
  97710. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  97711. */
  97712. set intensityMode(value: number);
  97713. private _radius;
  97714. /**
  97715. * Gets the light radius used by PBR Materials to simulate soft area lights.
  97716. */
  97717. get radius(): number;
  97718. /**
  97719. * sets the light radius used by PBR Materials to simulate soft area lights.
  97720. */
  97721. set radius(value: number);
  97722. private _renderPriority;
  97723. /**
  97724. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  97725. * exceeding the number allowed of the materials.
  97726. */
  97727. renderPriority: number;
  97728. private _shadowEnabled;
  97729. /**
  97730. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  97731. * the current shadow generator.
  97732. */
  97733. get shadowEnabled(): boolean;
  97734. /**
  97735. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  97736. * the current shadow generator.
  97737. */
  97738. set shadowEnabled(value: boolean);
  97739. private _includedOnlyMeshes;
  97740. /**
  97741. * Gets the only meshes impacted by this light.
  97742. */
  97743. get includedOnlyMeshes(): AbstractMesh[];
  97744. /**
  97745. * Sets the only meshes impacted by this light.
  97746. */
  97747. set includedOnlyMeshes(value: AbstractMesh[]);
  97748. private _excludedMeshes;
  97749. /**
  97750. * Gets the meshes not impacted by this light.
  97751. */
  97752. get excludedMeshes(): AbstractMesh[];
  97753. /**
  97754. * Sets the meshes not impacted by this light.
  97755. */
  97756. set excludedMeshes(value: AbstractMesh[]);
  97757. private _excludeWithLayerMask;
  97758. /**
  97759. * Gets the layer id use to find what meshes are not impacted by the light.
  97760. * Inactive if 0
  97761. */
  97762. get excludeWithLayerMask(): number;
  97763. /**
  97764. * Sets the layer id use to find what meshes are not impacted by the light.
  97765. * Inactive if 0
  97766. */
  97767. set excludeWithLayerMask(value: number);
  97768. private _includeOnlyWithLayerMask;
  97769. /**
  97770. * Gets the layer id use to find what meshes are impacted by the light.
  97771. * Inactive if 0
  97772. */
  97773. get includeOnlyWithLayerMask(): number;
  97774. /**
  97775. * Sets the layer id use to find what meshes are impacted by the light.
  97776. * Inactive if 0
  97777. */
  97778. set includeOnlyWithLayerMask(value: number);
  97779. private _lightmapMode;
  97780. /**
  97781. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  97782. */
  97783. get lightmapMode(): number;
  97784. /**
  97785. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  97786. */
  97787. set lightmapMode(value: number);
  97788. /**
  97789. * Shadow generator associted to the light.
  97790. * @hidden Internal use only.
  97791. */
  97792. _shadowGenerator: Nullable<IShadowGenerator>;
  97793. /**
  97794. * @hidden Internal use only.
  97795. */
  97796. _excludedMeshesIds: string[];
  97797. /**
  97798. * @hidden Internal use only.
  97799. */
  97800. _includedOnlyMeshesIds: string[];
  97801. /**
  97802. * The current light unifom buffer.
  97803. * @hidden Internal use only.
  97804. */
  97805. _uniformBuffer: UniformBuffer;
  97806. /** @hidden */
  97807. _renderId: number;
  97808. /**
  97809. * Creates a Light object in the scene.
  97810. * Documentation : https://doc.babylonjs.com/babylon101/lights
  97811. * @param name The firendly name of the light
  97812. * @param scene The scene the light belongs too
  97813. */
  97814. constructor(name: string, scene: Scene);
  97815. protected abstract _buildUniformLayout(): void;
  97816. /**
  97817. * Sets the passed Effect "effect" with the Light information.
  97818. * @param effect The effect to update
  97819. * @param lightIndex The index of the light in the effect to update
  97820. * @returns The light
  97821. */
  97822. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  97823. /**
  97824. * Sets the passed Effect "effect" with the Light textures.
  97825. * @param effect The effect to update
  97826. * @param lightIndex The index of the light in the effect to update
  97827. * @returns The light
  97828. */
  97829. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  97830. /**
  97831. * Binds the lights information from the scene to the effect for the given mesh.
  97832. * @param lightIndex Light index
  97833. * @param scene The scene where the light belongs to
  97834. * @param effect The effect we are binding the data to
  97835. * @param useSpecular Defines if specular is supported
  97836. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  97837. */
  97838. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  97839. /**
  97840. * Sets the passed Effect "effect" with the Light information.
  97841. * @param effect The effect to update
  97842. * @param lightDataUniformName The uniform used to store light data (position or direction)
  97843. * @returns The light
  97844. */
  97845. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  97846. /**
  97847. * Returns the string "Light".
  97848. * @returns the class name
  97849. */
  97850. getClassName(): string;
  97851. /** @hidden */
  97852. readonly _isLight: boolean;
  97853. /**
  97854. * Converts the light information to a readable string for debug purpose.
  97855. * @param fullDetails Supports for multiple levels of logging within scene loading
  97856. * @returns the human readable light info
  97857. */
  97858. toString(fullDetails?: boolean): string;
  97859. /** @hidden */
  97860. protected _syncParentEnabledState(): void;
  97861. /**
  97862. * Set the enabled state of this node.
  97863. * @param value - the new enabled state
  97864. */
  97865. setEnabled(value: boolean): void;
  97866. /**
  97867. * Returns the Light associated shadow generator if any.
  97868. * @return the associated shadow generator.
  97869. */
  97870. getShadowGenerator(): Nullable<IShadowGenerator>;
  97871. /**
  97872. * Returns a Vector3, the absolute light position in the World.
  97873. * @returns the world space position of the light
  97874. */
  97875. getAbsolutePosition(): Vector3;
  97876. /**
  97877. * Specifies if the light will affect the passed mesh.
  97878. * @param mesh The mesh to test against the light
  97879. * @return true the mesh is affected otherwise, false.
  97880. */
  97881. canAffectMesh(mesh: AbstractMesh): boolean;
  97882. /**
  97883. * Sort function to order lights for rendering.
  97884. * @param a First Light object to compare to second.
  97885. * @param b Second Light object to compare first.
  97886. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  97887. */
  97888. static CompareLightsPriority(a: Light, b: Light): number;
  97889. /**
  97890. * Releases resources associated with this node.
  97891. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  97892. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  97893. */
  97894. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  97895. /**
  97896. * Returns the light type ID (integer).
  97897. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  97898. */
  97899. getTypeID(): number;
  97900. /**
  97901. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  97902. * @returns the scaled intensity in intensity mode unit
  97903. */
  97904. getScaledIntensity(): number;
  97905. /**
  97906. * Returns a new Light object, named "name", from the current one.
  97907. * @param name The name of the cloned light
  97908. * @param newParent The parent of this light, if it has one
  97909. * @returns the new created light
  97910. */
  97911. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  97912. /**
  97913. * Serializes the current light into a Serialization object.
  97914. * @returns the serialized object.
  97915. */
  97916. serialize(): any;
  97917. /**
  97918. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  97919. * This new light is named "name" and added to the passed scene.
  97920. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  97921. * @param name The friendly name of the light
  97922. * @param scene The scene the new light will belong to
  97923. * @returns the constructor function
  97924. */
  97925. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  97926. /**
  97927. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  97928. * @param parsedLight The JSON representation of the light
  97929. * @param scene The scene to create the parsed light in
  97930. * @returns the created light after parsing
  97931. */
  97932. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  97933. private _hookArrayForExcluded;
  97934. private _hookArrayForIncludedOnly;
  97935. private _resyncMeshes;
  97936. /**
  97937. * Forces the meshes to update their light related information in their rendering used effects
  97938. * @hidden Internal Use Only
  97939. */
  97940. _markMeshesAsLightDirty(): void;
  97941. /**
  97942. * Recomputes the cached photometric scale if needed.
  97943. */
  97944. private _computePhotometricScale;
  97945. /**
  97946. * Returns the Photometric Scale according to the light type and intensity mode.
  97947. */
  97948. private _getPhotometricScale;
  97949. /**
  97950. * Reorder the light in the scene according to their defined priority.
  97951. * @hidden Internal Use Only
  97952. */
  97953. _reorderLightsInScene(): void;
  97954. /**
  97955. * Prepares the list of defines specific to the light type.
  97956. * @param defines the list of defines
  97957. * @param lightIndex defines the index of the light for the effect
  97958. */
  97959. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  97960. }
  97961. }
  97962. declare module BABYLON {
  97963. /**
  97964. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  97965. * This is the base of the follow, arc rotate cameras and Free camera
  97966. * @see https://doc.babylonjs.com/features/cameras
  97967. */
  97968. export class TargetCamera extends Camera {
  97969. private static _RigCamTransformMatrix;
  97970. private static _TargetTransformMatrix;
  97971. private static _TargetFocalPoint;
  97972. private _tmpUpVector;
  97973. private _tmpTargetVector;
  97974. /**
  97975. * Define the current direction the camera is moving to
  97976. */
  97977. cameraDirection: Vector3;
  97978. /**
  97979. * Define the current rotation the camera is rotating to
  97980. */
  97981. cameraRotation: Vector2;
  97982. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  97983. ignoreParentScaling: boolean;
  97984. /**
  97985. * When set, the up vector of the camera will be updated by the rotation of the camera
  97986. */
  97987. updateUpVectorFromRotation: boolean;
  97988. private _tmpQuaternion;
  97989. /**
  97990. * Define the current rotation of the camera
  97991. */
  97992. rotation: Vector3;
  97993. /**
  97994. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  97995. */
  97996. rotationQuaternion: Quaternion;
  97997. /**
  97998. * Define the current speed of the camera
  97999. */
  98000. speed: number;
  98001. /**
  98002. * Add constraint to the camera to prevent it to move freely in all directions and
  98003. * around all axis.
  98004. */
  98005. noRotationConstraint: boolean;
  98006. /**
  98007. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  98008. * panning
  98009. */
  98010. invertRotation: boolean;
  98011. /**
  98012. * Speed multiplier for inverse camera panning
  98013. */
  98014. inverseRotationSpeed: number;
  98015. /**
  98016. * Define the current target of the camera as an object or a position.
  98017. */
  98018. lockedTarget: any;
  98019. /** @hidden */
  98020. _currentTarget: Vector3;
  98021. /** @hidden */
  98022. _initialFocalDistance: number;
  98023. /** @hidden */
  98024. _viewMatrix: Matrix;
  98025. /** @hidden */
  98026. _camMatrix: Matrix;
  98027. /** @hidden */
  98028. _cameraTransformMatrix: Matrix;
  98029. /** @hidden */
  98030. _cameraRotationMatrix: Matrix;
  98031. /** @hidden */
  98032. _referencePoint: Vector3;
  98033. /** @hidden */
  98034. _transformedReferencePoint: Vector3;
  98035. /** @hidden */
  98036. _reset: () => void;
  98037. private _defaultUp;
  98038. /**
  98039. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  98040. * This is the base of the follow, arc rotate cameras and Free camera
  98041. * @see https://doc.babylonjs.com/features/cameras
  98042. * @param name Defines the name of the camera in the scene
  98043. * @param position Defines the start position of the camera in the scene
  98044. * @param scene Defines the scene the camera belongs to
  98045. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  98046. */
  98047. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  98048. /**
  98049. * Gets the position in front of the camera at a given distance.
  98050. * @param distance The distance from the camera we want the position to be
  98051. * @returns the position
  98052. */
  98053. getFrontPosition(distance: number): Vector3;
  98054. /** @hidden */
  98055. _getLockedTargetPosition(): Nullable<Vector3>;
  98056. private _storedPosition;
  98057. private _storedRotation;
  98058. private _storedRotationQuaternion;
  98059. /**
  98060. * Store current camera state of the camera (fov, position, rotation, etc..)
  98061. * @returns the camera
  98062. */
  98063. storeState(): Camera;
  98064. /**
  98065. * Restored camera state. You must call storeState() first
  98066. * @returns whether it was successful or not
  98067. * @hidden
  98068. */
  98069. _restoreStateValues(): boolean;
  98070. /** @hidden */
  98071. _initCache(): void;
  98072. /** @hidden */
  98073. _updateCache(ignoreParentClass?: boolean): void;
  98074. /** @hidden */
  98075. _isSynchronizedViewMatrix(): boolean;
  98076. /** @hidden */
  98077. _computeLocalCameraSpeed(): number;
  98078. /**
  98079. * Defines the target the camera should look at.
  98080. * @param target Defines the new target as a Vector or a mesh
  98081. */
  98082. setTarget(target: Vector3): void;
  98083. /**
  98084. * Defines the target point of the camera.
  98085. * The camera looks towards it form the radius distance.
  98086. */
  98087. get target(): Vector3;
  98088. set target(value: Vector3);
  98089. /**
  98090. * Return the current target position of the camera. This value is expressed in local space.
  98091. * @returns the target position
  98092. */
  98093. getTarget(): Vector3;
  98094. /** @hidden */
  98095. _decideIfNeedsToMove(): boolean;
  98096. /** @hidden */
  98097. _updatePosition(): void;
  98098. /** @hidden */
  98099. _checkInputs(): void;
  98100. protected _updateCameraRotationMatrix(): void;
  98101. /**
  98102. * 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)
  98103. * @returns the current camera
  98104. */
  98105. private _rotateUpVectorWithCameraRotationMatrix;
  98106. private _cachedRotationZ;
  98107. private _cachedQuaternionRotationZ;
  98108. /** @hidden */
  98109. _getViewMatrix(): Matrix;
  98110. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  98111. /**
  98112. * @hidden
  98113. */
  98114. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  98115. /**
  98116. * @hidden
  98117. */
  98118. _updateRigCameras(): void;
  98119. private _getRigCamPositionAndTarget;
  98120. /**
  98121. * Gets the current object class name.
  98122. * @return the class name
  98123. */
  98124. getClassName(): string;
  98125. }
  98126. }
  98127. declare module BABYLON {
  98128. /**
  98129. * Gather the list of keyboard event types as constants.
  98130. */
  98131. export class KeyboardEventTypes {
  98132. /**
  98133. * The keydown event is fired when a key becomes active (pressed).
  98134. */
  98135. static readonly KEYDOWN: number;
  98136. /**
  98137. * The keyup event is fired when a key has been released.
  98138. */
  98139. static readonly KEYUP: number;
  98140. }
  98141. /**
  98142. * This class is used to store keyboard related info for the onKeyboardObservable event.
  98143. */
  98144. export class KeyboardInfo {
  98145. /**
  98146. * Defines the type of event (KeyboardEventTypes)
  98147. */
  98148. type: number;
  98149. /**
  98150. * Defines the related dom event
  98151. */
  98152. event: KeyboardEvent;
  98153. /**
  98154. * Instantiates a new keyboard info.
  98155. * This class is used to store keyboard related info for the onKeyboardObservable event.
  98156. * @param type Defines the type of event (KeyboardEventTypes)
  98157. * @param event Defines the related dom event
  98158. */
  98159. constructor(
  98160. /**
  98161. * Defines the type of event (KeyboardEventTypes)
  98162. */
  98163. type: number,
  98164. /**
  98165. * Defines the related dom event
  98166. */
  98167. event: KeyboardEvent);
  98168. }
  98169. /**
  98170. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  98171. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  98172. */
  98173. export class KeyboardInfoPre extends KeyboardInfo {
  98174. /**
  98175. * Defines the type of event (KeyboardEventTypes)
  98176. */
  98177. type: number;
  98178. /**
  98179. * Defines the related dom event
  98180. */
  98181. event: KeyboardEvent;
  98182. /**
  98183. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  98184. */
  98185. skipOnPointerObservable: boolean;
  98186. /**
  98187. * Instantiates a new keyboard pre info.
  98188. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  98189. * @param type Defines the type of event (KeyboardEventTypes)
  98190. * @param event Defines the related dom event
  98191. */
  98192. constructor(
  98193. /**
  98194. * Defines the type of event (KeyboardEventTypes)
  98195. */
  98196. type: number,
  98197. /**
  98198. * Defines the related dom event
  98199. */
  98200. event: KeyboardEvent);
  98201. }
  98202. }
  98203. declare module BABYLON {
  98204. /**
  98205. * Manage the keyboard inputs to control the movement of a free camera.
  98206. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98207. */
  98208. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  98209. /**
  98210. * Defines the camera the input is attached to.
  98211. */
  98212. camera: FreeCamera;
  98213. /**
  98214. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  98215. */
  98216. keysUp: number[];
  98217. /**
  98218. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  98219. */
  98220. keysUpward: number[];
  98221. /**
  98222. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  98223. */
  98224. keysDown: number[];
  98225. /**
  98226. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  98227. */
  98228. keysDownward: number[];
  98229. /**
  98230. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  98231. */
  98232. keysLeft: number[];
  98233. /**
  98234. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  98235. */
  98236. keysRight: number[];
  98237. private _keys;
  98238. private _onCanvasBlurObserver;
  98239. private _onKeyboardObserver;
  98240. private _engine;
  98241. private _scene;
  98242. /**
  98243. * Attach the input controls to a specific dom element to get the input from.
  98244. * @param element Defines the element the controls should be listened from
  98245. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98246. */
  98247. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98248. /**
  98249. * Detach the current controls from the specified dom element.
  98250. * @param element Defines the element to stop listening the inputs from
  98251. */
  98252. detachControl(element: Nullable<HTMLElement>): void;
  98253. /**
  98254. * Update the current camera state depending on the inputs that have been used this frame.
  98255. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  98256. */
  98257. checkInputs(): void;
  98258. /**
  98259. * Gets the class name of the current intput.
  98260. * @returns the class name
  98261. */
  98262. getClassName(): string;
  98263. /** @hidden */
  98264. _onLostFocus(): void;
  98265. /**
  98266. * Get the friendly name associated with the input class.
  98267. * @returns the input friendly name
  98268. */
  98269. getSimpleName(): string;
  98270. }
  98271. }
  98272. declare module BABYLON {
  98273. /**
  98274. * Gather the list of pointer event types as constants.
  98275. */
  98276. export class PointerEventTypes {
  98277. /**
  98278. * 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.
  98279. */
  98280. static readonly POINTERDOWN: number;
  98281. /**
  98282. * The pointerup event is fired when a pointer is no longer active.
  98283. */
  98284. static readonly POINTERUP: number;
  98285. /**
  98286. * The pointermove event is fired when a pointer changes coordinates.
  98287. */
  98288. static readonly POINTERMOVE: number;
  98289. /**
  98290. * The pointerwheel event is fired when a mouse wheel has been rotated.
  98291. */
  98292. static readonly POINTERWHEEL: number;
  98293. /**
  98294. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  98295. */
  98296. static readonly POINTERPICK: number;
  98297. /**
  98298. * The pointertap event is fired when a the object has been touched and released without drag.
  98299. */
  98300. static readonly POINTERTAP: number;
  98301. /**
  98302. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  98303. */
  98304. static readonly POINTERDOUBLETAP: number;
  98305. }
  98306. /**
  98307. * Base class of pointer info types.
  98308. */
  98309. export class PointerInfoBase {
  98310. /**
  98311. * Defines the type of event (PointerEventTypes)
  98312. */
  98313. type: number;
  98314. /**
  98315. * Defines the related dom event
  98316. */
  98317. event: PointerEvent | MouseWheelEvent;
  98318. /**
  98319. * Instantiates the base class of pointers info.
  98320. * @param type Defines the type of event (PointerEventTypes)
  98321. * @param event Defines the related dom event
  98322. */
  98323. constructor(
  98324. /**
  98325. * Defines the type of event (PointerEventTypes)
  98326. */
  98327. type: number,
  98328. /**
  98329. * Defines the related dom event
  98330. */
  98331. event: PointerEvent | MouseWheelEvent);
  98332. }
  98333. /**
  98334. * This class is used to store pointer related info for the onPrePointerObservable event.
  98335. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  98336. */
  98337. export class PointerInfoPre extends PointerInfoBase {
  98338. /**
  98339. * Ray from a pointer if availible (eg. 6dof controller)
  98340. */
  98341. ray: Nullable<Ray>;
  98342. /**
  98343. * Defines the local position of the pointer on the canvas.
  98344. */
  98345. localPosition: Vector2;
  98346. /**
  98347. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  98348. */
  98349. skipOnPointerObservable: boolean;
  98350. /**
  98351. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  98352. * @param type Defines the type of event (PointerEventTypes)
  98353. * @param event Defines the related dom event
  98354. * @param localX Defines the local x coordinates of the pointer when the event occured
  98355. * @param localY Defines the local y coordinates of the pointer when the event occured
  98356. */
  98357. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  98358. }
  98359. /**
  98360. * This type contains all the data related to a pointer event in Babylon.js.
  98361. * 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.
  98362. */
  98363. export class PointerInfo extends PointerInfoBase {
  98364. /**
  98365. * Defines the picking info associated to the info (if any)\
  98366. */
  98367. pickInfo: Nullable<PickingInfo>;
  98368. /**
  98369. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  98370. * @param type Defines the type of event (PointerEventTypes)
  98371. * @param event Defines the related dom event
  98372. * @param pickInfo Defines the picking info associated to the info (if any)\
  98373. */
  98374. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  98375. /**
  98376. * Defines the picking info associated to the info (if any)\
  98377. */
  98378. pickInfo: Nullable<PickingInfo>);
  98379. }
  98380. /**
  98381. * Data relating to a touch event on the screen.
  98382. */
  98383. export interface PointerTouch {
  98384. /**
  98385. * X coordinate of touch.
  98386. */
  98387. x: number;
  98388. /**
  98389. * Y coordinate of touch.
  98390. */
  98391. y: number;
  98392. /**
  98393. * Id of touch. Unique for each finger.
  98394. */
  98395. pointerId: number;
  98396. /**
  98397. * Event type passed from DOM.
  98398. */
  98399. type: any;
  98400. }
  98401. }
  98402. declare module BABYLON {
  98403. /**
  98404. * Manage the mouse inputs to control the movement of a free camera.
  98405. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98406. */
  98407. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  98408. /**
  98409. * Define if touch is enabled in the mouse input
  98410. */
  98411. touchEnabled: boolean;
  98412. /**
  98413. * Defines the camera the input is attached to.
  98414. */
  98415. camera: FreeCamera;
  98416. /**
  98417. * Defines the buttons associated with the input to handle camera move.
  98418. */
  98419. buttons: number[];
  98420. /**
  98421. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  98422. */
  98423. angularSensibility: number;
  98424. private _pointerInput;
  98425. private _onMouseMove;
  98426. private _observer;
  98427. private previousPosition;
  98428. /**
  98429. * Observable for when a pointer move event occurs containing the move offset
  98430. */
  98431. onPointerMovedObservable: Observable<{
  98432. offsetX: number;
  98433. offsetY: number;
  98434. }>;
  98435. /**
  98436. * @hidden
  98437. * If the camera should be rotated automatically based on pointer movement
  98438. */
  98439. _allowCameraRotation: boolean;
  98440. /**
  98441. * Manage the mouse inputs to control the movement of a free camera.
  98442. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98443. * @param touchEnabled Defines if touch is enabled or not
  98444. */
  98445. constructor(
  98446. /**
  98447. * Define if touch is enabled in the mouse input
  98448. */
  98449. touchEnabled?: boolean);
  98450. /**
  98451. * Attach the input controls to a specific dom element to get the input from.
  98452. * @param element Defines the element the controls should be listened from
  98453. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98454. */
  98455. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98456. /**
  98457. * Called on JS contextmenu event.
  98458. * Override this method to provide functionality.
  98459. */
  98460. protected onContextMenu(evt: PointerEvent): void;
  98461. /**
  98462. * Detach the current controls from the specified dom element.
  98463. * @param element Defines the element to stop listening the inputs from
  98464. */
  98465. detachControl(element: Nullable<HTMLElement>): void;
  98466. /**
  98467. * Gets the class name of the current intput.
  98468. * @returns the class name
  98469. */
  98470. getClassName(): string;
  98471. /**
  98472. * Get the friendly name associated with the input class.
  98473. * @returns the input friendly name
  98474. */
  98475. getSimpleName(): string;
  98476. }
  98477. }
  98478. declare module BABYLON {
  98479. /**
  98480. * Manage the touch inputs to control the movement of a free camera.
  98481. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98482. */
  98483. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  98484. /**
  98485. * Define if mouse events can be treated as touch events
  98486. */
  98487. allowMouse: boolean;
  98488. /**
  98489. * Defines the camera the input is attached to.
  98490. */
  98491. camera: FreeCamera;
  98492. /**
  98493. * Defines the touch sensibility for rotation.
  98494. * The higher the faster.
  98495. */
  98496. touchAngularSensibility: number;
  98497. /**
  98498. * Defines the touch sensibility for move.
  98499. * The higher the faster.
  98500. */
  98501. touchMoveSensibility: number;
  98502. private _offsetX;
  98503. private _offsetY;
  98504. private _pointerPressed;
  98505. private _pointerInput;
  98506. private _observer;
  98507. private _onLostFocus;
  98508. /**
  98509. * Manage the touch inputs to control the movement of a free camera.
  98510. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98511. * @param allowMouse Defines if mouse events can be treated as touch events
  98512. */
  98513. constructor(
  98514. /**
  98515. * Define if mouse events can be treated as touch events
  98516. */
  98517. allowMouse?: boolean);
  98518. /**
  98519. * Attach the input controls to a specific dom element to get the input from.
  98520. * @param element Defines the element the controls should be listened from
  98521. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98522. */
  98523. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98524. /**
  98525. * Detach the current controls from the specified dom element.
  98526. * @param element Defines the element to stop listening the inputs from
  98527. */
  98528. detachControl(element: Nullable<HTMLElement>): void;
  98529. /**
  98530. * Update the current camera state depending on the inputs that have been used this frame.
  98531. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  98532. */
  98533. checkInputs(): void;
  98534. /**
  98535. * Gets the class name of the current intput.
  98536. * @returns the class name
  98537. */
  98538. getClassName(): string;
  98539. /**
  98540. * Get the friendly name associated with the input class.
  98541. * @returns the input friendly name
  98542. */
  98543. getSimpleName(): string;
  98544. }
  98545. }
  98546. declare module BABYLON {
  98547. /**
  98548. * Default Inputs manager for the FreeCamera.
  98549. * It groups all the default supported inputs for ease of use.
  98550. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98551. */
  98552. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  98553. /**
  98554. * @hidden
  98555. */
  98556. _mouseInput: Nullable<FreeCameraMouseInput>;
  98557. /**
  98558. * Instantiates a new FreeCameraInputsManager.
  98559. * @param camera Defines the camera the inputs belong to
  98560. */
  98561. constructor(camera: FreeCamera);
  98562. /**
  98563. * Add keyboard input support to the input manager.
  98564. * @returns the current input manager
  98565. */
  98566. addKeyboard(): FreeCameraInputsManager;
  98567. /**
  98568. * Add mouse input support to the input manager.
  98569. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  98570. * @returns the current input manager
  98571. */
  98572. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  98573. /**
  98574. * Removes the mouse input support from the manager
  98575. * @returns the current input manager
  98576. */
  98577. removeMouse(): FreeCameraInputsManager;
  98578. /**
  98579. * Add touch input support to the input manager.
  98580. * @returns the current input manager
  98581. */
  98582. addTouch(): FreeCameraInputsManager;
  98583. /**
  98584. * Remove all attached input methods from a camera
  98585. */
  98586. clear(): void;
  98587. }
  98588. }
  98589. declare module BABYLON {
  98590. /**
  98591. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  98592. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  98593. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  98594. */
  98595. export class FreeCamera extends TargetCamera {
  98596. /**
  98597. * Define the collision ellipsoid of the camera.
  98598. * This is helpful to simulate a camera body like the player body around the camera
  98599. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  98600. */
  98601. ellipsoid: Vector3;
  98602. /**
  98603. * Define an offset for the position of the ellipsoid around the camera.
  98604. * This can be helpful to determine the center of the body near the gravity center of the body
  98605. * instead of its head.
  98606. */
  98607. ellipsoidOffset: Vector3;
  98608. /**
  98609. * Enable or disable collisions of the camera with the rest of the scene objects.
  98610. */
  98611. checkCollisions: boolean;
  98612. /**
  98613. * Enable or disable gravity on the camera.
  98614. */
  98615. applyGravity: boolean;
  98616. /**
  98617. * Define the input manager associated to the camera.
  98618. */
  98619. inputs: FreeCameraInputsManager;
  98620. /**
  98621. * Gets the input sensibility for a mouse input. (default is 2000.0)
  98622. * Higher values reduce sensitivity.
  98623. */
  98624. get angularSensibility(): number;
  98625. /**
  98626. * Sets the input sensibility for a mouse input. (default is 2000.0)
  98627. * Higher values reduce sensitivity.
  98628. */
  98629. set angularSensibility(value: number);
  98630. /**
  98631. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  98632. */
  98633. get keysUp(): number[];
  98634. set keysUp(value: number[]);
  98635. /**
  98636. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  98637. */
  98638. get keysUpward(): number[];
  98639. set keysUpward(value: number[]);
  98640. /**
  98641. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  98642. */
  98643. get keysDown(): number[];
  98644. set keysDown(value: number[]);
  98645. /**
  98646. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  98647. */
  98648. get keysDownward(): number[];
  98649. set keysDownward(value: number[]);
  98650. /**
  98651. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  98652. */
  98653. get keysLeft(): number[];
  98654. set keysLeft(value: number[]);
  98655. /**
  98656. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  98657. */
  98658. get keysRight(): number[];
  98659. set keysRight(value: number[]);
  98660. /**
  98661. * Event raised when the camera collide with a mesh in the scene.
  98662. */
  98663. onCollide: (collidedMesh: AbstractMesh) => void;
  98664. private _collider;
  98665. private _needMoveForGravity;
  98666. private _oldPosition;
  98667. private _diffPosition;
  98668. private _newPosition;
  98669. /** @hidden */
  98670. _localDirection: Vector3;
  98671. /** @hidden */
  98672. _transformedDirection: Vector3;
  98673. /**
  98674. * Instantiates a Free Camera.
  98675. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  98676. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  98677. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  98678. * @param name Define the name of the camera in the scene
  98679. * @param position Define the start position of the camera in the scene
  98680. * @param scene Define the scene the camera belongs to
  98681. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  98682. */
  98683. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  98684. /**
  98685. * Attached controls to the current camera.
  98686. * @param element Defines the element the controls should be listened from
  98687. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98688. */
  98689. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98690. /**
  98691. * Detach the current controls from the camera.
  98692. * The camera will stop reacting to inputs.
  98693. * @param element Defines the element to stop listening the inputs from
  98694. */
  98695. detachControl(element: HTMLElement): void;
  98696. private _collisionMask;
  98697. /**
  98698. * Define a collision mask to limit the list of object the camera can collide with
  98699. */
  98700. get collisionMask(): number;
  98701. set collisionMask(mask: number);
  98702. /** @hidden */
  98703. _collideWithWorld(displacement: Vector3): void;
  98704. private _onCollisionPositionChange;
  98705. /** @hidden */
  98706. _checkInputs(): void;
  98707. /** @hidden */
  98708. _decideIfNeedsToMove(): boolean;
  98709. /** @hidden */
  98710. _updatePosition(): void;
  98711. /**
  98712. * Destroy the camera and release the current resources hold by it.
  98713. */
  98714. dispose(): void;
  98715. /**
  98716. * Gets the current object class name.
  98717. * @return the class name
  98718. */
  98719. getClassName(): string;
  98720. }
  98721. }
  98722. declare module BABYLON {
  98723. /**
  98724. * Represents a gamepad control stick position
  98725. */
  98726. export class StickValues {
  98727. /**
  98728. * The x component of the control stick
  98729. */
  98730. x: number;
  98731. /**
  98732. * The y component of the control stick
  98733. */
  98734. y: number;
  98735. /**
  98736. * Initializes the gamepad x and y control stick values
  98737. * @param x The x component of the gamepad control stick value
  98738. * @param y The y component of the gamepad control stick value
  98739. */
  98740. constructor(
  98741. /**
  98742. * The x component of the control stick
  98743. */
  98744. x: number,
  98745. /**
  98746. * The y component of the control stick
  98747. */
  98748. y: number);
  98749. }
  98750. /**
  98751. * An interface which manages callbacks for gamepad button changes
  98752. */
  98753. export interface GamepadButtonChanges {
  98754. /**
  98755. * Called when a gamepad has been changed
  98756. */
  98757. changed: boolean;
  98758. /**
  98759. * Called when a gamepad press event has been triggered
  98760. */
  98761. pressChanged: boolean;
  98762. /**
  98763. * Called when a touch event has been triggered
  98764. */
  98765. touchChanged: boolean;
  98766. /**
  98767. * Called when a value has changed
  98768. */
  98769. valueChanged: boolean;
  98770. }
  98771. /**
  98772. * Represents a gamepad
  98773. */
  98774. export class Gamepad {
  98775. /**
  98776. * The id of the gamepad
  98777. */
  98778. id: string;
  98779. /**
  98780. * The index of the gamepad
  98781. */
  98782. index: number;
  98783. /**
  98784. * The browser gamepad
  98785. */
  98786. browserGamepad: any;
  98787. /**
  98788. * Specifies what type of gamepad this represents
  98789. */
  98790. type: number;
  98791. private _leftStick;
  98792. private _rightStick;
  98793. /** @hidden */
  98794. _isConnected: boolean;
  98795. private _leftStickAxisX;
  98796. private _leftStickAxisY;
  98797. private _rightStickAxisX;
  98798. private _rightStickAxisY;
  98799. /**
  98800. * Triggered when the left control stick has been changed
  98801. */
  98802. private _onleftstickchanged;
  98803. /**
  98804. * Triggered when the right control stick has been changed
  98805. */
  98806. private _onrightstickchanged;
  98807. /**
  98808. * Represents a gamepad controller
  98809. */
  98810. static GAMEPAD: number;
  98811. /**
  98812. * Represents a generic controller
  98813. */
  98814. static GENERIC: number;
  98815. /**
  98816. * Represents an XBox controller
  98817. */
  98818. static XBOX: number;
  98819. /**
  98820. * Represents a pose-enabled controller
  98821. */
  98822. static POSE_ENABLED: number;
  98823. /**
  98824. * Represents an Dual Shock controller
  98825. */
  98826. static DUALSHOCK: number;
  98827. /**
  98828. * Specifies whether the left control stick should be Y-inverted
  98829. */
  98830. protected _invertLeftStickY: boolean;
  98831. /**
  98832. * Specifies if the gamepad has been connected
  98833. */
  98834. get isConnected(): boolean;
  98835. /**
  98836. * Initializes the gamepad
  98837. * @param id The id of the gamepad
  98838. * @param index The index of the gamepad
  98839. * @param browserGamepad The browser gamepad
  98840. * @param leftStickX The x component of the left joystick
  98841. * @param leftStickY The y component of the left joystick
  98842. * @param rightStickX The x component of the right joystick
  98843. * @param rightStickY The y component of the right joystick
  98844. */
  98845. constructor(
  98846. /**
  98847. * The id of the gamepad
  98848. */
  98849. id: string,
  98850. /**
  98851. * The index of the gamepad
  98852. */
  98853. index: number,
  98854. /**
  98855. * The browser gamepad
  98856. */
  98857. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  98858. /**
  98859. * Callback triggered when the left joystick has changed
  98860. * @param callback
  98861. */
  98862. onleftstickchanged(callback: (values: StickValues) => void): void;
  98863. /**
  98864. * Callback triggered when the right joystick has changed
  98865. * @param callback
  98866. */
  98867. onrightstickchanged(callback: (values: StickValues) => void): void;
  98868. /**
  98869. * Gets the left joystick
  98870. */
  98871. get leftStick(): StickValues;
  98872. /**
  98873. * Sets the left joystick values
  98874. */
  98875. set leftStick(newValues: StickValues);
  98876. /**
  98877. * Gets the right joystick
  98878. */
  98879. get rightStick(): StickValues;
  98880. /**
  98881. * Sets the right joystick value
  98882. */
  98883. set rightStick(newValues: StickValues);
  98884. /**
  98885. * Updates the gamepad joystick positions
  98886. */
  98887. update(): void;
  98888. /**
  98889. * Disposes the gamepad
  98890. */
  98891. dispose(): void;
  98892. }
  98893. /**
  98894. * Represents a generic gamepad
  98895. */
  98896. export class GenericPad extends Gamepad {
  98897. private _buttons;
  98898. private _onbuttondown;
  98899. private _onbuttonup;
  98900. /**
  98901. * Observable triggered when a button has been pressed
  98902. */
  98903. onButtonDownObservable: Observable<number>;
  98904. /**
  98905. * Observable triggered when a button has been released
  98906. */
  98907. onButtonUpObservable: Observable<number>;
  98908. /**
  98909. * Callback triggered when a button has been pressed
  98910. * @param callback Called when a button has been pressed
  98911. */
  98912. onbuttondown(callback: (buttonPressed: number) => void): void;
  98913. /**
  98914. * Callback triggered when a button has been released
  98915. * @param callback Called when a button has been released
  98916. */
  98917. onbuttonup(callback: (buttonReleased: number) => void): void;
  98918. /**
  98919. * Initializes the generic gamepad
  98920. * @param id The id of the generic gamepad
  98921. * @param index The index of the generic gamepad
  98922. * @param browserGamepad The browser gamepad
  98923. */
  98924. constructor(id: string, index: number, browserGamepad: any);
  98925. private _setButtonValue;
  98926. /**
  98927. * Updates the generic gamepad
  98928. */
  98929. update(): void;
  98930. /**
  98931. * Disposes the generic gamepad
  98932. */
  98933. dispose(): void;
  98934. }
  98935. }
  98936. declare module BABYLON {
  98937. /**
  98938. * Defines the types of pose enabled controllers that are supported
  98939. */
  98940. export enum PoseEnabledControllerType {
  98941. /**
  98942. * HTC Vive
  98943. */
  98944. VIVE = 0,
  98945. /**
  98946. * Oculus Rift
  98947. */
  98948. OCULUS = 1,
  98949. /**
  98950. * Windows mixed reality
  98951. */
  98952. WINDOWS = 2,
  98953. /**
  98954. * Samsung gear VR
  98955. */
  98956. GEAR_VR = 3,
  98957. /**
  98958. * Google Daydream
  98959. */
  98960. DAYDREAM = 4,
  98961. /**
  98962. * Generic
  98963. */
  98964. GENERIC = 5
  98965. }
  98966. /**
  98967. * Defines the MutableGamepadButton interface for the state of a gamepad button
  98968. */
  98969. export interface MutableGamepadButton {
  98970. /**
  98971. * Value of the button/trigger
  98972. */
  98973. value: number;
  98974. /**
  98975. * If the button/trigger is currently touched
  98976. */
  98977. touched: boolean;
  98978. /**
  98979. * If the button/trigger is currently pressed
  98980. */
  98981. pressed: boolean;
  98982. }
  98983. /**
  98984. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  98985. * @hidden
  98986. */
  98987. export interface ExtendedGamepadButton extends GamepadButton {
  98988. /**
  98989. * If the button/trigger is currently pressed
  98990. */
  98991. readonly pressed: boolean;
  98992. /**
  98993. * If the button/trigger is currently touched
  98994. */
  98995. readonly touched: boolean;
  98996. /**
  98997. * Value of the button/trigger
  98998. */
  98999. readonly value: number;
  99000. }
  99001. /** @hidden */
  99002. export interface _GamePadFactory {
  99003. /**
  99004. * Returns whether or not the current gamepad can be created for this type of controller.
  99005. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  99006. * @returns true if it can be created, otherwise false
  99007. */
  99008. canCreate(gamepadInfo: any): boolean;
  99009. /**
  99010. * Creates a new instance of the Gamepad.
  99011. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  99012. * @returns the new gamepad instance
  99013. */
  99014. create(gamepadInfo: any): Gamepad;
  99015. }
  99016. /**
  99017. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  99018. */
  99019. export class PoseEnabledControllerHelper {
  99020. /** @hidden */
  99021. static _ControllerFactories: _GamePadFactory[];
  99022. /** @hidden */
  99023. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  99024. /**
  99025. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  99026. * @param vrGamepad the gamepad to initialized
  99027. * @returns a vr controller of the type the gamepad identified as
  99028. */
  99029. static InitiateController(vrGamepad: any): Gamepad;
  99030. }
  99031. /**
  99032. * Defines the PoseEnabledController object that contains state of a vr capable controller
  99033. */
  99034. export class PoseEnabledController extends Gamepad implements PoseControlled {
  99035. /**
  99036. * If the controller is used in a webXR session
  99037. */
  99038. isXR: boolean;
  99039. private _deviceRoomPosition;
  99040. private _deviceRoomRotationQuaternion;
  99041. /**
  99042. * The device position in babylon space
  99043. */
  99044. devicePosition: Vector3;
  99045. /**
  99046. * The device rotation in babylon space
  99047. */
  99048. deviceRotationQuaternion: Quaternion;
  99049. /**
  99050. * The scale factor of the device in babylon space
  99051. */
  99052. deviceScaleFactor: number;
  99053. /**
  99054. * (Likely devicePosition should be used instead) The device position in its room space
  99055. */
  99056. position: Vector3;
  99057. /**
  99058. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  99059. */
  99060. rotationQuaternion: Quaternion;
  99061. /**
  99062. * The type of controller (Eg. Windows mixed reality)
  99063. */
  99064. controllerType: PoseEnabledControllerType;
  99065. protected _calculatedPosition: Vector3;
  99066. private _calculatedRotation;
  99067. /**
  99068. * The raw pose from the device
  99069. */
  99070. rawPose: DevicePose;
  99071. private _trackPosition;
  99072. private _maxRotationDistFromHeadset;
  99073. private _draggedRoomRotation;
  99074. /**
  99075. * @hidden
  99076. */
  99077. _disableTrackPosition(fixedPosition: Vector3): void;
  99078. /**
  99079. * Internal, the mesh attached to the controller
  99080. * @hidden
  99081. */
  99082. _mesh: Nullable<AbstractMesh>;
  99083. private _poseControlledCamera;
  99084. private _leftHandSystemQuaternion;
  99085. /**
  99086. * Internal, matrix used to convert room space to babylon space
  99087. * @hidden
  99088. */
  99089. _deviceToWorld: Matrix;
  99090. /**
  99091. * Node to be used when casting a ray from the controller
  99092. * @hidden
  99093. */
  99094. _pointingPoseNode: Nullable<TransformNode>;
  99095. /**
  99096. * Name of the child mesh that can be used to cast a ray from the controller
  99097. */
  99098. static readonly POINTING_POSE: string;
  99099. /**
  99100. * Creates a new PoseEnabledController from a gamepad
  99101. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  99102. */
  99103. constructor(browserGamepad: any);
  99104. private _workingMatrix;
  99105. /**
  99106. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  99107. */
  99108. update(): void;
  99109. /**
  99110. * Updates only the pose device and mesh without doing any button event checking
  99111. */
  99112. protected _updatePoseAndMesh(): void;
  99113. /**
  99114. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  99115. * @param poseData raw pose fromthe device
  99116. */
  99117. updateFromDevice(poseData: DevicePose): void;
  99118. /**
  99119. * @hidden
  99120. */
  99121. _meshAttachedObservable: Observable<AbstractMesh>;
  99122. /**
  99123. * Attaches a mesh to the controller
  99124. * @param mesh the mesh to be attached
  99125. */
  99126. attachToMesh(mesh: AbstractMesh): void;
  99127. /**
  99128. * Attaches the controllers mesh to a camera
  99129. * @param camera the camera the mesh should be attached to
  99130. */
  99131. attachToPoseControlledCamera(camera: TargetCamera): void;
  99132. /**
  99133. * Disposes of the controller
  99134. */
  99135. dispose(): void;
  99136. /**
  99137. * The mesh that is attached to the controller
  99138. */
  99139. get mesh(): Nullable<AbstractMesh>;
  99140. /**
  99141. * Gets the ray of the controller in the direction the controller is pointing
  99142. * @param length the length the resulting ray should be
  99143. * @returns a ray in the direction the controller is pointing
  99144. */
  99145. getForwardRay(length?: number): Ray;
  99146. }
  99147. }
  99148. declare module BABYLON {
  99149. /**
  99150. * Defines the WebVRController object that represents controllers tracked in 3D space
  99151. */
  99152. export abstract class WebVRController extends PoseEnabledController {
  99153. /**
  99154. * Internal, the default controller model for the controller
  99155. */
  99156. protected _defaultModel: Nullable<AbstractMesh>;
  99157. /**
  99158. * Fired when the trigger state has changed
  99159. */
  99160. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  99161. /**
  99162. * Fired when the main button state has changed
  99163. */
  99164. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  99165. /**
  99166. * Fired when the secondary button state has changed
  99167. */
  99168. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  99169. /**
  99170. * Fired when the pad state has changed
  99171. */
  99172. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  99173. /**
  99174. * Fired when controllers stick values have changed
  99175. */
  99176. onPadValuesChangedObservable: Observable<StickValues>;
  99177. /**
  99178. * Array of button availible on the controller
  99179. */
  99180. protected _buttons: Array<MutableGamepadButton>;
  99181. private _onButtonStateChange;
  99182. /**
  99183. * Fired when a controller button's state has changed
  99184. * @param callback the callback containing the button that was modified
  99185. */
  99186. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  99187. /**
  99188. * X and Y axis corresponding to the controllers joystick
  99189. */
  99190. pad: StickValues;
  99191. /**
  99192. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  99193. */
  99194. hand: string;
  99195. /**
  99196. * The default controller model for the controller
  99197. */
  99198. get defaultModel(): Nullable<AbstractMesh>;
  99199. /**
  99200. * Creates a new WebVRController from a gamepad
  99201. * @param vrGamepad the gamepad that the WebVRController should be created from
  99202. */
  99203. constructor(vrGamepad: any);
  99204. /**
  99205. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  99206. */
  99207. update(): void;
  99208. /**
  99209. * Function to be called when a button is modified
  99210. */
  99211. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  99212. /**
  99213. * Loads a mesh and attaches it to the controller
  99214. * @param scene the scene the mesh should be added to
  99215. * @param meshLoaded callback for when the mesh has been loaded
  99216. */
  99217. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  99218. private _setButtonValue;
  99219. private _changes;
  99220. private _checkChanges;
  99221. /**
  99222. * Disposes of th webVRCOntroller
  99223. */
  99224. dispose(): void;
  99225. }
  99226. }
  99227. declare module BABYLON {
  99228. /**
  99229. * The HemisphericLight simulates the ambient environment light,
  99230. * so the passed direction is the light reflection direction, not the incoming direction.
  99231. */
  99232. export class HemisphericLight extends Light {
  99233. /**
  99234. * The groundColor is the light in the opposite direction to the one specified during creation.
  99235. * 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.
  99236. */
  99237. groundColor: Color3;
  99238. /**
  99239. * The light reflection direction, not the incoming direction.
  99240. */
  99241. direction: Vector3;
  99242. /**
  99243. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  99244. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  99245. * The HemisphericLight can't cast shadows.
  99246. * Documentation : https://doc.babylonjs.com/babylon101/lights
  99247. * @param name The friendly name of the light
  99248. * @param direction The direction of the light reflection
  99249. * @param scene The scene the light belongs to
  99250. */
  99251. constructor(name: string, direction: Vector3, scene: Scene);
  99252. protected _buildUniformLayout(): void;
  99253. /**
  99254. * Returns the string "HemisphericLight".
  99255. * @return The class name
  99256. */
  99257. getClassName(): string;
  99258. /**
  99259. * Sets the HemisphericLight direction towards the passed target (Vector3).
  99260. * Returns the updated direction.
  99261. * @param target The target the direction should point to
  99262. * @return The computed direction
  99263. */
  99264. setDirectionToTarget(target: Vector3): Vector3;
  99265. /**
  99266. * Returns the shadow generator associated to the light.
  99267. * @returns Always null for hemispheric lights because it does not support shadows.
  99268. */
  99269. getShadowGenerator(): Nullable<IShadowGenerator>;
  99270. /**
  99271. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  99272. * @param effect The effect to update
  99273. * @param lightIndex The index of the light in the effect to update
  99274. * @returns The hemispheric light
  99275. */
  99276. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  99277. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  99278. /**
  99279. * Computes the world matrix of the node
  99280. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  99281. * @param useWasUpdatedFlag defines a reserved property
  99282. * @returns the world matrix
  99283. */
  99284. computeWorldMatrix(): Matrix;
  99285. /**
  99286. * Returns the integer 3.
  99287. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  99288. */
  99289. getTypeID(): number;
  99290. /**
  99291. * Prepares the list of defines specific to the light type.
  99292. * @param defines the list of defines
  99293. * @param lightIndex defines the index of the light for the effect
  99294. */
  99295. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  99296. }
  99297. }
  99298. declare module BABYLON {
  99299. /** @hidden */
  99300. export var vrMultiviewToSingleviewPixelShader: {
  99301. name: string;
  99302. shader: string;
  99303. };
  99304. }
  99305. declare module BABYLON {
  99306. /**
  99307. * Renders to multiple views with a single draw call
  99308. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  99309. */
  99310. export class MultiviewRenderTarget extends RenderTargetTexture {
  99311. /**
  99312. * Creates a multiview render target
  99313. * @param scene scene used with the render target
  99314. * @param size the size of the render target (used for each view)
  99315. */
  99316. constructor(scene: Scene, size?: number | {
  99317. width: number;
  99318. height: number;
  99319. } | {
  99320. ratio: number;
  99321. });
  99322. /**
  99323. * @hidden
  99324. * @param faceIndex the face index, if its a cube texture
  99325. */
  99326. _bindFrameBuffer(faceIndex?: number): void;
  99327. /**
  99328. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  99329. * @returns the view count
  99330. */
  99331. getViewCount(): number;
  99332. }
  99333. }
  99334. declare module BABYLON {
  99335. interface Engine {
  99336. /**
  99337. * Creates a new multiview render target
  99338. * @param width defines the width of the texture
  99339. * @param height defines the height of the texture
  99340. * @returns the created multiview texture
  99341. */
  99342. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  99343. /**
  99344. * Binds a multiview framebuffer to be drawn to
  99345. * @param multiviewTexture texture to bind
  99346. */
  99347. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  99348. }
  99349. interface Camera {
  99350. /**
  99351. * @hidden
  99352. * 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)
  99353. */
  99354. _useMultiviewToSingleView: boolean;
  99355. /**
  99356. * @hidden
  99357. * 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)
  99358. */
  99359. _multiviewTexture: Nullable<RenderTargetTexture>;
  99360. /**
  99361. * @hidden
  99362. * ensures the multiview texture of the camera exists and has the specified width/height
  99363. * @param width height to set on the multiview texture
  99364. * @param height width to set on the multiview texture
  99365. */
  99366. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  99367. }
  99368. interface Scene {
  99369. /** @hidden */
  99370. _transformMatrixR: Matrix;
  99371. /** @hidden */
  99372. _multiviewSceneUbo: Nullable<UniformBuffer>;
  99373. /** @hidden */
  99374. _createMultiviewUbo(): void;
  99375. /** @hidden */
  99376. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  99377. /** @hidden */
  99378. _renderMultiviewToSingleView(camera: Camera): void;
  99379. }
  99380. }
  99381. declare module BABYLON {
  99382. /**
  99383. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  99384. * This will not be used for webXR as it supports displaying texture arrays directly
  99385. */
  99386. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  99387. /**
  99388. * Gets a string identifying the name of the class
  99389. * @returns "VRMultiviewToSingleviewPostProcess" string
  99390. */
  99391. getClassName(): string;
  99392. /**
  99393. * Initializes a VRMultiviewToSingleview
  99394. * @param name name of the post process
  99395. * @param camera camera to be applied to
  99396. * @param scaleFactor scaling factor to the size of the output texture
  99397. */
  99398. constructor(name: string, camera: Camera, scaleFactor: number);
  99399. }
  99400. }
  99401. declare module BABYLON {
  99402. /**
  99403. * Interface used to define additional presentation attributes
  99404. */
  99405. export interface IVRPresentationAttributes {
  99406. /**
  99407. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  99408. */
  99409. highRefreshRate: boolean;
  99410. /**
  99411. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  99412. */
  99413. foveationLevel: number;
  99414. }
  99415. interface Engine {
  99416. /** @hidden */
  99417. _vrDisplay: any;
  99418. /** @hidden */
  99419. _vrSupported: boolean;
  99420. /** @hidden */
  99421. _oldSize: Size;
  99422. /** @hidden */
  99423. _oldHardwareScaleFactor: number;
  99424. /** @hidden */
  99425. _vrExclusivePointerMode: boolean;
  99426. /** @hidden */
  99427. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  99428. /** @hidden */
  99429. _onVRDisplayPointerRestricted: () => void;
  99430. /** @hidden */
  99431. _onVRDisplayPointerUnrestricted: () => void;
  99432. /** @hidden */
  99433. _onVrDisplayConnect: Nullable<(display: any) => void>;
  99434. /** @hidden */
  99435. _onVrDisplayDisconnect: Nullable<() => void>;
  99436. /** @hidden */
  99437. _onVrDisplayPresentChange: Nullable<() => void>;
  99438. /**
  99439. * Observable signaled when VR display mode changes
  99440. */
  99441. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  99442. /**
  99443. * Observable signaled when VR request present is complete
  99444. */
  99445. onVRRequestPresentComplete: Observable<boolean>;
  99446. /**
  99447. * Observable signaled when VR request present starts
  99448. */
  99449. onVRRequestPresentStart: Observable<Engine>;
  99450. /**
  99451. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  99452. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  99453. */
  99454. isInVRExclusivePointerMode: boolean;
  99455. /**
  99456. * Gets a boolean indicating if a webVR device was detected
  99457. * @returns true if a webVR device was detected
  99458. */
  99459. isVRDevicePresent(): boolean;
  99460. /**
  99461. * Gets the current webVR device
  99462. * @returns the current webVR device (or null)
  99463. */
  99464. getVRDevice(): any;
  99465. /**
  99466. * Initializes a webVR display and starts listening to display change events
  99467. * The onVRDisplayChangedObservable will be notified upon these changes
  99468. * @returns A promise containing a VRDisplay and if vr is supported
  99469. */
  99470. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  99471. /** @hidden */
  99472. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  99473. /**
  99474. * Gets or sets the presentation attributes used to configure VR rendering
  99475. */
  99476. vrPresentationAttributes?: IVRPresentationAttributes;
  99477. /**
  99478. * Call this function to switch to webVR mode
  99479. * Will do nothing if webVR is not supported or if there is no webVR device
  99480. * @param options the webvr options provided to the camera. mainly used for multiview
  99481. * @see https://doc.babylonjs.com/how_to/webvr_camera
  99482. */
  99483. enableVR(options: WebVROptions): void;
  99484. /** @hidden */
  99485. _onVRFullScreenTriggered(): void;
  99486. }
  99487. }
  99488. declare module BABYLON {
  99489. /**
  99490. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  99491. * IMPORTANT!! The data is right-hand data.
  99492. * @export
  99493. * @interface DevicePose
  99494. */
  99495. export interface DevicePose {
  99496. /**
  99497. * The position of the device, values in array are [x,y,z].
  99498. */
  99499. readonly position: Nullable<Float32Array>;
  99500. /**
  99501. * The linearVelocity of the device, values in array are [x,y,z].
  99502. */
  99503. readonly linearVelocity: Nullable<Float32Array>;
  99504. /**
  99505. * The linearAcceleration of the device, values in array are [x,y,z].
  99506. */
  99507. readonly linearAcceleration: Nullable<Float32Array>;
  99508. /**
  99509. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  99510. */
  99511. readonly orientation: Nullable<Float32Array>;
  99512. /**
  99513. * The angularVelocity of the device, values in array are [x,y,z].
  99514. */
  99515. readonly angularVelocity: Nullable<Float32Array>;
  99516. /**
  99517. * The angularAcceleration of the device, values in array are [x,y,z].
  99518. */
  99519. readonly angularAcceleration: Nullable<Float32Array>;
  99520. }
  99521. /**
  99522. * Interface representing a pose controlled object in Babylon.
  99523. * A pose controlled object has both regular pose values as well as pose values
  99524. * from an external device such as a VR head mounted display
  99525. */
  99526. export interface PoseControlled {
  99527. /**
  99528. * The position of the object in babylon space.
  99529. */
  99530. position: Vector3;
  99531. /**
  99532. * The rotation quaternion of the object in babylon space.
  99533. */
  99534. rotationQuaternion: Quaternion;
  99535. /**
  99536. * The position of the device in babylon space.
  99537. */
  99538. devicePosition?: Vector3;
  99539. /**
  99540. * The rotation quaternion of the device in babylon space.
  99541. */
  99542. deviceRotationQuaternion: Quaternion;
  99543. /**
  99544. * The raw pose coming from the device.
  99545. */
  99546. rawPose: Nullable<DevicePose>;
  99547. /**
  99548. * The scale of the device to be used when translating from device space to babylon space.
  99549. */
  99550. deviceScaleFactor: number;
  99551. /**
  99552. * Updates the poseControlled values based on the input device pose.
  99553. * @param poseData the pose data to update the object with
  99554. */
  99555. updateFromDevice(poseData: DevicePose): void;
  99556. }
  99557. /**
  99558. * Set of options to customize the webVRCamera
  99559. */
  99560. export interface WebVROptions {
  99561. /**
  99562. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  99563. */
  99564. trackPosition?: boolean;
  99565. /**
  99566. * Sets the scale of the vrDevice in babylon space. (default: 1)
  99567. */
  99568. positionScale?: number;
  99569. /**
  99570. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  99571. */
  99572. displayName?: string;
  99573. /**
  99574. * Should the native controller meshes be initialized. (default: true)
  99575. */
  99576. controllerMeshes?: boolean;
  99577. /**
  99578. * Creating a default HemiLight only on controllers. (default: true)
  99579. */
  99580. defaultLightingOnControllers?: boolean;
  99581. /**
  99582. * If you don't want to use the default VR button of the helper. (default: false)
  99583. */
  99584. useCustomVRButton?: boolean;
  99585. /**
  99586. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  99587. */
  99588. customVRButton?: HTMLButtonElement;
  99589. /**
  99590. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  99591. */
  99592. rayLength?: number;
  99593. /**
  99594. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  99595. */
  99596. defaultHeight?: number;
  99597. /**
  99598. * If multiview should be used if availible (default: false)
  99599. */
  99600. useMultiview?: boolean;
  99601. }
  99602. /**
  99603. * This represents a WebVR camera.
  99604. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  99605. * @example https://doc.babylonjs.com/how_to/webvr_camera
  99606. */
  99607. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  99608. private webVROptions;
  99609. /**
  99610. * @hidden
  99611. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  99612. */
  99613. _vrDevice: any;
  99614. /**
  99615. * The rawPose of the vrDevice.
  99616. */
  99617. rawPose: Nullable<DevicePose>;
  99618. private _onVREnabled;
  99619. private _specsVersion;
  99620. private _attached;
  99621. private _frameData;
  99622. protected _descendants: Array<Node>;
  99623. private _deviceRoomPosition;
  99624. /** @hidden */
  99625. _deviceRoomRotationQuaternion: Quaternion;
  99626. private _standingMatrix;
  99627. /**
  99628. * Represents device position in babylon space.
  99629. */
  99630. devicePosition: Vector3;
  99631. /**
  99632. * Represents device rotation in babylon space.
  99633. */
  99634. deviceRotationQuaternion: Quaternion;
  99635. /**
  99636. * The scale of the device to be used when translating from device space to babylon space.
  99637. */
  99638. deviceScaleFactor: number;
  99639. private _deviceToWorld;
  99640. private _worldToDevice;
  99641. /**
  99642. * References to the webVR controllers for the vrDevice.
  99643. */
  99644. controllers: Array<WebVRController>;
  99645. /**
  99646. * Emits an event when a controller is attached.
  99647. */
  99648. onControllersAttachedObservable: Observable<WebVRController[]>;
  99649. /**
  99650. * Emits an event when a controller's mesh has been loaded;
  99651. */
  99652. onControllerMeshLoadedObservable: Observable<WebVRController>;
  99653. /**
  99654. * Emits an event when the HMD's pose has been updated.
  99655. */
  99656. onPoseUpdatedFromDeviceObservable: Observable<any>;
  99657. private _poseSet;
  99658. /**
  99659. * If the rig cameras be used as parent instead of this camera.
  99660. */
  99661. rigParenting: boolean;
  99662. private _lightOnControllers;
  99663. private _defaultHeight?;
  99664. /**
  99665. * Instantiates a WebVRFreeCamera.
  99666. * @param name The name of the WebVRFreeCamera
  99667. * @param position The starting anchor position for the camera
  99668. * @param scene The scene the camera belongs to
  99669. * @param webVROptions a set of customizable options for the webVRCamera
  99670. */
  99671. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  99672. /**
  99673. * Gets the device distance from the ground in meters.
  99674. * @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.
  99675. */
  99676. deviceDistanceToRoomGround(): number;
  99677. /**
  99678. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  99679. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  99680. */
  99681. useStandingMatrix(callback?: (bool: boolean) => void): void;
  99682. /**
  99683. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  99684. * @returns A promise with a boolean set to if the standing matrix is supported.
  99685. */
  99686. useStandingMatrixAsync(): Promise<boolean>;
  99687. /**
  99688. * Disposes the camera
  99689. */
  99690. dispose(): void;
  99691. /**
  99692. * Gets a vrController by name.
  99693. * @param name The name of the controller to retreive
  99694. * @returns the controller matching the name specified or null if not found
  99695. */
  99696. getControllerByName(name: string): Nullable<WebVRController>;
  99697. private _leftController;
  99698. /**
  99699. * The controller corresponding to the users left hand.
  99700. */
  99701. get leftController(): Nullable<WebVRController>;
  99702. private _rightController;
  99703. /**
  99704. * The controller corresponding to the users right hand.
  99705. */
  99706. get rightController(): Nullable<WebVRController>;
  99707. /**
  99708. * Casts a ray forward from the vrCamera's gaze.
  99709. * @param length Length of the ray (default: 100)
  99710. * @returns the ray corresponding to the gaze
  99711. */
  99712. getForwardRay(length?: number): Ray;
  99713. /**
  99714. * @hidden
  99715. * Updates the camera based on device's frame data
  99716. */
  99717. _checkInputs(): void;
  99718. /**
  99719. * Updates the poseControlled values based on the input device pose.
  99720. * @param poseData Pose coming from the device
  99721. */
  99722. updateFromDevice(poseData: DevicePose): void;
  99723. private _htmlElementAttached;
  99724. private _detachIfAttached;
  99725. /**
  99726. * WebVR's attach control will start broadcasting frames to the device.
  99727. * Note that in certain browsers (chrome for example) this function must be called
  99728. * within a user-interaction callback. Example:
  99729. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  99730. *
  99731. * @param element html element to attach the vrDevice to
  99732. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  99733. */
  99734. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  99735. /**
  99736. * Detaches the camera from the html element and disables VR
  99737. *
  99738. * @param element html element to detach from
  99739. */
  99740. detachControl(element: HTMLElement): void;
  99741. /**
  99742. * @returns the name of this class
  99743. */
  99744. getClassName(): string;
  99745. /**
  99746. * Calls resetPose on the vrDisplay
  99747. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  99748. */
  99749. resetToCurrentRotation(): void;
  99750. /**
  99751. * @hidden
  99752. * Updates the rig cameras (left and right eye)
  99753. */
  99754. _updateRigCameras(): void;
  99755. private _workingVector;
  99756. private _oneVector;
  99757. private _workingMatrix;
  99758. private updateCacheCalled;
  99759. private _correctPositionIfNotTrackPosition;
  99760. /**
  99761. * @hidden
  99762. * Updates the cached values of the camera
  99763. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  99764. */
  99765. _updateCache(ignoreParentClass?: boolean): void;
  99766. /**
  99767. * @hidden
  99768. * Get current device position in babylon world
  99769. */
  99770. _computeDevicePosition(): void;
  99771. /**
  99772. * Updates the current device position and rotation in the babylon world
  99773. */
  99774. update(): void;
  99775. /**
  99776. * @hidden
  99777. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  99778. * @returns an identity matrix
  99779. */
  99780. _getViewMatrix(): Matrix;
  99781. private _tmpMatrix;
  99782. /**
  99783. * This function is called by the two RIG cameras.
  99784. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  99785. * @hidden
  99786. */
  99787. _getWebVRViewMatrix(): Matrix;
  99788. /** @hidden */
  99789. _getWebVRProjectionMatrix(): Matrix;
  99790. private _onGamepadConnectedObserver;
  99791. private _onGamepadDisconnectedObserver;
  99792. private _updateCacheWhenTrackingDisabledObserver;
  99793. /**
  99794. * Initializes the controllers and their meshes
  99795. */
  99796. initControllers(): void;
  99797. }
  99798. }
  99799. declare module BABYLON {
  99800. /**
  99801. * "Static Class" containing the most commonly used helper while dealing with material for rendering purpose.
  99802. *
  99803. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  99804. *
  99805. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  99806. */
  99807. export class MaterialHelper {
  99808. /**
  99809. * Bind the current view position to an effect.
  99810. * @param effect The effect to be bound
  99811. * @param scene The scene the eyes position is used from
  99812. * @param variableName name of the shader variable that will hold the eye position
  99813. */
  99814. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  99815. /**
  99816. * Helps preparing the defines values about the UVs in used in the effect.
  99817. * UVs are shared as much as we can accross channels in the shaders.
  99818. * @param texture The texture we are preparing the UVs for
  99819. * @param defines The defines to update
  99820. * @param key The channel key "diffuse", "specular"... used in the shader
  99821. */
  99822. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  99823. /**
  99824. * Binds a texture matrix value to its corrsponding uniform
  99825. * @param texture The texture to bind the matrix for
  99826. * @param uniformBuffer The uniform buffer receivin the data
  99827. * @param key The channel key "diffuse", "specular"... used in the shader
  99828. */
  99829. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  99830. /**
  99831. * Gets the current status of the fog (should it be enabled?)
  99832. * @param mesh defines the mesh to evaluate for fog support
  99833. * @param scene defines the hosting scene
  99834. * @returns true if fog must be enabled
  99835. */
  99836. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  99837. /**
  99838. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  99839. * @param mesh defines the current mesh
  99840. * @param scene defines the current scene
  99841. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  99842. * @param pointsCloud defines if point cloud rendering has to be turned on
  99843. * @param fogEnabled defines if fog has to be turned on
  99844. * @param alphaTest defines if alpha testing has to be turned on
  99845. * @param defines defines the current list of defines
  99846. */
  99847. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  99848. /**
  99849. * Helper used to prepare the list of defines associated with frame values for shader compilation
  99850. * @param scene defines the current scene
  99851. * @param engine defines the current engine
  99852. * @param defines specifies the list of active defines
  99853. * @param useInstances defines if instances have to be turned on
  99854. * @param useClipPlane defines if clip plane have to be turned on
  99855. * @param useInstances defines if instances have to be turned on
  99856. * @param useThinInstances defines if thin instances have to be turned on
  99857. */
  99858. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  99859. /**
  99860. * Prepares the defines for bones
  99861. * @param mesh The mesh containing the geometry data we will draw
  99862. * @param defines The defines to update
  99863. */
  99864. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  99865. /**
  99866. * Prepares the defines for morph targets
  99867. * @param mesh The mesh containing the geometry data we will draw
  99868. * @param defines The defines to update
  99869. */
  99870. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  99871. /**
  99872. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  99873. * @param mesh The mesh containing the geometry data we will draw
  99874. * @param defines The defines to update
  99875. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  99876. * @param useBones Precise whether bones should be used or not (override mesh info)
  99877. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  99878. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  99879. * @returns false if defines are considered not dirty and have not been checked
  99880. */
  99881. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  99882. /**
  99883. * Prepares the defines related to multiview
  99884. * @param scene The scene we are intending to draw
  99885. * @param defines The defines to update
  99886. */
  99887. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  99888. /**
  99889. * Prepares the defines related to the prepass
  99890. * @param scene The scene we are intending to draw
  99891. * @param defines The defines to update
  99892. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  99893. */
  99894. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  99895. /**
  99896. * Prepares the defines related to the light information passed in parameter
  99897. * @param scene The scene we are intending to draw
  99898. * @param mesh The mesh the effect is compiling for
  99899. * @param light The light the effect is compiling for
  99900. * @param lightIndex The index of the light
  99901. * @param defines The defines to update
  99902. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  99903. * @param state Defines the current state regarding what is needed (normals, etc...)
  99904. */
  99905. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  99906. needNormals: boolean;
  99907. needRebuild: boolean;
  99908. shadowEnabled: boolean;
  99909. specularEnabled: boolean;
  99910. lightmapMode: boolean;
  99911. }): void;
  99912. /**
  99913. * Prepares the defines related to the light information passed in parameter
  99914. * @param scene The scene we are intending to draw
  99915. * @param mesh The mesh the effect is compiling for
  99916. * @param defines The defines to update
  99917. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  99918. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  99919. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  99920. * @returns true if normals will be required for the rest of the effect
  99921. */
  99922. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  99923. /**
  99924. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  99925. * @param lightIndex defines the light index
  99926. * @param uniformsList The uniform list
  99927. * @param samplersList The sampler list
  99928. * @param projectedLightTexture defines if projected texture must be used
  99929. * @param uniformBuffersList defines an optional list of uniform buffers
  99930. */
  99931. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  99932. /**
  99933. * Prepares the uniforms and samplers list to be used in the effect
  99934. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  99935. * @param samplersList The sampler list
  99936. * @param defines The defines helping in the list generation
  99937. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  99938. */
  99939. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  99940. /**
  99941. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  99942. * @param defines The defines to update while falling back
  99943. * @param fallbacks The authorized effect fallbacks
  99944. * @param maxSimultaneousLights The maximum number of lights allowed
  99945. * @param rank the current rank of the Effect
  99946. * @returns The newly affected rank
  99947. */
  99948. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  99949. private static _TmpMorphInfluencers;
  99950. /**
  99951. * Prepares the list of attributes required for morph targets according to the effect defines.
  99952. * @param attribs The current list of supported attribs
  99953. * @param mesh The mesh to prepare the morph targets attributes for
  99954. * @param influencers The number of influencers
  99955. */
  99956. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  99957. /**
  99958. * Prepares the list of attributes required for morph targets according to the effect defines.
  99959. * @param attribs The current list of supported attribs
  99960. * @param mesh The mesh to prepare the morph targets attributes for
  99961. * @param defines The current Defines of the effect
  99962. */
  99963. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  99964. /**
  99965. * Prepares the list of attributes required for bones according to the effect defines.
  99966. * @param attribs The current list of supported attribs
  99967. * @param mesh The mesh to prepare the bones attributes for
  99968. * @param defines The current Defines of the effect
  99969. * @param fallbacks The current efffect fallback strategy
  99970. */
  99971. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  99972. /**
  99973. * Check and prepare the list of attributes required for instances according to the effect defines.
  99974. * @param attribs The current list of supported attribs
  99975. * @param defines The current MaterialDefines of the effect
  99976. */
  99977. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  99978. /**
  99979. * Add the list of attributes required for instances to the attribs array.
  99980. * @param attribs The current list of supported attribs
  99981. */
  99982. static PushAttributesForInstances(attribs: string[]): void;
  99983. /**
  99984. * Binds the light information to the effect.
  99985. * @param light The light containing the generator
  99986. * @param effect The effect we are binding the data to
  99987. * @param lightIndex The light index in the effect used to render
  99988. */
  99989. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  99990. /**
  99991. * Binds the lights information from the scene to the effect for the given mesh.
  99992. * @param light Light to bind
  99993. * @param lightIndex Light index
  99994. * @param scene The scene where the light belongs to
  99995. * @param effect The effect we are binding the data to
  99996. * @param useSpecular Defines if specular is supported
  99997. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  99998. */
  99999. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  100000. /**
  100001. * Binds the lights information from the scene to the effect for the given mesh.
  100002. * @param scene The scene the lights belongs to
  100003. * @param mesh The mesh we are binding the information to render
  100004. * @param effect The effect we are binding the data to
  100005. * @param defines The generated defines for the effect
  100006. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  100007. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  100008. */
  100009. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  100010. private static _tempFogColor;
  100011. /**
  100012. * Binds the fog information from the scene to the effect for the given mesh.
  100013. * @param scene The scene the lights belongs to
  100014. * @param mesh The mesh we are binding the information to render
  100015. * @param effect The effect we are binding the data to
  100016. * @param linearSpace Defines if the fog effect is applied in linear space
  100017. */
  100018. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  100019. /**
  100020. * Binds the bones information from the mesh to the effect.
  100021. * @param mesh The mesh we are binding the information to render
  100022. * @param effect The effect we are binding the data to
  100023. */
  100024. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  100025. /**
  100026. * Binds the morph targets information from the mesh to the effect.
  100027. * @param abstractMesh The mesh we are binding the information to render
  100028. * @param effect The effect we are binding the data to
  100029. */
  100030. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  100031. /**
  100032. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  100033. * @param defines The generated defines used in the effect
  100034. * @param effect The effect we are binding the data to
  100035. * @param scene The scene we are willing to render with logarithmic scale for
  100036. */
  100037. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  100038. /**
  100039. * Binds the clip plane information from the scene to the effect.
  100040. * @param scene The scene the clip plane information are extracted from
  100041. * @param effect The effect we are binding the data to
  100042. */
  100043. static BindClipPlane(effect: Effect, scene: Scene): void;
  100044. }
  100045. }
  100046. declare module BABYLON {
  100047. /**
  100048. * Block used to expose an input value
  100049. */
  100050. export class InputBlock extends NodeMaterialBlock {
  100051. private _mode;
  100052. private _associatedVariableName;
  100053. private _storedValue;
  100054. private _valueCallback;
  100055. private _type;
  100056. private _animationType;
  100057. /** Gets or set a value used to limit the range of float values */
  100058. min: number;
  100059. /** Gets or set a value used to limit the range of float values */
  100060. max: number;
  100061. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  100062. isBoolean: boolean;
  100063. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  100064. matrixMode: number;
  100065. /** @hidden */
  100066. _systemValue: Nullable<NodeMaterialSystemValues>;
  100067. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  100068. visibleInInspector: boolean;
  100069. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  100070. isConstant: boolean;
  100071. /** Gets or sets the group to use to display this block in the Inspector */
  100072. groupInInspector: string;
  100073. /** Gets an observable raised when the value is changed */
  100074. onValueChangedObservable: Observable<InputBlock>;
  100075. /**
  100076. * Gets or sets the connection point type (default is float)
  100077. */
  100078. get type(): NodeMaterialBlockConnectionPointTypes;
  100079. /**
  100080. * Creates a new InputBlock
  100081. * @param name defines the block name
  100082. * @param target defines the target of that block (Vertex by default)
  100083. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  100084. */
  100085. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  100086. /**
  100087. * Validates if a name is a reserve word.
  100088. * @param newName the new name to be given to the node.
  100089. * @returns false if the name is a reserve word, else true.
  100090. */
  100091. validateBlockName(newName: string): boolean;
  100092. /**
  100093. * Gets the output component
  100094. */
  100095. get output(): NodeMaterialConnectionPoint;
  100096. /**
  100097. * Set the source of this connection point to a vertex attribute
  100098. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  100099. * @returns the current connection point
  100100. */
  100101. setAsAttribute(attributeName?: string): InputBlock;
  100102. /**
  100103. * Set the source of this connection point to a system value
  100104. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  100105. * @returns the current connection point
  100106. */
  100107. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  100108. /**
  100109. * Gets or sets the value of that point.
  100110. * Please note that this value will be ignored if valueCallback is defined
  100111. */
  100112. get value(): any;
  100113. set value(value: any);
  100114. /**
  100115. * Gets or sets a callback used to get the value of that point.
  100116. * Please note that setting this value will force the connection point to ignore the value property
  100117. */
  100118. get valueCallback(): () => any;
  100119. set valueCallback(value: () => any);
  100120. /**
  100121. * Gets or sets the associated variable name in the shader
  100122. */
  100123. get associatedVariableName(): string;
  100124. set associatedVariableName(value: string);
  100125. /** Gets or sets the type of animation applied to the input */
  100126. get animationType(): AnimatedInputBlockTypes;
  100127. set animationType(value: AnimatedInputBlockTypes);
  100128. /**
  100129. * Gets a boolean indicating that this connection point not defined yet
  100130. */
  100131. get isUndefined(): boolean;
  100132. /**
  100133. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  100134. * In this case the connection point name must be the name of the uniform to use.
  100135. * Can only be set on inputs
  100136. */
  100137. get isUniform(): boolean;
  100138. set isUniform(value: boolean);
  100139. /**
  100140. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  100141. * In this case the connection point name must be the name of the attribute to use
  100142. * Can only be set on inputs
  100143. */
  100144. get isAttribute(): boolean;
  100145. set isAttribute(value: boolean);
  100146. /**
  100147. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  100148. * Can only be set on exit points
  100149. */
  100150. get isVarying(): boolean;
  100151. set isVarying(value: boolean);
  100152. /**
  100153. * Gets a boolean indicating that the current connection point is a system value
  100154. */
  100155. get isSystemValue(): boolean;
  100156. /**
  100157. * Gets or sets the current well known value or null if not defined as a system value
  100158. */
  100159. get systemValue(): Nullable<NodeMaterialSystemValues>;
  100160. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  100161. /**
  100162. * Gets the current class name
  100163. * @returns the class name
  100164. */
  100165. getClassName(): string;
  100166. /**
  100167. * Animate the input if animationType !== None
  100168. * @param scene defines the rendering scene
  100169. */
  100170. animate(scene: Scene): void;
  100171. private _emitDefine;
  100172. initialize(state: NodeMaterialBuildState): void;
  100173. /**
  100174. * Set the input block to its default value (based on its type)
  100175. */
  100176. setDefaultValue(): void;
  100177. private _emitConstant;
  100178. /** @hidden */
  100179. get _noContextSwitch(): boolean;
  100180. private _emit;
  100181. /** @hidden */
  100182. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  100183. /** @hidden */
  100184. _transmit(effect: Effect, scene: Scene): void;
  100185. protected _buildBlock(state: NodeMaterialBuildState): void;
  100186. protected _dumpPropertiesCode(): string;
  100187. dispose(): void;
  100188. serialize(): any;
  100189. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100190. }
  100191. }
  100192. declare module BABYLON {
  100193. /**
  100194. * Enum used to define the compatibility state between two connection points
  100195. */
  100196. export enum NodeMaterialConnectionPointCompatibilityStates {
  100197. /** Points are compatibles */
  100198. Compatible = 0,
  100199. /** Points are incompatible because of their types */
  100200. TypeIncompatible = 1,
  100201. /** Points are incompatible because of their targets (vertex vs fragment) */
  100202. TargetIncompatible = 2
  100203. }
  100204. /**
  100205. * Defines the direction of a connection point
  100206. */
  100207. export enum NodeMaterialConnectionPointDirection {
  100208. /** Input */
  100209. Input = 0,
  100210. /** Output */
  100211. Output = 1
  100212. }
  100213. /**
  100214. * Defines a connection point for a block
  100215. */
  100216. export class NodeMaterialConnectionPoint {
  100217. /** @hidden */
  100218. _ownerBlock: NodeMaterialBlock;
  100219. /** @hidden */
  100220. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  100221. private _endpoints;
  100222. private _associatedVariableName;
  100223. private _direction;
  100224. /** @hidden */
  100225. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  100226. /** @hidden */
  100227. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  100228. private _type;
  100229. /** @hidden */
  100230. _enforceAssociatedVariableName: boolean;
  100231. /** Gets the direction of the point */
  100232. get direction(): NodeMaterialConnectionPointDirection;
  100233. /** Indicates that this connection point needs dual validation before being connected to another point */
  100234. needDualDirectionValidation: boolean;
  100235. /**
  100236. * Gets or sets the additional types supported by this connection point
  100237. */
  100238. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  100239. /**
  100240. * Gets or sets the additional types excluded by this connection point
  100241. */
  100242. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  100243. /**
  100244. * Observable triggered when this point is connected
  100245. */
  100246. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  100247. /**
  100248. * Gets or sets the associated variable name in the shader
  100249. */
  100250. get associatedVariableName(): string;
  100251. set associatedVariableName(value: string);
  100252. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  100253. get innerType(): NodeMaterialBlockConnectionPointTypes;
  100254. /**
  100255. * Gets or sets the connection point type (default is float)
  100256. */
  100257. get type(): NodeMaterialBlockConnectionPointTypes;
  100258. set type(value: NodeMaterialBlockConnectionPointTypes);
  100259. /**
  100260. * Gets or sets the connection point name
  100261. */
  100262. name: string;
  100263. /**
  100264. * Gets or sets the connection point name
  100265. */
  100266. displayName: string;
  100267. /**
  100268. * Gets or sets a boolean indicating that this connection point can be omitted
  100269. */
  100270. isOptional: boolean;
  100271. /**
  100272. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  100273. */
  100274. isExposedOnFrame: boolean;
  100275. /**
  100276. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  100277. */
  100278. define: string;
  100279. /** @hidden */
  100280. _prioritizeVertex: boolean;
  100281. private _target;
  100282. /** Gets or sets the target of that connection point */
  100283. get target(): NodeMaterialBlockTargets;
  100284. set target(value: NodeMaterialBlockTargets);
  100285. /**
  100286. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  100287. */
  100288. get isConnected(): boolean;
  100289. /**
  100290. * Gets a boolean indicating that the current point is connected to an input block
  100291. */
  100292. get isConnectedToInputBlock(): boolean;
  100293. /**
  100294. * Gets a the connected input block (if any)
  100295. */
  100296. get connectInputBlock(): Nullable<InputBlock>;
  100297. /** Get the other side of the connection (if any) */
  100298. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  100299. /** Get the block that owns this connection point */
  100300. get ownerBlock(): NodeMaterialBlock;
  100301. /** Get the block connected on the other side of this connection (if any) */
  100302. get sourceBlock(): Nullable<NodeMaterialBlock>;
  100303. /** Get the block connected on the endpoints of this connection (if any) */
  100304. get connectedBlocks(): Array<NodeMaterialBlock>;
  100305. /** Gets the list of connected endpoints */
  100306. get endpoints(): NodeMaterialConnectionPoint[];
  100307. /** Gets a boolean indicating if that output point is connected to at least one input */
  100308. get hasEndpoints(): boolean;
  100309. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  100310. get isConnectedInVertexShader(): boolean;
  100311. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  100312. get isConnectedInFragmentShader(): boolean;
  100313. /**
  100314. * Creates a block suitable to be used as an input for this input point.
  100315. * If null is returned, a block based on the point type will be created.
  100316. * @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
  100317. */
  100318. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  100319. /**
  100320. * Creates a new connection point
  100321. * @param name defines the connection point name
  100322. * @param ownerBlock defines the block hosting this connection point
  100323. * @param direction defines the direction of the connection point
  100324. */
  100325. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  100326. /**
  100327. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  100328. * @returns the class name
  100329. */
  100330. getClassName(): string;
  100331. /**
  100332. * Gets a boolean indicating if the current point can be connected to another point
  100333. * @param connectionPoint defines the other connection point
  100334. * @returns a boolean
  100335. */
  100336. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  100337. /**
  100338. * Gets a number indicating if the current point can be connected to another point
  100339. * @param connectionPoint defines the other connection point
  100340. * @returns a number defining the compatibility state
  100341. */
  100342. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  100343. /**
  100344. * Connect this point to another connection point
  100345. * @param connectionPoint defines the other connection point
  100346. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  100347. * @returns the current connection point
  100348. */
  100349. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  100350. /**
  100351. * Disconnect this point from one of his endpoint
  100352. * @param endpoint defines the other connection point
  100353. * @returns the current connection point
  100354. */
  100355. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  100356. /**
  100357. * Serializes this point in a JSON representation
  100358. * @param isInput defines if the connection point is an input (default is true)
  100359. * @returns the serialized point object
  100360. */
  100361. serialize(isInput?: boolean): any;
  100362. /**
  100363. * Release resources
  100364. */
  100365. dispose(): void;
  100366. }
  100367. }
  100368. declare module BABYLON {
  100369. /**
  100370. * Enum used to define the material modes
  100371. */
  100372. export enum NodeMaterialModes {
  100373. /** Regular material */
  100374. Material = 0,
  100375. /** For post process */
  100376. PostProcess = 1,
  100377. /** For particle system */
  100378. Particle = 2
  100379. }
  100380. }
  100381. declare module BABYLON {
  100382. /**
  100383. * Block used to read a texture from a sampler
  100384. */
  100385. export class TextureBlock extends NodeMaterialBlock {
  100386. private _defineName;
  100387. private _linearDefineName;
  100388. private _gammaDefineName;
  100389. private _tempTextureRead;
  100390. private _samplerName;
  100391. private _transformedUVName;
  100392. private _textureTransformName;
  100393. private _textureInfoName;
  100394. private _mainUVName;
  100395. private _mainUVDefineName;
  100396. private _fragmentOnly;
  100397. /**
  100398. * Gets or sets the texture associated with the node
  100399. */
  100400. texture: Nullable<Texture>;
  100401. /**
  100402. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100403. */
  100404. convertToGammaSpace: boolean;
  100405. /**
  100406. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100407. */
  100408. convertToLinearSpace: boolean;
  100409. /**
  100410. * Create a new TextureBlock
  100411. * @param name defines the block name
  100412. */
  100413. constructor(name: string, fragmentOnly?: boolean);
  100414. /**
  100415. * Gets the current class name
  100416. * @returns the class name
  100417. */
  100418. getClassName(): string;
  100419. /**
  100420. * Gets the uv input component
  100421. */
  100422. get uv(): NodeMaterialConnectionPoint;
  100423. /**
  100424. * Gets the rgba output component
  100425. */
  100426. get rgba(): NodeMaterialConnectionPoint;
  100427. /**
  100428. * Gets the rgb output component
  100429. */
  100430. get rgb(): NodeMaterialConnectionPoint;
  100431. /**
  100432. * Gets the r output component
  100433. */
  100434. get r(): NodeMaterialConnectionPoint;
  100435. /**
  100436. * Gets the g output component
  100437. */
  100438. get g(): NodeMaterialConnectionPoint;
  100439. /**
  100440. * Gets the b output component
  100441. */
  100442. get b(): NodeMaterialConnectionPoint;
  100443. /**
  100444. * Gets the a output component
  100445. */
  100446. get a(): NodeMaterialConnectionPoint;
  100447. get target(): NodeMaterialBlockTargets;
  100448. autoConfigure(material: NodeMaterial): void;
  100449. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  100450. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100451. isReady(): boolean;
  100452. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  100453. private get _isMixed();
  100454. private _injectVertexCode;
  100455. private _writeTextureRead;
  100456. private _writeOutput;
  100457. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100458. protected _dumpPropertiesCode(): string;
  100459. serialize(): any;
  100460. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100461. }
  100462. }
  100463. declare module BABYLON {
  100464. /** @hidden */
  100465. export var reflectionFunction: {
  100466. name: string;
  100467. shader: string;
  100468. };
  100469. }
  100470. declare module BABYLON {
  100471. /**
  100472. * Base block used to read a reflection texture from a sampler
  100473. */
  100474. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  100475. /** @hidden */
  100476. _define3DName: string;
  100477. /** @hidden */
  100478. _defineCubicName: string;
  100479. /** @hidden */
  100480. _defineExplicitName: string;
  100481. /** @hidden */
  100482. _defineProjectionName: string;
  100483. /** @hidden */
  100484. _defineLocalCubicName: string;
  100485. /** @hidden */
  100486. _defineSphericalName: string;
  100487. /** @hidden */
  100488. _definePlanarName: string;
  100489. /** @hidden */
  100490. _defineEquirectangularName: string;
  100491. /** @hidden */
  100492. _defineMirroredEquirectangularFixedName: string;
  100493. /** @hidden */
  100494. _defineEquirectangularFixedName: string;
  100495. /** @hidden */
  100496. _defineSkyboxName: string;
  100497. /** @hidden */
  100498. _defineOppositeZ: string;
  100499. /** @hidden */
  100500. _cubeSamplerName: string;
  100501. /** @hidden */
  100502. _2DSamplerName: string;
  100503. protected _positionUVWName: string;
  100504. protected _directionWName: string;
  100505. protected _reflectionVectorName: string;
  100506. /** @hidden */
  100507. _reflectionCoordsName: string;
  100508. /** @hidden */
  100509. _reflectionMatrixName: string;
  100510. protected _reflectionColorName: string;
  100511. /**
  100512. * Gets or sets the texture associated with the node
  100513. */
  100514. texture: Nullable<BaseTexture>;
  100515. /**
  100516. * Create a new ReflectionTextureBaseBlock
  100517. * @param name defines the block name
  100518. */
  100519. constructor(name: string);
  100520. /**
  100521. * Gets the current class name
  100522. * @returns the class name
  100523. */
  100524. getClassName(): string;
  100525. /**
  100526. * Gets the world position input component
  100527. */
  100528. abstract get position(): NodeMaterialConnectionPoint;
  100529. /**
  100530. * Gets the world position input component
  100531. */
  100532. abstract get worldPosition(): NodeMaterialConnectionPoint;
  100533. /**
  100534. * Gets the world normal input component
  100535. */
  100536. abstract get worldNormal(): NodeMaterialConnectionPoint;
  100537. /**
  100538. * Gets the world input component
  100539. */
  100540. abstract get world(): NodeMaterialConnectionPoint;
  100541. /**
  100542. * Gets the camera (or eye) position component
  100543. */
  100544. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  100545. /**
  100546. * Gets the view input component
  100547. */
  100548. abstract get view(): NodeMaterialConnectionPoint;
  100549. protected _getTexture(): Nullable<BaseTexture>;
  100550. autoConfigure(material: NodeMaterial): void;
  100551. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100552. isReady(): boolean;
  100553. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  100554. /**
  100555. * Gets the code to inject in the vertex shader
  100556. * @param state current state of the node material building
  100557. * @returns the shader code
  100558. */
  100559. handleVertexSide(state: NodeMaterialBuildState): string;
  100560. /**
  100561. * Handles the inits for the fragment code path
  100562. * @param state node material build state
  100563. */
  100564. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  100565. /**
  100566. * Generates the reflection coords code for the fragment code path
  100567. * @param worldNormalVarName name of the world normal variable
  100568. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  100569. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  100570. * @returns the shader code
  100571. */
  100572. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  100573. /**
  100574. * Generates the reflection color code for the fragment code path
  100575. * @param lodVarName name of the lod variable
  100576. * @param swizzleLookupTexture swizzle to use for the final color variable
  100577. * @returns the shader code
  100578. */
  100579. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  100580. /**
  100581. * Generates the code corresponding to the connected output points
  100582. * @param state node material build state
  100583. * @param varName name of the variable to output
  100584. * @returns the shader code
  100585. */
  100586. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  100587. protected _buildBlock(state: NodeMaterialBuildState): this;
  100588. protected _dumpPropertiesCode(): string;
  100589. serialize(): any;
  100590. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100591. }
  100592. }
  100593. declare module BABYLON {
  100594. /**
  100595. * Defines a connection point to be used for points with a custom object type
  100596. */
  100597. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  100598. private _blockType;
  100599. private _blockName;
  100600. private _nameForCheking?;
  100601. /**
  100602. * Creates a new connection point
  100603. * @param name defines the connection point name
  100604. * @param ownerBlock defines the block hosting this connection point
  100605. * @param direction defines the direction of the connection point
  100606. */
  100607. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  100608. /**
  100609. * Gets a number indicating if the current point can be connected to another point
  100610. * @param connectionPoint defines the other connection point
  100611. * @returns a number defining the compatibility state
  100612. */
  100613. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  100614. /**
  100615. * Creates a block suitable to be used as an input for this input point.
  100616. * If null is returned, a block based on the point type will be created.
  100617. * @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
  100618. */
  100619. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  100620. }
  100621. }
  100622. declare module BABYLON {
  100623. /**
  100624. * Enum defining the type of properties that can be edited in the property pages in the NME
  100625. */
  100626. export enum PropertyTypeForEdition {
  100627. /** property is a boolean */
  100628. Boolean = 0,
  100629. /** property is a float */
  100630. Float = 1,
  100631. /** property is a Vector2 */
  100632. Vector2 = 2,
  100633. /** property is a list of values */
  100634. List = 3
  100635. }
  100636. /**
  100637. * Interface that defines an option in a variable of type list
  100638. */
  100639. export interface IEditablePropertyListOption {
  100640. /** label of the option */
  100641. "label": string;
  100642. /** value of the option */
  100643. "value": number;
  100644. }
  100645. /**
  100646. * Interface that defines the options available for an editable property
  100647. */
  100648. export interface IEditablePropertyOption {
  100649. /** min value */
  100650. "min"?: number;
  100651. /** max value */
  100652. "max"?: number;
  100653. /** notifiers: indicates which actions to take when the property is changed */
  100654. "notifiers"?: {
  100655. /** the material should be rebuilt */
  100656. "rebuild"?: boolean;
  100657. /** the preview should be updated */
  100658. "update"?: boolean;
  100659. };
  100660. /** list of the options for a variable of type list */
  100661. "options"?: IEditablePropertyListOption[];
  100662. }
  100663. /**
  100664. * Interface that describes an editable property
  100665. */
  100666. export interface IPropertyDescriptionForEdition {
  100667. /** name of the property */
  100668. "propertyName": string;
  100669. /** display name of the property */
  100670. "displayName": string;
  100671. /** type of the property */
  100672. "type": PropertyTypeForEdition;
  100673. /** group of the property - all properties with the same group value will be displayed in a specific section */
  100674. "groupName": string;
  100675. /** options for the property */
  100676. "options": IEditablePropertyOption;
  100677. }
  100678. /**
  100679. * Decorator that flags a property in a node material block as being editable
  100680. */
  100681. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  100682. }
  100683. declare module BABYLON {
  100684. /**
  100685. * Block used to implement the refraction part of the sub surface module of the PBR material
  100686. */
  100687. export class RefractionBlock extends NodeMaterialBlock {
  100688. /** @hidden */
  100689. _define3DName: string;
  100690. /** @hidden */
  100691. _refractionMatrixName: string;
  100692. /** @hidden */
  100693. _defineLODRefractionAlpha: string;
  100694. /** @hidden */
  100695. _defineLinearSpecularRefraction: string;
  100696. /** @hidden */
  100697. _defineOppositeZ: string;
  100698. /** @hidden */
  100699. _cubeSamplerName: string;
  100700. /** @hidden */
  100701. _2DSamplerName: string;
  100702. /** @hidden */
  100703. _vRefractionMicrosurfaceInfosName: string;
  100704. /** @hidden */
  100705. _vRefractionInfosName: string;
  100706. private _scene;
  100707. /**
  100708. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  100709. * Materials half opaque for instance using refraction could benefit from this control.
  100710. */
  100711. linkRefractionWithTransparency: boolean;
  100712. /**
  100713. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  100714. */
  100715. invertRefractionY: boolean;
  100716. /**
  100717. * Gets or sets the texture associated with the node
  100718. */
  100719. texture: Nullable<BaseTexture>;
  100720. /**
  100721. * Create a new RefractionBlock
  100722. * @param name defines the block name
  100723. */
  100724. constructor(name: string);
  100725. /**
  100726. * Gets the current class name
  100727. * @returns the class name
  100728. */
  100729. getClassName(): string;
  100730. /**
  100731. * Gets the intensity input component
  100732. */
  100733. get intensity(): NodeMaterialConnectionPoint;
  100734. /**
  100735. * Gets the index of refraction input component
  100736. */
  100737. get indexOfRefraction(): NodeMaterialConnectionPoint;
  100738. /**
  100739. * Gets the tint at distance input component
  100740. */
  100741. get tintAtDistance(): NodeMaterialConnectionPoint;
  100742. /**
  100743. * Gets the view input component
  100744. */
  100745. get view(): NodeMaterialConnectionPoint;
  100746. /**
  100747. * Gets the refraction object output component
  100748. */
  100749. get refraction(): NodeMaterialConnectionPoint;
  100750. /**
  100751. * Returns true if the block has a texture
  100752. */
  100753. get hasTexture(): boolean;
  100754. protected _getTexture(): Nullable<BaseTexture>;
  100755. autoConfigure(material: NodeMaterial): void;
  100756. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100757. isReady(): boolean;
  100758. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  100759. /**
  100760. * Gets the main code of the block (fragment side)
  100761. * @param state current state of the node material building
  100762. * @returns the shader code
  100763. */
  100764. getCode(state: NodeMaterialBuildState): string;
  100765. protected _buildBlock(state: NodeMaterialBuildState): this;
  100766. protected _dumpPropertiesCode(): string;
  100767. serialize(): any;
  100768. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100769. }
  100770. }
  100771. declare module BABYLON {
  100772. /**
  100773. * Base block used as input for post process
  100774. */
  100775. export class CurrentScreenBlock extends NodeMaterialBlock {
  100776. private _samplerName;
  100777. private _linearDefineName;
  100778. private _gammaDefineName;
  100779. private _mainUVName;
  100780. private _tempTextureRead;
  100781. /**
  100782. * Gets or sets the texture associated with the node
  100783. */
  100784. texture: Nullable<BaseTexture>;
  100785. /**
  100786. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100787. */
  100788. convertToGammaSpace: boolean;
  100789. /**
  100790. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100791. */
  100792. convertToLinearSpace: boolean;
  100793. /**
  100794. * Create a new CurrentScreenBlock
  100795. * @param name defines the block name
  100796. */
  100797. constructor(name: string);
  100798. /**
  100799. * Gets the current class name
  100800. * @returns the class name
  100801. */
  100802. getClassName(): string;
  100803. /**
  100804. * Gets the uv input component
  100805. */
  100806. get uv(): NodeMaterialConnectionPoint;
  100807. /**
  100808. * Gets the rgba output component
  100809. */
  100810. get rgba(): NodeMaterialConnectionPoint;
  100811. /**
  100812. * Gets the rgb output component
  100813. */
  100814. get rgb(): NodeMaterialConnectionPoint;
  100815. /**
  100816. * Gets the r output component
  100817. */
  100818. get r(): NodeMaterialConnectionPoint;
  100819. /**
  100820. * Gets the g output component
  100821. */
  100822. get g(): NodeMaterialConnectionPoint;
  100823. /**
  100824. * Gets the b output component
  100825. */
  100826. get b(): NodeMaterialConnectionPoint;
  100827. /**
  100828. * Gets the a output component
  100829. */
  100830. get a(): NodeMaterialConnectionPoint;
  100831. /**
  100832. * Initialize the block and prepare the context for build
  100833. * @param state defines the state that will be used for the build
  100834. */
  100835. initialize(state: NodeMaterialBuildState): void;
  100836. get target(): NodeMaterialBlockTargets;
  100837. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100838. isReady(): boolean;
  100839. private _injectVertexCode;
  100840. private _writeTextureRead;
  100841. private _writeOutput;
  100842. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100843. serialize(): any;
  100844. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100845. }
  100846. }
  100847. declare module BABYLON {
  100848. /**
  100849. * Base block used for the particle texture
  100850. */
  100851. export class ParticleTextureBlock extends NodeMaterialBlock {
  100852. private _samplerName;
  100853. private _linearDefineName;
  100854. private _gammaDefineName;
  100855. private _tempTextureRead;
  100856. /**
  100857. * Gets or sets the texture associated with the node
  100858. */
  100859. texture: Nullable<BaseTexture>;
  100860. /**
  100861. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100862. */
  100863. convertToGammaSpace: boolean;
  100864. /**
  100865. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100866. */
  100867. convertToLinearSpace: boolean;
  100868. /**
  100869. * Create a new ParticleTextureBlock
  100870. * @param name defines the block name
  100871. */
  100872. constructor(name: string);
  100873. /**
  100874. * Gets the current class name
  100875. * @returns the class name
  100876. */
  100877. getClassName(): string;
  100878. /**
  100879. * Gets the uv input component
  100880. */
  100881. get uv(): NodeMaterialConnectionPoint;
  100882. /**
  100883. * Gets the rgba output component
  100884. */
  100885. get rgba(): NodeMaterialConnectionPoint;
  100886. /**
  100887. * Gets the rgb output component
  100888. */
  100889. get rgb(): NodeMaterialConnectionPoint;
  100890. /**
  100891. * Gets the r output component
  100892. */
  100893. get r(): NodeMaterialConnectionPoint;
  100894. /**
  100895. * Gets the g output component
  100896. */
  100897. get g(): NodeMaterialConnectionPoint;
  100898. /**
  100899. * Gets the b output component
  100900. */
  100901. get b(): NodeMaterialConnectionPoint;
  100902. /**
  100903. * Gets the a output component
  100904. */
  100905. get a(): NodeMaterialConnectionPoint;
  100906. /**
  100907. * Initialize the block and prepare the context for build
  100908. * @param state defines the state that will be used for the build
  100909. */
  100910. initialize(state: NodeMaterialBuildState): void;
  100911. autoConfigure(material: NodeMaterial): void;
  100912. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100913. isReady(): boolean;
  100914. private _writeOutput;
  100915. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100916. serialize(): any;
  100917. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100918. }
  100919. }
  100920. declare module BABYLON {
  100921. /**
  100922. * Class used to store shared data between 2 NodeMaterialBuildState
  100923. */
  100924. export class NodeMaterialBuildStateSharedData {
  100925. /**
  100926. * Gets the list of emitted varyings
  100927. */
  100928. temps: string[];
  100929. /**
  100930. * Gets the list of emitted varyings
  100931. */
  100932. varyings: string[];
  100933. /**
  100934. * Gets the varying declaration string
  100935. */
  100936. varyingDeclaration: string;
  100937. /**
  100938. * Input blocks
  100939. */
  100940. inputBlocks: InputBlock[];
  100941. /**
  100942. * Input blocks
  100943. */
  100944. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  100945. /**
  100946. * Bindable blocks (Blocks that need to set data to the effect)
  100947. */
  100948. bindableBlocks: NodeMaterialBlock[];
  100949. /**
  100950. * List of blocks that can provide a compilation fallback
  100951. */
  100952. blocksWithFallbacks: NodeMaterialBlock[];
  100953. /**
  100954. * List of blocks that can provide a define update
  100955. */
  100956. blocksWithDefines: NodeMaterialBlock[];
  100957. /**
  100958. * List of blocks that can provide a repeatable content
  100959. */
  100960. repeatableContentBlocks: NodeMaterialBlock[];
  100961. /**
  100962. * List of blocks that can provide a dynamic list of uniforms
  100963. */
  100964. dynamicUniformBlocks: NodeMaterialBlock[];
  100965. /**
  100966. * List of blocks that can block the isReady function for the material
  100967. */
  100968. blockingBlocks: NodeMaterialBlock[];
  100969. /**
  100970. * Gets the list of animated inputs
  100971. */
  100972. animatedInputs: InputBlock[];
  100973. /**
  100974. * Build Id used to avoid multiple recompilations
  100975. */
  100976. buildId: number;
  100977. /** List of emitted variables */
  100978. variableNames: {
  100979. [key: string]: number;
  100980. };
  100981. /** List of emitted defines */
  100982. defineNames: {
  100983. [key: string]: number;
  100984. };
  100985. /** Should emit comments? */
  100986. emitComments: boolean;
  100987. /** Emit build activity */
  100988. verbose: boolean;
  100989. /** Gets or sets the hosting scene */
  100990. scene: Scene;
  100991. /**
  100992. * Gets the compilation hints emitted at compilation time
  100993. */
  100994. hints: {
  100995. needWorldViewMatrix: boolean;
  100996. needWorldViewProjectionMatrix: boolean;
  100997. needAlphaBlending: boolean;
  100998. needAlphaTesting: boolean;
  100999. };
  101000. /**
  101001. * List of compilation checks
  101002. */
  101003. checks: {
  101004. emitVertex: boolean;
  101005. emitFragment: boolean;
  101006. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  101007. };
  101008. /**
  101009. * Is vertex program allowed to be empty?
  101010. */
  101011. allowEmptyVertexProgram: boolean;
  101012. /** Creates a new shared data */
  101013. constructor();
  101014. /**
  101015. * Emits console errors and exceptions if there is a failing check
  101016. */
  101017. emitErrors(): void;
  101018. }
  101019. }
  101020. declare module BABYLON {
  101021. /**
  101022. * Class used to store node based material build state
  101023. */
  101024. export class NodeMaterialBuildState {
  101025. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  101026. supportUniformBuffers: boolean;
  101027. /**
  101028. * Gets the list of emitted attributes
  101029. */
  101030. attributes: string[];
  101031. /**
  101032. * Gets the list of emitted uniforms
  101033. */
  101034. uniforms: string[];
  101035. /**
  101036. * Gets the list of emitted constants
  101037. */
  101038. constants: string[];
  101039. /**
  101040. * Gets the list of emitted samplers
  101041. */
  101042. samplers: string[];
  101043. /**
  101044. * Gets the list of emitted functions
  101045. */
  101046. functions: {
  101047. [key: string]: string;
  101048. };
  101049. /**
  101050. * Gets the list of emitted extensions
  101051. */
  101052. extensions: {
  101053. [key: string]: string;
  101054. };
  101055. /**
  101056. * Gets the target of the compilation state
  101057. */
  101058. target: NodeMaterialBlockTargets;
  101059. /**
  101060. * Gets the list of emitted counters
  101061. */
  101062. counters: {
  101063. [key: string]: number;
  101064. };
  101065. /**
  101066. * Shared data between multiple NodeMaterialBuildState instances
  101067. */
  101068. sharedData: NodeMaterialBuildStateSharedData;
  101069. /** @hidden */
  101070. _vertexState: NodeMaterialBuildState;
  101071. /** @hidden */
  101072. _attributeDeclaration: string;
  101073. /** @hidden */
  101074. _uniformDeclaration: string;
  101075. /** @hidden */
  101076. _constantDeclaration: string;
  101077. /** @hidden */
  101078. _samplerDeclaration: string;
  101079. /** @hidden */
  101080. _varyingTransfer: string;
  101081. /** @hidden */
  101082. _injectAtEnd: string;
  101083. private _repeatableContentAnchorIndex;
  101084. /** @hidden */
  101085. _builtCompilationString: string;
  101086. /**
  101087. * Gets the emitted compilation strings
  101088. */
  101089. compilationString: string;
  101090. /**
  101091. * Finalize the compilation strings
  101092. * @param state defines the current compilation state
  101093. */
  101094. finalize(state: NodeMaterialBuildState): void;
  101095. /** @hidden */
  101096. get _repeatableContentAnchor(): string;
  101097. /** @hidden */
  101098. _getFreeVariableName(prefix: string): string;
  101099. /** @hidden */
  101100. _getFreeDefineName(prefix: string): string;
  101101. /** @hidden */
  101102. _excludeVariableName(name: string): void;
  101103. /** @hidden */
  101104. _emit2DSampler(name: string): void;
  101105. /** @hidden */
  101106. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  101107. /** @hidden */
  101108. _emitExtension(name: string, extension: string, define?: string): void;
  101109. /** @hidden */
  101110. _emitFunction(name: string, code: string, comments: string): void;
  101111. /** @hidden */
  101112. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  101113. replaceStrings?: {
  101114. search: RegExp;
  101115. replace: string;
  101116. }[];
  101117. repeatKey?: string;
  101118. }): string;
  101119. /** @hidden */
  101120. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  101121. repeatKey?: string;
  101122. removeAttributes?: boolean;
  101123. removeUniforms?: boolean;
  101124. removeVaryings?: boolean;
  101125. removeIfDef?: boolean;
  101126. replaceStrings?: {
  101127. search: RegExp;
  101128. replace: string;
  101129. }[];
  101130. }, storeKey?: string): void;
  101131. /** @hidden */
  101132. _registerTempVariable(name: string): boolean;
  101133. /** @hidden */
  101134. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  101135. /** @hidden */
  101136. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  101137. /** @hidden */
  101138. _emitFloat(value: number): string;
  101139. }
  101140. }
  101141. declare module BABYLON {
  101142. /**
  101143. * Helper class used to generate session unique ID
  101144. */
  101145. export class UniqueIdGenerator {
  101146. private static _UniqueIdCounter;
  101147. /**
  101148. * Gets an unique (relatively to the current scene) Id
  101149. */
  101150. static get UniqueId(): number;
  101151. }
  101152. }
  101153. declare module BABYLON {
  101154. /**
  101155. * Defines a block that can be used inside a node based material
  101156. */
  101157. export class NodeMaterialBlock {
  101158. private _buildId;
  101159. private _buildTarget;
  101160. private _target;
  101161. private _isFinalMerger;
  101162. private _isInput;
  101163. private _name;
  101164. protected _isUnique: boolean;
  101165. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  101166. inputsAreExclusive: boolean;
  101167. /** @hidden */
  101168. _codeVariableName: string;
  101169. /** @hidden */
  101170. _inputs: NodeMaterialConnectionPoint[];
  101171. /** @hidden */
  101172. _outputs: NodeMaterialConnectionPoint[];
  101173. /** @hidden */
  101174. _preparationId: number;
  101175. /**
  101176. * Gets the name of the block
  101177. */
  101178. get name(): string;
  101179. /**
  101180. * Sets the name of the block. Will check if the name is valid.
  101181. */
  101182. set name(newName: string);
  101183. /**
  101184. * Gets or sets the unique id of the node
  101185. */
  101186. uniqueId: number;
  101187. /**
  101188. * Gets or sets the comments associated with this block
  101189. */
  101190. comments: string;
  101191. /**
  101192. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  101193. */
  101194. get isUnique(): boolean;
  101195. /**
  101196. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  101197. */
  101198. get isFinalMerger(): boolean;
  101199. /**
  101200. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  101201. */
  101202. get isInput(): boolean;
  101203. /**
  101204. * Gets or sets the build Id
  101205. */
  101206. get buildId(): number;
  101207. set buildId(value: number);
  101208. /**
  101209. * Gets or sets the target of the block
  101210. */
  101211. get target(): NodeMaterialBlockTargets;
  101212. set target(value: NodeMaterialBlockTargets);
  101213. /**
  101214. * Gets the list of input points
  101215. */
  101216. get inputs(): NodeMaterialConnectionPoint[];
  101217. /** Gets the list of output points */
  101218. get outputs(): NodeMaterialConnectionPoint[];
  101219. /**
  101220. * Find an input by its name
  101221. * @param name defines the name of the input to look for
  101222. * @returns the input or null if not found
  101223. */
  101224. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  101225. /**
  101226. * Find an output by its name
  101227. * @param name defines the name of the outputto look for
  101228. * @returns the output or null if not found
  101229. */
  101230. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  101231. /**
  101232. * Creates a new NodeMaterialBlock
  101233. * @param name defines the block name
  101234. * @param target defines the target of that block (Vertex by default)
  101235. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  101236. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  101237. */
  101238. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  101239. /**
  101240. * Initialize the block and prepare the context for build
  101241. * @param state defines the state that will be used for the build
  101242. */
  101243. initialize(state: NodeMaterialBuildState): void;
  101244. /**
  101245. * Bind data to effect. Will only be called for blocks with isBindable === true
  101246. * @param effect defines the effect to bind data to
  101247. * @param nodeMaterial defines the hosting NodeMaterial
  101248. * @param mesh defines the mesh that will be rendered
  101249. * @param subMesh defines the submesh that will be rendered
  101250. */
  101251. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  101252. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  101253. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  101254. protected _writeFloat(value: number): string;
  101255. /**
  101256. * Gets the current class name e.g. "NodeMaterialBlock"
  101257. * @returns the class name
  101258. */
  101259. getClassName(): string;
  101260. /**
  101261. * Register a new input. Must be called inside a block constructor
  101262. * @param name defines the connection point name
  101263. * @param type defines the connection point type
  101264. * @param isOptional defines a boolean indicating that this input can be omitted
  101265. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  101266. * @param point an already created connection point. If not provided, create a new one
  101267. * @returns the current block
  101268. */
  101269. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  101270. /**
  101271. * Register a new output. Must be called inside a block constructor
  101272. * @param name defines the connection point name
  101273. * @param type defines the connection point type
  101274. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  101275. * @param point an already created connection point. If not provided, create a new one
  101276. * @returns the current block
  101277. */
  101278. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  101279. /**
  101280. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  101281. * @param forOutput defines an optional connection point to check compatibility with
  101282. * @returns the first available input or null
  101283. */
  101284. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  101285. /**
  101286. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  101287. * @param forBlock defines an optional block to check compatibility with
  101288. * @returns the first available input or null
  101289. */
  101290. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  101291. /**
  101292. * Gets the sibling of the given output
  101293. * @param current defines the current output
  101294. * @returns the next output in the list or null
  101295. */
  101296. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  101297. /**
  101298. * Connect current block with another block
  101299. * @param other defines the block to connect with
  101300. * @param options define the various options to help pick the right connections
  101301. * @returns the current block
  101302. */
  101303. connectTo(other: NodeMaterialBlock, options?: {
  101304. input?: string;
  101305. output?: string;
  101306. outputSwizzle?: string;
  101307. }): this | undefined;
  101308. protected _buildBlock(state: NodeMaterialBuildState): void;
  101309. /**
  101310. * Add uniforms, samplers and uniform buffers at compilation time
  101311. * @param state defines the state to update
  101312. * @param nodeMaterial defines the node material requesting the update
  101313. * @param defines defines the material defines to update
  101314. * @param uniformBuffers defines the list of uniform buffer names
  101315. */
  101316. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  101317. /**
  101318. * Add potential fallbacks if shader compilation fails
  101319. * @param mesh defines the mesh to be rendered
  101320. * @param fallbacks defines the current prioritized list of fallbacks
  101321. */
  101322. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  101323. /**
  101324. * Initialize defines for shader compilation
  101325. * @param mesh defines the mesh to be rendered
  101326. * @param nodeMaterial defines the node material requesting the update
  101327. * @param defines defines the material defines to update
  101328. * @param useInstances specifies that instances should be used
  101329. */
  101330. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  101331. /**
  101332. * Update defines for shader compilation
  101333. * @param mesh defines the mesh to be rendered
  101334. * @param nodeMaterial defines the node material requesting the update
  101335. * @param defines defines the material defines to update
  101336. * @param useInstances specifies that instances should be used
  101337. * @param subMesh defines which submesh to render
  101338. */
  101339. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  101340. /**
  101341. * Lets the block try to connect some inputs automatically
  101342. * @param material defines the hosting NodeMaterial
  101343. */
  101344. autoConfigure(material: NodeMaterial): void;
  101345. /**
  101346. * Function called when a block is declared as repeatable content generator
  101347. * @param vertexShaderState defines the current compilation state for the vertex shader
  101348. * @param fragmentShaderState defines the current compilation state for the fragment shader
  101349. * @param mesh defines the mesh to be rendered
  101350. * @param defines defines the material defines to update
  101351. */
  101352. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  101353. /**
  101354. * Checks if the block is ready
  101355. * @param mesh defines the mesh to be rendered
  101356. * @param nodeMaterial defines the node material requesting the update
  101357. * @param defines defines the material defines to update
  101358. * @param useInstances specifies that instances should be used
  101359. * @returns true if the block is ready
  101360. */
  101361. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  101362. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  101363. private _processBuild;
  101364. /**
  101365. * Validates the new name for the block node.
  101366. * @param newName the new name to be given to the node.
  101367. * @returns false if the name is a reserve word, else true.
  101368. */
  101369. validateBlockName(newName: string): boolean;
  101370. /**
  101371. * Compile the current node and generate the shader code
  101372. * @param state defines the current compilation state (uniforms, samplers, current string)
  101373. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  101374. * @returns true if already built
  101375. */
  101376. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  101377. protected _inputRename(name: string): string;
  101378. protected _outputRename(name: string): string;
  101379. protected _dumpPropertiesCode(): string;
  101380. /** @hidden */
  101381. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  101382. /** @hidden */
  101383. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  101384. /**
  101385. * Clone the current block to a new identical block
  101386. * @param scene defines the hosting scene
  101387. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  101388. * @returns a copy of the current block
  101389. */
  101390. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  101391. /**
  101392. * Serializes this block in a JSON representation
  101393. * @returns the serialized block object
  101394. */
  101395. serialize(): any;
  101396. /** @hidden */
  101397. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101398. private _deserializePortDisplayNamesAndExposedOnFrame;
  101399. /**
  101400. * Release resources
  101401. */
  101402. dispose(): void;
  101403. }
  101404. }
  101405. declare module BABYLON {
  101406. /**
  101407. * Base class of materials working in push mode in babylon JS
  101408. * @hidden
  101409. */
  101410. export class PushMaterial extends Material {
  101411. protected _activeEffect: Effect;
  101412. protected _normalMatrix: Matrix;
  101413. constructor(name: string, scene: Scene);
  101414. getEffect(): Effect;
  101415. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  101416. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  101417. /**
  101418. * Binds the given world matrix to the active effect
  101419. *
  101420. * @param world the matrix to bind
  101421. */
  101422. bindOnlyWorldMatrix(world: Matrix): void;
  101423. /**
  101424. * Binds the given normal matrix to the active effect
  101425. *
  101426. * @param normalMatrix the matrix to bind
  101427. */
  101428. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  101429. bind(world: Matrix, mesh?: Mesh): void;
  101430. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  101431. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  101432. }
  101433. }
  101434. declare module BABYLON {
  101435. /**
  101436. * Root class for all node material optimizers
  101437. */
  101438. export class NodeMaterialOptimizer {
  101439. /**
  101440. * Function used to optimize a NodeMaterial graph
  101441. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  101442. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  101443. */
  101444. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  101445. }
  101446. }
  101447. declare module BABYLON {
  101448. /**
  101449. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  101450. */
  101451. export class TransformBlock extends NodeMaterialBlock {
  101452. /**
  101453. * Defines the value to use to complement W value to transform it to a Vector4
  101454. */
  101455. complementW: number;
  101456. /**
  101457. * Defines the value to use to complement z value to transform it to a Vector4
  101458. */
  101459. complementZ: number;
  101460. /**
  101461. * Creates a new TransformBlock
  101462. * @param name defines the block name
  101463. */
  101464. constructor(name: string);
  101465. /**
  101466. * Gets the current class name
  101467. * @returns the class name
  101468. */
  101469. getClassName(): string;
  101470. /**
  101471. * Gets the vector input
  101472. */
  101473. get vector(): NodeMaterialConnectionPoint;
  101474. /**
  101475. * Gets the output component
  101476. */
  101477. get output(): NodeMaterialConnectionPoint;
  101478. /**
  101479. * Gets the xyz output component
  101480. */
  101481. get xyz(): NodeMaterialConnectionPoint;
  101482. /**
  101483. * Gets the matrix transform input
  101484. */
  101485. get transform(): NodeMaterialConnectionPoint;
  101486. protected _buildBlock(state: NodeMaterialBuildState): this;
  101487. /**
  101488. * Update defines for shader compilation
  101489. * @param mesh defines the mesh to be rendered
  101490. * @param nodeMaterial defines the node material requesting the update
  101491. * @param defines defines the material defines to update
  101492. * @param useInstances specifies that instances should be used
  101493. * @param subMesh defines which submesh to render
  101494. */
  101495. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  101496. serialize(): any;
  101497. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101498. protected _dumpPropertiesCode(): string;
  101499. }
  101500. }
  101501. declare module BABYLON {
  101502. /**
  101503. * Block used to output the vertex position
  101504. */
  101505. export class VertexOutputBlock extends NodeMaterialBlock {
  101506. /**
  101507. * Creates a new VertexOutputBlock
  101508. * @param name defines the block name
  101509. */
  101510. constructor(name: string);
  101511. /**
  101512. * Gets the current class name
  101513. * @returns the class name
  101514. */
  101515. getClassName(): string;
  101516. /**
  101517. * Gets the vector input component
  101518. */
  101519. get vector(): NodeMaterialConnectionPoint;
  101520. protected _buildBlock(state: NodeMaterialBuildState): this;
  101521. }
  101522. }
  101523. declare module BABYLON {
  101524. /**
  101525. * Block used to output the final color
  101526. */
  101527. export class FragmentOutputBlock extends NodeMaterialBlock {
  101528. /**
  101529. * Create a new FragmentOutputBlock
  101530. * @param name defines the block name
  101531. */
  101532. constructor(name: string);
  101533. /**
  101534. * Gets the current class name
  101535. * @returns the class name
  101536. */
  101537. getClassName(): string;
  101538. /**
  101539. * Gets the rgba input component
  101540. */
  101541. get rgba(): NodeMaterialConnectionPoint;
  101542. /**
  101543. * Gets the rgb input component
  101544. */
  101545. get rgb(): NodeMaterialConnectionPoint;
  101546. /**
  101547. * Gets the a input component
  101548. */
  101549. get a(): NodeMaterialConnectionPoint;
  101550. protected _buildBlock(state: NodeMaterialBuildState): this;
  101551. }
  101552. }
  101553. declare module BABYLON {
  101554. /**
  101555. * Block used for the particle ramp gradient section
  101556. */
  101557. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  101558. /**
  101559. * Create a new ParticleRampGradientBlock
  101560. * @param name defines the block name
  101561. */
  101562. constructor(name: string);
  101563. /**
  101564. * Gets the current class name
  101565. * @returns the class name
  101566. */
  101567. getClassName(): string;
  101568. /**
  101569. * Gets the color input component
  101570. */
  101571. get color(): NodeMaterialConnectionPoint;
  101572. /**
  101573. * Gets the rampColor output component
  101574. */
  101575. get rampColor(): NodeMaterialConnectionPoint;
  101576. /**
  101577. * Initialize the block and prepare the context for build
  101578. * @param state defines the state that will be used for the build
  101579. */
  101580. initialize(state: NodeMaterialBuildState): void;
  101581. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101582. }
  101583. }
  101584. declare module BABYLON {
  101585. /**
  101586. * Block used for the particle blend multiply section
  101587. */
  101588. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  101589. /**
  101590. * Create a new ParticleBlendMultiplyBlock
  101591. * @param name defines the block name
  101592. */
  101593. constructor(name: string);
  101594. /**
  101595. * Gets the current class name
  101596. * @returns the class name
  101597. */
  101598. getClassName(): string;
  101599. /**
  101600. * Gets the color input component
  101601. */
  101602. get color(): NodeMaterialConnectionPoint;
  101603. /**
  101604. * Gets the alphaTexture input component
  101605. */
  101606. get alphaTexture(): NodeMaterialConnectionPoint;
  101607. /**
  101608. * Gets the alphaColor input component
  101609. */
  101610. get alphaColor(): NodeMaterialConnectionPoint;
  101611. /**
  101612. * Gets the blendColor output component
  101613. */
  101614. get blendColor(): NodeMaterialConnectionPoint;
  101615. /**
  101616. * Initialize the block and prepare the context for build
  101617. * @param state defines the state that will be used for the build
  101618. */
  101619. initialize(state: NodeMaterialBuildState): void;
  101620. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101621. }
  101622. }
  101623. declare module BABYLON {
  101624. /**
  101625. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  101626. */
  101627. export class VectorMergerBlock extends NodeMaterialBlock {
  101628. /**
  101629. * Create a new VectorMergerBlock
  101630. * @param name defines the block name
  101631. */
  101632. constructor(name: string);
  101633. /**
  101634. * Gets the current class name
  101635. * @returns the class name
  101636. */
  101637. getClassName(): string;
  101638. /**
  101639. * Gets the xyz component (input)
  101640. */
  101641. get xyzIn(): NodeMaterialConnectionPoint;
  101642. /**
  101643. * Gets the xy component (input)
  101644. */
  101645. get xyIn(): NodeMaterialConnectionPoint;
  101646. /**
  101647. * Gets the x component (input)
  101648. */
  101649. get x(): NodeMaterialConnectionPoint;
  101650. /**
  101651. * Gets the y component (input)
  101652. */
  101653. get y(): NodeMaterialConnectionPoint;
  101654. /**
  101655. * Gets the z component (input)
  101656. */
  101657. get z(): NodeMaterialConnectionPoint;
  101658. /**
  101659. * Gets the w component (input)
  101660. */
  101661. get w(): NodeMaterialConnectionPoint;
  101662. /**
  101663. * Gets the xyzw component (output)
  101664. */
  101665. get xyzw(): NodeMaterialConnectionPoint;
  101666. /**
  101667. * Gets the xyz component (output)
  101668. */
  101669. get xyzOut(): NodeMaterialConnectionPoint;
  101670. /**
  101671. * Gets the xy component (output)
  101672. */
  101673. get xyOut(): NodeMaterialConnectionPoint;
  101674. /**
  101675. * Gets the xy component (output)
  101676. * @deprecated Please use xyOut instead.
  101677. */
  101678. get xy(): NodeMaterialConnectionPoint;
  101679. /**
  101680. * Gets the xyz component (output)
  101681. * @deprecated Please use xyzOut instead.
  101682. */
  101683. get xyz(): NodeMaterialConnectionPoint;
  101684. protected _buildBlock(state: NodeMaterialBuildState): this;
  101685. }
  101686. }
  101687. declare module BABYLON {
  101688. /**
  101689. * Block used to remap a float from a range to a new one
  101690. */
  101691. export class RemapBlock extends NodeMaterialBlock {
  101692. /**
  101693. * Gets or sets the source range
  101694. */
  101695. sourceRange: Vector2;
  101696. /**
  101697. * Gets or sets the target range
  101698. */
  101699. targetRange: Vector2;
  101700. /**
  101701. * Creates a new RemapBlock
  101702. * @param name defines the block name
  101703. */
  101704. constructor(name: string);
  101705. /**
  101706. * Gets the current class name
  101707. * @returns the class name
  101708. */
  101709. getClassName(): string;
  101710. /**
  101711. * Gets the input component
  101712. */
  101713. get input(): NodeMaterialConnectionPoint;
  101714. /**
  101715. * Gets the source min input component
  101716. */
  101717. get sourceMin(): NodeMaterialConnectionPoint;
  101718. /**
  101719. * Gets the source max input component
  101720. */
  101721. get sourceMax(): NodeMaterialConnectionPoint;
  101722. /**
  101723. * Gets the target min input component
  101724. */
  101725. get targetMin(): NodeMaterialConnectionPoint;
  101726. /**
  101727. * Gets the target max input component
  101728. */
  101729. get targetMax(): NodeMaterialConnectionPoint;
  101730. /**
  101731. * Gets the output component
  101732. */
  101733. get output(): NodeMaterialConnectionPoint;
  101734. protected _buildBlock(state: NodeMaterialBuildState): this;
  101735. protected _dumpPropertiesCode(): string;
  101736. serialize(): any;
  101737. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101738. }
  101739. }
  101740. declare module BABYLON {
  101741. /**
  101742. * Block used to multiply 2 values
  101743. */
  101744. export class MultiplyBlock extends NodeMaterialBlock {
  101745. /**
  101746. * Creates a new MultiplyBlock
  101747. * @param name defines the block name
  101748. */
  101749. constructor(name: string);
  101750. /**
  101751. * Gets the current class name
  101752. * @returns the class name
  101753. */
  101754. getClassName(): string;
  101755. /**
  101756. * Gets the left operand input component
  101757. */
  101758. get left(): NodeMaterialConnectionPoint;
  101759. /**
  101760. * Gets the right operand input component
  101761. */
  101762. get right(): NodeMaterialConnectionPoint;
  101763. /**
  101764. * Gets the output component
  101765. */
  101766. get output(): NodeMaterialConnectionPoint;
  101767. protected _buildBlock(state: NodeMaterialBuildState): this;
  101768. }
  101769. }
  101770. declare module BABYLON {
  101771. /**
  101772. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  101773. */
  101774. export class ColorSplitterBlock extends NodeMaterialBlock {
  101775. /**
  101776. * Create a new ColorSplitterBlock
  101777. * @param name defines the block name
  101778. */
  101779. constructor(name: string);
  101780. /**
  101781. * Gets the current class name
  101782. * @returns the class name
  101783. */
  101784. getClassName(): string;
  101785. /**
  101786. * Gets the rgba component (input)
  101787. */
  101788. get rgba(): NodeMaterialConnectionPoint;
  101789. /**
  101790. * Gets the rgb component (input)
  101791. */
  101792. get rgbIn(): NodeMaterialConnectionPoint;
  101793. /**
  101794. * Gets the rgb component (output)
  101795. */
  101796. get rgbOut(): NodeMaterialConnectionPoint;
  101797. /**
  101798. * Gets the r component (output)
  101799. */
  101800. get r(): NodeMaterialConnectionPoint;
  101801. /**
  101802. * Gets the g component (output)
  101803. */
  101804. get g(): NodeMaterialConnectionPoint;
  101805. /**
  101806. * Gets the b component (output)
  101807. */
  101808. get b(): NodeMaterialConnectionPoint;
  101809. /**
  101810. * Gets the a component (output)
  101811. */
  101812. get a(): NodeMaterialConnectionPoint;
  101813. protected _inputRename(name: string): string;
  101814. protected _outputRename(name: string): string;
  101815. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101816. }
  101817. }
  101818. declare module BABYLON {
  101819. /**
  101820. * Interface used to configure the node material editor
  101821. */
  101822. export interface INodeMaterialEditorOptions {
  101823. /** Define the URl to load node editor script */
  101824. editorURL?: string;
  101825. }
  101826. /** @hidden */
  101827. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  101828. NORMAL: boolean;
  101829. TANGENT: boolean;
  101830. UV1: boolean;
  101831. /** BONES */
  101832. NUM_BONE_INFLUENCERS: number;
  101833. BonesPerMesh: number;
  101834. BONETEXTURE: boolean;
  101835. /** MORPH TARGETS */
  101836. MORPHTARGETS: boolean;
  101837. MORPHTARGETS_NORMAL: boolean;
  101838. MORPHTARGETS_TANGENT: boolean;
  101839. MORPHTARGETS_UV: boolean;
  101840. NUM_MORPH_INFLUENCERS: number;
  101841. /** IMAGE PROCESSING */
  101842. IMAGEPROCESSING: boolean;
  101843. VIGNETTE: boolean;
  101844. VIGNETTEBLENDMODEMULTIPLY: boolean;
  101845. VIGNETTEBLENDMODEOPAQUE: boolean;
  101846. TONEMAPPING: boolean;
  101847. TONEMAPPING_ACES: boolean;
  101848. CONTRAST: boolean;
  101849. EXPOSURE: boolean;
  101850. COLORCURVES: boolean;
  101851. COLORGRADING: boolean;
  101852. COLORGRADING3D: boolean;
  101853. SAMPLER3DGREENDEPTH: boolean;
  101854. SAMPLER3DBGRMAP: boolean;
  101855. IMAGEPROCESSINGPOSTPROCESS: boolean;
  101856. /** MISC. */
  101857. BUMPDIRECTUV: number;
  101858. constructor();
  101859. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  101860. }
  101861. /**
  101862. * Class used to configure NodeMaterial
  101863. */
  101864. export interface INodeMaterialOptions {
  101865. /**
  101866. * Defines if blocks should emit comments
  101867. */
  101868. emitComments: boolean;
  101869. }
  101870. /**
  101871. * Class used to create a node based material built by assembling shader blocks
  101872. */
  101873. export class NodeMaterial extends PushMaterial {
  101874. private static _BuildIdGenerator;
  101875. private _options;
  101876. private _vertexCompilationState;
  101877. private _fragmentCompilationState;
  101878. private _sharedData;
  101879. private _buildId;
  101880. private _buildWasSuccessful;
  101881. private _cachedWorldViewMatrix;
  101882. private _cachedWorldViewProjectionMatrix;
  101883. private _optimizers;
  101884. private _animationFrame;
  101885. /** Define the Url to load node editor script */
  101886. static EditorURL: string;
  101887. /** Define the Url to load snippets */
  101888. static SnippetUrl: string;
  101889. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  101890. static IgnoreTexturesAtLoadTime: boolean;
  101891. private BJSNODEMATERIALEDITOR;
  101892. /** Get the inspector from bundle or global */
  101893. private _getGlobalNodeMaterialEditor;
  101894. /**
  101895. * Snippet ID if the material was created from the snippet server
  101896. */
  101897. snippetId: string;
  101898. /**
  101899. * Gets or sets data used by visual editor
  101900. * @see https://nme.babylonjs.com
  101901. */
  101902. editorData: any;
  101903. /**
  101904. * 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)
  101905. */
  101906. ignoreAlpha: boolean;
  101907. /**
  101908. * Defines the maximum number of lights that can be used in the material
  101909. */
  101910. maxSimultaneousLights: number;
  101911. /**
  101912. * Observable raised when the material is built
  101913. */
  101914. onBuildObservable: Observable<NodeMaterial>;
  101915. /**
  101916. * Gets or sets the root nodes of the material vertex shader
  101917. */
  101918. _vertexOutputNodes: NodeMaterialBlock[];
  101919. /**
  101920. * Gets or sets the root nodes of the material fragment (pixel) shader
  101921. */
  101922. _fragmentOutputNodes: NodeMaterialBlock[];
  101923. /** Gets or sets options to control the node material overall behavior */
  101924. get options(): INodeMaterialOptions;
  101925. set options(options: INodeMaterialOptions);
  101926. /**
  101927. * Default configuration related to image processing available in the standard Material.
  101928. */
  101929. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  101930. /**
  101931. * Gets the image processing configuration used either in this material.
  101932. */
  101933. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  101934. /**
  101935. * Sets the Default image processing configuration used either in the this material.
  101936. *
  101937. * If sets to null, the scene one is in use.
  101938. */
  101939. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  101940. /**
  101941. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  101942. */
  101943. attachedBlocks: NodeMaterialBlock[];
  101944. /**
  101945. * Specifies the mode of the node material
  101946. * @hidden
  101947. */
  101948. _mode: NodeMaterialModes;
  101949. /**
  101950. * Gets the mode property
  101951. */
  101952. get mode(): NodeMaterialModes;
  101953. /**
  101954. * Create a new node based material
  101955. * @param name defines the material name
  101956. * @param scene defines the hosting scene
  101957. * @param options defines creation option
  101958. */
  101959. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  101960. /**
  101961. * Gets the current class name of the material e.g. "NodeMaterial"
  101962. * @returns the class name
  101963. */
  101964. getClassName(): string;
  101965. /**
  101966. * Keep track of the image processing observer to allow dispose and replace.
  101967. */
  101968. private _imageProcessingObserver;
  101969. /**
  101970. * Attaches a new image processing configuration to the Standard Material.
  101971. * @param configuration
  101972. */
  101973. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  101974. /**
  101975. * Get a block by its name
  101976. * @param name defines the name of the block to retrieve
  101977. * @returns the required block or null if not found
  101978. */
  101979. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  101980. /**
  101981. * Get a block by its name
  101982. * @param predicate defines the predicate used to find the good candidate
  101983. * @returns the required block or null if not found
  101984. */
  101985. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  101986. /**
  101987. * Get an input block by its name
  101988. * @param predicate defines the predicate used to find the good candidate
  101989. * @returns the required input block or null if not found
  101990. */
  101991. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  101992. /**
  101993. * Gets the list of input blocks attached to this material
  101994. * @returns an array of InputBlocks
  101995. */
  101996. getInputBlocks(): InputBlock[];
  101997. /**
  101998. * Adds a new optimizer to the list of optimizers
  101999. * @param optimizer defines the optimizers to add
  102000. * @returns the current material
  102001. */
  102002. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  102003. /**
  102004. * Remove an optimizer from the list of optimizers
  102005. * @param optimizer defines the optimizers to remove
  102006. * @returns the current material
  102007. */
  102008. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  102009. /**
  102010. * Add a new block to the list of output nodes
  102011. * @param node defines the node to add
  102012. * @returns the current material
  102013. */
  102014. addOutputNode(node: NodeMaterialBlock): this;
  102015. /**
  102016. * Remove a block from the list of root nodes
  102017. * @param node defines the node to remove
  102018. * @returns the current material
  102019. */
  102020. removeOutputNode(node: NodeMaterialBlock): this;
  102021. private _addVertexOutputNode;
  102022. private _removeVertexOutputNode;
  102023. private _addFragmentOutputNode;
  102024. private _removeFragmentOutputNode;
  102025. /**
  102026. * Specifies if the material will require alpha blending
  102027. * @returns a boolean specifying if alpha blending is needed
  102028. */
  102029. needAlphaBlending(): boolean;
  102030. /**
  102031. * Specifies if this material should be rendered in alpha test mode
  102032. * @returns a boolean specifying if an alpha test is needed.
  102033. */
  102034. needAlphaTesting(): boolean;
  102035. private _initializeBlock;
  102036. private _resetDualBlocks;
  102037. /**
  102038. * Remove a block from the current node material
  102039. * @param block defines the block to remove
  102040. */
  102041. removeBlock(block: NodeMaterialBlock): void;
  102042. /**
  102043. * Build the material and generates the inner effect
  102044. * @param verbose defines if the build should log activity
  102045. */
  102046. build(verbose?: boolean): void;
  102047. /**
  102048. * Runs an otpimization phase to try to improve the shader code
  102049. */
  102050. optimize(): void;
  102051. private _prepareDefinesForAttributes;
  102052. /**
  102053. * Create a post process from the material
  102054. * @param camera The camera to apply the render pass to.
  102055. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102056. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102057. * @param engine The engine which the post process will be applied. (default: current engine)
  102058. * @param reusable If the post process can be reused on the same frame. (default: false)
  102059. * @param textureType Type of textures used when performing the post process. (default: 0)
  102060. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  102061. * @returns the post process created
  102062. */
  102063. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): PostProcess;
  102064. /**
  102065. * Create the post process effect from the material
  102066. * @param postProcess The post process to create the effect for
  102067. */
  102068. createEffectForPostProcess(postProcess: PostProcess): void;
  102069. private _createEffectOrPostProcess;
  102070. private _createEffectForParticles;
  102071. /**
  102072. * Create the effect to be used as the custom effect for a particle system
  102073. * @param particleSystem Particle system to create the effect for
  102074. * @param onCompiled defines a function to call when the effect creation is successful
  102075. * @param onError defines a function to call when the effect creation has failed
  102076. */
  102077. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102078. private _processDefines;
  102079. /**
  102080. * Get if the submesh is ready to be used and all its information available.
  102081. * Child classes can use it to update shaders
  102082. * @param mesh defines the mesh to check
  102083. * @param subMesh defines which submesh to check
  102084. * @param useInstances specifies that instances should be used
  102085. * @returns a boolean indicating that the submesh is ready or not
  102086. */
  102087. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  102088. /**
  102089. * Get a string representing the shaders built by the current node graph
  102090. */
  102091. get compiledShaders(): string;
  102092. /**
  102093. * Binds the world matrix to the material
  102094. * @param world defines the world transformation matrix
  102095. */
  102096. bindOnlyWorldMatrix(world: Matrix): void;
  102097. /**
  102098. * Binds the submesh to this material by preparing the effect and shader to draw
  102099. * @param world defines the world transformation matrix
  102100. * @param mesh defines the mesh containing the submesh
  102101. * @param subMesh defines the submesh to bind the material to
  102102. */
  102103. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  102104. /**
  102105. * Gets the active textures from the material
  102106. * @returns an array of textures
  102107. */
  102108. getActiveTextures(): BaseTexture[];
  102109. /**
  102110. * Gets the list of texture blocks
  102111. * @returns an array of texture blocks
  102112. */
  102113. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  102114. /**
  102115. * Specifies if the material uses a texture
  102116. * @param texture defines the texture to check against the material
  102117. * @returns a boolean specifying if the material uses the texture
  102118. */
  102119. hasTexture(texture: BaseTexture): boolean;
  102120. /**
  102121. * Disposes the material
  102122. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  102123. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  102124. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  102125. */
  102126. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  102127. /** Creates the node editor window. */
  102128. private _createNodeEditor;
  102129. /**
  102130. * Launch the node material editor
  102131. * @param config Define the configuration of the editor
  102132. * @return a promise fulfilled when the node editor is visible
  102133. */
  102134. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  102135. /**
  102136. * Clear the current material
  102137. */
  102138. clear(): void;
  102139. /**
  102140. * Clear the current material and set it to a default state
  102141. */
  102142. setToDefault(): void;
  102143. /**
  102144. * Clear the current material and set it to a default state for post process
  102145. */
  102146. setToDefaultPostProcess(): void;
  102147. /**
  102148. * Clear the current material and set it to a default state for particle
  102149. */
  102150. setToDefaultParticle(): void;
  102151. /**
  102152. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  102153. * @param url defines the url to load from
  102154. * @returns a promise that will fullfil when the material is fully loaded
  102155. */
  102156. loadAsync(url: string): Promise<void>;
  102157. private _gatherBlocks;
  102158. /**
  102159. * Generate a string containing the code declaration required to create an equivalent of this material
  102160. * @returns a string
  102161. */
  102162. generateCode(): string;
  102163. /**
  102164. * Serializes this material in a JSON representation
  102165. * @returns the serialized material object
  102166. */
  102167. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  102168. private _restoreConnections;
  102169. /**
  102170. * Clear the current graph and load a new one from a serialization object
  102171. * @param source defines the JSON representation of the material
  102172. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102173. * @param merge defines whether or not the source must be merged or replace the current content
  102174. */
  102175. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  102176. /**
  102177. * Makes a duplicate of the current material.
  102178. * @param name - name to use for the new material.
  102179. */
  102180. clone(name: string): NodeMaterial;
  102181. /**
  102182. * Creates a node material from parsed material data
  102183. * @param source defines the JSON representation of the material
  102184. * @param scene defines the hosting scene
  102185. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102186. * @returns a new node material
  102187. */
  102188. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  102189. /**
  102190. * Creates a node material from a snippet saved in a remote file
  102191. * @param name defines the name of the material to create
  102192. * @param url defines the url to load from
  102193. * @param scene defines the hosting scene
  102194. * @returns a promise that will resolve to the new node material
  102195. */
  102196. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  102197. /**
  102198. * Creates a node material from a snippet saved by the node material editor
  102199. * @param snippetId defines the snippet to load
  102200. * @param scene defines the hosting scene
  102201. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102202. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  102203. * @returns a promise that will resolve to the new node material
  102204. */
  102205. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  102206. /**
  102207. * Creates a new node material set to default basic configuration
  102208. * @param name defines the name of the material
  102209. * @param scene defines the hosting scene
  102210. * @returns a new NodeMaterial
  102211. */
  102212. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  102213. }
  102214. }
  102215. declare module BABYLON {
  102216. /**
  102217. * Size options for a post process
  102218. */
  102219. export type PostProcessOptions = {
  102220. width: number;
  102221. height: number;
  102222. };
  102223. /**
  102224. * PostProcess can be used to apply a shader to a texture after it has been rendered
  102225. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  102226. */
  102227. export class PostProcess {
  102228. /**
  102229. * Gets or sets the unique id of the post process
  102230. */
  102231. uniqueId: number;
  102232. /** Name of the PostProcess. */
  102233. name: string;
  102234. /**
  102235. * Width of the texture to apply the post process on
  102236. */
  102237. width: number;
  102238. /**
  102239. * Height of the texture to apply the post process on
  102240. */
  102241. height: number;
  102242. /**
  102243. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  102244. */
  102245. nodeMaterialSource: Nullable<NodeMaterial>;
  102246. /**
  102247. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  102248. * @hidden
  102249. */
  102250. _outputTexture: Nullable<InternalTexture>;
  102251. /**
  102252. * Sampling mode used by the shader
  102253. * See https://doc.babylonjs.com/classes/3.1/texture
  102254. */
  102255. renderTargetSamplingMode: number;
  102256. /**
  102257. * Clear color to use when screen clearing
  102258. */
  102259. clearColor: Color4;
  102260. /**
  102261. * If the buffer needs to be cleared before applying the post process. (default: true)
  102262. * Should be set to false if shader will overwrite all previous pixels.
  102263. */
  102264. autoClear: boolean;
  102265. /**
  102266. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  102267. */
  102268. alphaMode: number;
  102269. /**
  102270. * Sets the setAlphaBlendConstants of the babylon engine
  102271. */
  102272. alphaConstants: Color4;
  102273. /**
  102274. * Animations to be used for the post processing
  102275. */
  102276. animations: Animation[];
  102277. /**
  102278. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  102279. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  102280. */
  102281. enablePixelPerfectMode: boolean;
  102282. /**
  102283. * Force the postprocess to be applied without taking in account viewport
  102284. */
  102285. forceFullscreenViewport: boolean;
  102286. /**
  102287. * List of inspectable custom properties (used by the Inspector)
  102288. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  102289. */
  102290. inspectableCustomProperties: IInspectable[];
  102291. /**
  102292. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  102293. *
  102294. * | Value | Type | Description |
  102295. * | ----- | ----------------------------------- | ----------- |
  102296. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  102297. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  102298. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  102299. *
  102300. */
  102301. scaleMode: number;
  102302. /**
  102303. * Force textures to be a power of two (default: false)
  102304. */
  102305. alwaysForcePOT: boolean;
  102306. private _samples;
  102307. /**
  102308. * Number of sample textures (default: 1)
  102309. */
  102310. get samples(): number;
  102311. set samples(n: number);
  102312. /**
  102313. * Modify the scale of the post process to be the same as the viewport (default: false)
  102314. */
  102315. adaptScaleToCurrentViewport: boolean;
  102316. private _camera;
  102317. protected _scene: Scene;
  102318. private _engine;
  102319. private _options;
  102320. private _reusable;
  102321. private _textureType;
  102322. private _textureFormat;
  102323. /**
  102324. * Smart array of input and output textures for the post process.
  102325. * @hidden
  102326. */
  102327. _textures: SmartArray<InternalTexture>;
  102328. /**
  102329. * The index in _textures that corresponds to the output texture.
  102330. * @hidden
  102331. */
  102332. _currentRenderTextureInd: number;
  102333. private _effect;
  102334. private _samplers;
  102335. private _fragmentUrl;
  102336. private _vertexUrl;
  102337. private _parameters;
  102338. private _scaleRatio;
  102339. protected _indexParameters: any;
  102340. private _shareOutputWithPostProcess;
  102341. private _texelSize;
  102342. private _forcedOutputTexture;
  102343. /**
  102344. * Returns the fragment url or shader name used in the post process.
  102345. * @returns the fragment url or name in the shader store.
  102346. */
  102347. getEffectName(): string;
  102348. /**
  102349. * An event triggered when the postprocess is activated.
  102350. */
  102351. onActivateObservable: Observable<Camera>;
  102352. private _onActivateObserver;
  102353. /**
  102354. * A function that is added to the onActivateObservable
  102355. */
  102356. set onActivate(callback: Nullable<(camera: Camera) => void>);
  102357. /**
  102358. * An event triggered when the postprocess changes its size.
  102359. */
  102360. onSizeChangedObservable: Observable<PostProcess>;
  102361. private _onSizeChangedObserver;
  102362. /**
  102363. * A function that is added to the onSizeChangedObservable
  102364. */
  102365. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  102366. /**
  102367. * An event triggered when the postprocess applies its effect.
  102368. */
  102369. onApplyObservable: Observable<Effect>;
  102370. private _onApplyObserver;
  102371. /**
  102372. * A function that is added to the onApplyObservable
  102373. */
  102374. set onApply(callback: (effect: Effect) => void);
  102375. /**
  102376. * An event triggered before rendering the postprocess
  102377. */
  102378. onBeforeRenderObservable: Observable<Effect>;
  102379. private _onBeforeRenderObserver;
  102380. /**
  102381. * A function that is added to the onBeforeRenderObservable
  102382. */
  102383. set onBeforeRender(callback: (effect: Effect) => void);
  102384. /**
  102385. * An event triggered after rendering the postprocess
  102386. */
  102387. onAfterRenderObservable: Observable<Effect>;
  102388. private _onAfterRenderObserver;
  102389. /**
  102390. * A function that is added to the onAfterRenderObservable
  102391. */
  102392. set onAfterRender(callback: (efect: Effect) => void);
  102393. /**
  102394. * 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
  102395. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  102396. */
  102397. get inputTexture(): InternalTexture;
  102398. set inputTexture(value: InternalTexture);
  102399. /**
  102400. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  102401. * the only way to unset it is to use this function to restore its internal state
  102402. */
  102403. restoreDefaultInputTexture(): void;
  102404. /**
  102405. * Gets the camera which post process is applied to.
  102406. * @returns The camera the post process is applied to.
  102407. */
  102408. getCamera(): Camera;
  102409. /**
  102410. * Gets the texel size of the postprocess.
  102411. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  102412. */
  102413. get texelSize(): Vector2;
  102414. /**
  102415. * Creates a new instance PostProcess
  102416. * @param name The name of the PostProcess.
  102417. * @param fragmentUrl The url of the fragment shader to be used.
  102418. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  102419. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  102420. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102421. * @param camera The camera to apply the render pass to.
  102422. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102423. * @param engine The engine which the post process will be applied. (default: current engine)
  102424. * @param reusable If the post process can be reused on the same frame. (default: false)
  102425. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  102426. * @param textureType Type of textures used when performing the post process. (default: 0)
  102427. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  102428. * @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
  102429. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  102430. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  102431. */
  102432. 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);
  102433. /**
  102434. * Gets a string identifying the name of the class
  102435. * @returns "PostProcess" string
  102436. */
  102437. getClassName(): string;
  102438. /**
  102439. * Gets the engine which this post process belongs to.
  102440. * @returns The engine the post process was enabled with.
  102441. */
  102442. getEngine(): Engine;
  102443. /**
  102444. * The effect that is created when initializing the post process.
  102445. * @returns The created effect corresponding the the postprocess.
  102446. */
  102447. getEffect(): Effect;
  102448. /**
  102449. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  102450. * @param postProcess The post process to share the output with.
  102451. * @returns This post process.
  102452. */
  102453. shareOutputWith(postProcess: PostProcess): PostProcess;
  102454. /**
  102455. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  102456. * This should be called if the post process that shares output with this post process is disabled/disposed.
  102457. */
  102458. useOwnOutput(): void;
  102459. /**
  102460. * Updates the effect with the current post process compile time values and recompiles the shader.
  102461. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  102462. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  102463. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  102464. * @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
  102465. * @param onCompiled Called when the shader has been compiled.
  102466. * @param onError Called if there is an error when compiling a shader.
  102467. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  102468. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  102469. */
  102470. 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;
  102471. /**
  102472. * The post process is reusable if it can be used multiple times within one frame.
  102473. * @returns If the post process is reusable
  102474. */
  102475. isReusable(): boolean;
  102476. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  102477. markTextureDirty(): void;
  102478. /**
  102479. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  102480. * 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.
  102481. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  102482. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  102483. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  102484. * @returns The target texture that was bound to be written to.
  102485. */
  102486. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  102487. /**
  102488. * If the post process is supported.
  102489. */
  102490. get isSupported(): boolean;
  102491. /**
  102492. * The aspect ratio of the output texture.
  102493. */
  102494. get aspectRatio(): number;
  102495. /**
  102496. * Get a value indicating if the post-process is ready to be used
  102497. * @returns true if the post-process is ready (shader is compiled)
  102498. */
  102499. isReady(): boolean;
  102500. /**
  102501. * Binds all textures and uniforms to the shader, this will be run on every pass.
  102502. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  102503. */
  102504. apply(): Nullable<Effect>;
  102505. private _disposeTextures;
  102506. /**
  102507. * Disposes the post process.
  102508. * @param camera The camera to dispose the post process on.
  102509. */
  102510. dispose(camera?: Camera): void;
  102511. /**
  102512. * Serializes the particle system to a JSON object
  102513. * @returns the JSON object
  102514. */
  102515. serialize(): any;
  102516. /**
  102517. * Creates a material from parsed material data
  102518. * @param parsedPostProcess defines parsed post process data
  102519. * @param scene defines the hosting scene
  102520. * @param rootUrl defines the root URL to use to load textures
  102521. * @returns a new post process
  102522. */
  102523. static Parse(parsedPostProcess: any, scene: Scene, rootUrl: string): Nullable<PostProcess>;
  102524. }
  102525. }
  102526. declare module BABYLON {
  102527. /** @hidden */
  102528. export var kernelBlurVaryingDeclaration: {
  102529. name: string;
  102530. shader: string;
  102531. };
  102532. }
  102533. declare module BABYLON {
  102534. /** @hidden */
  102535. export var kernelBlurFragment: {
  102536. name: string;
  102537. shader: string;
  102538. };
  102539. }
  102540. declare module BABYLON {
  102541. /** @hidden */
  102542. export var kernelBlurFragment2: {
  102543. name: string;
  102544. shader: string;
  102545. };
  102546. }
  102547. declare module BABYLON {
  102548. /** @hidden */
  102549. export var kernelBlurPixelShader: {
  102550. name: string;
  102551. shader: string;
  102552. };
  102553. }
  102554. declare module BABYLON {
  102555. /** @hidden */
  102556. export var kernelBlurVertex: {
  102557. name: string;
  102558. shader: string;
  102559. };
  102560. }
  102561. declare module BABYLON {
  102562. /** @hidden */
  102563. export var kernelBlurVertexShader: {
  102564. name: string;
  102565. shader: string;
  102566. };
  102567. }
  102568. declare module BABYLON {
  102569. /**
  102570. * The Blur Post Process which blurs an image based on a kernel and direction.
  102571. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  102572. */
  102573. export class BlurPostProcess extends PostProcess {
  102574. private blockCompilation;
  102575. protected _kernel: number;
  102576. protected _idealKernel: number;
  102577. protected _packedFloat: boolean;
  102578. private _staticDefines;
  102579. /** The direction in which to blur the image. */
  102580. direction: Vector2;
  102581. /**
  102582. * Sets the length in pixels of the blur sample region
  102583. */
  102584. set kernel(v: number);
  102585. /**
  102586. * Gets the length in pixels of the blur sample region
  102587. */
  102588. get kernel(): number;
  102589. /**
  102590. * Sets wether or not the blur needs to unpack/repack floats
  102591. */
  102592. set packedFloat(v: boolean);
  102593. /**
  102594. * Gets wether or not the blur is unpacking/repacking floats
  102595. */
  102596. get packedFloat(): boolean;
  102597. /**
  102598. * Gets a string identifying the name of the class
  102599. * @returns "BlurPostProcess" string
  102600. */
  102601. getClassName(): string;
  102602. /**
  102603. * Creates a new instance BlurPostProcess
  102604. * @param name The name of the effect.
  102605. * @param direction The direction in which to blur the image.
  102606. * @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.
  102607. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102608. * @param camera The camera to apply the render pass to.
  102609. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102610. * @param engine The engine which the post process will be applied. (default: current engine)
  102611. * @param reusable If the post process can be reused on the same frame. (default: false)
  102612. * @param textureType Type of textures used when performing the post process. (default: 0)
  102613. * @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)
  102614. */
  102615. 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);
  102616. /**
  102617. * Updates the effect with the current post process compile time values and recompiles the shader.
  102618. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  102619. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  102620. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  102621. * @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
  102622. * @param onCompiled Called when the shader has been compiled.
  102623. * @param onError Called if there is an error when compiling a shader.
  102624. */
  102625. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102626. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102627. /**
  102628. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  102629. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  102630. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  102631. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  102632. * The gaps between physical kernels are compensated for in the weighting of the samples
  102633. * @param idealKernel Ideal blur kernel.
  102634. * @return Nearest best kernel.
  102635. */
  102636. protected _nearestBestKernel(idealKernel: number): number;
  102637. /**
  102638. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  102639. * @param x The point on the Gaussian distribution to sample.
  102640. * @return the value of the Gaussian function at x.
  102641. */
  102642. protected _gaussianWeight(x: number): number;
  102643. /**
  102644. * Generates a string that can be used as a floating point number in GLSL.
  102645. * @param x Value to print.
  102646. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  102647. * @return GLSL float string.
  102648. */
  102649. protected _glslFloat(x: number, decimalFigures?: number): string;
  102650. /** @hidden */
  102651. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlurPostProcess>;
  102652. }
  102653. }
  102654. declare module BABYLON {
  102655. /**
  102656. * Mirror texture can be used to simulate the view from a mirror in a scene.
  102657. * It will dynamically be rendered every frame to adapt to the camera point of view.
  102658. * You can then easily use it as a reflectionTexture on a flat surface.
  102659. * In case the surface is not a plane, please consider relying on reflection probes.
  102660. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102661. */
  102662. export class MirrorTexture extends RenderTargetTexture {
  102663. private scene;
  102664. /**
  102665. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  102666. * 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.
  102667. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102668. */
  102669. mirrorPlane: Plane;
  102670. /**
  102671. * Define the blur ratio used to blur the reflection if needed.
  102672. */
  102673. set blurRatio(value: number);
  102674. get blurRatio(): number;
  102675. /**
  102676. * Define the adaptive blur kernel used to blur the reflection if needed.
  102677. * This will autocompute the closest best match for the `blurKernel`
  102678. */
  102679. set adaptiveBlurKernel(value: number);
  102680. /**
  102681. * Define the blur kernel used to blur the reflection if needed.
  102682. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102683. */
  102684. set blurKernel(value: number);
  102685. /**
  102686. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  102687. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102688. */
  102689. set blurKernelX(value: number);
  102690. get blurKernelX(): number;
  102691. /**
  102692. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  102693. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102694. */
  102695. set blurKernelY(value: number);
  102696. get blurKernelY(): number;
  102697. private _autoComputeBlurKernel;
  102698. protected _onRatioRescale(): void;
  102699. private _updateGammaSpace;
  102700. private _imageProcessingConfigChangeObserver;
  102701. private _transformMatrix;
  102702. private _mirrorMatrix;
  102703. private _savedViewMatrix;
  102704. private _blurX;
  102705. private _blurY;
  102706. private _adaptiveBlurKernel;
  102707. private _blurKernelX;
  102708. private _blurKernelY;
  102709. private _blurRatio;
  102710. /**
  102711. * Instantiates a Mirror Texture.
  102712. * Mirror texture can be used to simulate the view from a mirror in a scene.
  102713. * It will dynamically be rendered every frame to adapt to the camera point of view.
  102714. * You can then easily use it as a reflectionTexture on a flat surface.
  102715. * In case the surface is not a plane, please consider relying on reflection probes.
  102716. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102717. * @param name
  102718. * @param size
  102719. * @param scene
  102720. * @param generateMipMaps
  102721. * @param type
  102722. * @param samplingMode
  102723. * @param generateDepthBuffer
  102724. */
  102725. constructor(name: string, size: number | {
  102726. width: number;
  102727. height: number;
  102728. } | {
  102729. ratio: number;
  102730. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  102731. private _preparePostProcesses;
  102732. /**
  102733. * Clone the mirror texture.
  102734. * @returns the cloned texture
  102735. */
  102736. clone(): MirrorTexture;
  102737. /**
  102738. * Serialize the texture to a JSON representation you could use in Parse later on
  102739. * @returns the serialized JSON representation
  102740. */
  102741. serialize(): any;
  102742. /**
  102743. * Dispose the texture and release its associated resources.
  102744. */
  102745. dispose(): void;
  102746. }
  102747. }
  102748. declare module BABYLON {
  102749. /**
  102750. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  102751. * @see https://doc.babylonjs.com/babylon101/materials#texture
  102752. */
  102753. export class Texture extends BaseTexture {
  102754. /**
  102755. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  102756. */
  102757. static SerializeBuffers: boolean;
  102758. /** @hidden */
  102759. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  102760. /** @hidden */
  102761. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  102762. /** @hidden */
  102763. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  102764. /** nearest is mag = nearest and min = nearest and mip = linear */
  102765. static readonly NEAREST_SAMPLINGMODE: number;
  102766. /** nearest is mag = nearest and min = nearest and mip = linear */
  102767. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  102768. /** Bilinear is mag = linear and min = linear and mip = nearest */
  102769. static readonly BILINEAR_SAMPLINGMODE: number;
  102770. /** Bilinear is mag = linear and min = linear and mip = nearest */
  102771. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  102772. /** Trilinear is mag = linear and min = linear and mip = linear */
  102773. static readonly TRILINEAR_SAMPLINGMODE: number;
  102774. /** Trilinear is mag = linear and min = linear and mip = linear */
  102775. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  102776. /** mag = nearest and min = nearest and mip = nearest */
  102777. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  102778. /** mag = nearest and min = linear and mip = nearest */
  102779. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  102780. /** mag = nearest and min = linear and mip = linear */
  102781. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  102782. /** mag = nearest and min = linear and mip = none */
  102783. static readonly NEAREST_LINEAR: number;
  102784. /** mag = nearest and min = nearest and mip = none */
  102785. static readonly NEAREST_NEAREST: number;
  102786. /** mag = linear and min = nearest and mip = nearest */
  102787. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  102788. /** mag = linear and min = nearest and mip = linear */
  102789. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  102790. /** mag = linear and min = linear and mip = none */
  102791. static readonly LINEAR_LINEAR: number;
  102792. /** mag = linear and min = nearest and mip = none */
  102793. static readonly LINEAR_NEAREST: number;
  102794. /** Explicit coordinates mode */
  102795. static readonly EXPLICIT_MODE: number;
  102796. /** Spherical coordinates mode */
  102797. static readonly SPHERICAL_MODE: number;
  102798. /** Planar coordinates mode */
  102799. static readonly PLANAR_MODE: number;
  102800. /** Cubic coordinates mode */
  102801. static readonly CUBIC_MODE: number;
  102802. /** Projection coordinates mode */
  102803. static readonly PROJECTION_MODE: number;
  102804. /** Inverse Cubic coordinates mode */
  102805. static readonly SKYBOX_MODE: number;
  102806. /** Inverse Cubic coordinates mode */
  102807. static readonly INVCUBIC_MODE: number;
  102808. /** Equirectangular coordinates mode */
  102809. static readonly EQUIRECTANGULAR_MODE: number;
  102810. /** Equirectangular Fixed coordinates mode */
  102811. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  102812. /** Equirectangular Fixed Mirrored coordinates mode */
  102813. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  102814. /** Texture is not repeating outside of 0..1 UVs */
  102815. static readonly CLAMP_ADDRESSMODE: number;
  102816. /** Texture is repeating outside of 0..1 UVs */
  102817. static readonly WRAP_ADDRESSMODE: number;
  102818. /** Texture is repeating and mirrored */
  102819. static readonly MIRROR_ADDRESSMODE: number;
  102820. /**
  102821. * 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
  102822. */
  102823. static UseSerializedUrlIfAny: boolean;
  102824. /**
  102825. * Define the url of the texture.
  102826. */
  102827. url: Nullable<string>;
  102828. /**
  102829. * Define an offset on the texture to offset the u coordinates of the UVs
  102830. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  102831. */
  102832. uOffset: number;
  102833. /**
  102834. * Define an offset on the texture to offset the v coordinates of the UVs
  102835. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  102836. */
  102837. vOffset: number;
  102838. /**
  102839. * Define an offset on the texture to scale the u coordinates of the UVs
  102840. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  102841. */
  102842. uScale: number;
  102843. /**
  102844. * Define an offset on the texture to scale the v coordinates of the UVs
  102845. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  102846. */
  102847. vScale: number;
  102848. /**
  102849. * Define an offset on the texture to rotate around the u coordinates of the UVs
  102850. * @see https://doc.babylonjs.com/how_to/more_materials
  102851. */
  102852. uAng: number;
  102853. /**
  102854. * Define an offset on the texture to rotate around the v coordinates of the UVs
  102855. * @see https://doc.babylonjs.com/how_to/more_materials
  102856. */
  102857. vAng: number;
  102858. /**
  102859. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  102860. * @see https://doc.babylonjs.com/how_to/more_materials
  102861. */
  102862. wAng: number;
  102863. /**
  102864. * Defines the center of rotation (U)
  102865. */
  102866. uRotationCenter: number;
  102867. /**
  102868. * Defines the center of rotation (V)
  102869. */
  102870. vRotationCenter: number;
  102871. /**
  102872. * Defines the center of rotation (W)
  102873. */
  102874. wRotationCenter: number;
  102875. /**
  102876. * Are mip maps generated for this texture or not.
  102877. */
  102878. get noMipmap(): boolean;
  102879. /**
  102880. * List of inspectable custom properties (used by the Inspector)
  102881. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  102882. */
  102883. inspectableCustomProperties: Nullable<IInspectable[]>;
  102884. private _noMipmap;
  102885. /** @hidden */
  102886. _invertY: boolean;
  102887. private _rowGenerationMatrix;
  102888. private _cachedTextureMatrix;
  102889. private _projectionModeMatrix;
  102890. private _t0;
  102891. private _t1;
  102892. private _t2;
  102893. private _cachedUOffset;
  102894. private _cachedVOffset;
  102895. private _cachedUScale;
  102896. private _cachedVScale;
  102897. private _cachedUAng;
  102898. private _cachedVAng;
  102899. private _cachedWAng;
  102900. private _cachedProjectionMatrixId;
  102901. private _cachedCoordinatesMode;
  102902. /** @hidden */
  102903. protected _initialSamplingMode: number;
  102904. /** @hidden */
  102905. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  102906. private _deleteBuffer;
  102907. protected _format: Nullable<number>;
  102908. private _delayedOnLoad;
  102909. private _delayedOnError;
  102910. private _mimeType?;
  102911. /** Returns the texture mime type if it was defined by a loader (undefined else) */
  102912. get mimeType(): string | undefined;
  102913. /**
  102914. * Observable triggered once the texture has been loaded.
  102915. */
  102916. onLoadObservable: Observable<Texture>;
  102917. protected _isBlocking: boolean;
  102918. /**
  102919. * Is the texture preventing material to render while loading.
  102920. * If false, a default texture will be used instead of the loading one during the preparation step.
  102921. */
  102922. set isBlocking(value: boolean);
  102923. get isBlocking(): boolean;
  102924. /**
  102925. * Get the current sampling mode associated with the texture.
  102926. */
  102927. get samplingMode(): number;
  102928. /**
  102929. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  102930. */
  102931. get invertY(): boolean;
  102932. /**
  102933. * Instantiates a new texture.
  102934. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  102935. * @see https://doc.babylonjs.com/babylon101/materials#texture
  102936. * @param url defines the url of the picture to load as a texture
  102937. * @param sceneOrEngine defines the scene or engine the texture will belong to
  102938. * @param noMipmap defines if the texture will require mip maps or not
  102939. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  102940. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  102941. * @param onLoad defines a callback triggered when the texture has been loaded
  102942. * @param onError defines a callback triggered when an error occurred during the loading session
  102943. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  102944. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  102945. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  102946. * @param mimeType defines an optional mime type information
  102947. */
  102948. 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);
  102949. /**
  102950. * Update the url (and optional buffer) of this texture if url was null during construction.
  102951. * @param url the url of the texture
  102952. * @param buffer the buffer of the texture (defaults to null)
  102953. * @param onLoad callback called when the texture is loaded (defaults to null)
  102954. */
  102955. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  102956. /**
  102957. * Finish the loading sequence of a texture flagged as delayed load.
  102958. * @hidden
  102959. */
  102960. delayLoad(): void;
  102961. private _prepareRowForTextureGeneration;
  102962. /**
  102963. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  102964. * @returns the transform matrix of the texture.
  102965. */
  102966. getTextureMatrix(uBase?: number): Matrix;
  102967. /**
  102968. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  102969. * @returns The reflection texture transform
  102970. */
  102971. getReflectionTextureMatrix(): Matrix;
  102972. /**
  102973. * Clones the texture.
  102974. * @returns the cloned texture
  102975. */
  102976. clone(): Texture;
  102977. /**
  102978. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  102979. * @returns The JSON representation of the texture
  102980. */
  102981. serialize(): any;
  102982. /**
  102983. * Get the current class name of the texture useful for serialization or dynamic coding.
  102984. * @returns "Texture"
  102985. */
  102986. getClassName(): string;
  102987. /**
  102988. * Dispose the texture and release its associated resources.
  102989. */
  102990. dispose(): void;
  102991. /**
  102992. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  102993. * @param parsedTexture Define the JSON representation of the texture
  102994. * @param scene Define the scene the parsed texture should be instantiated in
  102995. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  102996. * @returns The parsed texture if successful
  102997. */
  102998. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  102999. /**
  103000. * Creates a texture from its base 64 representation.
  103001. * @param data Define the base64 payload without the data: prefix
  103002. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  103003. * @param scene Define the scene the texture should belong to
  103004. * @param noMipmap Forces the texture to not create mip map information if true
  103005. * @param invertY define if the texture needs to be inverted on the y axis during loading
  103006. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  103007. * @param onLoad define a callback triggered when the texture has been loaded
  103008. * @param onError define a callback triggered when an error occurred during the loading session
  103009. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  103010. * @returns the created texture
  103011. */
  103012. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  103013. /**
  103014. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  103015. * @param data Define the base64 payload without the data: prefix
  103016. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  103017. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  103018. * @param scene Define the scene the texture should belong to
  103019. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  103020. * @param noMipmap Forces the texture to not create mip map information if true
  103021. * @param invertY define if the texture needs to be inverted on the y axis during loading
  103022. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  103023. * @param onLoad define a callback triggered when the texture has been loaded
  103024. * @param onError define a callback triggered when an error occurred during the loading session
  103025. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  103026. * @returns the created texture
  103027. */
  103028. 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;
  103029. }
  103030. }
  103031. declare module BABYLON {
  103032. /**
  103033. * PostProcessManager is used to manage one or more post processes or post process pipelines
  103034. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  103035. */
  103036. export class PostProcessManager {
  103037. private _scene;
  103038. private _indexBuffer;
  103039. private _vertexBuffers;
  103040. /**
  103041. * Creates a new instance PostProcess
  103042. * @param scene The scene that the post process is associated with.
  103043. */
  103044. constructor(scene: Scene);
  103045. private _prepareBuffers;
  103046. private _buildIndexBuffer;
  103047. /**
  103048. * Rebuilds the vertex buffers of the manager.
  103049. * @hidden
  103050. */
  103051. _rebuild(): void;
  103052. /**
  103053. * Prepares a frame to be run through a post process.
  103054. * @param sourceTexture The input texture to the post procesess. (default: null)
  103055. * @param postProcesses An array of post processes to be run. (default: null)
  103056. * @returns True if the post processes were able to be run.
  103057. * @hidden
  103058. */
  103059. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  103060. /**
  103061. * Manually render a set of post processes to a texture.
  103062. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  103063. * @param postProcesses An array of post processes to be run.
  103064. * @param targetTexture The target texture to render to.
  103065. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  103066. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  103067. * @param lodLevel defines which lod of the texture to render to
  103068. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  103069. */
  103070. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  103071. /**
  103072. * Finalize the result of the output of the postprocesses.
  103073. * @param doNotPresent If true the result will not be displayed to the screen.
  103074. * @param targetTexture The target texture to render to.
  103075. * @param faceIndex The index of the face to bind the target texture to.
  103076. * @param postProcesses The array of post processes to render.
  103077. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  103078. * @hidden
  103079. */
  103080. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  103081. /**
  103082. * Disposes of the post process manager.
  103083. */
  103084. dispose(): void;
  103085. }
  103086. }
  103087. declare module BABYLON {
  103088. /**
  103089. * This Helps creating a texture that will be created from a camera in your scene.
  103090. * It is basically a dynamic texture that could be used to create special effects for instance.
  103091. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  103092. */
  103093. export class RenderTargetTexture extends Texture {
  103094. /**
  103095. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  103096. */
  103097. static readonly REFRESHRATE_RENDER_ONCE: number;
  103098. /**
  103099. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  103100. */
  103101. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  103102. /**
  103103. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  103104. * the central point of your effect and can save a lot of performances.
  103105. */
  103106. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  103107. /**
  103108. * Use this predicate to dynamically define the list of mesh you want to render.
  103109. * If set, the renderList property will be overwritten.
  103110. */
  103111. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  103112. private _renderList;
  103113. /**
  103114. * Use this list to define the list of mesh you want to render.
  103115. */
  103116. get renderList(): Nullable<Array<AbstractMesh>>;
  103117. set renderList(value: Nullable<Array<AbstractMesh>>);
  103118. /**
  103119. * Use this function to overload the renderList array at rendering time.
  103120. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  103121. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  103122. * the cube (if the RTT is a cube, else layerOrFace=0).
  103123. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  103124. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  103125. * hold dummy elements!
  103126. */
  103127. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  103128. private _hookArray;
  103129. /**
  103130. * Define if particles should be rendered in your texture.
  103131. */
  103132. renderParticles: boolean;
  103133. /**
  103134. * Define if sprites should be rendered in your texture.
  103135. */
  103136. renderSprites: boolean;
  103137. /**
  103138. * Define the camera used to render the texture.
  103139. */
  103140. activeCamera: Nullable<Camera>;
  103141. /**
  103142. * Override the mesh isReady function with your own one.
  103143. */
  103144. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  103145. /**
  103146. * Override the render function of the texture with your own one.
  103147. */
  103148. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  103149. /**
  103150. * Define if camera post processes should be use while rendering the texture.
  103151. */
  103152. useCameraPostProcesses: boolean;
  103153. /**
  103154. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  103155. */
  103156. ignoreCameraViewport: boolean;
  103157. private _postProcessManager;
  103158. private _postProcesses;
  103159. private _resizeObserver;
  103160. /**
  103161. * An event triggered when the texture is unbind.
  103162. */
  103163. onBeforeBindObservable: Observable<RenderTargetTexture>;
  103164. /**
  103165. * An event triggered when the texture is unbind.
  103166. */
  103167. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  103168. private _onAfterUnbindObserver;
  103169. /**
  103170. * Set a after unbind callback in the texture.
  103171. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  103172. */
  103173. set onAfterUnbind(callback: () => void);
  103174. /**
  103175. * An event triggered before rendering the texture
  103176. */
  103177. onBeforeRenderObservable: Observable<number>;
  103178. private _onBeforeRenderObserver;
  103179. /**
  103180. * Set a before render callback in the texture.
  103181. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  103182. */
  103183. set onBeforeRender(callback: (faceIndex: number) => void);
  103184. /**
  103185. * An event triggered after rendering the texture
  103186. */
  103187. onAfterRenderObservable: Observable<number>;
  103188. private _onAfterRenderObserver;
  103189. /**
  103190. * Set a after render callback in the texture.
  103191. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  103192. */
  103193. set onAfterRender(callback: (faceIndex: number) => void);
  103194. /**
  103195. * An event triggered after the texture clear
  103196. */
  103197. onClearObservable: Observable<Engine>;
  103198. private _onClearObserver;
  103199. /**
  103200. * Set a clear callback in the texture.
  103201. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  103202. */
  103203. set onClear(callback: (Engine: Engine) => void);
  103204. /**
  103205. * An event triggered when the texture is resized.
  103206. */
  103207. onResizeObservable: Observable<RenderTargetTexture>;
  103208. /**
  103209. * Define the clear color of the Render Target if it should be different from the scene.
  103210. */
  103211. clearColor: Color4;
  103212. protected _size: number | {
  103213. width: number;
  103214. height: number;
  103215. layers?: number;
  103216. };
  103217. protected _initialSizeParameter: number | {
  103218. width: number;
  103219. height: number;
  103220. } | {
  103221. ratio: number;
  103222. };
  103223. protected _sizeRatio: Nullable<number>;
  103224. /** @hidden */
  103225. _generateMipMaps: boolean;
  103226. protected _renderingManager: RenderingManager;
  103227. /** @hidden */
  103228. _waitingRenderList?: string[];
  103229. protected _doNotChangeAspectRatio: boolean;
  103230. protected _currentRefreshId: number;
  103231. protected _refreshRate: number;
  103232. protected _textureMatrix: Matrix;
  103233. protected _samples: number;
  103234. protected _renderTargetOptions: RenderTargetCreationOptions;
  103235. /**
  103236. * Gets render target creation options that were used.
  103237. */
  103238. get renderTargetOptions(): RenderTargetCreationOptions;
  103239. protected _onRatioRescale(): void;
  103240. /**
  103241. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  103242. * It must define where the camera used to render the texture is set
  103243. */
  103244. boundingBoxPosition: Vector3;
  103245. private _boundingBoxSize;
  103246. /**
  103247. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  103248. * When defined, the cubemap will switch to local mode
  103249. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  103250. * @example https://www.babylonjs-playground.com/#RNASML
  103251. */
  103252. set boundingBoxSize(value: Vector3);
  103253. get boundingBoxSize(): Vector3;
  103254. /**
  103255. * In case the RTT has been created with a depth texture, get the associated
  103256. * depth texture.
  103257. * Otherwise, return null.
  103258. */
  103259. get depthStencilTexture(): Nullable<InternalTexture>;
  103260. /**
  103261. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  103262. * or used a shadow, depth texture...
  103263. * @param name The friendly name of the texture
  103264. * @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)
  103265. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  103266. * @param generateMipMaps True if mip maps need to be generated after render.
  103267. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  103268. * @param type The type of the buffer in the RTT (int, half float, float...)
  103269. * @param isCube True if a cube texture needs to be created
  103270. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  103271. * @param generateDepthBuffer True to generate a depth buffer
  103272. * @param generateStencilBuffer True to generate a stencil buffer
  103273. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  103274. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  103275. * @param delayAllocation if the texture allocation should be delayed (default: false)
  103276. */
  103277. constructor(name: string, size: number | {
  103278. width: number;
  103279. height: number;
  103280. layers?: number;
  103281. } | {
  103282. ratio: number;
  103283. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  103284. /**
  103285. * Creates a depth stencil texture.
  103286. * This is only available in WebGL 2 or with the depth texture extension available.
  103287. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  103288. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  103289. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  103290. */
  103291. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  103292. private _processSizeParameter;
  103293. /**
  103294. * Define the number of samples to use in case of MSAA.
  103295. * It defaults to one meaning no MSAA has been enabled.
  103296. */
  103297. get samples(): number;
  103298. set samples(value: number);
  103299. /**
  103300. * Resets the refresh counter of the texture and start bak from scratch.
  103301. * Could be useful to regenerate the texture if it is setup to render only once.
  103302. */
  103303. resetRefreshCounter(): void;
  103304. /**
  103305. * Define the refresh rate of the texture or the rendering frequency.
  103306. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  103307. */
  103308. get refreshRate(): number;
  103309. set refreshRate(value: number);
  103310. /**
  103311. * Adds a post process to the render target rendering passes.
  103312. * @param postProcess define the post process to add
  103313. */
  103314. addPostProcess(postProcess: PostProcess): void;
  103315. /**
  103316. * Clear all the post processes attached to the render target
  103317. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  103318. */
  103319. clearPostProcesses(dispose?: boolean): void;
  103320. /**
  103321. * Remove one of the post process from the list of attached post processes to the texture
  103322. * @param postProcess define the post process to remove from the list
  103323. */
  103324. removePostProcess(postProcess: PostProcess): void;
  103325. /** @hidden */
  103326. _shouldRender(): boolean;
  103327. /**
  103328. * Gets the actual render size of the texture.
  103329. * @returns the width of the render size
  103330. */
  103331. getRenderSize(): number;
  103332. /**
  103333. * Gets the actual render width of the texture.
  103334. * @returns the width of the render size
  103335. */
  103336. getRenderWidth(): number;
  103337. /**
  103338. * Gets the actual render height of the texture.
  103339. * @returns the height of the render size
  103340. */
  103341. getRenderHeight(): number;
  103342. /**
  103343. * Gets the actual number of layers of the texture.
  103344. * @returns the number of layers
  103345. */
  103346. getRenderLayers(): number;
  103347. /**
  103348. * Get if the texture can be rescaled or not.
  103349. */
  103350. get canRescale(): boolean;
  103351. /**
  103352. * Resize the texture using a ratio.
  103353. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  103354. */
  103355. scale(ratio: number): void;
  103356. /**
  103357. * Get the texture reflection matrix used to rotate/transform the reflection.
  103358. * @returns the reflection matrix
  103359. */
  103360. getReflectionTextureMatrix(): Matrix;
  103361. /**
  103362. * Resize the texture to a new desired size.
  103363. * Be carrefull as it will recreate all the data in the new texture.
  103364. * @param size Define the new size. It can be:
  103365. * - a number for squared texture,
  103366. * - an object containing { width: number, height: number }
  103367. * - or an object containing a ratio { ratio: number }
  103368. */
  103369. resize(size: number | {
  103370. width: number;
  103371. height: number;
  103372. } | {
  103373. ratio: number;
  103374. }): void;
  103375. private _defaultRenderListPrepared;
  103376. /**
  103377. * Renders all the objects from the render list into the texture.
  103378. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  103379. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  103380. */
  103381. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  103382. private _bestReflectionRenderTargetDimension;
  103383. private _prepareRenderingManager;
  103384. /**
  103385. * @hidden
  103386. * @param faceIndex face index to bind to if this is a cubetexture
  103387. * @param layer defines the index of the texture to bind in the array
  103388. */
  103389. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  103390. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  103391. private renderToTarget;
  103392. /**
  103393. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  103394. * This allowed control for front to back rendering or reversly depending of the special needs.
  103395. *
  103396. * @param renderingGroupId The rendering group id corresponding to its index
  103397. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  103398. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  103399. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  103400. */
  103401. 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;
  103402. /**
  103403. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  103404. *
  103405. * @param renderingGroupId The rendering group id corresponding to its index
  103406. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  103407. */
  103408. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  103409. /**
  103410. * Clones the texture.
  103411. * @returns the cloned texture
  103412. */
  103413. clone(): RenderTargetTexture;
  103414. /**
  103415. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  103416. * @returns The JSON representation of the texture
  103417. */
  103418. serialize(): any;
  103419. /**
  103420. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  103421. */
  103422. disposeFramebufferObjects(): void;
  103423. /**
  103424. * Dispose the texture and release its associated resources.
  103425. */
  103426. dispose(): void;
  103427. /** @hidden */
  103428. _rebuild(): void;
  103429. /**
  103430. * Clear the info related to rendering groups preventing retention point in material dispose.
  103431. */
  103432. freeRenderingGroups(): void;
  103433. /**
  103434. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  103435. * @returns the view count
  103436. */
  103437. getViewCount(): number;
  103438. }
  103439. }
  103440. declare module BABYLON {
  103441. /**
  103442. * Class used to manipulate GUIDs
  103443. */
  103444. export class GUID {
  103445. /**
  103446. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  103447. * Be aware Math.random() could cause collisions, but:
  103448. * "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"
  103449. * @returns a pseudo random id
  103450. */
  103451. static RandomId(): string;
  103452. }
  103453. }
  103454. declare module BABYLON {
  103455. /**
  103456. * Options to be used when creating a shadow depth material
  103457. */
  103458. export interface IIOptionShadowDepthMaterial {
  103459. /** Variables in the vertex shader code that need to have their names remapped.
  103460. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  103461. * "var_name" should be either: worldPos or vNormalW
  103462. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  103463. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  103464. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  103465. */
  103466. remappedVariables?: string[];
  103467. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  103468. standalone?: boolean;
  103469. }
  103470. /**
  103471. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  103472. */
  103473. export class ShadowDepthWrapper {
  103474. private _scene;
  103475. private _options?;
  103476. private _baseMaterial;
  103477. private _onEffectCreatedObserver;
  103478. private _subMeshToEffect;
  103479. private _subMeshToDepthEffect;
  103480. private _meshes;
  103481. /** @hidden */
  103482. _matriceNames: any;
  103483. /** Gets the standalone status of the wrapper */
  103484. get standalone(): boolean;
  103485. /** Gets the base material the wrapper is built upon */
  103486. get baseMaterial(): Material;
  103487. /**
  103488. * Instantiate a new shadow depth wrapper.
  103489. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  103490. * generate the shadow depth map. For more information, please refer to the documentation:
  103491. * https://doc.babylonjs.com/babylon101/shadows
  103492. * @param baseMaterial Material to wrap
  103493. * @param scene Define the scene the material belongs to
  103494. * @param options Options used to create the wrapper
  103495. */
  103496. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  103497. /**
  103498. * Gets the effect to use to generate the depth map
  103499. * @param subMesh subMesh to get the effect for
  103500. * @param shadowGenerator shadow generator to get the effect for
  103501. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  103502. */
  103503. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  103504. /**
  103505. * Specifies that the submesh is ready to be used for depth rendering
  103506. * @param subMesh submesh to check
  103507. * @param defines the list of defines to take into account when checking the effect
  103508. * @param shadowGenerator combined with subMesh, it defines the effect to check
  103509. * @param useInstances specifies that instances should be used
  103510. * @returns a boolean indicating that the submesh is ready or not
  103511. */
  103512. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  103513. /**
  103514. * Disposes the resources
  103515. */
  103516. dispose(): void;
  103517. private _makeEffect;
  103518. }
  103519. }
  103520. declare module BABYLON {
  103521. interface ThinEngine {
  103522. /**
  103523. * Unbind a list of render target textures from the webGL context
  103524. * This is used only when drawBuffer extension or webGL2 are active
  103525. * @param textures defines the render target textures to unbind
  103526. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  103527. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  103528. */
  103529. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  103530. /**
  103531. * Create a multi render target texture
  103532. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  103533. * @param size defines the size of the texture
  103534. * @param options defines the creation options
  103535. * @returns the cube texture as an InternalTexture
  103536. */
  103537. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  103538. /**
  103539. * Update the sample count for a given multiple render target texture
  103540. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  103541. * @param textures defines the textures to update
  103542. * @param samples defines the sample count to set
  103543. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  103544. */
  103545. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  103546. /**
  103547. * Select a subsets of attachments to draw to.
  103548. * @param attachments gl attachments
  103549. */
  103550. bindAttachments(attachments: number[]): void;
  103551. }
  103552. }
  103553. declare module BABYLON {
  103554. /**
  103555. * Creation options of the multi render target texture.
  103556. */
  103557. export interface IMultiRenderTargetOptions {
  103558. /**
  103559. * Define if the texture needs to create mip maps after render.
  103560. */
  103561. generateMipMaps?: boolean;
  103562. /**
  103563. * Define the types of all the draw buffers we want to create
  103564. */
  103565. types?: number[];
  103566. /**
  103567. * Define the sampling modes of all the draw buffers we want to create
  103568. */
  103569. samplingModes?: number[];
  103570. /**
  103571. * Define if a depth buffer is required
  103572. */
  103573. generateDepthBuffer?: boolean;
  103574. /**
  103575. * Define if a stencil buffer is required
  103576. */
  103577. generateStencilBuffer?: boolean;
  103578. /**
  103579. * Define if a depth texture is required instead of a depth buffer
  103580. */
  103581. generateDepthTexture?: boolean;
  103582. /**
  103583. * Define the number of desired draw buffers
  103584. */
  103585. textureCount?: number;
  103586. /**
  103587. * Define if aspect ratio should be adapted to the texture or stay the scene one
  103588. */
  103589. doNotChangeAspectRatio?: boolean;
  103590. /**
  103591. * Define the default type of the buffers we are creating
  103592. */
  103593. defaultType?: number;
  103594. }
  103595. /**
  103596. * A multi render target, like a render target provides the ability to render to a texture.
  103597. * Unlike the render target, it can render to several draw buffers in one draw.
  103598. * This is specially interesting in deferred rendering or for any effects requiring more than
  103599. * just one color from a single pass.
  103600. */
  103601. export class MultiRenderTarget extends RenderTargetTexture {
  103602. private _internalTextures;
  103603. private _textures;
  103604. private _multiRenderTargetOptions;
  103605. private _count;
  103606. /**
  103607. * Get if draw buffers are currently supported by the used hardware and browser.
  103608. */
  103609. get isSupported(): boolean;
  103610. /**
  103611. * Get the list of textures generated by the multi render target.
  103612. */
  103613. get textures(): Texture[];
  103614. /**
  103615. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  103616. */
  103617. get count(): number;
  103618. /**
  103619. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  103620. */
  103621. get depthTexture(): Texture;
  103622. /**
  103623. * Set the wrapping mode on U of all the textures we are rendering to.
  103624. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  103625. */
  103626. set wrapU(wrap: number);
  103627. /**
  103628. * Set the wrapping mode on V of all the textures we are rendering to.
  103629. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  103630. */
  103631. set wrapV(wrap: number);
  103632. /**
  103633. * Instantiate a new multi render target texture.
  103634. * A multi render target, like a render target provides the ability to render to a texture.
  103635. * Unlike the render target, it can render to several draw buffers in one draw.
  103636. * This is specially interesting in deferred rendering or for any effects requiring more than
  103637. * just one color from a single pass.
  103638. * @param name Define the name of the texture
  103639. * @param size Define the size of the buffers to render to
  103640. * @param count Define the number of target we are rendering into
  103641. * @param scene Define the scene the texture belongs to
  103642. * @param options Define the options used to create the multi render target
  103643. */
  103644. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  103645. /** @hidden */
  103646. _rebuild(): void;
  103647. private _createInternalTextures;
  103648. private _createTextures;
  103649. /**
  103650. * Define the number of samples used if MSAA is enabled.
  103651. */
  103652. get samples(): number;
  103653. set samples(value: number);
  103654. /**
  103655. * Resize all the textures in the multi render target.
  103656. * Be carrefull as it will recreate all the data in the new texture.
  103657. * @param size Define the new size
  103658. */
  103659. resize(size: any): void;
  103660. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  103661. /**
  103662. * Dispose the render targets and their associated resources
  103663. */
  103664. dispose(): void;
  103665. /**
  103666. * Release all the underlying texture used as draw buffers.
  103667. */
  103668. releaseInternalTextures(): void;
  103669. }
  103670. }
  103671. declare module BABYLON {
  103672. /** @hidden */
  103673. export var imageProcessingPixelShader: {
  103674. name: string;
  103675. shader: string;
  103676. };
  103677. }
  103678. declare module BABYLON {
  103679. /**
  103680. * ImageProcessingPostProcess
  103681. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  103682. */
  103683. export class ImageProcessingPostProcess extends PostProcess {
  103684. /**
  103685. * Default configuration related to image processing available in the PBR Material.
  103686. */
  103687. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  103688. /**
  103689. * Gets the image processing configuration used either in this material.
  103690. */
  103691. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  103692. /**
  103693. * Sets the Default image processing configuration used either in the this material.
  103694. *
  103695. * If sets to null, the scene one is in use.
  103696. */
  103697. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  103698. /**
  103699. * Keep track of the image processing observer to allow dispose and replace.
  103700. */
  103701. private _imageProcessingObserver;
  103702. /**
  103703. * Attaches a new image processing configuration to the PBR Material.
  103704. * @param configuration
  103705. */
  103706. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  103707. /**
  103708. * If the post process is supported.
  103709. */
  103710. get isSupported(): boolean;
  103711. /**
  103712. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  103713. */
  103714. get colorCurves(): Nullable<ColorCurves>;
  103715. /**
  103716. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  103717. */
  103718. set colorCurves(value: Nullable<ColorCurves>);
  103719. /**
  103720. * Gets wether the color curves effect is enabled.
  103721. */
  103722. get colorCurvesEnabled(): boolean;
  103723. /**
  103724. * Sets wether the color curves effect is enabled.
  103725. */
  103726. set colorCurvesEnabled(value: boolean);
  103727. /**
  103728. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  103729. */
  103730. get colorGradingTexture(): Nullable<BaseTexture>;
  103731. /**
  103732. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  103733. */
  103734. set colorGradingTexture(value: Nullable<BaseTexture>);
  103735. /**
  103736. * Gets wether the color grading effect is enabled.
  103737. */
  103738. get colorGradingEnabled(): boolean;
  103739. /**
  103740. * Gets wether the color grading effect is enabled.
  103741. */
  103742. set colorGradingEnabled(value: boolean);
  103743. /**
  103744. * Gets exposure used in the effect.
  103745. */
  103746. get exposure(): number;
  103747. /**
  103748. * Sets exposure used in the effect.
  103749. */
  103750. set exposure(value: number);
  103751. /**
  103752. * Gets wether tonemapping is enabled or not.
  103753. */
  103754. get toneMappingEnabled(): boolean;
  103755. /**
  103756. * Sets wether tonemapping is enabled or not
  103757. */
  103758. set toneMappingEnabled(value: boolean);
  103759. /**
  103760. * Gets the type of tone mapping effect.
  103761. */
  103762. get toneMappingType(): number;
  103763. /**
  103764. * Sets the type of tone mapping effect.
  103765. */
  103766. set toneMappingType(value: number);
  103767. /**
  103768. * Gets contrast used in the effect.
  103769. */
  103770. get contrast(): number;
  103771. /**
  103772. * Sets contrast used in the effect.
  103773. */
  103774. set contrast(value: number);
  103775. /**
  103776. * Gets Vignette stretch size.
  103777. */
  103778. get vignetteStretch(): number;
  103779. /**
  103780. * Sets Vignette stretch size.
  103781. */
  103782. set vignetteStretch(value: number);
  103783. /**
  103784. * Gets Vignette centre X Offset.
  103785. */
  103786. get vignetteCentreX(): number;
  103787. /**
  103788. * Sets Vignette centre X Offset.
  103789. */
  103790. set vignetteCentreX(value: number);
  103791. /**
  103792. * Gets Vignette centre Y Offset.
  103793. */
  103794. get vignetteCentreY(): number;
  103795. /**
  103796. * Sets Vignette centre Y Offset.
  103797. */
  103798. set vignetteCentreY(value: number);
  103799. /**
  103800. * Gets Vignette weight or intensity of the vignette effect.
  103801. */
  103802. get vignetteWeight(): number;
  103803. /**
  103804. * Sets Vignette weight or intensity of the vignette effect.
  103805. */
  103806. set vignetteWeight(value: number);
  103807. /**
  103808. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  103809. * if vignetteEnabled is set to true.
  103810. */
  103811. get vignetteColor(): Color4;
  103812. /**
  103813. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  103814. * if vignetteEnabled is set to true.
  103815. */
  103816. set vignetteColor(value: Color4);
  103817. /**
  103818. * Gets Camera field of view used by the Vignette effect.
  103819. */
  103820. get vignetteCameraFov(): number;
  103821. /**
  103822. * Sets Camera field of view used by the Vignette effect.
  103823. */
  103824. set vignetteCameraFov(value: number);
  103825. /**
  103826. * Gets the vignette blend mode allowing different kind of effect.
  103827. */
  103828. get vignetteBlendMode(): number;
  103829. /**
  103830. * Sets the vignette blend mode allowing different kind of effect.
  103831. */
  103832. set vignetteBlendMode(value: number);
  103833. /**
  103834. * Gets wether the vignette effect is enabled.
  103835. */
  103836. get vignetteEnabled(): boolean;
  103837. /**
  103838. * Sets wether the vignette effect is enabled.
  103839. */
  103840. set vignetteEnabled(value: boolean);
  103841. private _fromLinearSpace;
  103842. /**
  103843. * Gets wether the input of the processing is in Gamma or Linear Space.
  103844. */
  103845. get fromLinearSpace(): boolean;
  103846. /**
  103847. * Sets wether the input of the processing is in Gamma or Linear Space.
  103848. */
  103849. set fromLinearSpace(value: boolean);
  103850. /**
  103851. * Defines cache preventing GC.
  103852. */
  103853. private _defines;
  103854. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  103855. /**
  103856. * "ImageProcessingPostProcess"
  103857. * @returns "ImageProcessingPostProcess"
  103858. */
  103859. getClassName(): string;
  103860. /**
  103861. * @hidden
  103862. */
  103863. _updateParameters(): void;
  103864. dispose(camera?: Camera): void;
  103865. }
  103866. }
  103867. declare module BABYLON {
  103868. /** @hidden */
  103869. export var fibonacci: {
  103870. name: string;
  103871. shader: string;
  103872. };
  103873. }
  103874. declare module BABYLON {
  103875. /** @hidden */
  103876. export var subSurfaceScatteringFunctions: {
  103877. name: string;
  103878. shader: string;
  103879. };
  103880. }
  103881. declare module BABYLON {
  103882. /** @hidden */
  103883. export var diffusionProfile: {
  103884. name: string;
  103885. shader: string;
  103886. };
  103887. }
  103888. declare module BABYLON {
  103889. /** @hidden */
  103890. export var subSurfaceScatteringPixelShader: {
  103891. name: string;
  103892. shader: string;
  103893. };
  103894. }
  103895. declare module BABYLON {
  103896. /**
  103897. * Sub surface scattering post process
  103898. */
  103899. export class SubSurfaceScatteringPostProcess extends PostProcess {
  103900. /**
  103901. * Gets a string identifying the name of the class
  103902. * @returns "SubSurfaceScatteringPostProcess" string
  103903. */
  103904. getClassName(): string;
  103905. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  103906. }
  103907. }
  103908. declare module BABYLON {
  103909. /**
  103910. * Interface for defining prepass effects in the prepass post-process pipeline
  103911. */
  103912. export interface PrePassEffectConfiguration {
  103913. /**
  103914. * Post process to attach for this effect
  103915. */
  103916. postProcess: PostProcess;
  103917. /**
  103918. * Is the effect enabled
  103919. */
  103920. enabled: boolean;
  103921. /**
  103922. * Disposes the effect configuration
  103923. */
  103924. dispose(): void;
  103925. /**
  103926. * Disposes the effect configuration
  103927. */
  103928. createPostProcess: () => PostProcess;
  103929. }
  103930. }
  103931. declare module BABYLON {
  103932. /**
  103933. * Contains all parameters needed for the prepass to perform
  103934. * screen space subsurface scattering
  103935. */
  103936. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  103937. private _ssDiffusionS;
  103938. private _ssFilterRadii;
  103939. private _ssDiffusionD;
  103940. /**
  103941. * Post process to attach for screen space subsurface scattering
  103942. */
  103943. postProcess: SubSurfaceScatteringPostProcess;
  103944. /**
  103945. * Diffusion profile color for subsurface scattering
  103946. */
  103947. get ssDiffusionS(): number[];
  103948. /**
  103949. * Diffusion profile max color channel value for subsurface scattering
  103950. */
  103951. get ssDiffusionD(): number[];
  103952. /**
  103953. * Diffusion profile filter radius for subsurface scattering
  103954. */
  103955. get ssFilterRadii(): number[];
  103956. /**
  103957. * Is subsurface enabled
  103958. */
  103959. enabled: boolean;
  103960. /**
  103961. * Diffusion profile colors for subsurface scattering
  103962. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  103963. * See ...
  103964. * Note that you can only store up to 5 of them
  103965. */
  103966. ssDiffusionProfileColors: Color3[];
  103967. /**
  103968. * Defines the ratio real world => scene units.
  103969. * Used for subsurface scattering
  103970. */
  103971. metersPerUnit: number;
  103972. private _scene;
  103973. /**
  103974. * Builds a subsurface configuration object
  103975. * @param scene The scene
  103976. */
  103977. constructor(scene: Scene);
  103978. /**
  103979. * Adds a new diffusion profile.
  103980. * Useful for more realistic subsurface scattering on diverse materials.
  103981. * @param color The color of the diffusion profile. Should be the average color of the material.
  103982. * @return The index of the diffusion profile for the material subsurface configuration
  103983. */
  103984. addDiffusionProfile(color: Color3): number;
  103985. /**
  103986. * Creates the sss post process
  103987. * @return The created post process
  103988. */
  103989. createPostProcess(): SubSurfaceScatteringPostProcess;
  103990. /**
  103991. * Deletes all diffusion profiles.
  103992. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  103993. */
  103994. clearAllDiffusionProfiles(): void;
  103995. /**
  103996. * Disposes this object
  103997. */
  103998. dispose(): void;
  103999. /**
  104000. * @hidden
  104001. * https://zero-radiance.github.io/post/sampling-diffusion/
  104002. *
  104003. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  104004. * ------------------------------------------------------------------------------------
  104005. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  104006. * PDF[r, phi, s] = r * R[r, phi, s]
  104007. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  104008. * ------------------------------------------------------------------------------------
  104009. * We importance sample the color channel with the widest scattering distance.
  104010. */
  104011. getDiffusionProfileParameters(color: Color3): number;
  104012. /**
  104013. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  104014. * 'u' is the random number (the value of the CDF): [0, 1).
  104015. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  104016. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  104017. */
  104018. private _sampleBurleyDiffusionProfile;
  104019. }
  104020. }
  104021. declare module BABYLON {
  104022. /**
  104023. * Renders a pre pass of the scene
  104024. * This means every mesh in the scene will be rendered to a render target texture
  104025. * And then this texture will be composited to the rendering canvas with post processes
  104026. * It is necessary for effects like subsurface scattering or deferred shading
  104027. */
  104028. export class PrePassRenderer {
  104029. /** @hidden */
  104030. static _SceneComponentInitialization: (scene: Scene) => void;
  104031. private _scene;
  104032. private _engine;
  104033. private _isDirty;
  104034. /**
  104035. * Number of textures in the multi render target texture where the scene is directly rendered
  104036. */
  104037. readonly mrtCount: number;
  104038. /**
  104039. * The render target where the scene is directly rendered
  104040. */
  104041. prePassRT: MultiRenderTarget;
  104042. private _mrtTypes;
  104043. private _multiRenderAttachments;
  104044. private _defaultAttachments;
  104045. private _clearAttachments;
  104046. private _postProcesses;
  104047. private readonly _clearColor;
  104048. /**
  104049. * Image processing post process for composition
  104050. */
  104051. imageProcessingPostProcess: ImageProcessingPostProcess;
  104052. /**
  104053. * Configuration for sub surface scattering post process
  104054. */
  104055. subSurfaceConfiguration: SubSurfaceConfiguration;
  104056. /**
  104057. * Should materials render their geometry on the MRT
  104058. */
  104059. materialsShouldRenderGeometry: boolean;
  104060. /**
  104061. * Should materials render the irradiance information on the MRT
  104062. */
  104063. materialsShouldRenderIrradiance: boolean;
  104064. private _enabled;
  104065. /**
  104066. * Indicates if the prepass is enabled
  104067. */
  104068. get enabled(): boolean;
  104069. /**
  104070. * How many samples are used for MSAA of the scene render target
  104071. */
  104072. get samples(): number;
  104073. set samples(n: number);
  104074. /**
  104075. * Instanciates a prepass renderer
  104076. * @param scene The scene
  104077. */
  104078. constructor(scene: Scene);
  104079. private _initializeAttachments;
  104080. private _createCompositionEffect;
  104081. /**
  104082. * Indicates if rendering a prepass is supported
  104083. */
  104084. get isSupported(): boolean;
  104085. /**
  104086. * Sets the proper output textures to draw in the engine.
  104087. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  104088. */
  104089. bindAttachmentsForEffect(effect: Effect): void;
  104090. /**
  104091. * @hidden
  104092. */
  104093. _beforeCameraDraw(): void;
  104094. /**
  104095. * @hidden
  104096. */
  104097. _afterCameraDraw(): void;
  104098. private _checkRTSize;
  104099. private _bindFrameBuffer;
  104100. /**
  104101. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  104102. */
  104103. clear(): void;
  104104. private _setState;
  104105. private _enable;
  104106. private _disable;
  104107. private _resetPostProcessChain;
  104108. private _bindPostProcessChain;
  104109. /**
  104110. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  104111. */
  104112. markAsDirty(): void;
  104113. private _update;
  104114. /**
  104115. * Disposes the prepass renderer.
  104116. */
  104117. dispose(): void;
  104118. }
  104119. }
  104120. declare module BABYLON {
  104121. /**
  104122. * Options for compiling materials.
  104123. */
  104124. export interface IMaterialCompilationOptions {
  104125. /**
  104126. * Defines whether clip planes are enabled.
  104127. */
  104128. clipPlane: boolean;
  104129. /**
  104130. * Defines whether instances are enabled.
  104131. */
  104132. useInstances: boolean;
  104133. }
  104134. /**
  104135. * Options passed when calling customShaderNameResolve
  104136. */
  104137. export interface ICustomShaderNameResolveOptions {
  104138. /**
  104139. * 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
  104140. */
  104141. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  104142. }
  104143. /**
  104144. * Base class for the main features of a material in Babylon.js
  104145. */
  104146. export class Material implements IAnimatable {
  104147. /**
  104148. * Returns the triangle fill mode
  104149. */
  104150. static readonly TriangleFillMode: number;
  104151. /**
  104152. * Returns the wireframe mode
  104153. */
  104154. static readonly WireFrameFillMode: number;
  104155. /**
  104156. * Returns the point fill mode
  104157. */
  104158. static readonly PointFillMode: number;
  104159. /**
  104160. * Returns the point list draw mode
  104161. */
  104162. static readonly PointListDrawMode: number;
  104163. /**
  104164. * Returns the line list draw mode
  104165. */
  104166. static readonly LineListDrawMode: number;
  104167. /**
  104168. * Returns the line loop draw mode
  104169. */
  104170. static readonly LineLoopDrawMode: number;
  104171. /**
  104172. * Returns the line strip draw mode
  104173. */
  104174. static readonly LineStripDrawMode: number;
  104175. /**
  104176. * Returns the triangle strip draw mode
  104177. */
  104178. static readonly TriangleStripDrawMode: number;
  104179. /**
  104180. * Returns the triangle fan draw mode
  104181. */
  104182. static readonly TriangleFanDrawMode: number;
  104183. /**
  104184. * Stores the clock-wise side orientation
  104185. */
  104186. static readonly ClockWiseSideOrientation: number;
  104187. /**
  104188. * Stores the counter clock-wise side orientation
  104189. */
  104190. static readonly CounterClockWiseSideOrientation: number;
  104191. /**
  104192. * The dirty texture flag value
  104193. */
  104194. static readonly TextureDirtyFlag: number;
  104195. /**
  104196. * The dirty light flag value
  104197. */
  104198. static readonly LightDirtyFlag: number;
  104199. /**
  104200. * The dirty fresnel flag value
  104201. */
  104202. static readonly FresnelDirtyFlag: number;
  104203. /**
  104204. * The dirty attribute flag value
  104205. */
  104206. static readonly AttributesDirtyFlag: number;
  104207. /**
  104208. * The dirty misc flag value
  104209. */
  104210. static readonly MiscDirtyFlag: number;
  104211. /**
  104212. * The all dirty flag value
  104213. */
  104214. static readonly AllDirtyFlag: number;
  104215. /**
  104216. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  104217. */
  104218. static readonly MATERIAL_OPAQUE: number;
  104219. /**
  104220. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  104221. */
  104222. static readonly MATERIAL_ALPHATEST: number;
  104223. /**
  104224. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  104225. */
  104226. static readonly MATERIAL_ALPHABLEND: number;
  104227. /**
  104228. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  104229. * They are also discarded below the alpha cutoff threshold to improve performances.
  104230. */
  104231. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  104232. /**
  104233. * The Whiteout method is used to blend normals.
  104234. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  104235. */
  104236. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  104237. /**
  104238. * The Reoriented Normal Mapping method is used to blend normals.
  104239. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  104240. */
  104241. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  104242. /**
  104243. * Custom callback helping to override the default shader used in the material.
  104244. */
  104245. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  104246. /**
  104247. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  104248. */
  104249. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  104250. /**
  104251. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  104252. * This means that the material can keep using a previous shader while a new one is being compiled.
  104253. * This is mostly used when shader parallel compilation is supported (true by default)
  104254. */
  104255. allowShaderHotSwapping: boolean;
  104256. /**
  104257. * The ID of the material
  104258. */
  104259. id: string;
  104260. /**
  104261. * Gets or sets the unique id of the material
  104262. */
  104263. uniqueId: number;
  104264. /**
  104265. * The name of the material
  104266. */
  104267. name: string;
  104268. /**
  104269. * Gets or sets user defined metadata
  104270. */
  104271. metadata: any;
  104272. /**
  104273. * For internal use only. Please do not use.
  104274. */
  104275. reservedDataStore: any;
  104276. /**
  104277. * Specifies if the ready state should be checked on each call
  104278. */
  104279. checkReadyOnEveryCall: boolean;
  104280. /**
  104281. * Specifies if the ready state should be checked once
  104282. */
  104283. checkReadyOnlyOnce: boolean;
  104284. /**
  104285. * The state of the material
  104286. */
  104287. state: string;
  104288. /**
  104289. * If the material can be rendered to several textures with MRT extension
  104290. */
  104291. get canRenderToMRT(): boolean;
  104292. /**
  104293. * The alpha value of the material
  104294. */
  104295. protected _alpha: number;
  104296. /**
  104297. * List of inspectable custom properties (used by the Inspector)
  104298. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  104299. */
  104300. inspectableCustomProperties: IInspectable[];
  104301. /**
  104302. * Sets the alpha value of the material
  104303. */
  104304. set alpha(value: number);
  104305. /**
  104306. * Gets the alpha value of the material
  104307. */
  104308. get alpha(): number;
  104309. /**
  104310. * Specifies if back face culling is enabled
  104311. */
  104312. protected _backFaceCulling: boolean;
  104313. /**
  104314. * Sets the back-face culling state
  104315. */
  104316. set backFaceCulling(value: boolean);
  104317. /**
  104318. * Gets the back-face culling state
  104319. */
  104320. get backFaceCulling(): boolean;
  104321. /**
  104322. * Stores the value for side orientation
  104323. */
  104324. sideOrientation: number;
  104325. /**
  104326. * Callback triggered when the material is compiled
  104327. */
  104328. onCompiled: Nullable<(effect: Effect) => void>;
  104329. /**
  104330. * Callback triggered when an error occurs
  104331. */
  104332. onError: Nullable<(effect: Effect, errors: string) => void>;
  104333. /**
  104334. * Callback triggered to get the render target textures
  104335. */
  104336. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  104337. /**
  104338. * Gets a boolean indicating that current material needs to register RTT
  104339. */
  104340. get hasRenderTargetTextures(): boolean;
  104341. /**
  104342. * Specifies if the material should be serialized
  104343. */
  104344. doNotSerialize: boolean;
  104345. /**
  104346. * @hidden
  104347. */
  104348. _storeEffectOnSubMeshes: boolean;
  104349. /**
  104350. * Stores the animations for the material
  104351. */
  104352. animations: Nullable<Array<Animation>>;
  104353. /**
  104354. * An event triggered when the material is disposed
  104355. */
  104356. onDisposeObservable: Observable<Material>;
  104357. /**
  104358. * An observer which watches for dispose events
  104359. */
  104360. private _onDisposeObserver;
  104361. private _onUnBindObservable;
  104362. /**
  104363. * Called during a dispose event
  104364. */
  104365. set onDispose(callback: () => void);
  104366. private _onBindObservable;
  104367. /**
  104368. * An event triggered when the material is bound
  104369. */
  104370. get onBindObservable(): Observable<AbstractMesh>;
  104371. /**
  104372. * An observer which watches for bind events
  104373. */
  104374. private _onBindObserver;
  104375. /**
  104376. * Called during a bind event
  104377. */
  104378. set onBind(callback: (Mesh: AbstractMesh) => void);
  104379. /**
  104380. * An event triggered when the material is unbound
  104381. */
  104382. get onUnBindObservable(): Observable<Material>;
  104383. protected _onEffectCreatedObservable: Nullable<Observable<{
  104384. effect: Effect;
  104385. subMesh: Nullable<SubMesh>;
  104386. }>>;
  104387. /**
  104388. * An event triggered when the effect is (re)created
  104389. */
  104390. get onEffectCreatedObservable(): Observable<{
  104391. effect: Effect;
  104392. subMesh: Nullable<SubMesh>;
  104393. }>;
  104394. /**
  104395. * Stores the value of the alpha mode
  104396. */
  104397. private _alphaMode;
  104398. /**
  104399. * Sets the value of the alpha mode.
  104400. *
  104401. * | Value | Type | Description |
  104402. * | --- | --- | --- |
  104403. * | 0 | ALPHA_DISABLE | |
  104404. * | 1 | ALPHA_ADD | |
  104405. * | 2 | ALPHA_COMBINE | |
  104406. * | 3 | ALPHA_SUBTRACT | |
  104407. * | 4 | ALPHA_MULTIPLY | |
  104408. * | 5 | ALPHA_MAXIMIZED | |
  104409. * | 6 | ALPHA_ONEONE | |
  104410. * | 7 | ALPHA_PREMULTIPLIED | |
  104411. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  104412. * | 9 | ALPHA_INTERPOLATE | |
  104413. * | 10 | ALPHA_SCREENMODE | |
  104414. *
  104415. */
  104416. set alphaMode(value: number);
  104417. /**
  104418. * Gets the value of the alpha mode
  104419. */
  104420. get alphaMode(): number;
  104421. /**
  104422. * Stores the state of the need depth pre-pass value
  104423. */
  104424. private _needDepthPrePass;
  104425. /**
  104426. * Sets the need depth pre-pass value
  104427. */
  104428. set needDepthPrePass(value: boolean);
  104429. /**
  104430. * Gets the depth pre-pass value
  104431. */
  104432. get needDepthPrePass(): boolean;
  104433. /**
  104434. * Specifies if depth writing should be disabled
  104435. */
  104436. disableDepthWrite: boolean;
  104437. /**
  104438. * Specifies if color writing should be disabled
  104439. */
  104440. disableColorWrite: boolean;
  104441. /**
  104442. * Specifies if depth writing should be forced
  104443. */
  104444. forceDepthWrite: boolean;
  104445. /**
  104446. * Specifies the depth function that should be used. 0 means the default engine function
  104447. */
  104448. depthFunction: number;
  104449. /**
  104450. * Specifies if there should be a separate pass for culling
  104451. */
  104452. separateCullingPass: boolean;
  104453. /**
  104454. * Stores the state specifing if fog should be enabled
  104455. */
  104456. private _fogEnabled;
  104457. /**
  104458. * Sets the state for enabling fog
  104459. */
  104460. set fogEnabled(value: boolean);
  104461. /**
  104462. * Gets the value of the fog enabled state
  104463. */
  104464. get fogEnabled(): boolean;
  104465. /**
  104466. * Stores the size of points
  104467. */
  104468. pointSize: number;
  104469. /**
  104470. * Stores the z offset value
  104471. */
  104472. zOffset: number;
  104473. get wireframe(): boolean;
  104474. /**
  104475. * Sets the state of wireframe mode
  104476. */
  104477. set wireframe(value: boolean);
  104478. /**
  104479. * Gets the value specifying if point clouds are enabled
  104480. */
  104481. get pointsCloud(): boolean;
  104482. /**
  104483. * Sets the state of point cloud mode
  104484. */
  104485. set pointsCloud(value: boolean);
  104486. /**
  104487. * Gets the material fill mode
  104488. */
  104489. get fillMode(): number;
  104490. /**
  104491. * Sets the material fill mode
  104492. */
  104493. set fillMode(value: number);
  104494. /**
  104495. * @hidden
  104496. * Stores the effects for the material
  104497. */
  104498. _effect: Nullable<Effect>;
  104499. /**
  104500. * Specifies if uniform buffers should be used
  104501. */
  104502. private _useUBO;
  104503. /**
  104504. * Stores a reference to the scene
  104505. */
  104506. private _scene;
  104507. /**
  104508. * Stores the fill mode state
  104509. */
  104510. private _fillMode;
  104511. /**
  104512. * Specifies if the depth write state should be cached
  104513. */
  104514. private _cachedDepthWriteState;
  104515. /**
  104516. * Specifies if the color write state should be cached
  104517. */
  104518. private _cachedColorWriteState;
  104519. /**
  104520. * Specifies if the depth function state should be cached
  104521. */
  104522. private _cachedDepthFunctionState;
  104523. /**
  104524. * Stores the uniform buffer
  104525. */
  104526. protected _uniformBuffer: UniformBuffer;
  104527. /** @hidden */
  104528. _indexInSceneMaterialArray: number;
  104529. /** @hidden */
  104530. meshMap: Nullable<{
  104531. [id: string]: AbstractMesh | undefined;
  104532. }>;
  104533. /**
  104534. * Creates a material instance
  104535. * @param name defines the name of the material
  104536. * @param scene defines the scene to reference
  104537. * @param doNotAdd specifies if the material should be added to the scene
  104538. */
  104539. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  104540. /**
  104541. * Returns a string representation of the current material
  104542. * @param fullDetails defines a boolean indicating which levels of logging is desired
  104543. * @returns a string with material information
  104544. */
  104545. toString(fullDetails?: boolean): string;
  104546. /**
  104547. * Gets the class name of the material
  104548. * @returns a string with the class name of the material
  104549. */
  104550. getClassName(): string;
  104551. /**
  104552. * Specifies if updates for the material been locked
  104553. */
  104554. get isFrozen(): boolean;
  104555. /**
  104556. * Locks updates for the material
  104557. */
  104558. freeze(): void;
  104559. /**
  104560. * Unlocks updates for the material
  104561. */
  104562. unfreeze(): void;
  104563. /**
  104564. * Specifies if the material is ready to be used
  104565. * @param mesh defines the mesh to check
  104566. * @param useInstances specifies if instances should be used
  104567. * @returns a boolean indicating if the material is ready to be used
  104568. */
  104569. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  104570. /**
  104571. * Specifies that the submesh is ready to be used
  104572. * @param mesh defines the mesh to check
  104573. * @param subMesh defines which submesh to check
  104574. * @param useInstances specifies that instances should be used
  104575. * @returns a boolean indicating that the submesh is ready or not
  104576. */
  104577. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  104578. /**
  104579. * Returns the material effect
  104580. * @returns the effect associated with the material
  104581. */
  104582. getEffect(): Nullable<Effect>;
  104583. /**
  104584. * Returns the current scene
  104585. * @returns a Scene
  104586. */
  104587. getScene(): Scene;
  104588. /**
  104589. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  104590. */
  104591. protected _forceAlphaTest: boolean;
  104592. /**
  104593. * The transparency mode of the material.
  104594. */
  104595. protected _transparencyMode: Nullable<number>;
  104596. /**
  104597. * Gets the current transparency mode.
  104598. */
  104599. get transparencyMode(): Nullable<number>;
  104600. /**
  104601. * Sets the transparency mode of the material.
  104602. *
  104603. * | Value | Type | Description |
  104604. * | ----- | ----------------------------------- | ----------- |
  104605. * | 0 | OPAQUE | |
  104606. * | 1 | ALPHATEST | |
  104607. * | 2 | ALPHABLEND | |
  104608. * | 3 | ALPHATESTANDBLEND | |
  104609. *
  104610. */
  104611. set transparencyMode(value: Nullable<number>);
  104612. /**
  104613. * Returns true if alpha blending should be disabled.
  104614. */
  104615. protected get _disableAlphaBlending(): boolean;
  104616. /**
  104617. * Specifies whether or not this material should be rendered in alpha blend mode.
  104618. * @returns a boolean specifying if alpha blending is needed
  104619. */
  104620. needAlphaBlending(): boolean;
  104621. /**
  104622. * Specifies if the mesh will require alpha blending
  104623. * @param mesh defines the mesh to check
  104624. * @returns a boolean specifying if alpha blending is needed for the mesh
  104625. */
  104626. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  104627. /**
  104628. * Specifies whether or not this material should be rendered in alpha test mode.
  104629. * @returns a boolean specifying if an alpha test is needed.
  104630. */
  104631. needAlphaTesting(): boolean;
  104632. /**
  104633. * Specifies if material alpha testing should be turned on for the mesh
  104634. * @param mesh defines the mesh to check
  104635. */
  104636. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  104637. /**
  104638. * Gets the texture used for the alpha test
  104639. * @returns the texture to use for alpha testing
  104640. */
  104641. getAlphaTestTexture(): Nullable<BaseTexture>;
  104642. /**
  104643. * Marks the material to indicate that it needs to be re-calculated
  104644. */
  104645. markDirty(): void;
  104646. /** @hidden */
  104647. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  104648. /**
  104649. * Binds the material to the mesh
  104650. * @param world defines the world transformation matrix
  104651. * @param mesh defines the mesh to bind the material to
  104652. */
  104653. bind(world: Matrix, mesh?: Mesh): void;
  104654. /**
  104655. * Binds the submesh to the material
  104656. * @param world defines the world transformation matrix
  104657. * @param mesh defines the mesh containing the submesh
  104658. * @param subMesh defines the submesh to bind the material to
  104659. */
  104660. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  104661. /**
  104662. * Binds the world matrix to the material
  104663. * @param world defines the world transformation matrix
  104664. */
  104665. bindOnlyWorldMatrix(world: Matrix): void;
  104666. /**
  104667. * Binds the scene's uniform buffer to the effect.
  104668. * @param effect defines the effect to bind to the scene uniform buffer
  104669. * @param sceneUbo defines the uniform buffer storing scene data
  104670. */
  104671. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  104672. /**
  104673. * Binds the view matrix to the effect
  104674. * @param effect defines the effect to bind the view matrix to
  104675. */
  104676. bindView(effect: Effect): void;
  104677. /**
  104678. * Binds the view projection matrix to the effect
  104679. * @param effect defines the effect to bind the view projection matrix to
  104680. */
  104681. bindViewProjection(effect: Effect): void;
  104682. /**
  104683. * Processes to execute after binding the material to a mesh
  104684. * @param mesh defines the rendered mesh
  104685. */
  104686. protected _afterBind(mesh?: Mesh): void;
  104687. /**
  104688. * Unbinds the material from the mesh
  104689. */
  104690. unbind(): void;
  104691. /**
  104692. * Gets the active textures from the material
  104693. * @returns an array of textures
  104694. */
  104695. getActiveTextures(): BaseTexture[];
  104696. /**
  104697. * Specifies if the material uses a texture
  104698. * @param texture defines the texture to check against the material
  104699. * @returns a boolean specifying if the material uses the texture
  104700. */
  104701. hasTexture(texture: BaseTexture): boolean;
  104702. /**
  104703. * Makes a duplicate of the material, and gives it a new name
  104704. * @param name defines the new name for the duplicated material
  104705. * @returns the cloned material
  104706. */
  104707. clone(name: string): Nullable<Material>;
  104708. /**
  104709. * Gets the meshes bound to the material
  104710. * @returns an array of meshes bound to the material
  104711. */
  104712. getBindedMeshes(): AbstractMesh[];
  104713. /**
  104714. * Force shader compilation
  104715. * @param mesh defines the mesh associated with this material
  104716. * @param onCompiled defines a function to execute once the material is compiled
  104717. * @param options defines the options to configure the compilation
  104718. * @param onError defines a function to execute if the material fails compiling
  104719. */
  104720. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  104721. /**
  104722. * Force shader compilation
  104723. * @param mesh defines the mesh that will use this material
  104724. * @param options defines additional options for compiling the shaders
  104725. * @returns a promise that resolves when the compilation completes
  104726. */
  104727. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  104728. private static readonly _AllDirtyCallBack;
  104729. private static readonly _ImageProcessingDirtyCallBack;
  104730. private static readonly _TextureDirtyCallBack;
  104731. private static readonly _FresnelDirtyCallBack;
  104732. private static readonly _MiscDirtyCallBack;
  104733. private static readonly _LightsDirtyCallBack;
  104734. private static readonly _AttributeDirtyCallBack;
  104735. private static _FresnelAndMiscDirtyCallBack;
  104736. private static _TextureAndMiscDirtyCallBack;
  104737. private static readonly _DirtyCallbackArray;
  104738. private static readonly _RunDirtyCallBacks;
  104739. /**
  104740. * Marks a define in the material to indicate that it needs to be re-computed
  104741. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  104742. */
  104743. markAsDirty(flag: number): void;
  104744. /**
  104745. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  104746. * @param func defines a function which checks material defines against the submeshes
  104747. */
  104748. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  104749. /**
  104750. * Indicates that the scene should check if the rendering now needs a prepass
  104751. */
  104752. protected _markScenePrePassDirty(): void;
  104753. /**
  104754. * Indicates that we need to re-calculated for all submeshes
  104755. */
  104756. protected _markAllSubMeshesAsAllDirty(): void;
  104757. /**
  104758. * Indicates that image processing needs to be re-calculated for all submeshes
  104759. */
  104760. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  104761. /**
  104762. * Indicates that textures need to be re-calculated for all submeshes
  104763. */
  104764. protected _markAllSubMeshesAsTexturesDirty(): void;
  104765. /**
  104766. * Indicates that fresnel needs to be re-calculated for all submeshes
  104767. */
  104768. protected _markAllSubMeshesAsFresnelDirty(): void;
  104769. /**
  104770. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  104771. */
  104772. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  104773. /**
  104774. * Indicates that lights need to be re-calculated for all submeshes
  104775. */
  104776. protected _markAllSubMeshesAsLightsDirty(): void;
  104777. /**
  104778. * Indicates that attributes need to be re-calculated for all submeshes
  104779. */
  104780. protected _markAllSubMeshesAsAttributesDirty(): void;
  104781. /**
  104782. * Indicates that misc needs to be re-calculated for all submeshes
  104783. */
  104784. protected _markAllSubMeshesAsMiscDirty(): void;
  104785. /**
  104786. * Indicates that textures and misc need to be re-calculated for all submeshes
  104787. */
  104788. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  104789. /**
  104790. * Sets the required values to the prepass renderer.
  104791. * @param prePassRenderer defines the prepass renderer to setup.
  104792. * @returns true if the pre pass is needed.
  104793. */
  104794. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  104795. /**
  104796. * Disposes the material
  104797. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  104798. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  104799. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  104800. */
  104801. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  104802. /** @hidden */
  104803. private releaseVertexArrayObject;
  104804. /**
  104805. * Serializes this material
  104806. * @returns the serialized material object
  104807. */
  104808. serialize(): any;
  104809. /**
  104810. * Creates a material from parsed material data
  104811. * @param parsedMaterial defines parsed material data
  104812. * @param scene defines the hosting scene
  104813. * @param rootUrl defines the root URL to use to load textures
  104814. * @returns a new material
  104815. */
  104816. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  104817. }
  104818. }
  104819. declare module BABYLON {
  104820. /**
  104821. * A multi-material is used to apply different materials to different parts of the same object without the need of
  104822. * separate meshes. This can be use to improve performances.
  104823. * @see https://doc.babylonjs.com/how_to/multi_materials
  104824. */
  104825. export class MultiMaterial extends Material {
  104826. private _subMaterials;
  104827. /**
  104828. * Gets or Sets the list of Materials used within the multi material.
  104829. * They need to be ordered according to the submeshes order in the associated mesh
  104830. */
  104831. get subMaterials(): Nullable<Material>[];
  104832. set subMaterials(value: Nullable<Material>[]);
  104833. /**
  104834. * Function used to align with Node.getChildren()
  104835. * @returns the list of Materials used within the multi material
  104836. */
  104837. getChildren(): Nullable<Material>[];
  104838. /**
  104839. * Instantiates a new Multi Material
  104840. * A multi-material is used to apply different materials to different parts of the same object without the need of
  104841. * separate meshes. This can be use to improve performances.
  104842. * @see https://doc.babylonjs.com/how_to/multi_materials
  104843. * @param name Define the name in the scene
  104844. * @param scene Define the scene the material belongs to
  104845. */
  104846. constructor(name: string, scene: Scene);
  104847. private _hookArray;
  104848. /**
  104849. * Get one of the submaterial by its index in the submaterials array
  104850. * @param index The index to look the sub material at
  104851. * @returns The Material if the index has been defined
  104852. */
  104853. getSubMaterial(index: number): Nullable<Material>;
  104854. /**
  104855. * Get the list of active textures for the whole sub materials list.
  104856. * @returns All the textures that will be used during the rendering
  104857. */
  104858. getActiveTextures(): BaseTexture[];
  104859. /**
  104860. * Gets the current class name of the material e.g. "MultiMaterial"
  104861. * Mainly use in serialization.
  104862. * @returns the class name
  104863. */
  104864. getClassName(): string;
  104865. /**
  104866. * Checks if the material is ready to render the requested sub mesh
  104867. * @param mesh Define the mesh the submesh belongs to
  104868. * @param subMesh Define the sub mesh to look readyness for
  104869. * @param useInstances Define whether or not the material is used with instances
  104870. * @returns true if ready, otherwise false
  104871. */
  104872. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  104873. /**
  104874. * Clones the current material and its related sub materials
  104875. * @param name Define the name of the newly cloned material
  104876. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  104877. * @returns the cloned material
  104878. */
  104879. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  104880. /**
  104881. * Serializes the materials into a JSON representation.
  104882. * @returns the JSON representation
  104883. */
  104884. serialize(): any;
  104885. /**
  104886. * Dispose the material and release its associated resources
  104887. * @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)
  104888. * @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)
  104889. * @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)
  104890. */
  104891. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  104892. /**
  104893. * Creates a MultiMaterial from parsed MultiMaterial data.
  104894. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  104895. * @param scene defines the hosting scene
  104896. * @returns a new MultiMaterial
  104897. */
  104898. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  104899. }
  104900. }
  104901. declare module BABYLON {
  104902. /**
  104903. * Defines a subdivision inside a mesh
  104904. */
  104905. export class SubMesh implements ICullable {
  104906. /** the material index to use */
  104907. materialIndex: number;
  104908. /** vertex index start */
  104909. verticesStart: number;
  104910. /** vertices count */
  104911. verticesCount: number;
  104912. /** index start */
  104913. indexStart: number;
  104914. /** indices count */
  104915. indexCount: number;
  104916. /** @hidden */
  104917. _materialDefines: Nullable<MaterialDefines>;
  104918. /** @hidden */
  104919. _materialEffect: Nullable<Effect>;
  104920. /** @hidden */
  104921. _effectOverride: Nullable<Effect>;
  104922. /**
  104923. * Gets material defines used by the effect associated to the sub mesh
  104924. */
  104925. get materialDefines(): Nullable<MaterialDefines>;
  104926. /**
  104927. * Sets material defines used by the effect associated to the sub mesh
  104928. */
  104929. set materialDefines(defines: Nullable<MaterialDefines>);
  104930. /**
  104931. * Gets associated effect
  104932. */
  104933. get effect(): Nullable<Effect>;
  104934. /**
  104935. * Sets associated effect (effect used to render this submesh)
  104936. * @param effect defines the effect to associate with
  104937. * @param defines defines the set of defines used to compile this effect
  104938. */
  104939. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  104940. /** @hidden */
  104941. _linesIndexCount: number;
  104942. private _mesh;
  104943. private _renderingMesh;
  104944. private _boundingInfo;
  104945. private _linesIndexBuffer;
  104946. /** @hidden */
  104947. _lastColliderWorldVertices: Nullable<Vector3[]>;
  104948. /** @hidden */
  104949. _trianglePlanes: Plane[];
  104950. /** @hidden */
  104951. _lastColliderTransformMatrix: Nullable<Matrix>;
  104952. /** @hidden */
  104953. _renderId: number;
  104954. /** @hidden */
  104955. _alphaIndex: number;
  104956. /** @hidden */
  104957. _distanceToCamera: number;
  104958. /** @hidden */
  104959. _id: number;
  104960. private _currentMaterial;
  104961. /**
  104962. * Add a new submesh to a mesh
  104963. * @param materialIndex defines the material index to use
  104964. * @param verticesStart defines vertex index start
  104965. * @param verticesCount defines vertices count
  104966. * @param indexStart defines index start
  104967. * @param indexCount defines indices count
  104968. * @param mesh defines the parent mesh
  104969. * @param renderingMesh defines an optional rendering mesh
  104970. * @param createBoundingBox defines if bounding box should be created for this submesh
  104971. * @returns the new submesh
  104972. */
  104973. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  104974. /**
  104975. * Creates a new submesh
  104976. * @param materialIndex defines the material index to use
  104977. * @param verticesStart defines vertex index start
  104978. * @param verticesCount defines vertices count
  104979. * @param indexStart defines index start
  104980. * @param indexCount defines indices count
  104981. * @param mesh defines the parent mesh
  104982. * @param renderingMesh defines an optional rendering mesh
  104983. * @param createBoundingBox defines if bounding box should be created for this submesh
  104984. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  104985. */
  104986. constructor(
  104987. /** the material index to use */
  104988. materialIndex: number,
  104989. /** vertex index start */
  104990. verticesStart: number,
  104991. /** vertices count */
  104992. verticesCount: number,
  104993. /** index start */
  104994. indexStart: number,
  104995. /** indices count */
  104996. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  104997. /**
  104998. * Returns true if this submesh covers the entire parent mesh
  104999. * @ignorenaming
  105000. */
  105001. get IsGlobal(): boolean;
  105002. /**
  105003. * Returns the submesh BoudingInfo object
  105004. * @returns current bounding info (or mesh's one if the submesh is global)
  105005. */
  105006. getBoundingInfo(): BoundingInfo;
  105007. /**
  105008. * Sets the submesh BoundingInfo
  105009. * @param boundingInfo defines the new bounding info to use
  105010. * @returns the SubMesh
  105011. */
  105012. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  105013. /**
  105014. * Returns the mesh of the current submesh
  105015. * @return the parent mesh
  105016. */
  105017. getMesh(): AbstractMesh;
  105018. /**
  105019. * Returns the rendering mesh of the submesh
  105020. * @returns the rendering mesh (could be different from parent mesh)
  105021. */
  105022. getRenderingMesh(): Mesh;
  105023. /**
  105024. * Returns the replacement mesh of the submesh
  105025. * @returns the replacement mesh (could be different from parent mesh)
  105026. */
  105027. getReplacementMesh(): Nullable<AbstractMesh>;
  105028. /**
  105029. * Returns the effective mesh of the submesh
  105030. * @returns the effective mesh (could be different from parent mesh)
  105031. */
  105032. getEffectiveMesh(): AbstractMesh;
  105033. /**
  105034. * Returns the submesh material
  105035. * @returns null or the current material
  105036. */
  105037. getMaterial(): Nullable<Material>;
  105038. private _IsMultiMaterial;
  105039. /**
  105040. * Sets a new updated BoundingInfo object to the submesh
  105041. * @param data defines an optional position array to use to determine the bounding info
  105042. * @returns the SubMesh
  105043. */
  105044. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  105045. /** @hidden */
  105046. _checkCollision(collider: Collider): boolean;
  105047. /**
  105048. * Updates the submesh BoundingInfo
  105049. * @param world defines the world matrix to use to update the bounding info
  105050. * @returns the submesh
  105051. */
  105052. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  105053. /**
  105054. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  105055. * @param frustumPlanes defines the frustum planes
  105056. * @returns true if the submesh is intersecting with the frustum
  105057. */
  105058. isInFrustum(frustumPlanes: Plane[]): boolean;
  105059. /**
  105060. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  105061. * @param frustumPlanes defines the frustum planes
  105062. * @returns true if the submesh is inside the frustum
  105063. */
  105064. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  105065. /**
  105066. * Renders the submesh
  105067. * @param enableAlphaMode defines if alpha needs to be used
  105068. * @returns the submesh
  105069. */
  105070. render(enableAlphaMode: boolean): SubMesh;
  105071. /**
  105072. * @hidden
  105073. */
  105074. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  105075. /**
  105076. * Checks if the submesh intersects with a ray
  105077. * @param ray defines the ray to test
  105078. * @returns true is the passed ray intersects the submesh bounding box
  105079. */
  105080. canIntersects(ray: Ray): boolean;
  105081. /**
  105082. * Intersects current submesh with a ray
  105083. * @param ray defines the ray to test
  105084. * @param positions defines mesh's positions array
  105085. * @param indices defines mesh's indices array
  105086. * @param fastCheck defines if the first intersection will be used (and not the closest)
  105087. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  105088. * @returns intersection info or null if no intersection
  105089. */
  105090. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  105091. /** @hidden */
  105092. private _intersectLines;
  105093. /** @hidden */
  105094. private _intersectUnIndexedLines;
  105095. /** @hidden */
  105096. private _intersectTriangles;
  105097. /** @hidden */
  105098. private _intersectUnIndexedTriangles;
  105099. /** @hidden */
  105100. _rebuild(): void;
  105101. /**
  105102. * Creates a new submesh from the passed mesh
  105103. * @param newMesh defines the new hosting mesh
  105104. * @param newRenderingMesh defines an optional rendering mesh
  105105. * @returns the new submesh
  105106. */
  105107. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  105108. /**
  105109. * Release associated resources
  105110. */
  105111. dispose(): void;
  105112. /**
  105113. * Gets the class name
  105114. * @returns the string "SubMesh".
  105115. */
  105116. getClassName(): string;
  105117. /**
  105118. * Creates a new submesh from indices data
  105119. * @param materialIndex the index of the main mesh material
  105120. * @param startIndex the index where to start the copy in the mesh indices array
  105121. * @param indexCount the number of indices to copy then from the startIndex
  105122. * @param mesh the main mesh to create the submesh from
  105123. * @param renderingMesh the optional rendering mesh
  105124. * @returns a new submesh
  105125. */
  105126. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  105127. }
  105128. }
  105129. declare module BABYLON {
  105130. /**
  105131. * Class used to represent data loading progression
  105132. */
  105133. export class SceneLoaderFlags {
  105134. private static _ForceFullSceneLoadingForIncremental;
  105135. private static _ShowLoadingScreen;
  105136. private static _CleanBoneMatrixWeights;
  105137. private static _loggingLevel;
  105138. /**
  105139. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  105140. */
  105141. static get ForceFullSceneLoadingForIncremental(): boolean;
  105142. static set ForceFullSceneLoadingForIncremental(value: boolean);
  105143. /**
  105144. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  105145. */
  105146. static get ShowLoadingScreen(): boolean;
  105147. static set ShowLoadingScreen(value: boolean);
  105148. /**
  105149. * Defines the current logging level (while loading the scene)
  105150. * @ignorenaming
  105151. */
  105152. static get loggingLevel(): number;
  105153. static set loggingLevel(value: number);
  105154. /**
  105155. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  105156. */
  105157. static get CleanBoneMatrixWeights(): boolean;
  105158. static set CleanBoneMatrixWeights(value: boolean);
  105159. }
  105160. }
  105161. declare module BABYLON {
  105162. /**
  105163. * Class used to store geometry data (vertex buffers + index buffer)
  105164. */
  105165. export class Geometry implements IGetSetVerticesData {
  105166. /**
  105167. * Gets or sets the ID of the geometry
  105168. */
  105169. id: string;
  105170. /**
  105171. * Gets or sets the unique ID of the geometry
  105172. */
  105173. uniqueId: number;
  105174. /**
  105175. * Gets the delay loading state of the geometry (none by default which means not delayed)
  105176. */
  105177. delayLoadState: number;
  105178. /**
  105179. * Gets the file containing the data to load when running in delay load state
  105180. */
  105181. delayLoadingFile: Nullable<string>;
  105182. /**
  105183. * Callback called when the geometry is updated
  105184. */
  105185. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  105186. private _scene;
  105187. private _engine;
  105188. private _meshes;
  105189. private _totalVertices;
  105190. /** @hidden */
  105191. _indices: IndicesArray;
  105192. /** @hidden */
  105193. _vertexBuffers: {
  105194. [key: string]: VertexBuffer;
  105195. };
  105196. private _isDisposed;
  105197. private _extend;
  105198. private _boundingBias;
  105199. /** @hidden */
  105200. _delayInfo: Array<string>;
  105201. private _indexBuffer;
  105202. private _indexBufferIsUpdatable;
  105203. /** @hidden */
  105204. _boundingInfo: Nullable<BoundingInfo>;
  105205. /** @hidden */
  105206. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  105207. /** @hidden */
  105208. _softwareSkinningFrameId: number;
  105209. private _vertexArrayObjects;
  105210. private _updatable;
  105211. /** @hidden */
  105212. _positions: Nullable<Vector3[]>;
  105213. /**
  105214. * 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
  105215. */
  105216. get boundingBias(): Vector2;
  105217. /**
  105218. * 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
  105219. */
  105220. set boundingBias(value: Vector2);
  105221. /**
  105222. * Static function used to attach a new empty geometry to a mesh
  105223. * @param mesh defines the mesh to attach the geometry to
  105224. * @returns the new Geometry
  105225. */
  105226. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  105227. /** Get the list of meshes using this geometry */
  105228. get meshes(): Mesh[];
  105229. /**
  105230. * 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
  105231. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  105232. */
  105233. useBoundingInfoFromGeometry: boolean;
  105234. /**
  105235. * Creates a new geometry
  105236. * @param id defines the unique ID
  105237. * @param scene defines the hosting scene
  105238. * @param vertexData defines the VertexData used to get geometry data
  105239. * @param updatable defines if geometry must be updatable (false by default)
  105240. * @param mesh defines the mesh that will be associated with the geometry
  105241. */
  105242. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  105243. /**
  105244. * Gets the current extend of the geometry
  105245. */
  105246. get extend(): {
  105247. minimum: Vector3;
  105248. maximum: Vector3;
  105249. };
  105250. /**
  105251. * Gets the hosting scene
  105252. * @returns the hosting Scene
  105253. */
  105254. getScene(): Scene;
  105255. /**
  105256. * Gets the hosting engine
  105257. * @returns the hosting Engine
  105258. */
  105259. getEngine(): Engine;
  105260. /**
  105261. * Defines if the geometry is ready to use
  105262. * @returns true if the geometry is ready to be used
  105263. */
  105264. isReady(): boolean;
  105265. /**
  105266. * Gets a value indicating that the geometry should not be serialized
  105267. */
  105268. get doNotSerialize(): boolean;
  105269. /** @hidden */
  105270. _rebuild(): void;
  105271. /**
  105272. * Affects all geometry data in one call
  105273. * @param vertexData defines the geometry data
  105274. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  105275. */
  105276. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  105277. /**
  105278. * Set specific vertex data
  105279. * @param kind defines the data kind (Position, normal, etc...)
  105280. * @param data defines the vertex data to use
  105281. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  105282. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  105283. */
  105284. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  105285. /**
  105286. * Removes a specific vertex data
  105287. * @param kind defines the data kind (Position, normal, etc...)
  105288. */
  105289. removeVerticesData(kind: string): void;
  105290. /**
  105291. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  105292. * @param buffer defines the vertex buffer to use
  105293. * @param totalVertices defines the total number of vertices for position kind (could be null)
  105294. */
  105295. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  105296. /**
  105297. * Update a specific vertex buffer
  105298. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  105299. * It will do nothing if the buffer is not updatable
  105300. * @param kind defines the data kind (Position, normal, etc...)
  105301. * @param data defines the data to use
  105302. * @param offset defines the offset in the target buffer where to store the data
  105303. * @param useBytes set to true if the offset is in bytes
  105304. */
  105305. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  105306. /**
  105307. * Update a specific vertex buffer
  105308. * This function will create a new buffer if the current one is not updatable
  105309. * @param kind defines the data kind (Position, normal, etc...)
  105310. * @param data defines the data to use
  105311. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  105312. */
  105313. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  105314. private _updateBoundingInfo;
  105315. /** @hidden */
  105316. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  105317. /**
  105318. * Gets total number of vertices
  105319. * @returns the total number of vertices
  105320. */
  105321. getTotalVertices(): number;
  105322. /**
  105323. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  105324. * @param kind defines the data kind (Position, normal, etc...)
  105325. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105326. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105327. * @returns a float array containing vertex data
  105328. */
  105329. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  105330. /**
  105331. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  105332. * @param kind defines the data kind (Position, normal, etc...)
  105333. * @returns true if the vertex buffer with the specified kind is updatable
  105334. */
  105335. isVertexBufferUpdatable(kind: string): boolean;
  105336. /**
  105337. * Gets a specific vertex buffer
  105338. * @param kind defines the data kind (Position, normal, etc...)
  105339. * @returns a VertexBuffer
  105340. */
  105341. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  105342. /**
  105343. * Returns all vertex buffers
  105344. * @return an object holding all vertex buffers indexed by kind
  105345. */
  105346. getVertexBuffers(): Nullable<{
  105347. [key: string]: VertexBuffer;
  105348. }>;
  105349. /**
  105350. * Gets a boolean indicating if specific vertex buffer is present
  105351. * @param kind defines the data kind (Position, normal, etc...)
  105352. * @returns true if data is present
  105353. */
  105354. isVerticesDataPresent(kind: string): boolean;
  105355. /**
  105356. * Gets a list of all attached data kinds (Position, normal, etc...)
  105357. * @returns a list of string containing all kinds
  105358. */
  105359. getVerticesDataKinds(): string[];
  105360. /**
  105361. * Update index buffer
  105362. * @param indices defines the indices to store in the index buffer
  105363. * @param offset defines the offset in the target buffer where to store the data
  105364. * @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)
  105365. */
  105366. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  105367. /**
  105368. * Creates a new index buffer
  105369. * @param indices defines the indices to store in the index buffer
  105370. * @param totalVertices defines the total number of vertices (could be null)
  105371. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  105372. */
  105373. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  105374. /**
  105375. * Return the total number of indices
  105376. * @returns the total number of indices
  105377. */
  105378. getTotalIndices(): number;
  105379. /**
  105380. * Gets the index buffer array
  105381. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105382. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105383. * @returns the index buffer array
  105384. */
  105385. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  105386. /**
  105387. * Gets the index buffer
  105388. * @return the index buffer
  105389. */
  105390. getIndexBuffer(): Nullable<DataBuffer>;
  105391. /** @hidden */
  105392. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  105393. /**
  105394. * Release the associated resources for a specific mesh
  105395. * @param mesh defines the source mesh
  105396. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  105397. */
  105398. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  105399. /**
  105400. * Apply current geometry to a given mesh
  105401. * @param mesh defines the mesh to apply geometry to
  105402. */
  105403. applyToMesh(mesh: Mesh): void;
  105404. private _updateExtend;
  105405. private _applyToMesh;
  105406. private notifyUpdate;
  105407. /**
  105408. * Load the geometry if it was flagged as delay loaded
  105409. * @param scene defines the hosting scene
  105410. * @param onLoaded defines a callback called when the geometry is loaded
  105411. */
  105412. load(scene: Scene, onLoaded?: () => void): void;
  105413. private _queueLoad;
  105414. /**
  105415. * Invert the geometry to move from a right handed system to a left handed one.
  105416. */
  105417. toLeftHanded(): void;
  105418. /** @hidden */
  105419. _resetPointsArrayCache(): void;
  105420. /** @hidden */
  105421. _generatePointsArray(): boolean;
  105422. /**
  105423. * Gets a value indicating if the geometry is disposed
  105424. * @returns true if the geometry was disposed
  105425. */
  105426. isDisposed(): boolean;
  105427. private _disposeVertexArrayObjects;
  105428. /**
  105429. * Free all associated resources
  105430. */
  105431. dispose(): void;
  105432. /**
  105433. * Clone the current geometry into a new geometry
  105434. * @param id defines the unique ID of the new geometry
  105435. * @returns a new geometry object
  105436. */
  105437. copy(id: string): Geometry;
  105438. /**
  105439. * Serialize the current geometry info (and not the vertices data) into a JSON object
  105440. * @return a JSON representation of the current geometry data (without the vertices data)
  105441. */
  105442. serialize(): any;
  105443. private toNumberArray;
  105444. /**
  105445. * Serialize all vertices data into a JSON oject
  105446. * @returns a JSON representation of the current geometry data
  105447. */
  105448. serializeVerticeData(): any;
  105449. /**
  105450. * Extracts a clone of a mesh geometry
  105451. * @param mesh defines the source mesh
  105452. * @param id defines the unique ID of the new geometry object
  105453. * @returns the new geometry object
  105454. */
  105455. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  105456. /**
  105457. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  105458. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  105459. * Be aware Math.random() could cause collisions, but:
  105460. * "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"
  105461. * @returns a string containing a new GUID
  105462. */
  105463. static RandomId(): string;
  105464. /** @hidden */
  105465. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  105466. private static _CleanMatricesWeights;
  105467. /**
  105468. * Create a new geometry from persisted data (Using .babylon file format)
  105469. * @param parsedVertexData defines the persisted data
  105470. * @param scene defines the hosting scene
  105471. * @param rootUrl defines the root url to use to load assets (like delayed data)
  105472. * @returns the new geometry object
  105473. */
  105474. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  105475. }
  105476. }
  105477. declare module BABYLON {
  105478. /**
  105479. * Define an interface for all classes that will get and set the data on vertices
  105480. */
  105481. export interface IGetSetVerticesData {
  105482. /**
  105483. * Gets a boolean indicating if specific vertex data is present
  105484. * @param kind defines the vertex data kind to use
  105485. * @returns true is data kind is present
  105486. */
  105487. isVerticesDataPresent(kind: string): boolean;
  105488. /**
  105489. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  105490. * @param kind defines the data kind (Position, normal, etc...)
  105491. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105492. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105493. * @returns a float array containing vertex data
  105494. */
  105495. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  105496. /**
  105497. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  105498. * @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.
  105499. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105500. * @returns the indices array or an empty array if the mesh has no geometry
  105501. */
  105502. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  105503. /**
  105504. * Set specific vertex data
  105505. * @param kind defines the data kind (Position, normal, etc...)
  105506. * @param data defines the vertex data to use
  105507. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  105508. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  105509. */
  105510. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  105511. /**
  105512. * Update a specific associated vertex buffer
  105513. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  105514. * - VertexBuffer.PositionKind
  105515. * - VertexBuffer.UVKind
  105516. * - VertexBuffer.UV2Kind
  105517. * - VertexBuffer.UV3Kind
  105518. * - VertexBuffer.UV4Kind
  105519. * - VertexBuffer.UV5Kind
  105520. * - VertexBuffer.UV6Kind
  105521. * - VertexBuffer.ColorKind
  105522. * - VertexBuffer.MatricesIndicesKind
  105523. * - VertexBuffer.MatricesIndicesExtraKind
  105524. * - VertexBuffer.MatricesWeightsKind
  105525. * - VertexBuffer.MatricesWeightsExtraKind
  105526. * @param data defines the data source
  105527. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  105528. * @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)
  105529. */
  105530. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  105531. /**
  105532. * Creates a new index buffer
  105533. * @param indices defines the indices to store in the index buffer
  105534. * @param totalVertices defines the total number of vertices (could be null)
  105535. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  105536. */
  105537. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  105538. }
  105539. /**
  105540. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  105541. */
  105542. export class VertexData {
  105543. /**
  105544. * Mesh side orientation : usually the external or front surface
  105545. */
  105546. static readonly FRONTSIDE: number;
  105547. /**
  105548. * Mesh side orientation : usually the internal or back surface
  105549. */
  105550. static readonly BACKSIDE: number;
  105551. /**
  105552. * Mesh side orientation : both internal and external or front and back surfaces
  105553. */
  105554. static readonly DOUBLESIDE: number;
  105555. /**
  105556. * Mesh side orientation : by default, `FRONTSIDE`
  105557. */
  105558. static readonly DEFAULTSIDE: number;
  105559. /**
  105560. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  105561. */
  105562. positions: Nullable<FloatArray>;
  105563. /**
  105564. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  105565. */
  105566. normals: Nullable<FloatArray>;
  105567. /**
  105568. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  105569. */
  105570. tangents: Nullable<FloatArray>;
  105571. /**
  105572. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105573. */
  105574. uvs: Nullable<FloatArray>;
  105575. /**
  105576. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105577. */
  105578. uvs2: Nullable<FloatArray>;
  105579. /**
  105580. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105581. */
  105582. uvs3: Nullable<FloatArray>;
  105583. /**
  105584. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105585. */
  105586. uvs4: Nullable<FloatArray>;
  105587. /**
  105588. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105589. */
  105590. uvs5: Nullable<FloatArray>;
  105591. /**
  105592. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105593. */
  105594. uvs6: Nullable<FloatArray>;
  105595. /**
  105596. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  105597. */
  105598. colors: Nullable<FloatArray>;
  105599. /**
  105600. * 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).
  105601. */
  105602. matricesIndices: Nullable<FloatArray>;
  105603. /**
  105604. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  105605. */
  105606. matricesWeights: Nullable<FloatArray>;
  105607. /**
  105608. * An array extending the number of possible indices
  105609. */
  105610. matricesIndicesExtra: Nullable<FloatArray>;
  105611. /**
  105612. * An array extending the number of possible weights when the number of indices is extended
  105613. */
  105614. matricesWeightsExtra: Nullable<FloatArray>;
  105615. /**
  105616. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  105617. */
  105618. indices: Nullable<IndicesArray>;
  105619. /**
  105620. * Uses the passed data array to set the set the values for the specified kind of data
  105621. * @param data a linear array of floating numbers
  105622. * @param kind the type of data that is being set, eg positions, colors etc
  105623. */
  105624. set(data: FloatArray, kind: string): void;
  105625. /**
  105626. * Associates the vertexData to the passed Mesh.
  105627. * Sets it as updatable or not (default `false`)
  105628. * @param mesh the mesh the vertexData is applied to
  105629. * @param updatable when used and having the value true allows new data to update the vertexData
  105630. * @returns the VertexData
  105631. */
  105632. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  105633. /**
  105634. * Associates the vertexData to the passed Geometry.
  105635. * Sets it as updatable or not (default `false`)
  105636. * @param geometry the geometry the vertexData is applied to
  105637. * @param updatable when used and having the value true allows new data to update the vertexData
  105638. * @returns VertexData
  105639. */
  105640. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  105641. /**
  105642. * Updates the associated mesh
  105643. * @param mesh the mesh to be updated
  105644. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  105645. * @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
  105646. * @returns VertexData
  105647. */
  105648. updateMesh(mesh: Mesh): VertexData;
  105649. /**
  105650. * Updates the associated geometry
  105651. * @param geometry the geometry to be updated
  105652. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  105653. * @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
  105654. * @returns VertexData.
  105655. */
  105656. updateGeometry(geometry: Geometry): VertexData;
  105657. private _applyTo;
  105658. private _update;
  105659. /**
  105660. * Transforms each position and each normal of the vertexData according to the passed Matrix
  105661. * @param matrix the transforming matrix
  105662. * @returns the VertexData
  105663. */
  105664. transform(matrix: Matrix): VertexData;
  105665. /**
  105666. * Merges the passed VertexData into the current one
  105667. * @param other the VertexData to be merged into the current one
  105668. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  105669. * @returns the modified VertexData
  105670. */
  105671. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  105672. private _mergeElement;
  105673. private _validate;
  105674. /**
  105675. * Serializes the VertexData
  105676. * @returns a serialized object
  105677. */
  105678. serialize(): any;
  105679. /**
  105680. * Extracts the vertexData from a mesh
  105681. * @param mesh the mesh from which to extract the VertexData
  105682. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  105683. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  105684. * @returns the object VertexData associated to the passed mesh
  105685. */
  105686. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  105687. /**
  105688. * Extracts the vertexData from the geometry
  105689. * @param geometry the geometry from which to extract the VertexData
  105690. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  105691. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  105692. * @returns the object VertexData associated to the passed mesh
  105693. */
  105694. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  105695. private static _ExtractFrom;
  105696. /**
  105697. * Creates the VertexData for a Ribbon
  105698. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  105699. * * pathArray array of paths, each of which an array of successive Vector3
  105700. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  105701. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  105702. * * 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
  105703. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105704. * * 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)
  105705. * * 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)
  105706. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  105707. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  105708. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  105709. * @returns the VertexData of the ribbon
  105710. */
  105711. static CreateRibbon(options: {
  105712. pathArray: Vector3[][];
  105713. closeArray?: boolean;
  105714. closePath?: boolean;
  105715. offset?: number;
  105716. sideOrientation?: number;
  105717. frontUVs?: Vector4;
  105718. backUVs?: Vector4;
  105719. invertUV?: boolean;
  105720. uvs?: Vector2[];
  105721. colors?: Color4[];
  105722. }): VertexData;
  105723. /**
  105724. * Creates the VertexData for a box
  105725. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105726. * * size sets the width, height and depth of the box to the value of size, optional default 1
  105727. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  105728. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  105729. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  105730. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  105731. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  105732. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105733. * * 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)
  105734. * * 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)
  105735. * @returns the VertexData of the box
  105736. */
  105737. static CreateBox(options: {
  105738. size?: number;
  105739. width?: number;
  105740. height?: number;
  105741. depth?: number;
  105742. faceUV?: Vector4[];
  105743. faceColors?: Color4[];
  105744. sideOrientation?: number;
  105745. frontUVs?: Vector4;
  105746. backUVs?: Vector4;
  105747. }): VertexData;
  105748. /**
  105749. * Creates the VertexData for a tiled box
  105750. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105751. * * faceTiles sets the pattern, tile size and number of tiles for a face
  105752. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  105753. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  105754. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105755. * @returns the VertexData of the box
  105756. */
  105757. static CreateTiledBox(options: {
  105758. pattern?: number;
  105759. width?: number;
  105760. height?: number;
  105761. depth?: number;
  105762. tileSize?: number;
  105763. tileWidth?: number;
  105764. tileHeight?: number;
  105765. alignHorizontal?: number;
  105766. alignVertical?: number;
  105767. faceUV?: Vector4[];
  105768. faceColors?: Color4[];
  105769. sideOrientation?: number;
  105770. }): VertexData;
  105771. /**
  105772. * Creates the VertexData for a tiled plane
  105773. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105774. * * pattern a limited pattern arrangement depending on the number
  105775. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  105776. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  105777. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  105778. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105779. * * 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)
  105780. * * 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)
  105781. * @returns the VertexData of the tiled plane
  105782. */
  105783. static CreateTiledPlane(options: {
  105784. pattern?: number;
  105785. tileSize?: number;
  105786. tileWidth?: number;
  105787. tileHeight?: number;
  105788. size?: number;
  105789. width?: number;
  105790. height?: number;
  105791. alignHorizontal?: number;
  105792. alignVertical?: number;
  105793. sideOrientation?: number;
  105794. frontUVs?: Vector4;
  105795. backUVs?: Vector4;
  105796. }): VertexData;
  105797. /**
  105798. * Creates the VertexData for an ellipsoid, defaults to a sphere
  105799. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105800. * * segments sets the number of horizontal strips optional, default 32
  105801. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  105802. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  105803. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  105804. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  105805. * * 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
  105806. * * 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
  105807. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105808. * * 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)
  105809. * * 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)
  105810. * @returns the VertexData of the ellipsoid
  105811. */
  105812. static CreateSphere(options: {
  105813. segments?: number;
  105814. diameter?: number;
  105815. diameterX?: number;
  105816. diameterY?: number;
  105817. diameterZ?: number;
  105818. arc?: number;
  105819. slice?: number;
  105820. sideOrientation?: number;
  105821. frontUVs?: Vector4;
  105822. backUVs?: Vector4;
  105823. }): VertexData;
  105824. /**
  105825. * Creates the VertexData for a cylinder, cone or prism
  105826. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105827. * * height sets the height (y direction) of the cylinder, optional, default 2
  105828. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  105829. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  105830. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  105831. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  105832. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  105833. * * 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
  105834. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  105835. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  105836. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  105837. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  105838. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105839. * * 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)
  105840. * * 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)
  105841. * @returns the VertexData of the cylinder, cone or prism
  105842. */
  105843. static CreateCylinder(options: {
  105844. height?: number;
  105845. diameterTop?: number;
  105846. diameterBottom?: number;
  105847. diameter?: number;
  105848. tessellation?: number;
  105849. subdivisions?: number;
  105850. arc?: number;
  105851. faceColors?: Color4[];
  105852. faceUV?: Vector4[];
  105853. hasRings?: boolean;
  105854. enclose?: boolean;
  105855. sideOrientation?: number;
  105856. frontUVs?: Vector4;
  105857. backUVs?: Vector4;
  105858. }): VertexData;
  105859. /**
  105860. * Creates the VertexData for a torus
  105861. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105862. * * diameter the diameter of the torus, optional default 1
  105863. * * thickness the diameter of the tube forming the torus, optional default 0.5
  105864. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  105865. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105866. * * 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)
  105867. * * 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)
  105868. * @returns the VertexData of the torus
  105869. */
  105870. static CreateTorus(options: {
  105871. diameter?: number;
  105872. thickness?: number;
  105873. tessellation?: number;
  105874. sideOrientation?: number;
  105875. frontUVs?: Vector4;
  105876. backUVs?: Vector4;
  105877. }): VertexData;
  105878. /**
  105879. * Creates the VertexData of the LineSystem
  105880. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  105881. * - lines an array of lines, each line being an array of successive Vector3
  105882. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  105883. * @returns the VertexData of the LineSystem
  105884. */
  105885. static CreateLineSystem(options: {
  105886. lines: Vector3[][];
  105887. colors?: Nullable<Color4[][]>;
  105888. }): VertexData;
  105889. /**
  105890. * Create the VertexData for a DashedLines
  105891. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  105892. * - points an array successive Vector3
  105893. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  105894. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  105895. * - dashNb the intended total number of dashes, optional, default 200
  105896. * @returns the VertexData for the DashedLines
  105897. */
  105898. static CreateDashedLines(options: {
  105899. points: Vector3[];
  105900. dashSize?: number;
  105901. gapSize?: number;
  105902. dashNb?: number;
  105903. }): VertexData;
  105904. /**
  105905. * Creates the VertexData for a Ground
  105906. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  105907. * - width the width (x direction) of the ground, optional, default 1
  105908. * - height the height (z direction) of the ground, optional, default 1
  105909. * - subdivisions the number of subdivisions per side, optional, default 1
  105910. * @returns the VertexData of the Ground
  105911. */
  105912. static CreateGround(options: {
  105913. width?: number;
  105914. height?: number;
  105915. subdivisions?: number;
  105916. subdivisionsX?: number;
  105917. subdivisionsY?: number;
  105918. }): VertexData;
  105919. /**
  105920. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  105921. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  105922. * * xmin the ground minimum X coordinate, optional, default -1
  105923. * * zmin the ground minimum Z coordinate, optional, default -1
  105924. * * xmax the ground maximum X coordinate, optional, default 1
  105925. * * zmax the ground maximum Z coordinate, optional, default 1
  105926. * * 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}
  105927. * * 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}
  105928. * @returns the VertexData of the TiledGround
  105929. */
  105930. static CreateTiledGround(options: {
  105931. xmin: number;
  105932. zmin: number;
  105933. xmax: number;
  105934. zmax: number;
  105935. subdivisions?: {
  105936. w: number;
  105937. h: number;
  105938. };
  105939. precision?: {
  105940. w: number;
  105941. h: number;
  105942. };
  105943. }): VertexData;
  105944. /**
  105945. * Creates the VertexData of the Ground designed from a heightmap
  105946. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  105947. * * width the width (x direction) of the ground
  105948. * * height the height (z direction) of the ground
  105949. * * subdivisions the number of subdivisions per side
  105950. * * minHeight the minimum altitude on the ground, optional, default 0
  105951. * * maxHeight the maximum altitude on the ground, optional default 1
  105952. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  105953. * * buffer the array holding the image color data
  105954. * * bufferWidth the width of image
  105955. * * bufferHeight the height of image
  105956. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  105957. * @returns the VertexData of the Ground designed from a heightmap
  105958. */
  105959. static CreateGroundFromHeightMap(options: {
  105960. width: number;
  105961. height: number;
  105962. subdivisions: number;
  105963. minHeight: number;
  105964. maxHeight: number;
  105965. colorFilter: Color3;
  105966. buffer: Uint8Array;
  105967. bufferWidth: number;
  105968. bufferHeight: number;
  105969. alphaFilter: number;
  105970. }): VertexData;
  105971. /**
  105972. * Creates the VertexData for a Plane
  105973. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  105974. * * size sets the width and height of the plane to the value of size, optional default 1
  105975. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  105976. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  105977. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105978. * * 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)
  105979. * * 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)
  105980. * @returns the VertexData of the box
  105981. */
  105982. static CreatePlane(options: {
  105983. size?: number;
  105984. width?: number;
  105985. height?: number;
  105986. sideOrientation?: number;
  105987. frontUVs?: Vector4;
  105988. backUVs?: Vector4;
  105989. }): VertexData;
  105990. /**
  105991. * Creates the VertexData of the Disc or regular Polygon
  105992. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  105993. * * radius the radius of the disc, optional default 0.5
  105994. * * tessellation the number of polygon sides, optional, default 64
  105995. * * 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
  105996. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105997. * * 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)
  105998. * * 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)
  105999. * @returns the VertexData of the box
  106000. */
  106001. static CreateDisc(options: {
  106002. radius?: number;
  106003. tessellation?: number;
  106004. arc?: number;
  106005. sideOrientation?: number;
  106006. frontUVs?: Vector4;
  106007. backUVs?: Vector4;
  106008. }): VertexData;
  106009. /**
  106010. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  106011. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  106012. * @param polygon a mesh built from polygonTriangulation.build()
  106013. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106014. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  106015. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  106016. * @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)
  106017. * @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)
  106018. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  106019. * @returns the VertexData of the Polygon
  106020. */
  106021. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  106022. /**
  106023. * Creates the VertexData of the IcoSphere
  106024. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  106025. * * radius the radius of the IcoSphere, optional default 1
  106026. * * radiusX allows stretching in the x direction, optional, default radius
  106027. * * radiusY allows stretching in the y direction, optional, default radius
  106028. * * radiusZ allows stretching in the z direction, optional, default radius
  106029. * * flat when true creates a flat shaded mesh, optional, default true
  106030. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  106031. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106032. * * 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)
  106033. * * 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)
  106034. * @returns the VertexData of the IcoSphere
  106035. */
  106036. static CreateIcoSphere(options: {
  106037. radius?: number;
  106038. radiusX?: number;
  106039. radiusY?: number;
  106040. radiusZ?: number;
  106041. flat?: boolean;
  106042. subdivisions?: number;
  106043. sideOrientation?: number;
  106044. frontUVs?: Vector4;
  106045. backUVs?: Vector4;
  106046. }): VertexData;
  106047. /**
  106048. * Creates the VertexData for a Polyhedron
  106049. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  106050. * * type provided types are:
  106051. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  106052. * * 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)
  106053. * * size the size of the IcoSphere, optional default 1
  106054. * * sizeX allows stretching in the x direction, optional, default size
  106055. * * sizeY allows stretching in the y direction, optional, default size
  106056. * * sizeZ allows stretching in the z direction, optional, default size
  106057. * * 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
  106058. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  106059. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  106060. * * flat when true creates a flat shaded mesh, optional, default true
  106061. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  106062. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106063. * * 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)
  106064. * * 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)
  106065. * @returns the VertexData of the Polyhedron
  106066. */
  106067. static CreatePolyhedron(options: {
  106068. type?: number;
  106069. size?: number;
  106070. sizeX?: number;
  106071. sizeY?: number;
  106072. sizeZ?: number;
  106073. custom?: any;
  106074. faceUV?: Vector4[];
  106075. faceColors?: Color4[];
  106076. flat?: boolean;
  106077. sideOrientation?: number;
  106078. frontUVs?: Vector4;
  106079. backUVs?: Vector4;
  106080. }): VertexData;
  106081. /**
  106082. * Creates the VertexData for a TorusKnot
  106083. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  106084. * * radius the radius of the torus knot, optional, default 2
  106085. * * tube the thickness of the tube, optional, default 0.5
  106086. * * radialSegments the number of sides on each tube segments, optional, default 32
  106087. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  106088. * * p the number of windings around the z axis, optional, default 2
  106089. * * q the number of windings around the x axis, optional, default 3
  106090. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106091. * * 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)
  106092. * * 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)
  106093. * @returns the VertexData of the Torus Knot
  106094. */
  106095. static CreateTorusKnot(options: {
  106096. radius?: number;
  106097. tube?: number;
  106098. radialSegments?: number;
  106099. tubularSegments?: number;
  106100. p?: number;
  106101. q?: number;
  106102. sideOrientation?: number;
  106103. frontUVs?: Vector4;
  106104. backUVs?: Vector4;
  106105. }): VertexData;
  106106. /**
  106107. * Compute normals for given positions and indices
  106108. * @param positions an array of vertex positions, [...., x, y, z, ......]
  106109. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  106110. * @param normals an array of vertex normals, [...., x, y, z, ......]
  106111. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  106112. * * facetNormals : optional array of facet normals (vector3)
  106113. * * facetPositions : optional array of facet positions (vector3)
  106114. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  106115. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  106116. * * bInfo : optional bounding info, required for facetPartitioning computation
  106117. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  106118. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  106119. * * useRightHandedSystem: optional boolean to for right handed system computation
  106120. * * depthSort : optional boolean to enable the facet depth sort computation
  106121. * * distanceTo : optional Vector3 to compute the facet depth from this location
  106122. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  106123. */
  106124. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  106125. facetNormals?: any;
  106126. facetPositions?: any;
  106127. facetPartitioning?: any;
  106128. ratio?: number;
  106129. bInfo?: any;
  106130. bbSize?: Vector3;
  106131. subDiv?: any;
  106132. useRightHandedSystem?: boolean;
  106133. depthSort?: boolean;
  106134. distanceTo?: Vector3;
  106135. depthSortedFacets?: any;
  106136. }): void;
  106137. /** @hidden */
  106138. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  106139. /**
  106140. * Applies VertexData created from the imported parameters to the geometry
  106141. * @param parsedVertexData the parsed data from an imported file
  106142. * @param geometry the geometry to apply the VertexData to
  106143. */
  106144. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  106145. }
  106146. }
  106147. declare module BABYLON {
  106148. /**
  106149. * Defines a target to use with MorphTargetManager
  106150. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  106151. */
  106152. export class MorphTarget implements IAnimatable {
  106153. /** defines the name of the target */
  106154. name: string;
  106155. /**
  106156. * Gets or sets the list of animations
  106157. */
  106158. animations: Animation[];
  106159. private _scene;
  106160. private _positions;
  106161. private _normals;
  106162. private _tangents;
  106163. private _uvs;
  106164. private _influence;
  106165. private _uniqueId;
  106166. /**
  106167. * Observable raised when the influence changes
  106168. */
  106169. onInfluenceChanged: Observable<boolean>;
  106170. /** @hidden */
  106171. _onDataLayoutChanged: Observable<void>;
  106172. /**
  106173. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  106174. */
  106175. get influence(): number;
  106176. set influence(influence: number);
  106177. /**
  106178. * Gets or sets the id of the morph Target
  106179. */
  106180. id: string;
  106181. private _animationPropertiesOverride;
  106182. /**
  106183. * Gets or sets the animation properties override
  106184. */
  106185. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  106186. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  106187. /**
  106188. * Creates a new MorphTarget
  106189. * @param name defines the name of the target
  106190. * @param influence defines the influence to use
  106191. * @param scene defines the scene the morphtarget belongs to
  106192. */
  106193. constructor(
  106194. /** defines the name of the target */
  106195. name: string, influence?: number, scene?: Nullable<Scene>);
  106196. /**
  106197. * Gets the unique ID of this manager
  106198. */
  106199. get uniqueId(): number;
  106200. /**
  106201. * Gets a boolean defining if the target contains position data
  106202. */
  106203. get hasPositions(): boolean;
  106204. /**
  106205. * Gets a boolean defining if the target contains normal data
  106206. */
  106207. get hasNormals(): boolean;
  106208. /**
  106209. * Gets a boolean defining if the target contains tangent data
  106210. */
  106211. get hasTangents(): boolean;
  106212. /**
  106213. * Gets a boolean defining if the target contains texture coordinates data
  106214. */
  106215. get hasUVs(): boolean;
  106216. /**
  106217. * Affects position data to this target
  106218. * @param data defines the position data to use
  106219. */
  106220. setPositions(data: Nullable<FloatArray>): void;
  106221. /**
  106222. * Gets the position data stored in this target
  106223. * @returns a FloatArray containing the position data (or null if not present)
  106224. */
  106225. getPositions(): Nullable<FloatArray>;
  106226. /**
  106227. * Affects normal data to this target
  106228. * @param data defines the normal data to use
  106229. */
  106230. setNormals(data: Nullable<FloatArray>): void;
  106231. /**
  106232. * Gets the normal data stored in this target
  106233. * @returns a FloatArray containing the normal data (or null if not present)
  106234. */
  106235. getNormals(): Nullable<FloatArray>;
  106236. /**
  106237. * Affects tangent data to this target
  106238. * @param data defines the tangent data to use
  106239. */
  106240. setTangents(data: Nullable<FloatArray>): void;
  106241. /**
  106242. * Gets the tangent data stored in this target
  106243. * @returns a FloatArray containing the tangent data (or null if not present)
  106244. */
  106245. getTangents(): Nullable<FloatArray>;
  106246. /**
  106247. * Affects texture coordinates data to this target
  106248. * @param data defines the texture coordinates data to use
  106249. */
  106250. setUVs(data: Nullable<FloatArray>): void;
  106251. /**
  106252. * Gets the texture coordinates data stored in this target
  106253. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  106254. */
  106255. getUVs(): Nullable<FloatArray>;
  106256. /**
  106257. * Clone the current target
  106258. * @returns a new MorphTarget
  106259. */
  106260. clone(): MorphTarget;
  106261. /**
  106262. * Serializes the current target into a Serialization object
  106263. * @returns the serialized object
  106264. */
  106265. serialize(): any;
  106266. /**
  106267. * Returns the string "MorphTarget"
  106268. * @returns "MorphTarget"
  106269. */
  106270. getClassName(): string;
  106271. /**
  106272. * Creates a new target from serialized data
  106273. * @param serializationObject defines the serialized data to use
  106274. * @returns a new MorphTarget
  106275. */
  106276. static Parse(serializationObject: any): MorphTarget;
  106277. /**
  106278. * Creates a MorphTarget from mesh data
  106279. * @param mesh defines the source mesh
  106280. * @param name defines the name to use for the new target
  106281. * @param influence defines the influence to attach to the target
  106282. * @returns a new MorphTarget
  106283. */
  106284. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  106285. }
  106286. }
  106287. declare module BABYLON {
  106288. /**
  106289. * This class is used to deform meshes using morphing between different targets
  106290. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  106291. */
  106292. export class MorphTargetManager {
  106293. private _targets;
  106294. private _targetInfluenceChangedObservers;
  106295. private _targetDataLayoutChangedObservers;
  106296. private _activeTargets;
  106297. private _scene;
  106298. private _influences;
  106299. private _supportsNormals;
  106300. private _supportsTangents;
  106301. private _supportsUVs;
  106302. private _vertexCount;
  106303. private _uniqueId;
  106304. private _tempInfluences;
  106305. /**
  106306. * Gets or sets a boolean indicating if normals must be morphed
  106307. */
  106308. enableNormalMorphing: boolean;
  106309. /**
  106310. * Gets or sets a boolean indicating if tangents must be morphed
  106311. */
  106312. enableTangentMorphing: boolean;
  106313. /**
  106314. * Gets or sets a boolean indicating if UV must be morphed
  106315. */
  106316. enableUVMorphing: boolean;
  106317. /**
  106318. * Creates a new MorphTargetManager
  106319. * @param scene defines the current scene
  106320. */
  106321. constructor(scene?: Nullable<Scene>);
  106322. /**
  106323. * Gets the unique ID of this manager
  106324. */
  106325. get uniqueId(): number;
  106326. /**
  106327. * Gets the number of vertices handled by this manager
  106328. */
  106329. get vertexCount(): number;
  106330. /**
  106331. * Gets a boolean indicating if this manager supports morphing of normals
  106332. */
  106333. get supportsNormals(): boolean;
  106334. /**
  106335. * Gets a boolean indicating if this manager supports morphing of tangents
  106336. */
  106337. get supportsTangents(): boolean;
  106338. /**
  106339. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  106340. */
  106341. get supportsUVs(): boolean;
  106342. /**
  106343. * Gets the number of targets stored in this manager
  106344. */
  106345. get numTargets(): number;
  106346. /**
  106347. * Gets the number of influencers (ie. the number of targets with influences > 0)
  106348. */
  106349. get numInfluencers(): number;
  106350. /**
  106351. * Gets the list of influences (one per target)
  106352. */
  106353. get influences(): Float32Array;
  106354. /**
  106355. * Gets the active target at specified index. An active target is a target with an influence > 0
  106356. * @param index defines the index to check
  106357. * @returns the requested target
  106358. */
  106359. getActiveTarget(index: number): MorphTarget;
  106360. /**
  106361. * Gets the target at specified index
  106362. * @param index defines the index to check
  106363. * @returns the requested target
  106364. */
  106365. getTarget(index: number): MorphTarget;
  106366. /**
  106367. * Add a new target to this manager
  106368. * @param target defines the target to add
  106369. */
  106370. addTarget(target: MorphTarget): void;
  106371. /**
  106372. * Removes a target from the manager
  106373. * @param target defines the target to remove
  106374. */
  106375. removeTarget(target: MorphTarget): void;
  106376. /**
  106377. * Clone the current manager
  106378. * @returns a new MorphTargetManager
  106379. */
  106380. clone(): MorphTargetManager;
  106381. /**
  106382. * Serializes the current manager into a Serialization object
  106383. * @returns the serialized object
  106384. */
  106385. serialize(): any;
  106386. private _syncActiveTargets;
  106387. /**
  106388. * Syncrhonize the targets with all the meshes using this morph target manager
  106389. */
  106390. synchronize(): void;
  106391. /**
  106392. * Creates a new MorphTargetManager from serialized data
  106393. * @param serializationObject defines the serialized data
  106394. * @param scene defines the hosting scene
  106395. * @returns the new MorphTargetManager
  106396. */
  106397. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  106398. }
  106399. }
  106400. declare module BABYLON {
  106401. /**
  106402. * Class used to represent a specific level of detail of a mesh
  106403. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  106404. */
  106405. export class MeshLODLevel {
  106406. /** Defines the distance where this level should start being displayed */
  106407. distance: number;
  106408. /** Defines the mesh to use to render this level */
  106409. mesh: Nullable<Mesh>;
  106410. /**
  106411. * Creates a new LOD level
  106412. * @param distance defines the distance where this level should star being displayed
  106413. * @param mesh defines the mesh to use to render this level
  106414. */
  106415. constructor(
  106416. /** Defines the distance where this level should start being displayed */
  106417. distance: number,
  106418. /** Defines the mesh to use to render this level */
  106419. mesh: Nullable<Mesh>);
  106420. }
  106421. }
  106422. declare module BABYLON {
  106423. /**
  106424. * Helper class used to generate a canvas to manipulate images
  106425. */
  106426. export class CanvasGenerator {
  106427. /**
  106428. * Create a new canvas (or offscreen canvas depending on the context)
  106429. * @param width defines the expected width
  106430. * @param height defines the expected height
  106431. * @return a new canvas or offscreen canvas
  106432. */
  106433. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  106434. }
  106435. }
  106436. declare module BABYLON {
  106437. /**
  106438. * Mesh representing the gorund
  106439. */
  106440. export class GroundMesh extends Mesh {
  106441. /** If octree should be generated */
  106442. generateOctree: boolean;
  106443. private _heightQuads;
  106444. /** @hidden */
  106445. _subdivisionsX: number;
  106446. /** @hidden */
  106447. _subdivisionsY: number;
  106448. /** @hidden */
  106449. _width: number;
  106450. /** @hidden */
  106451. _height: number;
  106452. /** @hidden */
  106453. _minX: number;
  106454. /** @hidden */
  106455. _maxX: number;
  106456. /** @hidden */
  106457. _minZ: number;
  106458. /** @hidden */
  106459. _maxZ: number;
  106460. constructor(name: string, scene: Scene);
  106461. /**
  106462. * "GroundMesh"
  106463. * @returns "GroundMesh"
  106464. */
  106465. getClassName(): string;
  106466. /**
  106467. * The minimum of x and y subdivisions
  106468. */
  106469. get subdivisions(): number;
  106470. /**
  106471. * X subdivisions
  106472. */
  106473. get subdivisionsX(): number;
  106474. /**
  106475. * Y subdivisions
  106476. */
  106477. get subdivisionsY(): number;
  106478. /**
  106479. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  106480. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  106481. * @param chunksCount the number of subdivisions for x and y
  106482. * @param octreeBlocksSize (Default: 32)
  106483. */
  106484. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  106485. /**
  106486. * Returns a height (y) value in the Worl system :
  106487. * the ground altitude at the coordinates (x, z) expressed in the World system.
  106488. * @param x x coordinate
  106489. * @param z z coordinate
  106490. * @returns the ground y position if (x, z) are outside the ground surface.
  106491. */
  106492. getHeightAtCoordinates(x: number, z: number): number;
  106493. /**
  106494. * Returns a normalized vector (Vector3) orthogonal to the ground
  106495. * at the ground coordinates (x, z) expressed in the World system.
  106496. * @param x x coordinate
  106497. * @param z z coordinate
  106498. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  106499. */
  106500. getNormalAtCoordinates(x: number, z: number): Vector3;
  106501. /**
  106502. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  106503. * at the ground coordinates (x, z) expressed in the World system.
  106504. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  106505. * @param x x coordinate
  106506. * @param z z coordinate
  106507. * @param ref vector to store the result
  106508. * @returns the GroundMesh.
  106509. */
  106510. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  106511. /**
  106512. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  106513. * if the ground has been updated.
  106514. * This can be used in the render loop.
  106515. * @returns the GroundMesh.
  106516. */
  106517. updateCoordinateHeights(): GroundMesh;
  106518. private _getFacetAt;
  106519. private _initHeightQuads;
  106520. private _computeHeightQuads;
  106521. /**
  106522. * Serializes this ground mesh
  106523. * @param serializationObject object to write serialization to
  106524. */
  106525. serialize(serializationObject: any): void;
  106526. /**
  106527. * Parses a serialized ground mesh
  106528. * @param parsedMesh the serialized mesh
  106529. * @param scene the scene to create the ground mesh in
  106530. * @returns the created ground mesh
  106531. */
  106532. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  106533. }
  106534. }
  106535. declare module BABYLON {
  106536. /**
  106537. * Interface for Physics-Joint data
  106538. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106539. */
  106540. export interface PhysicsJointData {
  106541. /**
  106542. * The main pivot of the joint
  106543. */
  106544. mainPivot?: Vector3;
  106545. /**
  106546. * The connected pivot of the joint
  106547. */
  106548. connectedPivot?: Vector3;
  106549. /**
  106550. * The main axis of the joint
  106551. */
  106552. mainAxis?: Vector3;
  106553. /**
  106554. * The connected axis of the joint
  106555. */
  106556. connectedAxis?: Vector3;
  106557. /**
  106558. * The collision of the joint
  106559. */
  106560. collision?: boolean;
  106561. /**
  106562. * Native Oimo/Cannon/Energy data
  106563. */
  106564. nativeParams?: any;
  106565. }
  106566. /**
  106567. * This is a holder class for the physics joint created by the physics plugin
  106568. * It holds a set of functions to control the underlying joint
  106569. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106570. */
  106571. export class PhysicsJoint {
  106572. /**
  106573. * The type of the physics joint
  106574. */
  106575. type: number;
  106576. /**
  106577. * The data for the physics joint
  106578. */
  106579. jointData: PhysicsJointData;
  106580. private _physicsJoint;
  106581. protected _physicsPlugin: IPhysicsEnginePlugin;
  106582. /**
  106583. * Initializes the physics joint
  106584. * @param type The type of the physics joint
  106585. * @param jointData The data for the physics joint
  106586. */
  106587. constructor(
  106588. /**
  106589. * The type of the physics joint
  106590. */
  106591. type: number,
  106592. /**
  106593. * The data for the physics joint
  106594. */
  106595. jointData: PhysicsJointData);
  106596. /**
  106597. * Gets the physics joint
  106598. */
  106599. get physicsJoint(): any;
  106600. /**
  106601. * Sets the physics joint
  106602. */
  106603. set physicsJoint(newJoint: any);
  106604. /**
  106605. * Sets the physics plugin
  106606. */
  106607. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  106608. /**
  106609. * Execute a function that is physics-plugin specific.
  106610. * @param {Function} func the function that will be executed.
  106611. * It accepts two parameters: the physics world and the physics joint
  106612. */
  106613. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  106614. /**
  106615. * Distance-Joint type
  106616. */
  106617. static DistanceJoint: number;
  106618. /**
  106619. * Hinge-Joint type
  106620. */
  106621. static HingeJoint: number;
  106622. /**
  106623. * Ball-and-Socket joint type
  106624. */
  106625. static BallAndSocketJoint: number;
  106626. /**
  106627. * Wheel-Joint type
  106628. */
  106629. static WheelJoint: number;
  106630. /**
  106631. * Slider-Joint type
  106632. */
  106633. static SliderJoint: number;
  106634. /**
  106635. * Prismatic-Joint type
  106636. */
  106637. static PrismaticJoint: number;
  106638. /**
  106639. * Universal-Joint type
  106640. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  106641. */
  106642. static UniversalJoint: number;
  106643. /**
  106644. * Hinge-Joint 2 type
  106645. */
  106646. static Hinge2Joint: number;
  106647. /**
  106648. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  106649. */
  106650. static PointToPointJoint: number;
  106651. /**
  106652. * Spring-Joint type
  106653. */
  106654. static SpringJoint: number;
  106655. /**
  106656. * Lock-Joint type
  106657. */
  106658. static LockJoint: number;
  106659. }
  106660. /**
  106661. * A class representing a physics distance joint
  106662. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106663. */
  106664. export class DistanceJoint extends PhysicsJoint {
  106665. /**
  106666. *
  106667. * @param jointData The data for the Distance-Joint
  106668. */
  106669. constructor(jointData: DistanceJointData);
  106670. /**
  106671. * Update the predefined distance.
  106672. * @param maxDistance The maximum preferred distance
  106673. * @param minDistance The minimum preferred distance
  106674. */
  106675. updateDistance(maxDistance: number, minDistance?: number): void;
  106676. }
  106677. /**
  106678. * Represents a Motor-Enabled Joint
  106679. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106680. */
  106681. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  106682. /**
  106683. * Initializes the Motor-Enabled Joint
  106684. * @param type The type of the joint
  106685. * @param jointData The physica joint data for the joint
  106686. */
  106687. constructor(type: number, jointData: PhysicsJointData);
  106688. /**
  106689. * Set the motor values.
  106690. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106691. * @param force the force to apply
  106692. * @param maxForce max force for this motor.
  106693. */
  106694. setMotor(force?: number, maxForce?: number): void;
  106695. /**
  106696. * Set the motor's limits.
  106697. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106698. * @param upperLimit The upper limit of the motor
  106699. * @param lowerLimit The lower limit of the motor
  106700. */
  106701. setLimit(upperLimit: number, lowerLimit?: number): void;
  106702. }
  106703. /**
  106704. * This class represents a single physics Hinge-Joint
  106705. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106706. */
  106707. export class HingeJoint extends MotorEnabledJoint {
  106708. /**
  106709. * Initializes the Hinge-Joint
  106710. * @param jointData The joint data for the Hinge-Joint
  106711. */
  106712. constructor(jointData: PhysicsJointData);
  106713. /**
  106714. * Set the motor values.
  106715. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106716. * @param {number} force the force to apply
  106717. * @param {number} maxForce max force for this motor.
  106718. */
  106719. setMotor(force?: number, maxForce?: number): void;
  106720. /**
  106721. * Set the motor's limits.
  106722. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106723. * @param upperLimit The upper limit of the motor
  106724. * @param lowerLimit The lower limit of the motor
  106725. */
  106726. setLimit(upperLimit: number, lowerLimit?: number): void;
  106727. }
  106728. /**
  106729. * This class represents a dual hinge physics joint (same as wheel joint)
  106730. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106731. */
  106732. export class Hinge2Joint extends MotorEnabledJoint {
  106733. /**
  106734. * Initializes the Hinge2-Joint
  106735. * @param jointData The joint data for the Hinge2-Joint
  106736. */
  106737. constructor(jointData: PhysicsJointData);
  106738. /**
  106739. * Set the motor values.
  106740. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106741. * @param {number} targetSpeed the speed the motor is to reach
  106742. * @param {number} maxForce max force for this motor.
  106743. * @param {motorIndex} the motor's index, 0 or 1.
  106744. */
  106745. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  106746. /**
  106747. * Set the motor limits.
  106748. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106749. * @param {number} upperLimit the upper limit
  106750. * @param {number} lowerLimit lower limit
  106751. * @param {motorIndex} the motor's index, 0 or 1.
  106752. */
  106753. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106754. }
  106755. /**
  106756. * Interface for a motor enabled joint
  106757. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106758. */
  106759. export interface IMotorEnabledJoint {
  106760. /**
  106761. * Physics joint
  106762. */
  106763. physicsJoint: any;
  106764. /**
  106765. * Sets the motor of the motor-enabled joint
  106766. * @param force The force of the motor
  106767. * @param maxForce The maximum force of the motor
  106768. * @param motorIndex The index of the motor
  106769. */
  106770. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  106771. /**
  106772. * Sets the limit of the motor
  106773. * @param upperLimit The upper limit of the motor
  106774. * @param lowerLimit The lower limit of the motor
  106775. * @param motorIndex The index of the motor
  106776. */
  106777. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106778. }
  106779. /**
  106780. * Joint data for a Distance-Joint
  106781. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106782. */
  106783. export interface DistanceJointData extends PhysicsJointData {
  106784. /**
  106785. * Max distance the 2 joint objects can be apart
  106786. */
  106787. maxDistance: number;
  106788. }
  106789. /**
  106790. * Joint data from a spring joint
  106791. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106792. */
  106793. export interface SpringJointData extends PhysicsJointData {
  106794. /**
  106795. * Length of the spring
  106796. */
  106797. length: number;
  106798. /**
  106799. * Stiffness of the spring
  106800. */
  106801. stiffness: number;
  106802. /**
  106803. * Damping of the spring
  106804. */
  106805. damping: number;
  106806. /** this callback will be called when applying the force to the impostors. */
  106807. forceApplicationCallback: () => void;
  106808. }
  106809. }
  106810. declare module BABYLON {
  106811. /**
  106812. * Holds the data for the raycast result
  106813. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106814. */
  106815. export class PhysicsRaycastResult {
  106816. private _hasHit;
  106817. private _hitDistance;
  106818. private _hitNormalWorld;
  106819. private _hitPointWorld;
  106820. private _rayFromWorld;
  106821. private _rayToWorld;
  106822. /**
  106823. * Gets if there was a hit
  106824. */
  106825. get hasHit(): boolean;
  106826. /**
  106827. * Gets the distance from the hit
  106828. */
  106829. get hitDistance(): number;
  106830. /**
  106831. * Gets the hit normal/direction in the world
  106832. */
  106833. get hitNormalWorld(): Vector3;
  106834. /**
  106835. * Gets the hit point in the world
  106836. */
  106837. get hitPointWorld(): Vector3;
  106838. /**
  106839. * Gets the ray "start point" of the ray in the world
  106840. */
  106841. get rayFromWorld(): Vector3;
  106842. /**
  106843. * Gets the ray "end point" of the ray in the world
  106844. */
  106845. get rayToWorld(): Vector3;
  106846. /**
  106847. * Sets the hit data (normal & point in world space)
  106848. * @param hitNormalWorld defines the normal in world space
  106849. * @param hitPointWorld defines the point in world space
  106850. */
  106851. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  106852. /**
  106853. * Sets the distance from the start point to the hit point
  106854. * @param distance
  106855. */
  106856. setHitDistance(distance: number): void;
  106857. /**
  106858. * Calculates the distance manually
  106859. */
  106860. calculateHitDistance(): void;
  106861. /**
  106862. * Resets all the values to default
  106863. * @param from The from point on world space
  106864. * @param to The to point on world space
  106865. */
  106866. reset(from?: Vector3, to?: Vector3): void;
  106867. }
  106868. /**
  106869. * Interface for the size containing width and height
  106870. */
  106871. interface IXYZ {
  106872. /**
  106873. * X
  106874. */
  106875. x: number;
  106876. /**
  106877. * Y
  106878. */
  106879. y: number;
  106880. /**
  106881. * Z
  106882. */
  106883. z: number;
  106884. }
  106885. }
  106886. declare module BABYLON {
  106887. /**
  106888. * Interface used to describe a physics joint
  106889. */
  106890. export interface PhysicsImpostorJoint {
  106891. /** Defines the main impostor to which the joint is linked */
  106892. mainImpostor: PhysicsImpostor;
  106893. /** Defines the impostor that is connected to the main impostor using this joint */
  106894. connectedImpostor: PhysicsImpostor;
  106895. /** Defines the joint itself */
  106896. joint: PhysicsJoint;
  106897. }
  106898. /** @hidden */
  106899. export interface IPhysicsEnginePlugin {
  106900. world: any;
  106901. name: string;
  106902. setGravity(gravity: Vector3): void;
  106903. setTimeStep(timeStep: number): void;
  106904. getTimeStep(): number;
  106905. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  106906. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  106907. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  106908. generatePhysicsBody(impostor: PhysicsImpostor): void;
  106909. removePhysicsBody(impostor: PhysicsImpostor): void;
  106910. generateJoint(joint: PhysicsImpostorJoint): void;
  106911. removeJoint(joint: PhysicsImpostorJoint): void;
  106912. isSupported(): boolean;
  106913. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  106914. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  106915. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  106916. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  106917. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  106918. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  106919. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  106920. getBodyMass(impostor: PhysicsImpostor): number;
  106921. getBodyFriction(impostor: PhysicsImpostor): number;
  106922. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  106923. getBodyRestitution(impostor: PhysicsImpostor): number;
  106924. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  106925. getBodyPressure?(impostor: PhysicsImpostor): number;
  106926. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  106927. getBodyStiffness?(impostor: PhysicsImpostor): number;
  106928. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  106929. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  106930. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  106931. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  106932. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  106933. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  106934. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  106935. sleepBody(impostor: PhysicsImpostor): void;
  106936. wakeUpBody(impostor: PhysicsImpostor): void;
  106937. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  106938. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  106939. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  106940. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106941. getRadius(impostor: PhysicsImpostor): number;
  106942. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  106943. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  106944. dispose(): void;
  106945. }
  106946. /**
  106947. * Interface used to define a physics engine
  106948. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106949. */
  106950. export interface IPhysicsEngine {
  106951. /**
  106952. * Gets the gravity vector used by the simulation
  106953. */
  106954. gravity: Vector3;
  106955. /**
  106956. * Sets the gravity vector used by the simulation
  106957. * @param gravity defines the gravity vector to use
  106958. */
  106959. setGravity(gravity: Vector3): void;
  106960. /**
  106961. * Set the time step of the physics engine.
  106962. * Default is 1/60.
  106963. * To slow it down, enter 1/600 for example.
  106964. * To speed it up, 1/30
  106965. * @param newTimeStep the new timestep to apply to this world.
  106966. */
  106967. setTimeStep(newTimeStep: number): void;
  106968. /**
  106969. * Get the time step of the physics engine.
  106970. * @returns the current time step
  106971. */
  106972. getTimeStep(): number;
  106973. /**
  106974. * Set the sub time step of the physics engine.
  106975. * Default is 0 meaning there is no sub steps
  106976. * To increase physics resolution precision, set a small value (like 1 ms)
  106977. * @param subTimeStep defines the new sub timestep used for physics resolution.
  106978. */
  106979. setSubTimeStep(subTimeStep: number): void;
  106980. /**
  106981. * Get the sub time step of the physics engine.
  106982. * @returns the current sub time step
  106983. */
  106984. getSubTimeStep(): number;
  106985. /**
  106986. * Release all resources
  106987. */
  106988. dispose(): void;
  106989. /**
  106990. * Gets the name of the current physics plugin
  106991. * @returns the name of the plugin
  106992. */
  106993. getPhysicsPluginName(): string;
  106994. /**
  106995. * Adding a new impostor for the impostor tracking.
  106996. * This will be done by the impostor itself.
  106997. * @param impostor the impostor to add
  106998. */
  106999. addImpostor(impostor: PhysicsImpostor): void;
  107000. /**
  107001. * Remove an impostor from the engine.
  107002. * This impostor and its mesh will not longer be updated by the physics engine.
  107003. * @param impostor the impostor to remove
  107004. */
  107005. removeImpostor(impostor: PhysicsImpostor): void;
  107006. /**
  107007. * Add a joint to the physics engine
  107008. * @param mainImpostor defines the main impostor to which the joint is added.
  107009. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  107010. * @param joint defines the joint that will connect both impostors.
  107011. */
  107012. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  107013. /**
  107014. * Removes a joint from the simulation
  107015. * @param mainImpostor defines the impostor used with the joint
  107016. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  107017. * @param joint defines the joint to remove
  107018. */
  107019. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  107020. /**
  107021. * Gets the current plugin used to run the simulation
  107022. * @returns current plugin
  107023. */
  107024. getPhysicsPlugin(): IPhysicsEnginePlugin;
  107025. /**
  107026. * Gets the list of physic impostors
  107027. * @returns an array of PhysicsImpostor
  107028. */
  107029. getImpostors(): Array<PhysicsImpostor>;
  107030. /**
  107031. * Gets the impostor for a physics enabled object
  107032. * @param object defines the object impersonated by the impostor
  107033. * @returns the PhysicsImpostor or null if not found
  107034. */
  107035. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  107036. /**
  107037. * Gets the impostor for a physics body object
  107038. * @param body defines physics body used by the impostor
  107039. * @returns the PhysicsImpostor or null if not found
  107040. */
  107041. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  107042. /**
  107043. * Does a raycast in the physics world
  107044. * @param from when should the ray start?
  107045. * @param to when should the ray end?
  107046. * @returns PhysicsRaycastResult
  107047. */
  107048. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  107049. /**
  107050. * Called by the scene. No need to call it.
  107051. * @param delta defines the timespam between frames
  107052. */
  107053. _step(delta: number): void;
  107054. }
  107055. }
  107056. declare module BABYLON {
  107057. /**
  107058. * The interface for the physics imposter parameters
  107059. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107060. */
  107061. export interface PhysicsImpostorParameters {
  107062. /**
  107063. * The mass of the physics imposter
  107064. */
  107065. mass: number;
  107066. /**
  107067. * The friction of the physics imposter
  107068. */
  107069. friction?: number;
  107070. /**
  107071. * The coefficient of restitution of the physics imposter
  107072. */
  107073. restitution?: number;
  107074. /**
  107075. * The native options of the physics imposter
  107076. */
  107077. nativeOptions?: any;
  107078. /**
  107079. * Specifies if the parent should be ignored
  107080. */
  107081. ignoreParent?: boolean;
  107082. /**
  107083. * Specifies if bi-directional transformations should be disabled
  107084. */
  107085. disableBidirectionalTransformation?: boolean;
  107086. /**
  107087. * The pressure inside the physics imposter, soft object only
  107088. */
  107089. pressure?: number;
  107090. /**
  107091. * The stiffness the physics imposter, soft object only
  107092. */
  107093. stiffness?: number;
  107094. /**
  107095. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  107096. */
  107097. velocityIterations?: number;
  107098. /**
  107099. * The number of iterations used in maintaining consistent vertex positions, soft object only
  107100. */
  107101. positionIterations?: number;
  107102. /**
  107103. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  107104. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  107105. * Add to fix multiple points
  107106. */
  107107. fixedPoints?: number;
  107108. /**
  107109. * The collision margin around a soft object
  107110. */
  107111. margin?: number;
  107112. /**
  107113. * The collision margin around a soft object
  107114. */
  107115. damping?: number;
  107116. /**
  107117. * The path for a rope based on an extrusion
  107118. */
  107119. path?: any;
  107120. /**
  107121. * The shape of an extrusion used for a rope based on an extrusion
  107122. */
  107123. shape?: any;
  107124. }
  107125. /**
  107126. * Interface for a physics-enabled object
  107127. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107128. */
  107129. export interface IPhysicsEnabledObject {
  107130. /**
  107131. * The position of the physics-enabled object
  107132. */
  107133. position: Vector3;
  107134. /**
  107135. * The rotation of the physics-enabled object
  107136. */
  107137. rotationQuaternion: Nullable<Quaternion>;
  107138. /**
  107139. * The scale of the physics-enabled object
  107140. */
  107141. scaling: Vector3;
  107142. /**
  107143. * The rotation of the physics-enabled object
  107144. */
  107145. rotation?: Vector3;
  107146. /**
  107147. * The parent of the physics-enabled object
  107148. */
  107149. parent?: any;
  107150. /**
  107151. * The bounding info of the physics-enabled object
  107152. * @returns The bounding info of the physics-enabled object
  107153. */
  107154. getBoundingInfo(): BoundingInfo;
  107155. /**
  107156. * Computes the world matrix
  107157. * @param force Specifies if the world matrix should be computed by force
  107158. * @returns A world matrix
  107159. */
  107160. computeWorldMatrix(force: boolean): Matrix;
  107161. /**
  107162. * Gets the world matrix
  107163. * @returns A world matrix
  107164. */
  107165. getWorldMatrix?(): Matrix;
  107166. /**
  107167. * Gets the child meshes
  107168. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  107169. * @returns An array of abstract meshes
  107170. */
  107171. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  107172. /**
  107173. * Gets the vertex data
  107174. * @param kind The type of vertex data
  107175. * @returns A nullable array of numbers, or a float32 array
  107176. */
  107177. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  107178. /**
  107179. * Gets the indices from the mesh
  107180. * @returns A nullable array of index arrays
  107181. */
  107182. getIndices?(): Nullable<IndicesArray>;
  107183. /**
  107184. * Gets the scene from the mesh
  107185. * @returns the indices array or null
  107186. */
  107187. getScene?(): Scene;
  107188. /**
  107189. * Gets the absolute position from the mesh
  107190. * @returns the absolute position
  107191. */
  107192. getAbsolutePosition(): Vector3;
  107193. /**
  107194. * Gets the absolute pivot point from the mesh
  107195. * @returns the absolute pivot point
  107196. */
  107197. getAbsolutePivotPoint(): Vector3;
  107198. /**
  107199. * Rotates the mesh
  107200. * @param axis The axis of rotation
  107201. * @param amount The amount of rotation
  107202. * @param space The space of the rotation
  107203. * @returns The rotation transform node
  107204. */
  107205. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  107206. /**
  107207. * Translates the mesh
  107208. * @param axis The axis of translation
  107209. * @param distance The distance of translation
  107210. * @param space The space of the translation
  107211. * @returns The transform node
  107212. */
  107213. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  107214. /**
  107215. * Sets the absolute position of the mesh
  107216. * @param absolutePosition The absolute position of the mesh
  107217. * @returns The transform node
  107218. */
  107219. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  107220. /**
  107221. * Gets the class name of the mesh
  107222. * @returns The class name
  107223. */
  107224. getClassName(): string;
  107225. }
  107226. /**
  107227. * Represents a physics imposter
  107228. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107229. */
  107230. export class PhysicsImpostor {
  107231. /**
  107232. * The physics-enabled object used as the physics imposter
  107233. */
  107234. object: IPhysicsEnabledObject;
  107235. /**
  107236. * The type of the physics imposter
  107237. */
  107238. type: number;
  107239. private _options;
  107240. private _scene?;
  107241. /**
  107242. * The default object size of the imposter
  107243. */
  107244. static DEFAULT_OBJECT_SIZE: Vector3;
  107245. /**
  107246. * The identity quaternion of the imposter
  107247. */
  107248. static IDENTITY_QUATERNION: Quaternion;
  107249. /** @hidden */
  107250. _pluginData: any;
  107251. private _physicsEngine;
  107252. private _physicsBody;
  107253. private _bodyUpdateRequired;
  107254. private _onBeforePhysicsStepCallbacks;
  107255. private _onAfterPhysicsStepCallbacks;
  107256. /** @hidden */
  107257. _onPhysicsCollideCallbacks: Array<{
  107258. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  107259. otherImpostors: Array<PhysicsImpostor>;
  107260. }>;
  107261. private _deltaPosition;
  107262. private _deltaRotation;
  107263. private _deltaRotationConjugated;
  107264. /** @hidden */
  107265. _isFromLine: boolean;
  107266. private _parent;
  107267. private _isDisposed;
  107268. private static _tmpVecs;
  107269. private static _tmpQuat;
  107270. /**
  107271. * Specifies if the physics imposter is disposed
  107272. */
  107273. get isDisposed(): boolean;
  107274. /**
  107275. * Gets the mass of the physics imposter
  107276. */
  107277. get mass(): number;
  107278. set mass(value: number);
  107279. /**
  107280. * Gets the coefficient of friction
  107281. */
  107282. get friction(): number;
  107283. /**
  107284. * Sets the coefficient of friction
  107285. */
  107286. set friction(value: number);
  107287. /**
  107288. * Gets the coefficient of restitution
  107289. */
  107290. get restitution(): number;
  107291. /**
  107292. * Sets the coefficient of restitution
  107293. */
  107294. set restitution(value: number);
  107295. /**
  107296. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  107297. */
  107298. get pressure(): number;
  107299. /**
  107300. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  107301. */
  107302. set pressure(value: number);
  107303. /**
  107304. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  107305. */
  107306. get stiffness(): number;
  107307. /**
  107308. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  107309. */
  107310. set stiffness(value: number);
  107311. /**
  107312. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  107313. */
  107314. get velocityIterations(): number;
  107315. /**
  107316. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  107317. */
  107318. set velocityIterations(value: number);
  107319. /**
  107320. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  107321. */
  107322. get positionIterations(): number;
  107323. /**
  107324. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  107325. */
  107326. set positionIterations(value: number);
  107327. /**
  107328. * The unique id of the physics imposter
  107329. * set by the physics engine when adding this impostor to the array
  107330. */
  107331. uniqueId: number;
  107332. /**
  107333. * @hidden
  107334. */
  107335. soft: boolean;
  107336. /**
  107337. * @hidden
  107338. */
  107339. segments: number;
  107340. private _joints;
  107341. /**
  107342. * Initializes the physics imposter
  107343. * @param object The physics-enabled object used as the physics imposter
  107344. * @param type The type of the physics imposter
  107345. * @param _options The options for the physics imposter
  107346. * @param _scene The Babylon scene
  107347. */
  107348. constructor(
  107349. /**
  107350. * The physics-enabled object used as the physics imposter
  107351. */
  107352. object: IPhysicsEnabledObject,
  107353. /**
  107354. * The type of the physics imposter
  107355. */
  107356. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  107357. /**
  107358. * This function will completly initialize this impostor.
  107359. * It will create a new body - but only if this mesh has no parent.
  107360. * If it has, this impostor will not be used other than to define the impostor
  107361. * of the child mesh.
  107362. * @hidden
  107363. */
  107364. _init(): void;
  107365. private _getPhysicsParent;
  107366. /**
  107367. * Should a new body be generated.
  107368. * @returns boolean specifying if body initialization is required
  107369. */
  107370. isBodyInitRequired(): boolean;
  107371. /**
  107372. * Sets the updated scaling
  107373. * @param updated Specifies if the scaling is updated
  107374. */
  107375. setScalingUpdated(): void;
  107376. /**
  107377. * Force a regeneration of this or the parent's impostor's body.
  107378. * Use under cautious - This will remove all joints already implemented.
  107379. */
  107380. forceUpdate(): void;
  107381. /**
  107382. * Gets the body that holds this impostor. Either its own, or its parent.
  107383. */
  107384. get physicsBody(): any;
  107385. /**
  107386. * Get the parent of the physics imposter
  107387. * @returns Physics imposter or null
  107388. */
  107389. get parent(): Nullable<PhysicsImpostor>;
  107390. /**
  107391. * Sets the parent of the physics imposter
  107392. */
  107393. set parent(value: Nullable<PhysicsImpostor>);
  107394. /**
  107395. * Set the physics body. Used mainly by the physics engine/plugin
  107396. */
  107397. set physicsBody(physicsBody: any);
  107398. /**
  107399. * Resets the update flags
  107400. */
  107401. resetUpdateFlags(): void;
  107402. /**
  107403. * Gets the object extend size
  107404. * @returns the object extend size
  107405. */
  107406. getObjectExtendSize(): Vector3;
  107407. /**
  107408. * Gets the object center
  107409. * @returns The object center
  107410. */
  107411. getObjectCenter(): Vector3;
  107412. /**
  107413. * Get a specific parameter from the options parameters
  107414. * @param paramName The object parameter name
  107415. * @returns The object parameter
  107416. */
  107417. getParam(paramName: string): any;
  107418. /**
  107419. * Sets a specific parameter in the options given to the physics plugin
  107420. * @param paramName The parameter name
  107421. * @param value The value of the parameter
  107422. */
  107423. setParam(paramName: string, value: number): void;
  107424. /**
  107425. * Specifically change the body's mass option. Won't recreate the physics body object
  107426. * @param mass The mass of the physics imposter
  107427. */
  107428. setMass(mass: number): void;
  107429. /**
  107430. * Gets the linear velocity
  107431. * @returns linear velocity or null
  107432. */
  107433. getLinearVelocity(): Nullable<Vector3>;
  107434. /**
  107435. * Sets the linear velocity
  107436. * @param velocity linear velocity or null
  107437. */
  107438. setLinearVelocity(velocity: Nullable<Vector3>): void;
  107439. /**
  107440. * Gets the angular velocity
  107441. * @returns angular velocity or null
  107442. */
  107443. getAngularVelocity(): Nullable<Vector3>;
  107444. /**
  107445. * Sets the angular velocity
  107446. * @param velocity The velocity or null
  107447. */
  107448. setAngularVelocity(velocity: Nullable<Vector3>): void;
  107449. /**
  107450. * Execute a function with the physics plugin native code
  107451. * Provide a function the will have two variables - the world object and the physics body object
  107452. * @param func The function to execute with the physics plugin native code
  107453. */
  107454. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  107455. /**
  107456. * Register a function that will be executed before the physics world is stepping forward
  107457. * @param func The function to execute before the physics world is stepped forward
  107458. */
  107459. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107460. /**
  107461. * Unregister a function that will be executed before the physics world is stepping forward
  107462. * @param func The function to execute before the physics world is stepped forward
  107463. */
  107464. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107465. /**
  107466. * Register a function that will be executed after the physics step
  107467. * @param func The function to execute after physics step
  107468. */
  107469. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107470. /**
  107471. * Unregisters a function that will be executed after the physics step
  107472. * @param func The function to execute after physics step
  107473. */
  107474. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107475. /**
  107476. * register a function that will be executed when this impostor collides against a different body
  107477. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  107478. * @param func Callback that is executed on collision
  107479. */
  107480. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  107481. /**
  107482. * Unregisters the physics imposter on contact
  107483. * @param collideAgainst The physics object to collide against
  107484. * @param func Callback to execute on collision
  107485. */
  107486. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  107487. private _tmpQuat;
  107488. private _tmpQuat2;
  107489. /**
  107490. * Get the parent rotation
  107491. * @returns The parent rotation
  107492. */
  107493. getParentsRotation(): Quaternion;
  107494. /**
  107495. * this function is executed by the physics engine.
  107496. */
  107497. beforeStep: () => void;
  107498. /**
  107499. * this function is executed by the physics engine
  107500. */
  107501. afterStep: () => void;
  107502. /**
  107503. * Legacy collision detection event support
  107504. */
  107505. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  107506. /**
  107507. * event and body object due to cannon's event-based architecture.
  107508. */
  107509. onCollide: (e: {
  107510. body: any;
  107511. }) => void;
  107512. /**
  107513. * Apply a force
  107514. * @param force The force to apply
  107515. * @param contactPoint The contact point for the force
  107516. * @returns The physics imposter
  107517. */
  107518. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  107519. /**
  107520. * Apply an impulse
  107521. * @param force The impulse force
  107522. * @param contactPoint The contact point for the impulse force
  107523. * @returns The physics imposter
  107524. */
  107525. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  107526. /**
  107527. * A help function to create a joint
  107528. * @param otherImpostor A physics imposter used to create a joint
  107529. * @param jointType The type of joint
  107530. * @param jointData The data for the joint
  107531. * @returns The physics imposter
  107532. */
  107533. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  107534. /**
  107535. * Add a joint to this impostor with a different impostor
  107536. * @param otherImpostor A physics imposter used to add a joint
  107537. * @param joint The joint to add
  107538. * @returns The physics imposter
  107539. */
  107540. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  107541. /**
  107542. * Add an anchor to a cloth impostor
  107543. * @param otherImpostor rigid impostor to anchor to
  107544. * @param width ratio across width from 0 to 1
  107545. * @param height ratio up height from 0 to 1
  107546. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  107547. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  107548. * @returns impostor the soft imposter
  107549. */
  107550. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  107551. /**
  107552. * Add a hook to a rope impostor
  107553. * @param otherImpostor rigid impostor to anchor to
  107554. * @param length ratio across rope from 0 to 1
  107555. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  107556. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  107557. * @returns impostor the rope imposter
  107558. */
  107559. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  107560. /**
  107561. * Will keep this body still, in a sleep mode.
  107562. * @returns the physics imposter
  107563. */
  107564. sleep(): PhysicsImpostor;
  107565. /**
  107566. * Wake the body up.
  107567. * @returns The physics imposter
  107568. */
  107569. wakeUp(): PhysicsImpostor;
  107570. /**
  107571. * Clones the physics imposter
  107572. * @param newObject The physics imposter clones to this physics-enabled object
  107573. * @returns A nullable physics imposter
  107574. */
  107575. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  107576. /**
  107577. * Disposes the physics imposter
  107578. */
  107579. dispose(): void;
  107580. /**
  107581. * Sets the delta position
  107582. * @param position The delta position amount
  107583. */
  107584. setDeltaPosition(position: Vector3): void;
  107585. /**
  107586. * Sets the delta rotation
  107587. * @param rotation The delta rotation amount
  107588. */
  107589. setDeltaRotation(rotation: Quaternion): void;
  107590. /**
  107591. * Gets the box size of the physics imposter and stores the result in the input parameter
  107592. * @param result Stores the box size
  107593. * @returns The physics imposter
  107594. */
  107595. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  107596. /**
  107597. * Gets the radius of the physics imposter
  107598. * @returns Radius of the physics imposter
  107599. */
  107600. getRadius(): number;
  107601. /**
  107602. * Sync a bone with this impostor
  107603. * @param bone The bone to sync to the impostor.
  107604. * @param boneMesh The mesh that the bone is influencing.
  107605. * @param jointPivot The pivot of the joint / bone in local space.
  107606. * @param distToJoint Optional distance from the impostor to the joint.
  107607. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  107608. */
  107609. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  107610. /**
  107611. * Sync impostor to a bone
  107612. * @param bone The bone that the impostor will be synced to.
  107613. * @param boneMesh The mesh that the bone is influencing.
  107614. * @param jointPivot The pivot of the joint / bone in local space.
  107615. * @param distToJoint Optional distance from the impostor to the joint.
  107616. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  107617. * @param boneAxis Optional vector3 axis the bone is aligned with
  107618. */
  107619. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  107620. /**
  107621. * No-Imposter type
  107622. */
  107623. static NoImpostor: number;
  107624. /**
  107625. * Sphere-Imposter type
  107626. */
  107627. static SphereImpostor: number;
  107628. /**
  107629. * Box-Imposter type
  107630. */
  107631. static BoxImpostor: number;
  107632. /**
  107633. * Plane-Imposter type
  107634. */
  107635. static PlaneImpostor: number;
  107636. /**
  107637. * Mesh-imposter type
  107638. */
  107639. static MeshImpostor: number;
  107640. /**
  107641. * Capsule-Impostor type (Ammo.js plugin only)
  107642. */
  107643. static CapsuleImpostor: number;
  107644. /**
  107645. * Cylinder-Imposter type
  107646. */
  107647. static CylinderImpostor: number;
  107648. /**
  107649. * Particle-Imposter type
  107650. */
  107651. static ParticleImpostor: number;
  107652. /**
  107653. * Heightmap-Imposter type
  107654. */
  107655. static HeightmapImpostor: number;
  107656. /**
  107657. * ConvexHull-Impostor type (Ammo.js plugin only)
  107658. */
  107659. static ConvexHullImpostor: number;
  107660. /**
  107661. * Custom-Imposter type (Ammo.js plugin only)
  107662. */
  107663. static CustomImpostor: number;
  107664. /**
  107665. * Rope-Imposter type
  107666. */
  107667. static RopeImpostor: number;
  107668. /**
  107669. * Cloth-Imposter type
  107670. */
  107671. static ClothImpostor: number;
  107672. /**
  107673. * Softbody-Imposter type
  107674. */
  107675. static SoftbodyImpostor: number;
  107676. }
  107677. }
  107678. declare module BABYLON {
  107679. /**
  107680. * @hidden
  107681. **/
  107682. export class _CreationDataStorage {
  107683. closePath?: boolean;
  107684. closeArray?: boolean;
  107685. idx: number[];
  107686. dashSize: number;
  107687. gapSize: number;
  107688. path3D: Path3D;
  107689. pathArray: Vector3[][];
  107690. arc: number;
  107691. radius: number;
  107692. cap: number;
  107693. tessellation: number;
  107694. }
  107695. /**
  107696. * @hidden
  107697. **/
  107698. class _InstanceDataStorage {
  107699. visibleInstances: any;
  107700. batchCache: _InstancesBatch;
  107701. instancesBufferSize: number;
  107702. instancesBuffer: Nullable<Buffer>;
  107703. instancesData: Float32Array;
  107704. overridenInstanceCount: number;
  107705. isFrozen: boolean;
  107706. previousBatch: Nullable<_InstancesBatch>;
  107707. hardwareInstancedRendering: boolean;
  107708. sideOrientation: number;
  107709. manualUpdate: boolean;
  107710. }
  107711. /**
  107712. * @hidden
  107713. **/
  107714. export class _InstancesBatch {
  107715. mustReturn: boolean;
  107716. visibleInstances: Nullable<InstancedMesh[]>[];
  107717. renderSelf: boolean[];
  107718. hardwareInstancedRendering: boolean[];
  107719. }
  107720. /**
  107721. * @hidden
  107722. **/
  107723. class _ThinInstanceDataStorage {
  107724. instancesCount: number;
  107725. matrixBuffer: Nullable<Buffer>;
  107726. matrixBufferSize: number;
  107727. matrixData: Nullable<Float32Array>;
  107728. boundingVectors: Array<Vector3>;
  107729. worldMatrices: Nullable<Matrix[]>;
  107730. }
  107731. /**
  107732. * Class used to represent renderable models
  107733. */
  107734. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  107735. /**
  107736. * Mesh side orientation : usually the external or front surface
  107737. */
  107738. static readonly FRONTSIDE: number;
  107739. /**
  107740. * Mesh side orientation : usually the internal or back surface
  107741. */
  107742. static readonly BACKSIDE: number;
  107743. /**
  107744. * Mesh side orientation : both internal and external or front and back surfaces
  107745. */
  107746. static readonly DOUBLESIDE: number;
  107747. /**
  107748. * Mesh side orientation : by default, `FRONTSIDE`
  107749. */
  107750. static readonly DEFAULTSIDE: number;
  107751. /**
  107752. * Mesh cap setting : no cap
  107753. */
  107754. static readonly NO_CAP: number;
  107755. /**
  107756. * Mesh cap setting : one cap at the beginning of the mesh
  107757. */
  107758. static readonly CAP_START: number;
  107759. /**
  107760. * Mesh cap setting : one cap at the end of the mesh
  107761. */
  107762. static readonly CAP_END: number;
  107763. /**
  107764. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  107765. */
  107766. static readonly CAP_ALL: number;
  107767. /**
  107768. * Mesh pattern setting : no flip or rotate
  107769. */
  107770. static readonly NO_FLIP: number;
  107771. /**
  107772. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  107773. */
  107774. static readonly FLIP_TILE: number;
  107775. /**
  107776. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  107777. */
  107778. static readonly ROTATE_TILE: number;
  107779. /**
  107780. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  107781. */
  107782. static readonly FLIP_ROW: number;
  107783. /**
  107784. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  107785. */
  107786. static readonly ROTATE_ROW: number;
  107787. /**
  107788. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  107789. */
  107790. static readonly FLIP_N_ROTATE_TILE: number;
  107791. /**
  107792. * Mesh pattern setting : rotate pattern and rotate
  107793. */
  107794. static readonly FLIP_N_ROTATE_ROW: number;
  107795. /**
  107796. * Mesh tile positioning : part tiles same on left/right or top/bottom
  107797. */
  107798. static readonly CENTER: number;
  107799. /**
  107800. * Mesh tile positioning : part tiles on left
  107801. */
  107802. static readonly LEFT: number;
  107803. /**
  107804. * Mesh tile positioning : part tiles on right
  107805. */
  107806. static readonly RIGHT: number;
  107807. /**
  107808. * Mesh tile positioning : part tiles on top
  107809. */
  107810. static readonly TOP: number;
  107811. /**
  107812. * Mesh tile positioning : part tiles on bottom
  107813. */
  107814. static readonly BOTTOM: number;
  107815. /**
  107816. * Gets the default side orientation.
  107817. * @param orientation the orientation to value to attempt to get
  107818. * @returns the default orientation
  107819. * @hidden
  107820. */
  107821. static _GetDefaultSideOrientation(orientation?: number): number;
  107822. private _internalMeshDataInfo;
  107823. get computeBonesUsingShaders(): boolean;
  107824. set computeBonesUsingShaders(value: boolean);
  107825. /**
  107826. * An event triggered before rendering the mesh
  107827. */
  107828. get onBeforeRenderObservable(): Observable<Mesh>;
  107829. /**
  107830. * An event triggered before binding the mesh
  107831. */
  107832. get onBeforeBindObservable(): Observable<Mesh>;
  107833. /**
  107834. * An event triggered after rendering the mesh
  107835. */
  107836. get onAfterRenderObservable(): Observable<Mesh>;
  107837. /**
  107838. * An event triggered before drawing the mesh
  107839. */
  107840. get onBeforeDrawObservable(): Observable<Mesh>;
  107841. private _onBeforeDrawObserver;
  107842. /**
  107843. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  107844. */
  107845. set onBeforeDraw(callback: () => void);
  107846. get hasInstances(): boolean;
  107847. get hasThinInstances(): boolean;
  107848. /**
  107849. * Gets the delay loading state of the mesh (when delay loading is turned on)
  107850. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  107851. */
  107852. delayLoadState: number;
  107853. /**
  107854. * Gets the list of instances created from this mesh
  107855. * it is not supposed to be modified manually.
  107856. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  107857. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  107858. */
  107859. instances: InstancedMesh[];
  107860. /**
  107861. * Gets the file containing delay loading data for this mesh
  107862. */
  107863. delayLoadingFile: string;
  107864. /** @hidden */
  107865. _binaryInfo: any;
  107866. /**
  107867. * User defined function used to change how LOD level selection is done
  107868. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107869. */
  107870. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  107871. /**
  107872. * Gets or sets the morph target manager
  107873. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  107874. */
  107875. get morphTargetManager(): Nullable<MorphTargetManager>;
  107876. set morphTargetManager(value: Nullable<MorphTargetManager>);
  107877. /** @hidden */
  107878. _creationDataStorage: Nullable<_CreationDataStorage>;
  107879. /** @hidden */
  107880. _geometry: Nullable<Geometry>;
  107881. /** @hidden */
  107882. _delayInfo: Array<string>;
  107883. /** @hidden */
  107884. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  107885. /** @hidden */
  107886. _instanceDataStorage: _InstanceDataStorage;
  107887. /** @hidden */
  107888. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  107889. private _effectiveMaterial;
  107890. /** @hidden */
  107891. _shouldGenerateFlatShading: boolean;
  107892. /** @hidden */
  107893. _originalBuilderSideOrientation: number;
  107894. /**
  107895. * Use this property to change the original side orientation defined at construction time
  107896. */
  107897. overrideMaterialSideOrientation: Nullable<number>;
  107898. /**
  107899. * Gets the source mesh (the one used to clone this one from)
  107900. */
  107901. get source(): Nullable<Mesh>;
  107902. /**
  107903. * Gets or sets a boolean indicating that this mesh does not use index buffer
  107904. */
  107905. get isUnIndexed(): boolean;
  107906. set isUnIndexed(value: boolean);
  107907. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  107908. get worldMatrixInstancedBuffer(): Float32Array;
  107909. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  107910. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  107911. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  107912. /**
  107913. * @constructor
  107914. * @param name The value used by scene.getMeshByName() to do a lookup.
  107915. * @param scene The scene to add this mesh to.
  107916. * @param parent The parent of this mesh, if it has one
  107917. * @param source An optional Mesh from which geometry is shared, cloned.
  107918. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  107919. * When false, achieved by calling a clone(), also passing False.
  107920. * This will make creation of children, recursive.
  107921. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  107922. */
  107923. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  107924. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  107925. doNotInstantiate: boolean;
  107926. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  107927. /**
  107928. * Gets the class name
  107929. * @returns the string "Mesh".
  107930. */
  107931. getClassName(): string;
  107932. /** @hidden */
  107933. get _isMesh(): boolean;
  107934. /**
  107935. * Returns a description of this mesh
  107936. * @param fullDetails define if full details about this mesh must be used
  107937. * @returns a descriptive string representing this mesh
  107938. */
  107939. toString(fullDetails?: boolean): string;
  107940. /** @hidden */
  107941. _unBindEffect(): void;
  107942. /**
  107943. * Gets a boolean indicating if this mesh has LOD
  107944. */
  107945. get hasLODLevels(): boolean;
  107946. /**
  107947. * Gets the list of MeshLODLevel associated with the current mesh
  107948. * @returns an array of MeshLODLevel
  107949. */
  107950. getLODLevels(): MeshLODLevel[];
  107951. private _sortLODLevels;
  107952. /**
  107953. * Add a mesh as LOD level triggered at the given distance.
  107954. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107955. * @param distance The distance from the center of the object to show this level
  107956. * @param mesh The mesh to be added as LOD level (can be null)
  107957. * @return This mesh (for chaining)
  107958. */
  107959. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  107960. /**
  107961. * Returns the LOD level mesh at the passed distance or null if not found.
  107962. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107963. * @param distance The distance from the center of the object to show this level
  107964. * @returns a Mesh or `null`
  107965. */
  107966. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  107967. /**
  107968. * Remove a mesh from the LOD array
  107969. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107970. * @param mesh defines the mesh to be removed
  107971. * @return This mesh (for chaining)
  107972. */
  107973. removeLODLevel(mesh: Mesh): Mesh;
  107974. /**
  107975. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  107976. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107977. * @param camera defines the camera to use to compute distance
  107978. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  107979. * @return This mesh (for chaining)
  107980. */
  107981. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  107982. /**
  107983. * Gets the mesh internal Geometry object
  107984. */
  107985. get geometry(): Nullable<Geometry>;
  107986. /**
  107987. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  107988. * @returns the total number of vertices
  107989. */
  107990. getTotalVertices(): number;
  107991. /**
  107992. * Returns the content of an associated vertex buffer
  107993. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  107994. * - VertexBuffer.PositionKind
  107995. * - VertexBuffer.UVKind
  107996. * - VertexBuffer.UV2Kind
  107997. * - VertexBuffer.UV3Kind
  107998. * - VertexBuffer.UV4Kind
  107999. * - VertexBuffer.UV5Kind
  108000. * - VertexBuffer.UV6Kind
  108001. * - VertexBuffer.ColorKind
  108002. * - VertexBuffer.MatricesIndicesKind
  108003. * - VertexBuffer.MatricesIndicesExtraKind
  108004. * - VertexBuffer.MatricesWeightsKind
  108005. * - VertexBuffer.MatricesWeightsExtraKind
  108006. * @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
  108007. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  108008. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  108009. */
  108010. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  108011. /**
  108012. * Returns the mesh VertexBuffer object from the requested `kind`
  108013. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108014. * - VertexBuffer.PositionKind
  108015. * - VertexBuffer.NormalKind
  108016. * - VertexBuffer.UVKind
  108017. * - VertexBuffer.UV2Kind
  108018. * - VertexBuffer.UV3Kind
  108019. * - VertexBuffer.UV4Kind
  108020. * - VertexBuffer.UV5Kind
  108021. * - VertexBuffer.UV6Kind
  108022. * - VertexBuffer.ColorKind
  108023. * - VertexBuffer.MatricesIndicesKind
  108024. * - VertexBuffer.MatricesIndicesExtraKind
  108025. * - VertexBuffer.MatricesWeightsKind
  108026. * - VertexBuffer.MatricesWeightsExtraKind
  108027. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  108028. */
  108029. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  108030. /**
  108031. * Tests if a specific vertex buffer is associated with this mesh
  108032. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  108033. * - VertexBuffer.PositionKind
  108034. * - VertexBuffer.NormalKind
  108035. * - VertexBuffer.UVKind
  108036. * - VertexBuffer.UV2Kind
  108037. * - VertexBuffer.UV3Kind
  108038. * - VertexBuffer.UV4Kind
  108039. * - VertexBuffer.UV5Kind
  108040. * - VertexBuffer.UV6Kind
  108041. * - VertexBuffer.ColorKind
  108042. * - VertexBuffer.MatricesIndicesKind
  108043. * - VertexBuffer.MatricesIndicesExtraKind
  108044. * - VertexBuffer.MatricesWeightsKind
  108045. * - VertexBuffer.MatricesWeightsExtraKind
  108046. * @returns a boolean
  108047. */
  108048. isVerticesDataPresent(kind: string): boolean;
  108049. /**
  108050. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  108051. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  108052. * - VertexBuffer.PositionKind
  108053. * - VertexBuffer.UVKind
  108054. * - VertexBuffer.UV2Kind
  108055. * - VertexBuffer.UV3Kind
  108056. * - VertexBuffer.UV4Kind
  108057. * - VertexBuffer.UV5Kind
  108058. * - VertexBuffer.UV6Kind
  108059. * - VertexBuffer.ColorKind
  108060. * - VertexBuffer.MatricesIndicesKind
  108061. * - VertexBuffer.MatricesIndicesExtraKind
  108062. * - VertexBuffer.MatricesWeightsKind
  108063. * - VertexBuffer.MatricesWeightsExtraKind
  108064. * @returns a boolean
  108065. */
  108066. isVertexBufferUpdatable(kind: string): boolean;
  108067. /**
  108068. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  108069. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108070. * - VertexBuffer.PositionKind
  108071. * - VertexBuffer.NormalKind
  108072. * - VertexBuffer.UVKind
  108073. * - VertexBuffer.UV2Kind
  108074. * - VertexBuffer.UV3Kind
  108075. * - VertexBuffer.UV4Kind
  108076. * - VertexBuffer.UV5Kind
  108077. * - VertexBuffer.UV6Kind
  108078. * - VertexBuffer.ColorKind
  108079. * - VertexBuffer.MatricesIndicesKind
  108080. * - VertexBuffer.MatricesIndicesExtraKind
  108081. * - VertexBuffer.MatricesWeightsKind
  108082. * - VertexBuffer.MatricesWeightsExtraKind
  108083. * @returns an array of strings
  108084. */
  108085. getVerticesDataKinds(): string[];
  108086. /**
  108087. * Returns a positive integer : the total number of indices in this mesh geometry.
  108088. * @returns the numner of indices or zero if the mesh has no geometry.
  108089. */
  108090. getTotalIndices(): number;
  108091. /**
  108092. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  108093. * @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.
  108094. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  108095. * @returns the indices array or an empty array if the mesh has no geometry
  108096. */
  108097. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  108098. get isBlocked(): boolean;
  108099. /**
  108100. * Determine if the current mesh is ready to be rendered
  108101. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  108102. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  108103. * @returns true if all associated assets are ready (material, textures, shaders)
  108104. */
  108105. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  108106. /**
  108107. * 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.
  108108. */
  108109. get areNormalsFrozen(): boolean;
  108110. /**
  108111. * 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.
  108112. * @returns the current mesh
  108113. */
  108114. freezeNormals(): Mesh;
  108115. /**
  108116. * 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
  108117. * @returns the current mesh
  108118. */
  108119. unfreezeNormals(): Mesh;
  108120. /**
  108121. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  108122. */
  108123. set overridenInstanceCount(count: number);
  108124. /** @hidden */
  108125. _preActivate(): Mesh;
  108126. /** @hidden */
  108127. _preActivateForIntermediateRendering(renderId: number): Mesh;
  108128. /** @hidden */
  108129. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  108130. protected _afterComputeWorldMatrix(): void;
  108131. /** @hidden */
  108132. _postActivate(): void;
  108133. /**
  108134. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  108135. * This means the mesh underlying bounding box and sphere are recomputed.
  108136. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  108137. * @returns the current mesh
  108138. */
  108139. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  108140. /** @hidden */
  108141. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  108142. /**
  108143. * This function will subdivide the mesh into multiple submeshes
  108144. * @param count defines the expected number of submeshes
  108145. */
  108146. subdivide(count: number): void;
  108147. /**
  108148. * Copy a FloatArray into a specific associated vertex buffer
  108149. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  108150. * - VertexBuffer.PositionKind
  108151. * - VertexBuffer.UVKind
  108152. * - VertexBuffer.UV2Kind
  108153. * - VertexBuffer.UV3Kind
  108154. * - VertexBuffer.UV4Kind
  108155. * - VertexBuffer.UV5Kind
  108156. * - VertexBuffer.UV6Kind
  108157. * - VertexBuffer.ColorKind
  108158. * - VertexBuffer.MatricesIndicesKind
  108159. * - VertexBuffer.MatricesIndicesExtraKind
  108160. * - VertexBuffer.MatricesWeightsKind
  108161. * - VertexBuffer.MatricesWeightsExtraKind
  108162. * @param data defines the data source
  108163. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  108164. * @param stride defines the data stride size (can be null)
  108165. * @returns the current mesh
  108166. */
  108167. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  108168. /**
  108169. * Delete a vertex buffer associated with this mesh
  108170. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  108171. * - VertexBuffer.PositionKind
  108172. * - VertexBuffer.UVKind
  108173. * - VertexBuffer.UV2Kind
  108174. * - VertexBuffer.UV3Kind
  108175. * - VertexBuffer.UV4Kind
  108176. * - VertexBuffer.UV5Kind
  108177. * - VertexBuffer.UV6Kind
  108178. * - VertexBuffer.ColorKind
  108179. * - VertexBuffer.MatricesIndicesKind
  108180. * - VertexBuffer.MatricesIndicesExtraKind
  108181. * - VertexBuffer.MatricesWeightsKind
  108182. * - VertexBuffer.MatricesWeightsExtraKind
  108183. */
  108184. removeVerticesData(kind: string): void;
  108185. /**
  108186. * Flags an associated vertex buffer as updatable
  108187. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  108188. * - VertexBuffer.PositionKind
  108189. * - VertexBuffer.UVKind
  108190. * - VertexBuffer.UV2Kind
  108191. * - VertexBuffer.UV3Kind
  108192. * - VertexBuffer.UV4Kind
  108193. * - VertexBuffer.UV5Kind
  108194. * - VertexBuffer.UV6Kind
  108195. * - VertexBuffer.ColorKind
  108196. * - VertexBuffer.MatricesIndicesKind
  108197. * - VertexBuffer.MatricesIndicesExtraKind
  108198. * - VertexBuffer.MatricesWeightsKind
  108199. * - VertexBuffer.MatricesWeightsExtraKind
  108200. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  108201. */
  108202. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  108203. /**
  108204. * Sets the mesh global Vertex Buffer
  108205. * @param buffer defines the buffer to use
  108206. * @returns the current mesh
  108207. */
  108208. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  108209. /**
  108210. * Update a specific associated vertex buffer
  108211. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  108212. * - VertexBuffer.PositionKind
  108213. * - VertexBuffer.UVKind
  108214. * - VertexBuffer.UV2Kind
  108215. * - VertexBuffer.UV3Kind
  108216. * - VertexBuffer.UV4Kind
  108217. * - VertexBuffer.UV5Kind
  108218. * - VertexBuffer.UV6Kind
  108219. * - VertexBuffer.ColorKind
  108220. * - VertexBuffer.MatricesIndicesKind
  108221. * - VertexBuffer.MatricesIndicesExtraKind
  108222. * - VertexBuffer.MatricesWeightsKind
  108223. * - VertexBuffer.MatricesWeightsExtraKind
  108224. * @param data defines the data source
  108225. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  108226. * @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)
  108227. * @returns the current mesh
  108228. */
  108229. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  108230. /**
  108231. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  108232. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  108233. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  108234. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  108235. * @returns the current mesh
  108236. */
  108237. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  108238. /**
  108239. * Creates a un-shared specific occurence of the geometry for the mesh.
  108240. * @returns the current mesh
  108241. */
  108242. makeGeometryUnique(): Mesh;
  108243. /**
  108244. * Set the index buffer of this mesh
  108245. * @param indices defines the source data
  108246. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  108247. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  108248. * @returns the current mesh
  108249. */
  108250. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  108251. /**
  108252. * Update the current index buffer
  108253. * @param indices defines the source data
  108254. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  108255. * @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)
  108256. * @returns the current mesh
  108257. */
  108258. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  108259. /**
  108260. * Invert the geometry to move from a right handed system to a left handed one.
  108261. * @returns the current mesh
  108262. */
  108263. toLeftHanded(): Mesh;
  108264. /** @hidden */
  108265. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  108266. /** @hidden */
  108267. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  108268. /**
  108269. * Registers for this mesh a javascript function called just before the rendering process
  108270. * @param func defines the function to call before rendering this mesh
  108271. * @returns the current mesh
  108272. */
  108273. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  108274. /**
  108275. * Disposes a previously registered javascript function called before the rendering
  108276. * @param func defines the function to remove
  108277. * @returns the current mesh
  108278. */
  108279. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  108280. /**
  108281. * Registers for this mesh a javascript function called just after the rendering is complete
  108282. * @param func defines the function to call after rendering this mesh
  108283. * @returns the current mesh
  108284. */
  108285. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  108286. /**
  108287. * Disposes a previously registered javascript function called after the rendering.
  108288. * @param func defines the function to remove
  108289. * @returns the current mesh
  108290. */
  108291. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  108292. /** @hidden */
  108293. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  108294. /** @hidden */
  108295. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  108296. /** @hidden */
  108297. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  108298. /** @hidden */
  108299. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  108300. /** @hidden */
  108301. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  108302. /** @hidden */
  108303. _rebuild(): void;
  108304. /** @hidden */
  108305. _freeze(): void;
  108306. /** @hidden */
  108307. _unFreeze(): void;
  108308. /**
  108309. * 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
  108310. * @param subMesh defines the subMesh to render
  108311. * @param enableAlphaMode defines if alpha mode can be changed
  108312. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  108313. * @returns the current mesh
  108314. */
  108315. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  108316. private _onBeforeDraw;
  108317. /**
  108318. * Renormalize the mesh and patch it up if there are no weights
  108319. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  108320. * However in the case of zero weights then we set just a single influence to 1.
  108321. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  108322. */
  108323. cleanMatrixWeights(): void;
  108324. private normalizeSkinFourWeights;
  108325. private normalizeSkinWeightsAndExtra;
  108326. /**
  108327. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  108328. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  108329. * the user know there was an issue with importing the mesh
  108330. * @returns a validation object with skinned, valid and report string
  108331. */
  108332. validateSkinning(): {
  108333. skinned: boolean;
  108334. valid: boolean;
  108335. report: string;
  108336. };
  108337. /** @hidden */
  108338. _checkDelayState(): Mesh;
  108339. private _queueLoad;
  108340. /**
  108341. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  108342. * A mesh is in the frustum if its bounding box intersects the frustum
  108343. * @param frustumPlanes defines the frustum to test
  108344. * @returns true if the mesh is in the frustum planes
  108345. */
  108346. isInFrustum(frustumPlanes: Plane[]): boolean;
  108347. /**
  108348. * Sets the mesh material by the material or multiMaterial `id` property
  108349. * @param id is a string identifying the material or the multiMaterial
  108350. * @returns the current mesh
  108351. */
  108352. setMaterialByID(id: string): Mesh;
  108353. /**
  108354. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  108355. * @returns an array of IAnimatable
  108356. */
  108357. getAnimatables(): IAnimatable[];
  108358. /**
  108359. * Modifies the mesh geometry according to the passed transformation matrix.
  108360. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  108361. * The mesh normals are modified using the same transformation.
  108362. * Note that, under the hood, this method sets a new VertexBuffer each call.
  108363. * @param transform defines the transform matrix to use
  108364. * @see https://doc.babylonjs.com/resources/baking_transformations
  108365. * @returns the current mesh
  108366. */
  108367. bakeTransformIntoVertices(transform: Matrix): Mesh;
  108368. /**
  108369. * Modifies the mesh geometry according to its own current World Matrix.
  108370. * The mesh World Matrix is then reset.
  108371. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  108372. * Note that, under the hood, this method sets a new VertexBuffer each call.
  108373. * @see https://doc.babylonjs.com/resources/baking_transformations
  108374. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  108375. * @returns the current mesh
  108376. */
  108377. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  108378. /** @hidden */
  108379. get _positions(): Nullable<Vector3[]>;
  108380. /** @hidden */
  108381. _resetPointsArrayCache(): Mesh;
  108382. /** @hidden */
  108383. _generatePointsArray(): boolean;
  108384. /**
  108385. * Returns a new Mesh object generated from the current mesh properties.
  108386. * This method must not get confused with createInstance()
  108387. * @param name is a string, the name given to the new mesh
  108388. * @param newParent can be any Node object (default `null`)
  108389. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  108390. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  108391. * @returns a new mesh
  108392. */
  108393. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  108394. /**
  108395. * Releases resources associated with this mesh.
  108396. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  108397. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  108398. */
  108399. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  108400. /** @hidden */
  108401. _disposeInstanceSpecificData(): void;
  108402. /** @hidden */
  108403. _disposeThinInstanceSpecificData(): void;
  108404. /**
  108405. * Modifies the mesh geometry according to a displacement map.
  108406. * 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.
  108407. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  108408. * @param url is a string, the URL from the image file is to be downloaded.
  108409. * @param minHeight is the lower limit of the displacement.
  108410. * @param maxHeight is the upper limit of the displacement.
  108411. * @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.
  108412. * @param uvOffset is an optional vector2 used to offset UV.
  108413. * @param uvScale is an optional vector2 used to scale UV.
  108414. * @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.
  108415. * @returns the Mesh.
  108416. */
  108417. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  108418. /**
  108419. * Modifies the mesh geometry according to a displacementMap buffer.
  108420. * 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.
  108421. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  108422. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  108423. * @param heightMapWidth is the width of the buffer image.
  108424. * @param heightMapHeight is the height of the buffer image.
  108425. * @param minHeight is the lower limit of the displacement.
  108426. * @param maxHeight is the upper limit of the displacement.
  108427. * @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.
  108428. * @param uvOffset is an optional vector2 used to offset UV.
  108429. * @param uvScale is an optional vector2 used to scale UV.
  108430. * @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.
  108431. * @returns the Mesh.
  108432. */
  108433. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  108434. /**
  108435. * Modify the mesh to get a flat shading rendering.
  108436. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  108437. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  108438. * @returns current mesh
  108439. */
  108440. convertToFlatShadedMesh(): Mesh;
  108441. /**
  108442. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  108443. * In other words, more vertices, no more indices and a single bigger VBO.
  108444. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  108445. * @returns current mesh
  108446. */
  108447. convertToUnIndexedMesh(): Mesh;
  108448. /**
  108449. * Inverses facet orientations.
  108450. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108451. * @param flipNormals will also inverts the normals
  108452. * @returns current mesh
  108453. */
  108454. flipFaces(flipNormals?: boolean): Mesh;
  108455. /**
  108456. * Increase the number of facets and hence vertices in a mesh
  108457. * Vertex normals are interpolated from existing vertex normals
  108458. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108459. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  108460. */
  108461. increaseVertices(numberPerEdge: number): void;
  108462. /**
  108463. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  108464. * This will undo any application of covertToFlatShadedMesh
  108465. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108466. */
  108467. forceSharedVertices(): void;
  108468. /** @hidden */
  108469. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  108470. /** @hidden */
  108471. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  108472. /**
  108473. * Creates a new InstancedMesh object from the mesh model.
  108474. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  108475. * @param name defines the name of the new instance
  108476. * @returns a new InstancedMesh
  108477. */
  108478. createInstance(name: string): InstancedMesh;
  108479. /**
  108480. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  108481. * After this call, all the mesh instances have the same submeshes than the current mesh.
  108482. * @returns the current mesh
  108483. */
  108484. synchronizeInstances(): Mesh;
  108485. /**
  108486. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  108487. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  108488. * This should be used together with the simplification to avoid disappearing triangles.
  108489. * @param successCallback an optional success callback to be called after the optimization finished.
  108490. * @returns the current mesh
  108491. */
  108492. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  108493. /**
  108494. * Serialize current mesh
  108495. * @param serializationObject defines the object which will receive the serialization data
  108496. */
  108497. serialize(serializationObject: any): void;
  108498. /** @hidden */
  108499. _syncGeometryWithMorphTargetManager(): void;
  108500. /** @hidden */
  108501. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  108502. /**
  108503. * Returns a new Mesh object parsed from the source provided.
  108504. * @param parsedMesh is the source
  108505. * @param scene defines the hosting scene
  108506. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  108507. * @returns a new Mesh
  108508. */
  108509. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  108510. /**
  108511. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  108512. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108513. * @param name defines the name of the mesh to create
  108514. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  108515. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  108516. * @param closePath creates a seam between the first and the last points of each path of the path array
  108517. * @param offset is taken in account only if the `pathArray` is containing a single path
  108518. * @param scene defines the hosting scene
  108519. * @param updatable defines if the mesh must be flagged as updatable
  108520. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108521. * @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)
  108522. * @returns a new Mesh
  108523. */
  108524. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108525. /**
  108526. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  108527. * @param name defines the name of the mesh to create
  108528. * @param radius sets the radius size (float) of the polygon (default 0.5)
  108529. * @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
  108530. * @param scene defines the hosting scene
  108531. * @param updatable defines if the mesh must be flagged as updatable
  108532. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108533. * @returns a new Mesh
  108534. */
  108535. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  108536. /**
  108537. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  108538. * @param name defines the name of the mesh to create
  108539. * @param size sets the size (float) of each box side (default 1)
  108540. * @param scene defines the hosting scene
  108541. * @param updatable defines if the mesh must be flagged as updatable
  108542. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108543. * @returns a new Mesh
  108544. */
  108545. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  108546. /**
  108547. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  108548. * @param name defines the name of the mesh to create
  108549. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  108550. * @param diameter sets the diameter size (float) of the sphere (default 1)
  108551. * @param scene defines the hosting scene
  108552. * @param updatable defines if the mesh must be flagged as updatable
  108553. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108554. * @returns a new Mesh
  108555. */
  108556. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108557. /**
  108558. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  108559. * @param name defines the name of the mesh to create
  108560. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  108561. * @param diameter sets the diameter size (float) of the sphere (default 1)
  108562. * @param scene defines the hosting scene
  108563. * @returns a new Mesh
  108564. */
  108565. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  108566. /**
  108567. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  108568. * @param name defines the name of the mesh to create
  108569. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  108570. * @param diameterTop set the top cap diameter (floats, default 1)
  108571. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  108572. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  108573. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  108574. * @param scene defines the hosting scene
  108575. * @param updatable defines if the mesh must be flagged as updatable
  108576. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108577. * @returns a new Mesh
  108578. */
  108579. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  108580. /**
  108581. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  108582. * @param name defines the name of the mesh to create
  108583. * @param diameter sets the diameter size (float) of the torus (default 1)
  108584. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  108585. * @param tessellation sets the number of torus sides (postive integer, default 16)
  108586. * @param scene defines the hosting scene
  108587. * @param updatable defines if the mesh must be flagged as updatable
  108588. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108589. * @returns a new Mesh
  108590. */
  108591. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108592. /**
  108593. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  108594. * @param name defines the name of the mesh to create
  108595. * @param radius sets the global radius size (float) of the torus knot (default 2)
  108596. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  108597. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  108598. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  108599. * @param p the number of windings on X axis (positive integers, default 2)
  108600. * @param q the number of windings on Y axis (positive integers, default 3)
  108601. * @param scene defines the hosting scene
  108602. * @param updatable defines if the mesh must be flagged as updatable
  108603. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108604. * @returns a new Mesh
  108605. */
  108606. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108607. /**
  108608. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  108609. * @param name defines the name of the mesh to create
  108610. * @param points is an array successive Vector3
  108611. * @param scene defines the hosting scene
  108612. * @param updatable defines if the mesh must be flagged as updatable
  108613. * @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).
  108614. * @returns a new Mesh
  108615. */
  108616. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  108617. /**
  108618. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  108619. * @param name defines the name of the mesh to create
  108620. * @param points is an array successive Vector3
  108621. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  108622. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  108623. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  108624. * @param scene defines the hosting scene
  108625. * @param updatable defines if the mesh must be flagged as updatable
  108626. * @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)
  108627. * @returns a new Mesh
  108628. */
  108629. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  108630. /**
  108631. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  108632. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  108633. * 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.
  108634. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108635. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  108636. * Remember you can only change the shape positions, not their number when updating a polygon.
  108637. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  108638. * @param name defines the name of the mesh to create
  108639. * @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
  108640. * @param scene defines the hosting scene
  108641. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  108642. * @param updatable defines if the mesh must be flagged as updatable
  108643. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108644. * @param earcutInjection can be used to inject your own earcut reference
  108645. * @returns a new Mesh
  108646. */
  108647. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  108648. /**
  108649. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  108650. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  108651. * @param name defines the name of the mesh to create
  108652. * @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
  108653. * @param depth defines the height of extrusion
  108654. * @param scene defines the hosting scene
  108655. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  108656. * @param updatable defines if the mesh must be flagged as updatable
  108657. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108658. * @param earcutInjection can be used to inject your own earcut reference
  108659. * @returns a new Mesh
  108660. */
  108661. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  108662. /**
  108663. * Creates an extruded shape mesh.
  108664. * 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
  108665. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108666. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  108667. * @param name defines the name of the mesh to create
  108668. * @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
  108669. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  108670. * @param scale is the value to scale the shape
  108671. * @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
  108672. * @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
  108673. * @param scene defines the hosting scene
  108674. * @param updatable defines if the mesh must be flagged as updatable
  108675. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108676. * @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)
  108677. * @returns a new Mesh
  108678. */
  108679. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108680. /**
  108681. * Creates an custom extruded shape mesh.
  108682. * The custom extrusion is a parametric shape.
  108683. * It has no predefined shape. Its final shape will depend on the input parameters.
  108684. * Please consider using the same method from the MeshBuilder class instead
  108685. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  108686. * @param name defines the name of the mesh to create
  108687. * @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
  108688. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  108689. * @param scaleFunction is a custom Javascript function called on each path point
  108690. * @param rotationFunction is a custom Javascript function called on each path point
  108691. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  108692. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  108693. * @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
  108694. * @param scene defines the hosting scene
  108695. * @param updatable defines if the mesh must be flagged as updatable
  108696. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108697. * @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)
  108698. * @returns a new Mesh
  108699. */
  108700. 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;
  108701. /**
  108702. * Creates lathe mesh.
  108703. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  108704. * Please consider using the same method from the MeshBuilder class instead
  108705. * @param name defines the name of the mesh to create
  108706. * @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
  108707. * @param radius is the radius value of the lathe
  108708. * @param tessellation is the side number of the lathe.
  108709. * @param scene defines the hosting scene
  108710. * @param updatable defines if the mesh must be flagged as updatable
  108711. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108712. * @returns a new Mesh
  108713. */
  108714. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108715. /**
  108716. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  108717. * @param name defines the name of the mesh to create
  108718. * @param size sets the size (float) of both sides of the plane at once (default 1)
  108719. * @param scene defines the hosting scene
  108720. * @param updatable defines if the mesh must be flagged as updatable
  108721. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108722. * @returns a new Mesh
  108723. */
  108724. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108725. /**
  108726. * Creates a ground mesh.
  108727. * Please consider using the same method from the MeshBuilder class instead
  108728. * @param name defines the name of the mesh to create
  108729. * @param width set the width of the ground
  108730. * @param height set the height of the ground
  108731. * @param subdivisions sets the number of subdivisions per side
  108732. * @param scene defines the hosting scene
  108733. * @param updatable defines if the mesh must be flagged as updatable
  108734. * @returns a new Mesh
  108735. */
  108736. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  108737. /**
  108738. * Creates a tiled ground mesh.
  108739. * Please consider using the same method from the MeshBuilder class instead
  108740. * @param name defines the name of the mesh to create
  108741. * @param xmin set the ground minimum X coordinate
  108742. * @param zmin set the ground minimum Y coordinate
  108743. * @param xmax set the ground maximum X coordinate
  108744. * @param zmax set the ground maximum Z coordinate
  108745. * @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
  108746. * @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
  108747. * @param scene defines the hosting scene
  108748. * @param updatable defines if the mesh must be flagged as updatable
  108749. * @returns a new Mesh
  108750. */
  108751. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  108752. w: number;
  108753. h: number;
  108754. }, precision: {
  108755. w: number;
  108756. h: number;
  108757. }, scene: Scene, updatable?: boolean): Mesh;
  108758. /**
  108759. * Creates a ground mesh from a height map.
  108760. * Please consider using the same method from the MeshBuilder class instead
  108761. * @see https://doc.babylonjs.com/babylon101/height_map
  108762. * @param name defines the name of the mesh to create
  108763. * @param url sets the URL of the height map image resource
  108764. * @param width set the ground width size
  108765. * @param height set the ground height size
  108766. * @param subdivisions sets the number of subdivision per side
  108767. * @param minHeight is the minimum altitude on the ground
  108768. * @param maxHeight is the maximum altitude on the ground
  108769. * @param scene defines the hosting scene
  108770. * @param updatable defines if the mesh must be flagged as updatable
  108771. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  108772. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  108773. * @returns a new Mesh
  108774. */
  108775. 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;
  108776. /**
  108777. * Creates a tube mesh.
  108778. * The tube is a parametric shape.
  108779. * It has no predefined shape. Its final shape will depend on the input parameters.
  108780. * Please consider using the same method from the MeshBuilder class instead
  108781. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108782. * @param name defines the name of the mesh to create
  108783. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  108784. * @param radius sets the tube radius size
  108785. * @param tessellation is the number of sides on the tubular surface
  108786. * @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
  108787. * @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
  108788. * @param scene defines the hosting scene
  108789. * @param updatable defines if the mesh must be flagged as updatable
  108790. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108791. * @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)
  108792. * @returns a new Mesh
  108793. */
  108794. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  108795. (i: number, distance: number): number;
  108796. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108797. /**
  108798. * Creates a polyhedron mesh.
  108799. * Please consider using the same method from the MeshBuilder class instead.
  108800. * * 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
  108801. * * The parameter `size` (positive float, default 1) sets the polygon size
  108802. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  108803. * * 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`
  108804. * * 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
  108805. * * 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)`)
  108806. * * 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
  108807. * * 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
  108808. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108809. * * 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
  108810. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108811. * @param name defines the name of the mesh to create
  108812. * @param options defines the options used to create the mesh
  108813. * @param scene defines the hosting scene
  108814. * @returns a new Mesh
  108815. */
  108816. static CreatePolyhedron(name: string, options: {
  108817. type?: number;
  108818. size?: number;
  108819. sizeX?: number;
  108820. sizeY?: number;
  108821. sizeZ?: number;
  108822. custom?: any;
  108823. faceUV?: Vector4[];
  108824. faceColors?: Color4[];
  108825. updatable?: boolean;
  108826. sideOrientation?: number;
  108827. }, scene: Scene): Mesh;
  108828. /**
  108829. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  108830. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  108831. * * 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`)
  108832. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  108833. * * 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
  108834. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108835. * * 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
  108836. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108837. * @param name defines the name of the mesh
  108838. * @param options defines the options used to create the mesh
  108839. * @param scene defines the hosting scene
  108840. * @returns a new Mesh
  108841. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  108842. */
  108843. static CreateIcoSphere(name: string, options: {
  108844. radius?: number;
  108845. flat?: boolean;
  108846. subdivisions?: number;
  108847. sideOrientation?: number;
  108848. updatable?: boolean;
  108849. }, scene: Scene): Mesh;
  108850. /**
  108851. * Creates a decal mesh.
  108852. * Please consider using the same method from the MeshBuilder class instead.
  108853. * A decal is a mesh usually applied as a model onto the surface of another mesh
  108854. * @param name defines the name of the mesh
  108855. * @param sourceMesh defines the mesh receiving the decal
  108856. * @param position sets the position of the decal in world coordinates
  108857. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  108858. * @param size sets the decal scaling
  108859. * @param angle sets the angle to rotate the decal
  108860. * @returns a new Mesh
  108861. */
  108862. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  108863. /**
  108864. * Prepare internal position array for software CPU skinning
  108865. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  108866. */
  108867. setPositionsForCPUSkinning(): Float32Array;
  108868. /**
  108869. * Prepare internal normal array for software CPU skinning
  108870. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  108871. */
  108872. setNormalsForCPUSkinning(): Float32Array;
  108873. /**
  108874. * Updates the vertex buffer by applying transformation from the bones
  108875. * @param skeleton defines the skeleton to apply to current mesh
  108876. * @returns the current mesh
  108877. */
  108878. applySkeleton(skeleton: Skeleton): Mesh;
  108879. /**
  108880. * 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
  108881. * @param meshes defines the list of meshes to scan
  108882. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  108883. */
  108884. static MinMax(meshes: AbstractMesh[]): {
  108885. min: Vector3;
  108886. max: Vector3;
  108887. };
  108888. /**
  108889. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  108890. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  108891. * @returns a vector3
  108892. */
  108893. static Center(meshesOrMinMaxVector: {
  108894. min: Vector3;
  108895. max: Vector3;
  108896. } | AbstractMesh[]): Vector3;
  108897. /**
  108898. * Merge the array of meshes into a single mesh for performance reasons.
  108899. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  108900. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  108901. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  108902. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  108903. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  108904. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  108905. * @returns a new mesh
  108906. */
  108907. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  108908. /** @hidden */
  108909. addInstance(instance: InstancedMesh): void;
  108910. /** @hidden */
  108911. removeInstance(instance: InstancedMesh): void;
  108912. }
  108913. }
  108914. declare module BABYLON {
  108915. /**
  108916. * This is the base class of all the camera used in the application.
  108917. * @see https://doc.babylonjs.com/features/cameras
  108918. */
  108919. export class Camera extends Node {
  108920. /** @hidden */
  108921. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  108922. /**
  108923. * This is the default projection mode used by the cameras.
  108924. * It helps recreating a feeling of perspective and better appreciate depth.
  108925. * This is the best way to simulate real life cameras.
  108926. */
  108927. static readonly PERSPECTIVE_CAMERA: number;
  108928. /**
  108929. * This helps creating camera with an orthographic mode.
  108930. * 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.
  108931. */
  108932. static readonly ORTHOGRAPHIC_CAMERA: number;
  108933. /**
  108934. * This is the default FOV mode for perspective cameras.
  108935. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  108936. */
  108937. static readonly FOVMODE_VERTICAL_FIXED: number;
  108938. /**
  108939. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  108940. */
  108941. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  108942. /**
  108943. * This specifies ther is no need for a camera rig.
  108944. * Basically only one eye is rendered corresponding to the camera.
  108945. */
  108946. static readonly RIG_MODE_NONE: number;
  108947. /**
  108948. * Simulates a camera Rig with one blue eye and one red eye.
  108949. * This can be use with 3d blue and red glasses.
  108950. */
  108951. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  108952. /**
  108953. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  108954. */
  108955. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  108956. /**
  108957. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  108958. */
  108959. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  108960. /**
  108961. * Defines that both eyes of the camera will be rendered over under each other.
  108962. */
  108963. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  108964. /**
  108965. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  108966. */
  108967. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  108968. /**
  108969. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  108970. */
  108971. static readonly RIG_MODE_VR: number;
  108972. /**
  108973. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  108974. */
  108975. static readonly RIG_MODE_WEBVR: number;
  108976. /**
  108977. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  108978. */
  108979. static readonly RIG_MODE_CUSTOM: number;
  108980. /**
  108981. * Defines if by default attaching controls should prevent the default javascript event to continue.
  108982. */
  108983. static ForceAttachControlToAlwaysPreventDefault: boolean;
  108984. /**
  108985. * Define the input manager associated with the camera.
  108986. */
  108987. inputs: CameraInputsManager<Camera>;
  108988. /** @hidden */
  108989. _position: Vector3;
  108990. /**
  108991. * Define the current local position of the camera in the scene
  108992. */
  108993. get position(): Vector3;
  108994. set position(newPosition: Vector3);
  108995. protected _upVector: Vector3;
  108996. /**
  108997. * The vector the camera should consider as up.
  108998. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  108999. */
  109000. set upVector(vec: Vector3);
  109001. get upVector(): Vector3;
  109002. /**
  109003. * Define the current limit on the left side for an orthographic camera
  109004. * In scene unit
  109005. */
  109006. orthoLeft: Nullable<number>;
  109007. /**
  109008. * Define the current limit on the right side for an orthographic camera
  109009. * In scene unit
  109010. */
  109011. orthoRight: Nullable<number>;
  109012. /**
  109013. * Define the current limit on the bottom side for an orthographic camera
  109014. * In scene unit
  109015. */
  109016. orthoBottom: Nullable<number>;
  109017. /**
  109018. * Define the current limit on the top side for an orthographic camera
  109019. * In scene unit
  109020. */
  109021. orthoTop: Nullable<number>;
  109022. /**
  109023. * Field Of View is set in Radians. (default is 0.8)
  109024. */
  109025. fov: number;
  109026. /**
  109027. * Define the minimum distance the camera can see from.
  109028. * This is important to note that the depth buffer are not infinite and the closer it starts
  109029. * the more your scene might encounter depth fighting issue.
  109030. */
  109031. minZ: number;
  109032. /**
  109033. * Define the maximum distance the camera can see to.
  109034. * This is important to note that the depth buffer are not infinite and the further it end
  109035. * the more your scene might encounter depth fighting issue.
  109036. */
  109037. maxZ: number;
  109038. /**
  109039. * Define the default inertia of the camera.
  109040. * This helps giving a smooth feeling to the camera movement.
  109041. */
  109042. inertia: number;
  109043. /**
  109044. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  109045. */
  109046. mode: number;
  109047. /**
  109048. * Define whether the camera is intermediate.
  109049. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  109050. */
  109051. isIntermediate: boolean;
  109052. /**
  109053. * Define the viewport of the camera.
  109054. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  109055. */
  109056. viewport: Viewport;
  109057. /**
  109058. * Restricts the camera to viewing objects with the same layerMask.
  109059. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  109060. */
  109061. layerMask: number;
  109062. /**
  109063. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  109064. */
  109065. fovMode: number;
  109066. /**
  109067. * Rig mode of the camera.
  109068. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  109069. * This is normally controlled byt the camera themselves as internal use.
  109070. */
  109071. cameraRigMode: number;
  109072. /**
  109073. * Defines the distance between both "eyes" in case of a RIG
  109074. */
  109075. interaxialDistance: number;
  109076. /**
  109077. * Defines if stereoscopic rendering is done side by side or over under.
  109078. */
  109079. isStereoscopicSideBySide: boolean;
  109080. /**
  109081. * 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
  109082. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  109083. * else in the scene. (Eg. security camera)
  109084. *
  109085. * 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)
  109086. */
  109087. customRenderTargets: RenderTargetTexture[];
  109088. /**
  109089. * When set, the camera will render to this render target instead of the default canvas
  109090. *
  109091. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  109092. */
  109093. outputRenderTarget: Nullable<RenderTargetTexture>;
  109094. /**
  109095. * Observable triggered when the camera view matrix has changed.
  109096. */
  109097. onViewMatrixChangedObservable: Observable<Camera>;
  109098. /**
  109099. * Observable triggered when the camera Projection matrix has changed.
  109100. */
  109101. onProjectionMatrixChangedObservable: Observable<Camera>;
  109102. /**
  109103. * Observable triggered when the inputs have been processed.
  109104. */
  109105. onAfterCheckInputsObservable: Observable<Camera>;
  109106. /**
  109107. * Observable triggered when reset has been called and applied to the camera.
  109108. */
  109109. onRestoreStateObservable: Observable<Camera>;
  109110. /**
  109111. * Is this camera a part of a rig system?
  109112. */
  109113. isRigCamera: boolean;
  109114. /**
  109115. * If isRigCamera set to true this will be set with the parent camera.
  109116. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  109117. */
  109118. rigParent?: Camera;
  109119. /** @hidden */
  109120. _cameraRigParams: any;
  109121. /** @hidden */
  109122. _rigCameras: Camera[];
  109123. /** @hidden */
  109124. _rigPostProcess: Nullable<PostProcess>;
  109125. protected _webvrViewMatrix: Matrix;
  109126. /** @hidden */
  109127. _skipRendering: boolean;
  109128. /** @hidden */
  109129. _projectionMatrix: Matrix;
  109130. /** @hidden */
  109131. _postProcesses: Nullable<PostProcess>[];
  109132. /** @hidden */
  109133. _activeMeshes: SmartArray<AbstractMesh>;
  109134. protected _globalPosition: Vector3;
  109135. /** @hidden */
  109136. _computedViewMatrix: Matrix;
  109137. private _doNotComputeProjectionMatrix;
  109138. private _transformMatrix;
  109139. private _frustumPlanes;
  109140. private _refreshFrustumPlanes;
  109141. private _storedFov;
  109142. private _stateStored;
  109143. /**
  109144. * Instantiates a new camera object.
  109145. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  109146. * @see https://doc.babylonjs.com/features/cameras
  109147. * @param name Defines the name of the camera in the scene
  109148. * @param position Defines the position of the camera
  109149. * @param scene Defines the scene the camera belongs too
  109150. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  109151. */
  109152. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  109153. /**
  109154. * Store current camera state (fov, position, etc..)
  109155. * @returns the camera
  109156. */
  109157. storeState(): Camera;
  109158. /**
  109159. * Restores the camera state values if it has been stored. You must call storeState() first
  109160. */
  109161. protected _restoreStateValues(): boolean;
  109162. /**
  109163. * Restored camera state. You must call storeState() first.
  109164. * @returns true if restored and false otherwise
  109165. */
  109166. restoreState(): boolean;
  109167. /**
  109168. * Gets the class name of the camera.
  109169. * @returns the class name
  109170. */
  109171. getClassName(): string;
  109172. /** @hidden */
  109173. readonly _isCamera: boolean;
  109174. /**
  109175. * Gets a string representation of the camera useful for debug purpose.
  109176. * @param fullDetails Defines that a more verboe level of logging is required
  109177. * @returns the string representation
  109178. */
  109179. toString(fullDetails?: boolean): string;
  109180. /**
  109181. * Gets the current world space position of the camera.
  109182. */
  109183. get globalPosition(): Vector3;
  109184. /**
  109185. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  109186. * @returns the active meshe list
  109187. */
  109188. getActiveMeshes(): SmartArray<AbstractMesh>;
  109189. /**
  109190. * Check whether a mesh is part of the current active mesh list of the camera
  109191. * @param mesh Defines the mesh to check
  109192. * @returns true if active, false otherwise
  109193. */
  109194. isActiveMesh(mesh: Mesh): boolean;
  109195. /**
  109196. * Is this camera ready to be used/rendered
  109197. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  109198. * @return true if the camera is ready
  109199. */
  109200. isReady(completeCheck?: boolean): boolean;
  109201. /** @hidden */
  109202. _initCache(): void;
  109203. /** @hidden */
  109204. _updateCache(ignoreParentClass?: boolean): void;
  109205. /** @hidden */
  109206. _isSynchronized(): boolean;
  109207. /** @hidden */
  109208. _isSynchronizedViewMatrix(): boolean;
  109209. /** @hidden */
  109210. _isSynchronizedProjectionMatrix(): boolean;
  109211. /**
  109212. * Attach the input controls to a specific dom element to get the input from.
  109213. * @param element Defines the element the controls should be listened from
  109214. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  109215. */
  109216. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  109217. /**
  109218. * Detach the current controls from the specified dom element.
  109219. * @param element Defines the element to stop listening the inputs from
  109220. */
  109221. detachControl(element: HTMLElement): void;
  109222. /**
  109223. * Update the camera state according to the different inputs gathered during the frame.
  109224. */
  109225. update(): void;
  109226. /** @hidden */
  109227. _checkInputs(): void;
  109228. /** @hidden */
  109229. get rigCameras(): Camera[];
  109230. /**
  109231. * Gets the post process used by the rig cameras
  109232. */
  109233. get rigPostProcess(): Nullable<PostProcess>;
  109234. /**
  109235. * Internal, gets the first post proces.
  109236. * @returns the first post process to be run on this camera.
  109237. */
  109238. _getFirstPostProcess(): Nullable<PostProcess>;
  109239. private _cascadePostProcessesToRigCams;
  109240. /**
  109241. * Attach a post process to the camera.
  109242. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  109243. * @param postProcess The post process to attach to the camera
  109244. * @param insertAt The position of the post process in case several of them are in use in the scene
  109245. * @returns the position the post process has been inserted at
  109246. */
  109247. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  109248. /**
  109249. * Detach a post process to the camera.
  109250. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  109251. * @param postProcess The post process to detach from the camera
  109252. */
  109253. detachPostProcess(postProcess: PostProcess): void;
  109254. /**
  109255. * Gets the current world matrix of the camera
  109256. */
  109257. getWorldMatrix(): Matrix;
  109258. /** @hidden */
  109259. _getViewMatrix(): Matrix;
  109260. /**
  109261. * Gets the current view matrix of the camera.
  109262. * @param force forces the camera to recompute the matrix without looking at the cached state
  109263. * @returns the view matrix
  109264. */
  109265. getViewMatrix(force?: boolean): Matrix;
  109266. /**
  109267. * Freeze the projection matrix.
  109268. * It will prevent the cache check of the camera projection compute and can speed up perf
  109269. * if no parameter of the camera are meant to change
  109270. * @param projection Defines manually a projection if necessary
  109271. */
  109272. freezeProjectionMatrix(projection?: Matrix): void;
  109273. /**
  109274. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  109275. */
  109276. unfreezeProjectionMatrix(): void;
  109277. /**
  109278. * Gets the current projection matrix of the camera.
  109279. * @param force forces the camera to recompute the matrix without looking at the cached state
  109280. * @returns the projection matrix
  109281. */
  109282. getProjectionMatrix(force?: boolean): Matrix;
  109283. /**
  109284. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  109285. * @returns a Matrix
  109286. */
  109287. getTransformationMatrix(): Matrix;
  109288. private _updateFrustumPlanes;
  109289. /**
  109290. * Checks if a cullable object (mesh...) is in the camera frustum
  109291. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  109292. * @param target The object to check
  109293. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  109294. * @returns true if the object is in frustum otherwise false
  109295. */
  109296. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  109297. /**
  109298. * Checks if a cullable object (mesh...) is in the camera frustum
  109299. * Unlike isInFrustum this cheks the full bounding box
  109300. * @param target The object to check
  109301. * @returns true if the object is in frustum otherwise false
  109302. */
  109303. isCompletelyInFrustum(target: ICullable): boolean;
  109304. /**
  109305. * Gets a ray in the forward direction from the camera.
  109306. * @param length Defines the length of the ray to create
  109307. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  109308. * @param origin Defines the start point of the ray which defaults to the camera position
  109309. * @returns the forward ray
  109310. */
  109311. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  109312. /**
  109313. * Gets a ray in the forward direction from the camera.
  109314. * @param refRay the ray to (re)use when setting the values
  109315. * @param length Defines the length of the ray to create
  109316. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  109317. * @param origin Defines the start point of the ray which defaults to the camera position
  109318. * @returns the forward ray
  109319. */
  109320. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  109321. /**
  109322. * Releases resources associated with this node.
  109323. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  109324. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  109325. */
  109326. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  109327. /** @hidden */
  109328. _isLeftCamera: boolean;
  109329. /**
  109330. * Gets the left camera of a rig setup in case of Rigged Camera
  109331. */
  109332. get isLeftCamera(): boolean;
  109333. /** @hidden */
  109334. _isRightCamera: boolean;
  109335. /**
  109336. * Gets the right camera of a rig setup in case of Rigged Camera
  109337. */
  109338. get isRightCamera(): boolean;
  109339. /**
  109340. * Gets the left camera of a rig setup in case of Rigged Camera
  109341. */
  109342. get leftCamera(): Nullable<FreeCamera>;
  109343. /**
  109344. * Gets the right camera of a rig setup in case of Rigged Camera
  109345. */
  109346. get rightCamera(): Nullable<FreeCamera>;
  109347. /**
  109348. * Gets the left camera target of a rig setup in case of Rigged Camera
  109349. * @returns the target position
  109350. */
  109351. getLeftTarget(): Nullable<Vector3>;
  109352. /**
  109353. * Gets the right camera target of a rig setup in case of Rigged Camera
  109354. * @returns the target position
  109355. */
  109356. getRightTarget(): Nullable<Vector3>;
  109357. /**
  109358. * @hidden
  109359. */
  109360. setCameraRigMode(mode: number, rigParams: any): void;
  109361. /** @hidden */
  109362. static _setStereoscopicRigMode(camera: Camera): void;
  109363. /** @hidden */
  109364. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  109365. /** @hidden */
  109366. static _setVRRigMode(camera: Camera, rigParams: any): void;
  109367. /** @hidden */
  109368. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  109369. /** @hidden */
  109370. _getVRProjectionMatrix(): Matrix;
  109371. protected _updateCameraRotationMatrix(): void;
  109372. protected _updateWebVRCameraRotationMatrix(): void;
  109373. /**
  109374. * This function MUST be overwritten by the different WebVR cameras available.
  109375. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  109376. * @hidden
  109377. */
  109378. _getWebVRProjectionMatrix(): Matrix;
  109379. /**
  109380. * This function MUST be overwritten by the different WebVR cameras available.
  109381. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  109382. * @hidden
  109383. */
  109384. _getWebVRViewMatrix(): Matrix;
  109385. /** @hidden */
  109386. setCameraRigParameter(name: string, value: any): void;
  109387. /**
  109388. * needs to be overridden by children so sub has required properties to be copied
  109389. * @hidden
  109390. */
  109391. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  109392. /**
  109393. * May need to be overridden by children
  109394. * @hidden
  109395. */
  109396. _updateRigCameras(): void;
  109397. /** @hidden */
  109398. _setupInputs(): void;
  109399. /**
  109400. * Serialiaze the camera setup to a json represention
  109401. * @returns the JSON representation
  109402. */
  109403. serialize(): any;
  109404. /**
  109405. * Clones the current camera.
  109406. * @param name The cloned camera name
  109407. * @returns the cloned camera
  109408. */
  109409. clone(name: string): Camera;
  109410. /**
  109411. * Gets the direction of the camera relative to a given local axis.
  109412. * @param localAxis Defines the reference axis to provide a relative direction.
  109413. * @return the direction
  109414. */
  109415. getDirection(localAxis: Vector3): Vector3;
  109416. /**
  109417. * Returns the current camera absolute rotation
  109418. */
  109419. get absoluteRotation(): Quaternion;
  109420. /**
  109421. * Gets the direction of the camera relative to a given local axis into a passed vector.
  109422. * @param localAxis Defines the reference axis to provide a relative direction.
  109423. * @param result Defines the vector to store the result in
  109424. */
  109425. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  109426. /**
  109427. * Gets a camera constructor for a given camera type
  109428. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  109429. * @param name The name of the camera the result will be able to instantiate
  109430. * @param scene The scene the result will construct the camera in
  109431. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  109432. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  109433. * @returns a factory method to construc the camera
  109434. */
  109435. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  109436. /**
  109437. * Compute the world matrix of the camera.
  109438. * @returns the camera world matrix
  109439. */
  109440. computeWorldMatrix(): Matrix;
  109441. /**
  109442. * Parse a JSON and creates the camera from the parsed information
  109443. * @param parsedCamera The JSON to parse
  109444. * @param scene The scene to instantiate the camera in
  109445. * @returns the newly constructed camera
  109446. */
  109447. static Parse(parsedCamera: any, scene: Scene): Camera;
  109448. }
  109449. }
  109450. declare module BABYLON {
  109451. /**
  109452. * Class containing static functions to help procedurally build meshes
  109453. */
  109454. export class DiscBuilder {
  109455. /**
  109456. * Creates a plane polygonal mesh. By default, this is a disc
  109457. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  109458. * * 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
  109459. * * 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
  109460. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  109461. * * 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
  109462. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  109463. * @param name defines the name of the mesh
  109464. * @param options defines the options used to create the mesh
  109465. * @param scene defines the hosting scene
  109466. * @returns the plane polygonal mesh
  109467. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  109468. */
  109469. static CreateDisc(name: string, options: {
  109470. radius?: number;
  109471. tessellation?: number;
  109472. arc?: number;
  109473. updatable?: boolean;
  109474. sideOrientation?: number;
  109475. frontUVs?: Vector4;
  109476. backUVs?: Vector4;
  109477. }, scene?: Nullable<Scene>): Mesh;
  109478. }
  109479. }
  109480. declare module BABYLON {
  109481. /**
  109482. * Options to be used when creating a FresnelParameters.
  109483. */
  109484. export type IFresnelParametersCreationOptions = {
  109485. /**
  109486. * Define the color used on edges (grazing angle)
  109487. */
  109488. leftColor?: Color3;
  109489. /**
  109490. * Define the color used on center
  109491. */
  109492. rightColor?: Color3;
  109493. /**
  109494. * Define bias applied to computed fresnel term
  109495. */
  109496. bias?: number;
  109497. /**
  109498. * Defined the power exponent applied to fresnel term
  109499. */
  109500. power?: number;
  109501. /**
  109502. * Define if the fresnel effect is enable or not.
  109503. */
  109504. isEnabled?: boolean;
  109505. };
  109506. /**
  109507. * Serialized format for FresnelParameters.
  109508. */
  109509. export type IFresnelParametersSerialized = {
  109510. /**
  109511. * Define the color used on edges (grazing angle) [as an array]
  109512. */
  109513. leftColor: number[];
  109514. /**
  109515. * Define the color used on center [as an array]
  109516. */
  109517. rightColor: number[];
  109518. /**
  109519. * Define bias applied to computed fresnel term
  109520. */
  109521. bias: number;
  109522. /**
  109523. * Defined the power exponent applied to fresnel term
  109524. */
  109525. power?: number;
  109526. /**
  109527. * Define if the fresnel effect is enable or not.
  109528. */
  109529. isEnabled: boolean;
  109530. };
  109531. /**
  109532. * This represents all the required information to add a fresnel effect on a material:
  109533. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109534. */
  109535. export class FresnelParameters {
  109536. private _isEnabled;
  109537. /**
  109538. * Define if the fresnel effect is enable or not.
  109539. */
  109540. get isEnabled(): boolean;
  109541. set isEnabled(value: boolean);
  109542. /**
  109543. * Define the color used on edges (grazing angle)
  109544. */
  109545. leftColor: Color3;
  109546. /**
  109547. * Define the color used on center
  109548. */
  109549. rightColor: Color3;
  109550. /**
  109551. * Define bias applied to computed fresnel term
  109552. */
  109553. bias: number;
  109554. /**
  109555. * Defined the power exponent applied to fresnel term
  109556. */
  109557. power: number;
  109558. /**
  109559. * Creates a new FresnelParameters object.
  109560. *
  109561. * @param options provide your own settings to optionally to override defaults
  109562. */
  109563. constructor(options?: IFresnelParametersCreationOptions);
  109564. /**
  109565. * Clones the current fresnel and its valuues
  109566. * @returns a clone fresnel configuration
  109567. */
  109568. clone(): FresnelParameters;
  109569. /**
  109570. * Determines equality between FresnelParameters objects
  109571. * @param otherFresnelParameters defines the second operand
  109572. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  109573. */
  109574. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  109575. /**
  109576. * Serializes the current fresnel parameters to a JSON representation.
  109577. * @return the JSON serialization
  109578. */
  109579. serialize(): IFresnelParametersSerialized;
  109580. /**
  109581. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  109582. * @param parsedFresnelParameters Define the JSON representation
  109583. * @returns the parsed parameters
  109584. */
  109585. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  109586. }
  109587. }
  109588. declare module BABYLON {
  109589. /**
  109590. * This groups all the flags used to control the materials channel.
  109591. */
  109592. export class MaterialFlags {
  109593. private static _DiffuseTextureEnabled;
  109594. /**
  109595. * Are diffuse textures enabled in the application.
  109596. */
  109597. static get DiffuseTextureEnabled(): boolean;
  109598. static set DiffuseTextureEnabled(value: boolean);
  109599. private static _DetailTextureEnabled;
  109600. /**
  109601. * Are detail textures enabled in the application.
  109602. */
  109603. static get DetailTextureEnabled(): boolean;
  109604. static set DetailTextureEnabled(value: boolean);
  109605. private static _AmbientTextureEnabled;
  109606. /**
  109607. * Are ambient textures enabled in the application.
  109608. */
  109609. static get AmbientTextureEnabled(): boolean;
  109610. static set AmbientTextureEnabled(value: boolean);
  109611. private static _OpacityTextureEnabled;
  109612. /**
  109613. * Are opacity textures enabled in the application.
  109614. */
  109615. static get OpacityTextureEnabled(): boolean;
  109616. static set OpacityTextureEnabled(value: boolean);
  109617. private static _ReflectionTextureEnabled;
  109618. /**
  109619. * Are reflection textures enabled in the application.
  109620. */
  109621. static get ReflectionTextureEnabled(): boolean;
  109622. static set ReflectionTextureEnabled(value: boolean);
  109623. private static _EmissiveTextureEnabled;
  109624. /**
  109625. * Are emissive textures enabled in the application.
  109626. */
  109627. static get EmissiveTextureEnabled(): boolean;
  109628. static set EmissiveTextureEnabled(value: boolean);
  109629. private static _SpecularTextureEnabled;
  109630. /**
  109631. * Are specular textures enabled in the application.
  109632. */
  109633. static get SpecularTextureEnabled(): boolean;
  109634. static set SpecularTextureEnabled(value: boolean);
  109635. private static _BumpTextureEnabled;
  109636. /**
  109637. * Are bump textures enabled in the application.
  109638. */
  109639. static get BumpTextureEnabled(): boolean;
  109640. static set BumpTextureEnabled(value: boolean);
  109641. private static _LightmapTextureEnabled;
  109642. /**
  109643. * Are lightmap textures enabled in the application.
  109644. */
  109645. static get LightmapTextureEnabled(): boolean;
  109646. static set LightmapTextureEnabled(value: boolean);
  109647. private static _RefractionTextureEnabled;
  109648. /**
  109649. * Are refraction textures enabled in the application.
  109650. */
  109651. static get RefractionTextureEnabled(): boolean;
  109652. static set RefractionTextureEnabled(value: boolean);
  109653. private static _ColorGradingTextureEnabled;
  109654. /**
  109655. * Are color grading textures enabled in the application.
  109656. */
  109657. static get ColorGradingTextureEnabled(): boolean;
  109658. static set ColorGradingTextureEnabled(value: boolean);
  109659. private static _FresnelEnabled;
  109660. /**
  109661. * Are fresnels enabled in the application.
  109662. */
  109663. static get FresnelEnabled(): boolean;
  109664. static set FresnelEnabled(value: boolean);
  109665. private static _ClearCoatTextureEnabled;
  109666. /**
  109667. * Are clear coat textures enabled in the application.
  109668. */
  109669. static get ClearCoatTextureEnabled(): boolean;
  109670. static set ClearCoatTextureEnabled(value: boolean);
  109671. private static _ClearCoatBumpTextureEnabled;
  109672. /**
  109673. * Are clear coat bump textures enabled in the application.
  109674. */
  109675. static get ClearCoatBumpTextureEnabled(): boolean;
  109676. static set ClearCoatBumpTextureEnabled(value: boolean);
  109677. private static _ClearCoatTintTextureEnabled;
  109678. /**
  109679. * Are clear coat tint textures enabled in the application.
  109680. */
  109681. static get ClearCoatTintTextureEnabled(): boolean;
  109682. static set ClearCoatTintTextureEnabled(value: boolean);
  109683. private static _SheenTextureEnabled;
  109684. /**
  109685. * Are sheen textures enabled in the application.
  109686. */
  109687. static get SheenTextureEnabled(): boolean;
  109688. static set SheenTextureEnabled(value: boolean);
  109689. private static _AnisotropicTextureEnabled;
  109690. /**
  109691. * Are anisotropic textures enabled in the application.
  109692. */
  109693. static get AnisotropicTextureEnabled(): boolean;
  109694. static set AnisotropicTextureEnabled(value: boolean);
  109695. private static _ThicknessTextureEnabled;
  109696. /**
  109697. * Are thickness textures enabled in the application.
  109698. */
  109699. static get ThicknessTextureEnabled(): boolean;
  109700. static set ThicknessTextureEnabled(value: boolean);
  109701. }
  109702. }
  109703. declare module BABYLON {
  109704. /** @hidden */
  109705. export var defaultFragmentDeclaration: {
  109706. name: string;
  109707. shader: string;
  109708. };
  109709. }
  109710. declare module BABYLON {
  109711. /** @hidden */
  109712. export var defaultUboDeclaration: {
  109713. name: string;
  109714. shader: string;
  109715. };
  109716. }
  109717. declare module BABYLON {
  109718. /** @hidden */
  109719. export var prePassDeclaration: {
  109720. name: string;
  109721. shader: string;
  109722. };
  109723. }
  109724. declare module BABYLON {
  109725. /** @hidden */
  109726. export var lightFragmentDeclaration: {
  109727. name: string;
  109728. shader: string;
  109729. };
  109730. }
  109731. declare module BABYLON {
  109732. /** @hidden */
  109733. export var lightUboDeclaration: {
  109734. name: string;
  109735. shader: string;
  109736. };
  109737. }
  109738. declare module BABYLON {
  109739. /** @hidden */
  109740. export var lightsFragmentFunctions: {
  109741. name: string;
  109742. shader: string;
  109743. };
  109744. }
  109745. declare module BABYLON {
  109746. /** @hidden */
  109747. export var shadowsFragmentFunctions: {
  109748. name: string;
  109749. shader: string;
  109750. };
  109751. }
  109752. declare module BABYLON {
  109753. /** @hidden */
  109754. export var fresnelFunction: {
  109755. name: string;
  109756. shader: string;
  109757. };
  109758. }
  109759. declare module BABYLON {
  109760. /** @hidden */
  109761. export var bumpFragmentMainFunctions: {
  109762. name: string;
  109763. shader: string;
  109764. };
  109765. }
  109766. declare module BABYLON {
  109767. /** @hidden */
  109768. export var bumpFragmentFunctions: {
  109769. name: string;
  109770. shader: string;
  109771. };
  109772. }
  109773. declare module BABYLON {
  109774. /** @hidden */
  109775. export var logDepthDeclaration: {
  109776. name: string;
  109777. shader: string;
  109778. };
  109779. }
  109780. declare module BABYLON {
  109781. /** @hidden */
  109782. export var bumpFragment: {
  109783. name: string;
  109784. shader: string;
  109785. };
  109786. }
  109787. declare module BABYLON {
  109788. /** @hidden */
  109789. export var depthPrePass: {
  109790. name: string;
  109791. shader: string;
  109792. };
  109793. }
  109794. declare module BABYLON {
  109795. /** @hidden */
  109796. export var lightFragment: {
  109797. name: string;
  109798. shader: string;
  109799. };
  109800. }
  109801. declare module BABYLON {
  109802. /** @hidden */
  109803. export var logDepthFragment: {
  109804. name: string;
  109805. shader: string;
  109806. };
  109807. }
  109808. declare module BABYLON {
  109809. /** @hidden */
  109810. export var defaultPixelShader: {
  109811. name: string;
  109812. shader: string;
  109813. };
  109814. }
  109815. declare module BABYLON {
  109816. /** @hidden */
  109817. export var defaultVertexDeclaration: {
  109818. name: string;
  109819. shader: string;
  109820. };
  109821. }
  109822. declare module BABYLON {
  109823. /** @hidden */
  109824. export var bumpVertexDeclaration: {
  109825. name: string;
  109826. shader: string;
  109827. };
  109828. }
  109829. declare module BABYLON {
  109830. /** @hidden */
  109831. export var bumpVertex: {
  109832. name: string;
  109833. shader: string;
  109834. };
  109835. }
  109836. declare module BABYLON {
  109837. /** @hidden */
  109838. export var fogVertex: {
  109839. name: string;
  109840. shader: string;
  109841. };
  109842. }
  109843. declare module BABYLON {
  109844. /** @hidden */
  109845. export var shadowsVertex: {
  109846. name: string;
  109847. shader: string;
  109848. };
  109849. }
  109850. declare module BABYLON {
  109851. /** @hidden */
  109852. export var pointCloudVertex: {
  109853. name: string;
  109854. shader: string;
  109855. };
  109856. }
  109857. declare module BABYLON {
  109858. /** @hidden */
  109859. export var logDepthVertex: {
  109860. name: string;
  109861. shader: string;
  109862. };
  109863. }
  109864. declare module BABYLON {
  109865. /** @hidden */
  109866. export var defaultVertexShader: {
  109867. name: string;
  109868. shader: string;
  109869. };
  109870. }
  109871. declare module BABYLON {
  109872. /**
  109873. * @hidden
  109874. */
  109875. export interface IMaterialDetailMapDefines {
  109876. DETAIL: boolean;
  109877. DETAILDIRECTUV: number;
  109878. DETAIL_NORMALBLENDMETHOD: number;
  109879. /** @hidden */
  109880. _areTexturesDirty: boolean;
  109881. }
  109882. /**
  109883. * Define the code related to the detail map parameters of a material
  109884. *
  109885. * Inspired from:
  109886. * 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
  109887. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  109888. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  109889. */
  109890. export class DetailMapConfiguration {
  109891. private _texture;
  109892. /**
  109893. * The detail texture of the material.
  109894. */
  109895. texture: Nullable<BaseTexture>;
  109896. /**
  109897. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  109898. * Bigger values mean stronger blending
  109899. */
  109900. diffuseBlendLevel: number;
  109901. /**
  109902. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  109903. * Bigger values mean stronger blending. Only used with PBR materials
  109904. */
  109905. roughnessBlendLevel: number;
  109906. /**
  109907. * Defines how strong the bump effect from the detail map is
  109908. * Bigger values mean stronger effect
  109909. */
  109910. bumpLevel: number;
  109911. private _normalBlendMethod;
  109912. /**
  109913. * The method used to blend the bump and detail normals together
  109914. */
  109915. normalBlendMethod: number;
  109916. private _isEnabled;
  109917. /**
  109918. * Enable or disable the detail map on this material
  109919. */
  109920. isEnabled: boolean;
  109921. /** @hidden */
  109922. private _internalMarkAllSubMeshesAsTexturesDirty;
  109923. /** @hidden */
  109924. _markAllSubMeshesAsTexturesDirty(): void;
  109925. /**
  109926. * Instantiate a new detail map
  109927. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  109928. */
  109929. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  109930. /**
  109931. * Gets whether the submesh is ready to be used or not.
  109932. * @param defines the list of "defines" to update.
  109933. * @param scene defines the scene the material belongs to.
  109934. * @returns - boolean indicating that the submesh is ready or not.
  109935. */
  109936. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  109937. /**
  109938. * Update the defines for detail map usage
  109939. * @param defines the list of "defines" to update.
  109940. * @param scene defines the scene the material belongs to.
  109941. */
  109942. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  109943. /**
  109944. * Binds the material data.
  109945. * @param uniformBuffer defines the Uniform buffer to fill in.
  109946. * @param scene defines the scene the material belongs to.
  109947. * @param isFrozen defines whether the material is frozen or not.
  109948. */
  109949. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  109950. /**
  109951. * Checks to see if a texture is used in the material.
  109952. * @param texture - Base texture to use.
  109953. * @returns - Boolean specifying if a texture is used in the material.
  109954. */
  109955. hasTexture(texture: BaseTexture): boolean;
  109956. /**
  109957. * Returns an array of the actively used textures.
  109958. * @param activeTextures Array of BaseTextures
  109959. */
  109960. getActiveTextures(activeTextures: BaseTexture[]): void;
  109961. /**
  109962. * Returns the animatable textures.
  109963. * @param animatables Array of animatable textures.
  109964. */
  109965. getAnimatables(animatables: IAnimatable[]): void;
  109966. /**
  109967. * Disposes the resources of the material.
  109968. * @param forceDisposeTextures - Forces the disposal of all textures.
  109969. */
  109970. dispose(forceDisposeTextures?: boolean): void;
  109971. /**
  109972. * Get the current class name useful for serialization or dynamic coding.
  109973. * @returns "DetailMap"
  109974. */
  109975. getClassName(): string;
  109976. /**
  109977. * Add the required uniforms to the current list.
  109978. * @param uniforms defines the current uniform list.
  109979. */
  109980. static AddUniforms(uniforms: string[]): void;
  109981. /**
  109982. * Add the required samplers to the current list.
  109983. * @param samplers defines the current sampler list.
  109984. */
  109985. static AddSamplers(samplers: string[]): void;
  109986. /**
  109987. * Add the required uniforms to the current buffer.
  109988. * @param uniformBuffer defines the current uniform buffer.
  109989. */
  109990. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  109991. /**
  109992. * Makes a duplicate of the current instance into another one.
  109993. * @param detailMap define the instance where to copy the info
  109994. */
  109995. copyTo(detailMap: DetailMapConfiguration): void;
  109996. /**
  109997. * Serializes this detail map instance
  109998. * @returns - An object with the serialized instance.
  109999. */
  110000. serialize(): any;
  110001. /**
  110002. * Parses a detail map setting from a serialized object.
  110003. * @param source - Serialized object.
  110004. * @param scene Defines the scene we are parsing for
  110005. * @param rootUrl Defines the rootUrl to load from
  110006. */
  110007. parse(source: any, scene: Scene, rootUrl: string): void;
  110008. }
  110009. }
  110010. declare module BABYLON {
  110011. /** @hidden */
  110012. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  110013. MAINUV1: boolean;
  110014. MAINUV2: boolean;
  110015. DIFFUSE: boolean;
  110016. DIFFUSEDIRECTUV: number;
  110017. DETAIL: boolean;
  110018. DETAILDIRECTUV: number;
  110019. DETAIL_NORMALBLENDMETHOD: number;
  110020. AMBIENT: boolean;
  110021. AMBIENTDIRECTUV: number;
  110022. OPACITY: boolean;
  110023. OPACITYDIRECTUV: number;
  110024. OPACITYRGB: boolean;
  110025. REFLECTION: boolean;
  110026. EMISSIVE: boolean;
  110027. EMISSIVEDIRECTUV: number;
  110028. SPECULAR: boolean;
  110029. SPECULARDIRECTUV: number;
  110030. BUMP: boolean;
  110031. BUMPDIRECTUV: number;
  110032. PARALLAX: boolean;
  110033. PARALLAXOCCLUSION: boolean;
  110034. SPECULAROVERALPHA: boolean;
  110035. CLIPPLANE: boolean;
  110036. CLIPPLANE2: boolean;
  110037. CLIPPLANE3: boolean;
  110038. CLIPPLANE4: boolean;
  110039. CLIPPLANE5: boolean;
  110040. CLIPPLANE6: boolean;
  110041. ALPHATEST: boolean;
  110042. DEPTHPREPASS: boolean;
  110043. ALPHAFROMDIFFUSE: boolean;
  110044. POINTSIZE: boolean;
  110045. FOG: boolean;
  110046. SPECULARTERM: boolean;
  110047. DIFFUSEFRESNEL: boolean;
  110048. OPACITYFRESNEL: boolean;
  110049. REFLECTIONFRESNEL: boolean;
  110050. REFRACTIONFRESNEL: boolean;
  110051. EMISSIVEFRESNEL: boolean;
  110052. FRESNEL: boolean;
  110053. NORMAL: boolean;
  110054. UV1: boolean;
  110055. UV2: boolean;
  110056. VERTEXCOLOR: boolean;
  110057. VERTEXALPHA: boolean;
  110058. NUM_BONE_INFLUENCERS: number;
  110059. BonesPerMesh: number;
  110060. BONETEXTURE: boolean;
  110061. INSTANCES: boolean;
  110062. THIN_INSTANCES: boolean;
  110063. GLOSSINESS: boolean;
  110064. ROUGHNESS: boolean;
  110065. EMISSIVEASILLUMINATION: boolean;
  110066. LINKEMISSIVEWITHDIFFUSE: boolean;
  110067. REFLECTIONFRESNELFROMSPECULAR: boolean;
  110068. LIGHTMAP: boolean;
  110069. LIGHTMAPDIRECTUV: number;
  110070. OBJECTSPACE_NORMALMAP: boolean;
  110071. USELIGHTMAPASSHADOWMAP: boolean;
  110072. REFLECTIONMAP_3D: boolean;
  110073. REFLECTIONMAP_SPHERICAL: boolean;
  110074. REFLECTIONMAP_PLANAR: boolean;
  110075. REFLECTIONMAP_CUBIC: boolean;
  110076. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  110077. REFLECTIONMAP_PROJECTION: boolean;
  110078. REFLECTIONMAP_SKYBOX: boolean;
  110079. REFLECTIONMAP_EXPLICIT: boolean;
  110080. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  110081. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  110082. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  110083. INVERTCUBICMAP: boolean;
  110084. LOGARITHMICDEPTH: boolean;
  110085. REFRACTION: boolean;
  110086. REFRACTIONMAP_3D: boolean;
  110087. REFLECTIONOVERALPHA: boolean;
  110088. TWOSIDEDLIGHTING: boolean;
  110089. SHADOWFLOAT: boolean;
  110090. MORPHTARGETS: boolean;
  110091. MORPHTARGETS_NORMAL: boolean;
  110092. MORPHTARGETS_TANGENT: boolean;
  110093. MORPHTARGETS_UV: boolean;
  110094. NUM_MORPH_INFLUENCERS: number;
  110095. NONUNIFORMSCALING: boolean;
  110096. PREMULTIPLYALPHA: boolean;
  110097. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  110098. ALPHABLEND: boolean;
  110099. PREPASS: boolean;
  110100. SCENE_MRT_COUNT: number;
  110101. RGBDLIGHTMAP: boolean;
  110102. RGBDREFLECTION: boolean;
  110103. RGBDREFRACTION: boolean;
  110104. IMAGEPROCESSING: boolean;
  110105. VIGNETTE: boolean;
  110106. VIGNETTEBLENDMODEMULTIPLY: boolean;
  110107. VIGNETTEBLENDMODEOPAQUE: boolean;
  110108. TONEMAPPING: boolean;
  110109. TONEMAPPING_ACES: boolean;
  110110. CONTRAST: boolean;
  110111. COLORCURVES: boolean;
  110112. COLORGRADING: boolean;
  110113. COLORGRADING3D: boolean;
  110114. SAMPLER3DGREENDEPTH: boolean;
  110115. SAMPLER3DBGRMAP: boolean;
  110116. IMAGEPROCESSINGPOSTPROCESS: boolean;
  110117. MULTIVIEW: boolean;
  110118. /**
  110119. * If the reflection texture on this material is in linear color space
  110120. * @hidden
  110121. */
  110122. IS_REFLECTION_LINEAR: boolean;
  110123. /**
  110124. * If the refraction texture on this material is in linear color space
  110125. * @hidden
  110126. */
  110127. IS_REFRACTION_LINEAR: boolean;
  110128. EXPOSURE: boolean;
  110129. constructor();
  110130. setReflectionMode(modeToEnable: string): void;
  110131. }
  110132. /**
  110133. * This is the default material used in Babylon. It is the best trade off between quality
  110134. * and performances.
  110135. * @see https://doc.babylonjs.com/babylon101/materials
  110136. */
  110137. export class StandardMaterial extends PushMaterial {
  110138. private _diffuseTexture;
  110139. /**
  110140. * The basic texture of the material as viewed under a light.
  110141. */
  110142. diffuseTexture: Nullable<BaseTexture>;
  110143. private _ambientTexture;
  110144. /**
  110145. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  110146. */
  110147. ambientTexture: Nullable<BaseTexture>;
  110148. private _opacityTexture;
  110149. /**
  110150. * Define the transparency of the material from a texture.
  110151. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  110152. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  110153. */
  110154. opacityTexture: Nullable<BaseTexture>;
  110155. private _reflectionTexture;
  110156. /**
  110157. * Define the texture used to display the reflection.
  110158. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110159. */
  110160. reflectionTexture: Nullable<BaseTexture>;
  110161. private _emissiveTexture;
  110162. /**
  110163. * Define texture of the material as if self lit.
  110164. * This will be mixed in the final result even in the absence of light.
  110165. */
  110166. emissiveTexture: Nullable<BaseTexture>;
  110167. private _specularTexture;
  110168. /**
  110169. * Define how the color and intensity of the highlight given by the light in the material.
  110170. */
  110171. specularTexture: Nullable<BaseTexture>;
  110172. private _bumpTexture;
  110173. /**
  110174. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  110175. * 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.
  110176. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  110177. */
  110178. bumpTexture: Nullable<BaseTexture>;
  110179. private _lightmapTexture;
  110180. /**
  110181. * Complex lighting can be computationally expensive to compute at runtime.
  110182. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  110183. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  110184. */
  110185. lightmapTexture: Nullable<BaseTexture>;
  110186. private _refractionTexture;
  110187. /**
  110188. * Define the texture used to display the refraction.
  110189. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110190. */
  110191. refractionTexture: Nullable<BaseTexture>;
  110192. /**
  110193. * The color of the material lit by the environmental background lighting.
  110194. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  110195. */
  110196. ambientColor: Color3;
  110197. /**
  110198. * The basic color of the material as viewed under a light.
  110199. */
  110200. diffuseColor: Color3;
  110201. /**
  110202. * Define how the color and intensity of the highlight given by the light in the material.
  110203. */
  110204. specularColor: Color3;
  110205. /**
  110206. * Define the color of the material as if self lit.
  110207. * This will be mixed in the final result even in the absence of light.
  110208. */
  110209. emissiveColor: Color3;
  110210. /**
  110211. * Defines how sharp are the highlights in the material.
  110212. * The bigger the value the sharper giving a more glossy feeling to the result.
  110213. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  110214. */
  110215. specularPower: number;
  110216. private _useAlphaFromDiffuseTexture;
  110217. /**
  110218. * Does the transparency come from the diffuse texture alpha channel.
  110219. */
  110220. useAlphaFromDiffuseTexture: boolean;
  110221. private _useEmissiveAsIllumination;
  110222. /**
  110223. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  110224. */
  110225. useEmissiveAsIllumination: boolean;
  110226. private _linkEmissiveWithDiffuse;
  110227. /**
  110228. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  110229. * the emissive level when the final color is close to one.
  110230. */
  110231. linkEmissiveWithDiffuse: boolean;
  110232. private _useSpecularOverAlpha;
  110233. /**
  110234. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  110235. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  110236. */
  110237. useSpecularOverAlpha: boolean;
  110238. private _useReflectionOverAlpha;
  110239. /**
  110240. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  110241. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  110242. */
  110243. useReflectionOverAlpha: boolean;
  110244. private _disableLighting;
  110245. /**
  110246. * Does lights from the scene impacts this material.
  110247. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  110248. */
  110249. disableLighting: boolean;
  110250. private _useObjectSpaceNormalMap;
  110251. /**
  110252. * Allows using an object space normal map (instead of tangent space).
  110253. */
  110254. useObjectSpaceNormalMap: boolean;
  110255. private _useParallax;
  110256. /**
  110257. * Is parallax enabled or not.
  110258. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  110259. */
  110260. useParallax: boolean;
  110261. private _useParallaxOcclusion;
  110262. /**
  110263. * Is parallax occlusion enabled or not.
  110264. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  110265. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  110266. */
  110267. useParallaxOcclusion: boolean;
  110268. /**
  110269. * 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.
  110270. */
  110271. parallaxScaleBias: number;
  110272. private _roughness;
  110273. /**
  110274. * Helps to define how blurry the reflections should appears in the material.
  110275. */
  110276. roughness: number;
  110277. /**
  110278. * In case of refraction, define the value of the index of refraction.
  110279. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110280. */
  110281. indexOfRefraction: number;
  110282. /**
  110283. * Invert the refraction texture alongside the y axis.
  110284. * It can be useful with procedural textures or probe for instance.
  110285. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110286. */
  110287. invertRefractionY: boolean;
  110288. /**
  110289. * Defines the alpha limits in alpha test mode.
  110290. */
  110291. alphaCutOff: number;
  110292. private _useLightmapAsShadowmap;
  110293. /**
  110294. * In case of light mapping, define whether the map contains light or shadow informations.
  110295. */
  110296. useLightmapAsShadowmap: boolean;
  110297. private _diffuseFresnelParameters;
  110298. /**
  110299. * Define the diffuse fresnel parameters of the material.
  110300. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110301. */
  110302. diffuseFresnelParameters: FresnelParameters;
  110303. private _opacityFresnelParameters;
  110304. /**
  110305. * Define the opacity fresnel parameters of the material.
  110306. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110307. */
  110308. opacityFresnelParameters: FresnelParameters;
  110309. private _reflectionFresnelParameters;
  110310. /**
  110311. * Define the reflection fresnel parameters of the material.
  110312. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110313. */
  110314. reflectionFresnelParameters: FresnelParameters;
  110315. private _refractionFresnelParameters;
  110316. /**
  110317. * Define the refraction fresnel parameters of the material.
  110318. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110319. */
  110320. refractionFresnelParameters: FresnelParameters;
  110321. private _emissiveFresnelParameters;
  110322. /**
  110323. * Define the emissive fresnel parameters of the material.
  110324. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110325. */
  110326. emissiveFresnelParameters: FresnelParameters;
  110327. private _useReflectionFresnelFromSpecular;
  110328. /**
  110329. * If true automatically deducts the fresnels values from the material specularity.
  110330. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110331. */
  110332. useReflectionFresnelFromSpecular: boolean;
  110333. private _useGlossinessFromSpecularMapAlpha;
  110334. /**
  110335. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  110336. */
  110337. useGlossinessFromSpecularMapAlpha: boolean;
  110338. private _maxSimultaneousLights;
  110339. /**
  110340. * Defines the maximum number of lights that can be used in the material
  110341. */
  110342. maxSimultaneousLights: number;
  110343. private _invertNormalMapX;
  110344. /**
  110345. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  110346. */
  110347. invertNormalMapX: boolean;
  110348. private _invertNormalMapY;
  110349. /**
  110350. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  110351. */
  110352. invertNormalMapY: boolean;
  110353. private _twoSidedLighting;
  110354. /**
  110355. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  110356. */
  110357. twoSidedLighting: boolean;
  110358. /**
  110359. * Default configuration related to image processing available in the standard Material.
  110360. */
  110361. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  110362. /**
  110363. * Gets the image processing configuration used either in this material.
  110364. */
  110365. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  110366. /**
  110367. * Sets the Default image processing configuration used either in the this material.
  110368. *
  110369. * If sets to null, the scene one is in use.
  110370. */
  110371. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  110372. /**
  110373. * Keep track of the image processing observer to allow dispose and replace.
  110374. */
  110375. private _imageProcessingObserver;
  110376. /**
  110377. * Attaches a new image processing configuration to the Standard Material.
  110378. * @param configuration
  110379. */
  110380. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  110381. /**
  110382. * Gets wether the color curves effect is enabled.
  110383. */
  110384. get cameraColorCurvesEnabled(): boolean;
  110385. /**
  110386. * Sets wether the color curves effect is enabled.
  110387. */
  110388. set cameraColorCurvesEnabled(value: boolean);
  110389. /**
  110390. * Gets wether the color grading effect is enabled.
  110391. */
  110392. get cameraColorGradingEnabled(): boolean;
  110393. /**
  110394. * Gets wether the color grading effect is enabled.
  110395. */
  110396. set cameraColorGradingEnabled(value: boolean);
  110397. /**
  110398. * Gets wether tonemapping is enabled or not.
  110399. */
  110400. get cameraToneMappingEnabled(): boolean;
  110401. /**
  110402. * Sets wether tonemapping is enabled or not
  110403. */
  110404. set cameraToneMappingEnabled(value: boolean);
  110405. /**
  110406. * The camera exposure used on this material.
  110407. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  110408. * This corresponds to a photographic exposure.
  110409. */
  110410. get cameraExposure(): number;
  110411. /**
  110412. * The camera exposure used on this material.
  110413. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  110414. * This corresponds to a photographic exposure.
  110415. */
  110416. set cameraExposure(value: number);
  110417. /**
  110418. * Gets The camera contrast used on this material.
  110419. */
  110420. get cameraContrast(): number;
  110421. /**
  110422. * Sets The camera contrast used on this material.
  110423. */
  110424. set cameraContrast(value: number);
  110425. /**
  110426. * Gets the Color Grading 2D Lookup Texture.
  110427. */
  110428. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  110429. /**
  110430. * Sets the Color Grading 2D Lookup Texture.
  110431. */
  110432. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  110433. /**
  110434. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  110435. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  110436. * 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;
  110437. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  110438. */
  110439. get cameraColorCurves(): Nullable<ColorCurves>;
  110440. /**
  110441. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  110442. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  110443. * 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;
  110444. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  110445. */
  110446. set cameraColorCurves(value: Nullable<ColorCurves>);
  110447. /**
  110448. * Can this material render to several textures at once
  110449. */
  110450. get canRenderToMRT(): boolean;
  110451. /**
  110452. * Defines the detail map parameters for the material.
  110453. */
  110454. readonly detailMap: DetailMapConfiguration;
  110455. protected _renderTargets: SmartArray<RenderTargetTexture>;
  110456. protected _worldViewProjectionMatrix: Matrix;
  110457. protected _globalAmbientColor: Color3;
  110458. protected _useLogarithmicDepth: boolean;
  110459. protected _rebuildInParallel: boolean;
  110460. /**
  110461. * Instantiates a new standard material.
  110462. * This is the default material used in Babylon. It is the best trade off between quality
  110463. * and performances.
  110464. * @see https://doc.babylonjs.com/babylon101/materials
  110465. * @param name Define the name of the material in the scene
  110466. * @param scene Define the scene the material belong to
  110467. */
  110468. constructor(name: string, scene: Scene);
  110469. /**
  110470. * Gets a boolean indicating that current material needs to register RTT
  110471. */
  110472. get hasRenderTargetTextures(): boolean;
  110473. /**
  110474. * Gets the current class name of the material e.g. "StandardMaterial"
  110475. * Mainly use in serialization.
  110476. * @returns the class name
  110477. */
  110478. getClassName(): string;
  110479. /**
  110480. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  110481. * You can try switching to logarithmic depth.
  110482. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  110483. */
  110484. get useLogarithmicDepth(): boolean;
  110485. set useLogarithmicDepth(value: boolean);
  110486. /**
  110487. * Specifies if the material will require alpha blending
  110488. * @returns a boolean specifying if alpha blending is needed
  110489. */
  110490. needAlphaBlending(): boolean;
  110491. /**
  110492. * Specifies if this material should be rendered in alpha test mode
  110493. * @returns a boolean specifying if an alpha test is needed.
  110494. */
  110495. needAlphaTesting(): boolean;
  110496. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  110497. /**
  110498. * Get the texture used for alpha test purpose.
  110499. * @returns the diffuse texture in case of the standard material.
  110500. */
  110501. getAlphaTestTexture(): Nullable<BaseTexture>;
  110502. /**
  110503. * Get if the submesh is ready to be used and all its information available.
  110504. * Child classes can use it to update shaders
  110505. * @param mesh defines the mesh to check
  110506. * @param subMesh defines which submesh to check
  110507. * @param useInstances specifies that instances should be used
  110508. * @returns a boolean indicating that the submesh is ready or not
  110509. */
  110510. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  110511. /**
  110512. * Builds the material UBO layouts.
  110513. * Used internally during the effect preparation.
  110514. */
  110515. buildUniformLayout(): void;
  110516. /**
  110517. * Unbinds the material from the mesh
  110518. */
  110519. unbind(): void;
  110520. /**
  110521. * Binds the submesh to this material by preparing the effect and shader to draw
  110522. * @param world defines the world transformation matrix
  110523. * @param mesh defines the mesh containing the submesh
  110524. * @param subMesh defines the submesh to bind the material to
  110525. */
  110526. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  110527. /**
  110528. * Get the list of animatables in the material.
  110529. * @returns the list of animatables object used in the material
  110530. */
  110531. getAnimatables(): IAnimatable[];
  110532. /**
  110533. * Gets the active textures from the material
  110534. * @returns an array of textures
  110535. */
  110536. getActiveTextures(): BaseTexture[];
  110537. /**
  110538. * Specifies if the material uses a texture
  110539. * @param texture defines the texture to check against the material
  110540. * @returns a boolean specifying if the material uses the texture
  110541. */
  110542. hasTexture(texture: BaseTexture): boolean;
  110543. /**
  110544. * Disposes the material
  110545. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  110546. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  110547. */
  110548. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  110549. /**
  110550. * Makes a duplicate of the material, and gives it a new name
  110551. * @param name defines the new name for the duplicated material
  110552. * @returns the cloned material
  110553. */
  110554. clone(name: string): StandardMaterial;
  110555. /**
  110556. * Serializes this material in a JSON representation
  110557. * @returns the serialized material object
  110558. */
  110559. serialize(): any;
  110560. /**
  110561. * Creates a standard material from parsed material data
  110562. * @param source defines the JSON representation of the material
  110563. * @param scene defines the hosting scene
  110564. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  110565. * @returns a new standard material
  110566. */
  110567. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  110568. /**
  110569. * Are diffuse textures enabled in the application.
  110570. */
  110571. static get DiffuseTextureEnabled(): boolean;
  110572. static set DiffuseTextureEnabled(value: boolean);
  110573. /**
  110574. * Are detail textures enabled in the application.
  110575. */
  110576. static get DetailTextureEnabled(): boolean;
  110577. static set DetailTextureEnabled(value: boolean);
  110578. /**
  110579. * Are ambient textures enabled in the application.
  110580. */
  110581. static get AmbientTextureEnabled(): boolean;
  110582. static set AmbientTextureEnabled(value: boolean);
  110583. /**
  110584. * Are opacity textures enabled in the application.
  110585. */
  110586. static get OpacityTextureEnabled(): boolean;
  110587. static set OpacityTextureEnabled(value: boolean);
  110588. /**
  110589. * Are reflection textures enabled in the application.
  110590. */
  110591. static get ReflectionTextureEnabled(): boolean;
  110592. static set ReflectionTextureEnabled(value: boolean);
  110593. /**
  110594. * Are emissive textures enabled in the application.
  110595. */
  110596. static get EmissiveTextureEnabled(): boolean;
  110597. static set EmissiveTextureEnabled(value: boolean);
  110598. /**
  110599. * Are specular textures enabled in the application.
  110600. */
  110601. static get SpecularTextureEnabled(): boolean;
  110602. static set SpecularTextureEnabled(value: boolean);
  110603. /**
  110604. * Are bump textures enabled in the application.
  110605. */
  110606. static get BumpTextureEnabled(): boolean;
  110607. static set BumpTextureEnabled(value: boolean);
  110608. /**
  110609. * Are lightmap textures enabled in the application.
  110610. */
  110611. static get LightmapTextureEnabled(): boolean;
  110612. static set LightmapTextureEnabled(value: boolean);
  110613. /**
  110614. * Are refraction textures enabled in the application.
  110615. */
  110616. static get RefractionTextureEnabled(): boolean;
  110617. static set RefractionTextureEnabled(value: boolean);
  110618. /**
  110619. * Are color grading textures enabled in the application.
  110620. */
  110621. static get ColorGradingTextureEnabled(): boolean;
  110622. static set ColorGradingTextureEnabled(value: boolean);
  110623. /**
  110624. * Are fresnels enabled in the application.
  110625. */
  110626. static get FresnelEnabled(): boolean;
  110627. static set FresnelEnabled(value: boolean);
  110628. }
  110629. }
  110630. declare module BABYLON {
  110631. /**
  110632. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  110633. *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.
  110634. * The SPS is also a particle system. It provides some methods to manage the particles.
  110635. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  110636. *
  110637. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  110638. */
  110639. export class SolidParticleSystem implements IDisposable {
  110640. /**
  110641. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  110642. * Example : var p = SPS.particles[i];
  110643. */
  110644. particles: SolidParticle[];
  110645. /**
  110646. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  110647. */
  110648. nbParticles: number;
  110649. /**
  110650. * If the particles must ever face the camera (default false). Useful for planar particles.
  110651. */
  110652. billboard: boolean;
  110653. /**
  110654. * Recompute normals when adding a shape
  110655. */
  110656. recomputeNormals: boolean;
  110657. /**
  110658. * This a counter ofr your own usage. It's not set by any SPS functions.
  110659. */
  110660. counter: number;
  110661. /**
  110662. * The SPS name. This name is also given to the underlying mesh.
  110663. */
  110664. name: string;
  110665. /**
  110666. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  110667. */
  110668. mesh: Mesh;
  110669. /**
  110670. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  110671. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  110672. */
  110673. vars: any;
  110674. /**
  110675. * This array is populated when the SPS is set as 'pickable'.
  110676. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  110677. * Each element of this array is an object `{idx: int, faceId: int}`.
  110678. * `idx` is the picked particle index in the `SPS.particles` array
  110679. * `faceId` is the picked face index counted within this particle.
  110680. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  110681. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  110682. * Use the method SPS.pickedParticle(pickingInfo) instead.
  110683. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  110684. */
  110685. pickedParticles: {
  110686. idx: number;
  110687. faceId: number;
  110688. }[];
  110689. /**
  110690. * This array is populated when the SPS is set as 'pickable'
  110691. * Each key of this array is a submesh index.
  110692. * Each element of this array is a second array defined like this :
  110693. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  110694. * Each element of this second array is an object `{idx: int, faceId: int}`.
  110695. * `idx` is the picked particle index in the `SPS.particles` array
  110696. * `faceId` is the picked face index counted within this particle.
  110697. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  110698. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  110699. */
  110700. pickedBySubMesh: {
  110701. idx: number;
  110702. faceId: number;
  110703. }[][];
  110704. /**
  110705. * This array is populated when `enableDepthSort` is set to true.
  110706. * Each element of this array is an instance of the class DepthSortedParticle.
  110707. */
  110708. depthSortedParticles: DepthSortedParticle[];
  110709. /**
  110710. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  110711. * @hidden
  110712. */
  110713. _bSphereOnly: boolean;
  110714. /**
  110715. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  110716. * @hidden
  110717. */
  110718. _bSphereRadiusFactor: number;
  110719. private _scene;
  110720. private _positions;
  110721. private _indices;
  110722. private _normals;
  110723. private _colors;
  110724. private _uvs;
  110725. private _indices32;
  110726. private _positions32;
  110727. private _normals32;
  110728. private _fixedNormal32;
  110729. private _colors32;
  110730. private _uvs32;
  110731. private _index;
  110732. private _updatable;
  110733. private _pickable;
  110734. private _isVisibilityBoxLocked;
  110735. private _alwaysVisible;
  110736. private _depthSort;
  110737. private _expandable;
  110738. private _shapeCounter;
  110739. private _copy;
  110740. private _color;
  110741. private _computeParticleColor;
  110742. private _computeParticleTexture;
  110743. private _computeParticleRotation;
  110744. private _computeParticleVertex;
  110745. private _computeBoundingBox;
  110746. private _depthSortParticles;
  110747. private _camera;
  110748. private _mustUnrotateFixedNormals;
  110749. private _particlesIntersect;
  110750. private _needs32Bits;
  110751. private _isNotBuilt;
  110752. private _lastParticleId;
  110753. private _idxOfId;
  110754. private _multimaterialEnabled;
  110755. private _useModelMaterial;
  110756. private _indicesByMaterial;
  110757. private _materialIndexes;
  110758. private _depthSortFunction;
  110759. private _materialSortFunction;
  110760. private _materials;
  110761. private _multimaterial;
  110762. private _materialIndexesById;
  110763. private _defaultMaterial;
  110764. private _autoUpdateSubMeshes;
  110765. private _tmpVertex;
  110766. /**
  110767. * Creates a SPS (Solid Particle System) object.
  110768. * @param name (String) is the SPS name, this will be the underlying mesh name.
  110769. * @param scene (Scene) is the scene in which the SPS is added.
  110770. * @param options defines the options of the sps e.g.
  110771. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  110772. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  110773. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  110774. * * 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.
  110775. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  110776. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  110777. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  110778. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  110779. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  110780. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  110781. */
  110782. constructor(name: string, scene: Scene, options?: {
  110783. updatable?: boolean;
  110784. isPickable?: boolean;
  110785. enableDepthSort?: boolean;
  110786. particleIntersection?: boolean;
  110787. boundingSphereOnly?: boolean;
  110788. bSphereRadiusFactor?: number;
  110789. expandable?: boolean;
  110790. useModelMaterial?: boolean;
  110791. enableMultiMaterial?: boolean;
  110792. });
  110793. /**
  110794. * Builds the SPS underlying mesh. Returns a standard Mesh.
  110795. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  110796. * @returns the created mesh
  110797. */
  110798. buildMesh(): Mesh;
  110799. /**
  110800. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  110801. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  110802. * Thus the particles generated from `digest()` have their property `position` set yet.
  110803. * @param mesh ( Mesh ) is the mesh to be digested
  110804. * @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
  110805. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  110806. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  110807. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  110808. * @returns the current SPS
  110809. */
  110810. digest(mesh: Mesh, options?: {
  110811. facetNb?: number;
  110812. number?: number;
  110813. delta?: number;
  110814. storage?: [];
  110815. }): SolidParticleSystem;
  110816. /**
  110817. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  110818. * @hidden
  110819. */
  110820. private _unrotateFixedNormals;
  110821. /**
  110822. * Resets the temporary working copy particle
  110823. * @hidden
  110824. */
  110825. private _resetCopy;
  110826. /**
  110827. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  110828. * @param p the current index in the positions array to be updated
  110829. * @param ind the current index in the indices array
  110830. * @param shape a Vector3 array, the shape geometry
  110831. * @param positions the positions array to be updated
  110832. * @param meshInd the shape indices array
  110833. * @param indices the indices array to be updated
  110834. * @param meshUV the shape uv array
  110835. * @param uvs the uv array to be updated
  110836. * @param meshCol the shape color array
  110837. * @param colors the color array to be updated
  110838. * @param meshNor the shape normals array
  110839. * @param normals the normals array to be updated
  110840. * @param idx the particle index
  110841. * @param idxInShape the particle index in its shape
  110842. * @param options the addShape() method passed options
  110843. * @model the particle model
  110844. * @hidden
  110845. */
  110846. private _meshBuilder;
  110847. /**
  110848. * Returns a shape Vector3 array from positions float array
  110849. * @param positions float array
  110850. * @returns a vector3 array
  110851. * @hidden
  110852. */
  110853. private _posToShape;
  110854. /**
  110855. * Returns a shapeUV array from a float uvs (array deep copy)
  110856. * @param uvs as a float array
  110857. * @returns a shapeUV array
  110858. * @hidden
  110859. */
  110860. private _uvsToShapeUV;
  110861. /**
  110862. * Adds a new particle object in the particles array
  110863. * @param idx particle index in particles array
  110864. * @param id particle id
  110865. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  110866. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  110867. * @param model particle ModelShape object
  110868. * @param shapeId model shape identifier
  110869. * @param idxInShape index of the particle in the current model
  110870. * @param bInfo model bounding info object
  110871. * @param storage target storage array, if any
  110872. * @hidden
  110873. */
  110874. private _addParticle;
  110875. /**
  110876. * Adds some particles to the SPS from the model shape. Returns the shape id.
  110877. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  110878. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  110879. * @param nb (positive integer) the number of particles to be created from this model
  110880. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  110881. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  110882. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  110883. * @returns the number of shapes in the system
  110884. */
  110885. addShape(mesh: Mesh, nb: number, options?: {
  110886. positionFunction?: any;
  110887. vertexFunction?: any;
  110888. storage?: [];
  110889. }): number;
  110890. /**
  110891. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  110892. * @hidden
  110893. */
  110894. private _rebuildParticle;
  110895. /**
  110896. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  110897. * @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.
  110898. * @returns the SPS.
  110899. */
  110900. rebuildMesh(reset?: boolean): SolidParticleSystem;
  110901. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  110902. * Returns an array with the removed particles.
  110903. * 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.
  110904. * The SPS can't be empty so at least one particle needs to remain in place.
  110905. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  110906. * @param start index of the first particle to remove
  110907. * @param end index of the last particle to remove (included)
  110908. * @returns an array populated with the removed particles
  110909. */
  110910. removeParticles(start: number, end: number): SolidParticle[];
  110911. /**
  110912. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  110913. * @param solidParticleArray an array populated with Solid Particles objects
  110914. * @returns the SPS
  110915. */
  110916. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  110917. /**
  110918. * Creates a new particle and modifies the SPS mesh geometry :
  110919. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  110920. * - calls _addParticle() to populate the particle array
  110921. * factorized code from addShape() and insertParticlesFromArray()
  110922. * @param idx particle index in the particles array
  110923. * @param i particle index in its shape
  110924. * @param modelShape particle ModelShape object
  110925. * @param shape shape vertex array
  110926. * @param meshInd shape indices array
  110927. * @param meshUV shape uv array
  110928. * @param meshCol shape color array
  110929. * @param meshNor shape normals array
  110930. * @param bbInfo shape bounding info
  110931. * @param storage target particle storage
  110932. * @options addShape() passed options
  110933. * @hidden
  110934. */
  110935. private _insertNewParticle;
  110936. /**
  110937. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  110938. * This method calls `updateParticle()` for each particle of the SPS.
  110939. * For an animated SPS, it is usually called within the render loop.
  110940. * 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.
  110941. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  110942. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  110943. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  110944. * @returns the SPS.
  110945. */
  110946. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  110947. /**
  110948. * Disposes the SPS.
  110949. */
  110950. dispose(): void;
  110951. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  110952. * idx is the particle index in the SPS
  110953. * faceId is the picked face index counted within this particle.
  110954. * Returns null if the pickInfo can't identify a picked particle.
  110955. * @param pickingInfo (PickingInfo object)
  110956. * @returns {idx: number, faceId: number} or null
  110957. */
  110958. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  110959. idx: number;
  110960. faceId: number;
  110961. }>;
  110962. /**
  110963. * Returns a SolidParticle object from its identifier : particle.id
  110964. * @param id (integer) the particle Id
  110965. * @returns the searched particle or null if not found in the SPS.
  110966. */
  110967. getParticleById(id: number): Nullable<SolidParticle>;
  110968. /**
  110969. * Returns a new array populated with the particles having the passed shapeId.
  110970. * @param shapeId (integer) the shape identifier
  110971. * @returns a new solid particle array
  110972. */
  110973. getParticlesByShapeId(shapeId: number): SolidParticle[];
  110974. /**
  110975. * Populates the passed array "ref" with the particles having the passed shapeId.
  110976. * @param shapeId the shape identifier
  110977. * @returns the SPS
  110978. * @param ref
  110979. */
  110980. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  110981. /**
  110982. * Computes the required SubMeshes according the materials assigned to the particles.
  110983. * @returns the solid particle system.
  110984. * Does nothing if called before the SPS mesh is built.
  110985. */
  110986. computeSubMeshes(): SolidParticleSystem;
  110987. /**
  110988. * Sorts the solid particles by material when MultiMaterial is enabled.
  110989. * Updates the indices32 array.
  110990. * Updates the indicesByMaterial array.
  110991. * Updates the mesh indices array.
  110992. * @returns the SPS
  110993. * @hidden
  110994. */
  110995. private _sortParticlesByMaterial;
  110996. /**
  110997. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  110998. * @hidden
  110999. */
  111000. private _setMaterialIndexesById;
  111001. /**
  111002. * Returns an array with unique values of Materials from the passed array
  111003. * @param array the material array to be checked and filtered
  111004. * @hidden
  111005. */
  111006. private _filterUniqueMaterialId;
  111007. /**
  111008. * Sets a new Standard Material as _defaultMaterial if not already set.
  111009. * @hidden
  111010. */
  111011. private _setDefaultMaterial;
  111012. /**
  111013. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  111014. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111015. * @returns the SPS.
  111016. */
  111017. refreshVisibleSize(): SolidParticleSystem;
  111018. /**
  111019. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  111020. * @param size the size (float) of the visibility box
  111021. * note : this doesn't lock the SPS mesh bounding box.
  111022. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111023. */
  111024. setVisibilityBox(size: number): void;
  111025. /**
  111026. * Gets whether the SPS as always visible or not
  111027. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111028. */
  111029. get isAlwaysVisible(): boolean;
  111030. /**
  111031. * Sets the SPS as always visible or not
  111032. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111033. */
  111034. set isAlwaysVisible(val: boolean);
  111035. /**
  111036. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  111037. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111038. */
  111039. set isVisibilityBoxLocked(val: boolean);
  111040. /**
  111041. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  111042. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111043. */
  111044. get isVisibilityBoxLocked(): boolean;
  111045. /**
  111046. * Tells to `setParticles()` to compute the particle rotations or not.
  111047. * Default value : true. The SPS is faster when it's set to false.
  111048. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  111049. */
  111050. set computeParticleRotation(val: boolean);
  111051. /**
  111052. * Tells to `setParticles()` to compute the particle colors or not.
  111053. * Default value : true. The SPS is faster when it's set to false.
  111054. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  111055. */
  111056. set computeParticleColor(val: boolean);
  111057. set computeParticleTexture(val: boolean);
  111058. /**
  111059. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  111060. * Default value : false. The SPS is faster when it's set to false.
  111061. * Note : the particle custom vertex positions aren't stored values.
  111062. */
  111063. set computeParticleVertex(val: boolean);
  111064. /**
  111065. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  111066. */
  111067. set computeBoundingBox(val: boolean);
  111068. /**
  111069. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  111070. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  111071. * Default : `true`
  111072. */
  111073. set depthSortParticles(val: boolean);
  111074. /**
  111075. * Gets if `setParticles()` computes the particle rotations or not.
  111076. * Default value : true. The SPS is faster when it's set to false.
  111077. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  111078. */
  111079. get computeParticleRotation(): boolean;
  111080. /**
  111081. * Gets if `setParticles()` computes the particle colors or not.
  111082. * Default value : true. The SPS is faster when it's set to false.
  111083. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  111084. */
  111085. get computeParticleColor(): boolean;
  111086. /**
  111087. * Gets if `setParticles()` computes the particle textures or not.
  111088. * Default value : true. The SPS is faster when it's set to false.
  111089. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  111090. */
  111091. get computeParticleTexture(): boolean;
  111092. /**
  111093. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  111094. * Default value : false. The SPS is faster when it's set to false.
  111095. * Note : the particle custom vertex positions aren't stored values.
  111096. */
  111097. get computeParticleVertex(): boolean;
  111098. /**
  111099. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  111100. */
  111101. get computeBoundingBox(): boolean;
  111102. /**
  111103. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  111104. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  111105. * Default : `true`
  111106. */
  111107. get depthSortParticles(): boolean;
  111108. /**
  111109. * Gets if the SPS is created as expandable at construction time.
  111110. * Default : `false`
  111111. */
  111112. get expandable(): boolean;
  111113. /**
  111114. * Gets if the SPS supports the Multi Materials
  111115. */
  111116. get multimaterialEnabled(): boolean;
  111117. /**
  111118. * Gets if the SPS uses the model materials for its own multimaterial.
  111119. */
  111120. get useModelMaterial(): boolean;
  111121. /**
  111122. * The SPS used material array.
  111123. */
  111124. get materials(): Material[];
  111125. /**
  111126. * Sets the SPS MultiMaterial from the passed materials.
  111127. * Note : the passed array is internally copied and not used then by reference.
  111128. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  111129. */
  111130. setMultiMaterial(materials: Material[]): void;
  111131. /**
  111132. * The SPS computed multimaterial object
  111133. */
  111134. get multimaterial(): MultiMaterial;
  111135. set multimaterial(mm: MultiMaterial);
  111136. /**
  111137. * If the subMeshes must be updated on the next call to setParticles()
  111138. */
  111139. get autoUpdateSubMeshes(): boolean;
  111140. set autoUpdateSubMeshes(val: boolean);
  111141. /**
  111142. * This function does nothing. It may be overwritten to set all the particle first values.
  111143. * The SPS doesn't call this function, you may have to call it by your own.
  111144. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111145. */
  111146. initParticles(): void;
  111147. /**
  111148. * This function does nothing. It may be overwritten to recycle a particle.
  111149. * The SPS doesn't call this function, you may have to call it by your own.
  111150. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111151. * @param particle The particle to recycle
  111152. * @returns the recycled particle
  111153. */
  111154. recycleParticle(particle: SolidParticle): SolidParticle;
  111155. /**
  111156. * Updates a particle : this function should be overwritten by the user.
  111157. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  111158. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111159. * @example : just set a particle position or velocity and recycle conditions
  111160. * @param particle The particle to update
  111161. * @returns the updated particle
  111162. */
  111163. updateParticle(particle: SolidParticle): SolidParticle;
  111164. /**
  111165. * Updates a vertex of a particle : it can be overwritten by the user.
  111166. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  111167. * @param particle the current particle
  111168. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  111169. * @param pt the index of the current vertex in the particle shape
  111170. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  111171. * @example : just set a vertex particle position or color
  111172. * @returns the sps
  111173. */
  111174. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  111175. /**
  111176. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  111177. * This does nothing and may be overwritten by the user.
  111178. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111179. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111180. * @param update the boolean update value actually passed to setParticles()
  111181. */
  111182. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  111183. /**
  111184. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  111185. * This will be passed three parameters.
  111186. * This does nothing and may be overwritten by the user.
  111187. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111188. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111189. * @param update the boolean update value actually passed to setParticles()
  111190. */
  111191. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  111192. }
  111193. }
  111194. declare module BABYLON {
  111195. /**
  111196. * Represents one particle of a solid particle system.
  111197. */
  111198. export class SolidParticle {
  111199. /**
  111200. * particle global index
  111201. */
  111202. idx: number;
  111203. /**
  111204. * particle identifier
  111205. */
  111206. id: number;
  111207. /**
  111208. * The color of the particle
  111209. */
  111210. color: Nullable<Color4>;
  111211. /**
  111212. * The world space position of the particle.
  111213. */
  111214. position: Vector3;
  111215. /**
  111216. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  111217. */
  111218. rotation: Vector3;
  111219. /**
  111220. * The world space rotation quaternion of the particle.
  111221. */
  111222. rotationQuaternion: Nullable<Quaternion>;
  111223. /**
  111224. * The scaling of the particle.
  111225. */
  111226. scaling: Vector3;
  111227. /**
  111228. * The uvs of the particle.
  111229. */
  111230. uvs: Vector4;
  111231. /**
  111232. * The current speed of the particle.
  111233. */
  111234. velocity: Vector3;
  111235. /**
  111236. * The pivot point in the particle local space.
  111237. */
  111238. pivot: Vector3;
  111239. /**
  111240. * Must the particle be translated from its pivot point in its local space ?
  111241. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  111242. * Default : false
  111243. */
  111244. translateFromPivot: boolean;
  111245. /**
  111246. * Is the particle active or not ?
  111247. */
  111248. alive: boolean;
  111249. /**
  111250. * Is the particle visible or not ?
  111251. */
  111252. isVisible: boolean;
  111253. /**
  111254. * Index of this particle in the global "positions" array (Internal use)
  111255. * @hidden
  111256. */
  111257. _pos: number;
  111258. /**
  111259. * @hidden Index of this particle in the global "indices" array (Internal use)
  111260. */
  111261. _ind: number;
  111262. /**
  111263. * @hidden ModelShape of this particle (Internal use)
  111264. */
  111265. _model: ModelShape;
  111266. /**
  111267. * ModelShape id of this particle
  111268. */
  111269. shapeId: number;
  111270. /**
  111271. * Index of the particle in its shape id
  111272. */
  111273. idxInShape: number;
  111274. /**
  111275. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  111276. */
  111277. _modelBoundingInfo: BoundingInfo;
  111278. /**
  111279. * @hidden Particle BoundingInfo object (Internal use)
  111280. */
  111281. _boundingInfo: BoundingInfo;
  111282. /**
  111283. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  111284. */
  111285. _sps: SolidParticleSystem;
  111286. /**
  111287. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  111288. */
  111289. _stillInvisible: boolean;
  111290. /**
  111291. * @hidden Last computed particle rotation matrix
  111292. */
  111293. _rotationMatrix: number[];
  111294. /**
  111295. * Parent particle Id, if any.
  111296. * Default null.
  111297. */
  111298. parentId: Nullable<number>;
  111299. /**
  111300. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  111301. */
  111302. materialIndex: Nullable<number>;
  111303. /**
  111304. * Custom object or properties.
  111305. */
  111306. props: Nullable<any>;
  111307. /**
  111308. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  111309. * The possible values are :
  111310. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  111311. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111312. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  111313. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  111314. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111315. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  111316. * */
  111317. cullingStrategy: number;
  111318. /**
  111319. * @hidden Internal global position in the SPS.
  111320. */
  111321. _globalPosition: Vector3;
  111322. /**
  111323. * Creates a Solid Particle object.
  111324. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  111325. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  111326. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  111327. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  111328. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  111329. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  111330. * @param shapeId (integer) is the model shape identifier in the SPS.
  111331. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  111332. * @param sps defines the sps it is associated to
  111333. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  111334. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  111335. */
  111336. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  111337. /**
  111338. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  111339. * @param target the particle target
  111340. * @returns the current particle
  111341. */
  111342. copyToRef(target: SolidParticle): SolidParticle;
  111343. /**
  111344. * Legacy support, changed scale to scaling
  111345. */
  111346. get scale(): Vector3;
  111347. /**
  111348. * Legacy support, changed scale to scaling
  111349. */
  111350. set scale(scale: Vector3);
  111351. /**
  111352. * Legacy support, changed quaternion to rotationQuaternion
  111353. */
  111354. get quaternion(): Nullable<Quaternion>;
  111355. /**
  111356. * Legacy support, changed quaternion to rotationQuaternion
  111357. */
  111358. set quaternion(q: Nullable<Quaternion>);
  111359. /**
  111360. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  111361. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  111362. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  111363. * @returns true if it intersects
  111364. */
  111365. intersectsMesh(target: Mesh | SolidParticle): boolean;
  111366. /**
  111367. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  111368. * A particle is in the frustum if its bounding box intersects the frustum
  111369. * @param frustumPlanes defines the frustum to test
  111370. * @returns true if the particle is in the frustum planes
  111371. */
  111372. isInFrustum(frustumPlanes: Plane[]): boolean;
  111373. /**
  111374. * get the rotation matrix of the particle
  111375. * @hidden
  111376. */
  111377. getRotationMatrix(m: Matrix): void;
  111378. }
  111379. /**
  111380. * Represents the shape of the model used by one particle of a solid particle system.
  111381. * SPS internal tool, don't use it manually.
  111382. */
  111383. export class ModelShape {
  111384. /**
  111385. * The shape id
  111386. * @hidden
  111387. */
  111388. shapeID: number;
  111389. /**
  111390. * flat array of model positions (internal use)
  111391. * @hidden
  111392. */
  111393. _shape: Vector3[];
  111394. /**
  111395. * flat array of model UVs (internal use)
  111396. * @hidden
  111397. */
  111398. _shapeUV: number[];
  111399. /**
  111400. * color array of the model
  111401. * @hidden
  111402. */
  111403. _shapeColors: number[];
  111404. /**
  111405. * indices array of the model
  111406. * @hidden
  111407. */
  111408. _indices: number[];
  111409. /**
  111410. * normals array of the model
  111411. * @hidden
  111412. */
  111413. _normals: number[];
  111414. /**
  111415. * length of the shape in the model indices array (internal use)
  111416. * @hidden
  111417. */
  111418. _indicesLength: number;
  111419. /**
  111420. * Custom position function (internal use)
  111421. * @hidden
  111422. */
  111423. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  111424. /**
  111425. * Custom vertex function (internal use)
  111426. * @hidden
  111427. */
  111428. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  111429. /**
  111430. * Model material (internal use)
  111431. * @hidden
  111432. */
  111433. _material: Nullable<Material>;
  111434. /**
  111435. * 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.
  111436. * SPS internal tool, don't use it manually.
  111437. * @hidden
  111438. */
  111439. 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>);
  111440. }
  111441. /**
  111442. * Represents a Depth Sorted Particle in the solid particle system.
  111443. * @hidden
  111444. */
  111445. export class DepthSortedParticle {
  111446. /**
  111447. * Particle index
  111448. */
  111449. idx: number;
  111450. /**
  111451. * Index of the particle in the "indices" array
  111452. */
  111453. ind: number;
  111454. /**
  111455. * Length of the particle shape in the "indices" array
  111456. */
  111457. indicesLength: number;
  111458. /**
  111459. * Squared distance from the particle to the camera
  111460. */
  111461. sqDistance: number;
  111462. /**
  111463. * Material index when used with MultiMaterials
  111464. */
  111465. materialIndex: number;
  111466. /**
  111467. * Creates a new sorted particle
  111468. * @param materialIndex
  111469. */
  111470. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  111471. }
  111472. /**
  111473. * Represents a solid particle vertex
  111474. */
  111475. export class SolidParticleVertex {
  111476. /**
  111477. * Vertex position
  111478. */
  111479. position: Vector3;
  111480. /**
  111481. * Vertex color
  111482. */
  111483. color: Color4;
  111484. /**
  111485. * Vertex UV
  111486. */
  111487. uv: Vector2;
  111488. /**
  111489. * Creates a new solid particle vertex
  111490. */
  111491. constructor();
  111492. /** Vertex x coordinate */
  111493. get x(): number;
  111494. set x(val: number);
  111495. /** Vertex y coordinate */
  111496. get y(): number;
  111497. set y(val: number);
  111498. /** Vertex z coordinate */
  111499. get z(): number;
  111500. set z(val: number);
  111501. }
  111502. }
  111503. declare module BABYLON {
  111504. /**
  111505. * @hidden
  111506. */
  111507. export class _MeshCollisionData {
  111508. _checkCollisions: boolean;
  111509. _collisionMask: number;
  111510. _collisionGroup: number;
  111511. _surroundingMeshes: Nullable<AbstractMesh[]>;
  111512. _collider: Nullable<Collider>;
  111513. _oldPositionForCollisions: Vector3;
  111514. _diffPositionForCollisions: Vector3;
  111515. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  111516. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  111517. }
  111518. }
  111519. declare module BABYLON {
  111520. /** @hidden */
  111521. class _FacetDataStorage {
  111522. facetPositions: Vector3[];
  111523. facetNormals: Vector3[];
  111524. facetPartitioning: number[][];
  111525. facetNb: number;
  111526. partitioningSubdivisions: number;
  111527. partitioningBBoxRatio: number;
  111528. facetDataEnabled: boolean;
  111529. facetParameters: any;
  111530. bbSize: Vector3;
  111531. subDiv: {
  111532. max: number;
  111533. X: number;
  111534. Y: number;
  111535. Z: number;
  111536. };
  111537. facetDepthSort: boolean;
  111538. facetDepthSortEnabled: boolean;
  111539. depthSortedIndices: IndicesArray;
  111540. depthSortedFacets: {
  111541. ind: number;
  111542. sqDistance: number;
  111543. }[];
  111544. facetDepthSortFunction: (f1: {
  111545. ind: number;
  111546. sqDistance: number;
  111547. }, f2: {
  111548. ind: number;
  111549. sqDistance: number;
  111550. }) => number;
  111551. facetDepthSortFrom: Vector3;
  111552. facetDepthSortOrigin: Vector3;
  111553. invertedMatrix: Matrix;
  111554. }
  111555. /**
  111556. * @hidden
  111557. **/
  111558. class _InternalAbstractMeshDataInfo {
  111559. _hasVertexAlpha: boolean;
  111560. _useVertexColors: boolean;
  111561. _numBoneInfluencers: number;
  111562. _applyFog: boolean;
  111563. _receiveShadows: boolean;
  111564. _facetData: _FacetDataStorage;
  111565. _visibility: number;
  111566. _skeleton: Nullable<Skeleton>;
  111567. _layerMask: number;
  111568. _computeBonesUsingShaders: boolean;
  111569. _isActive: boolean;
  111570. _onlyForInstances: boolean;
  111571. _isActiveIntermediate: boolean;
  111572. _onlyForInstancesIntermediate: boolean;
  111573. _actAsRegularMesh: boolean;
  111574. }
  111575. /**
  111576. * Class used to store all common mesh properties
  111577. */
  111578. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  111579. /** No occlusion */
  111580. static OCCLUSION_TYPE_NONE: number;
  111581. /** Occlusion set to optimisitic */
  111582. static OCCLUSION_TYPE_OPTIMISTIC: number;
  111583. /** Occlusion set to strict */
  111584. static OCCLUSION_TYPE_STRICT: number;
  111585. /** Use an accurante occlusion algorithm */
  111586. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  111587. /** Use a conservative occlusion algorithm */
  111588. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  111589. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  111590. * Test order :
  111591. * Is the bounding sphere outside the frustum ?
  111592. * If not, are the bounding box vertices outside the frustum ?
  111593. * It not, then the cullable object is in the frustum.
  111594. */
  111595. static readonly CULLINGSTRATEGY_STANDARD: number;
  111596. /** Culling strategy : Bounding Sphere Only.
  111597. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  111598. * It's also less accurate than the standard because some not visible objects can still be selected.
  111599. * Test : is the bounding sphere outside the frustum ?
  111600. * If not, then the cullable object is in the frustum.
  111601. */
  111602. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  111603. /** Culling strategy : Optimistic Inclusion.
  111604. * This in an inclusion test first, then the standard exclusion test.
  111605. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  111606. * 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.
  111607. * Anyway, it's as accurate as the standard strategy.
  111608. * Test :
  111609. * Is the cullable object bounding sphere center in the frustum ?
  111610. * If not, apply the default culling strategy.
  111611. */
  111612. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  111613. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  111614. * This in an inclusion test first, then the bounding sphere only exclusion test.
  111615. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  111616. * 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.
  111617. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  111618. * Test :
  111619. * Is the cullable object bounding sphere center in the frustum ?
  111620. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  111621. */
  111622. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  111623. /**
  111624. * No billboard
  111625. */
  111626. static get BILLBOARDMODE_NONE(): number;
  111627. /** Billboard on X axis */
  111628. static get BILLBOARDMODE_X(): number;
  111629. /** Billboard on Y axis */
  111630. static get BILLBOARDMODE_Y(): number;
  111631. /** Billboard on Z axis */
  111632. static get BILLBOARDMODE_Z(): number;
  111633. /** Billboard on all axes */
  111634. static get BILLBOARDMODE_ALL(): number;
  111635. /** Billboard on using position instead of orientation */
  111636. static get BILLBOARDMODE_USE_POSITION(): number;
  111637. /** @hidden */
  111638. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  111639. /**
  111640. * The culling strategy to use to check whether the mesh must be rendered or not.
  111641. * This value can be changed at any time and will be used on the next render mesh selection.
  111642. * The possible values are :
  111643. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  111644. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111645. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  111646. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  111647. * Please read each static variable documentation to get details about the culling process.
  111648. * */
  111649. cullingStrategy: number;
  111650. /**
  111651. * Gets the number of facets in the mesh
  111652. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  111653. */
  111654. get facetNb(): number;
  111655. /**
  111656. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  111657. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  111658. */
  111659. get partitioningSubdivisions(): number;
  111660. set partitioningSubdivisions(nb: number);
  111661. /**
  111662. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  111663. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  111664. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  111665. */
  111666. get partitioningBBoxRatio(): number;
  111667. set partitioningBBoxRatio(ratio: number);
  111668. /**
  111669. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  111670. * Works only for updatable meshes.
  111671. * Doesn't work with multi-materials
  111672. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  111673. */
  111674. get mustDepthSortFacets(): boolean;
  111675. set mustDepthSortFacets(sort: boolean);
  111676. /**
  111677. * The location (Vector3) where the facet depth sort must be computed from.
  111678. * By default, the active camera position.
  111679. * Used only when facet depth sort is enabled
  111680. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  111681. */
  111682. get facetDepthSortFrom(): Vector3;
  111683. set facetDepthSortFrom(location: Vector3);
  111684. /**
  111685. * gets a boolean indicating if facetData is enabled
  111686. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  111687. */
  111688. get isFacetDataEnabled(): boolean;
  111689. /** @hidden */
  111690. _updateNonUniformScalingState(value: boolean): boolean;
  111691. /**
  111692. * An event triggered when this mesh collides with another one
  111693. */
  111694. onCollideObservable: Observable<AbstractMesh>;
  111695. /** Set a function to call when this mesh collides with another one */
  111696. set onCollide(callback: () => void);
  111697. /**
  111698. * An event triggered when the collision's position changes
  111699. */
  111700. onCollisionPositionChangeObservable: Observable<Vector3>;
  111701. /** Set a function to call when the collision's position changes */
  111702. set onCollisionPositionChange(callback: () => void);
  111703. /**
  111704. * An event triggered when material is changed
  111705. */
  111706. onMaterialChangedObservable: Observable<AbstractMesh>;
  111707. /**
  111708. * Gets or sets the orientation for POV movement & rotation
  111709. */
  111710. definedFacingForward: boolean;
  111711. /** @hidden */
  111712. _occlusionQuery: Nullable<WebGLQuery>;
  111713. /** @hidden */
  111714. _renderingGroup: Nullable<RenderingGroup>;
  111715. /**
  111716. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  111717. */
  111718. get visibility(): number;
  111719. /**
  111720. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  111721. */
  111722. set visibility(value: number);
  111723. /** Gets or sets the alpha index used to sort transparent meshes
  111724. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  111725. */
  111726. alphaIndex: number;
  111727. /**
  111728. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  111729. */
  111730. isVisible: boolean;
  111731. /**
  111732. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  111733. */
  111734. isPickable: boolean;
  111735. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  111736. showSubMeshesBoundingBox: boolean;
  111737. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  111738. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  111739. */
  111740. isBlocker: boolean;
  111741. /**
  111742. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  111743. */
  111744. enablePointerMoveEvents: boolean;
  111745. private _renderingGroupId;
  111746. /**
  111747. * Specifies the rendering group id for this mesh (0 by default)
  111748. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  111749. */
  111750. get renderingGroupId(): number;
  111751. set renderingGroupId(value: number);
  111752. private _material;
  111753. /** Gets or sets current material */
  111754. get material(): Nullable<Material>;
  111755. set material(value: Nullable<Material>);
  111756. /**
  111757. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  111758. * @see https://doc.babylonjs.com/babylon101/shadows
  111759. */
  111760. get receiveShadows(): boolean;
  111761. set receiveShadows(value: boolean);
  111762. /** Defines color to use when rendering outline */
  111763. outlineColor: Color3;
  111764. /** Define width to use when rendering outline */
  111765. outlineWidth: number;
  111766. /** Defines color to use when rendering overlay */
  111767. overlayColor: Color3;
  111768. /** Defines alpha to use when rendering overlay */
  111769. overlayAlpha: number;
  111770. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  111771. get hasVertexAlpha(): boolean;
  111772. set hasVertexAlpha(value: boolean);
  111773. /** 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) */
  111774. get useVertexColors(): boolean;
  111775. set useVertexColors(value: boolean);
  111776. /**
  111777. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  111778. */
  111779. get computeBonesUsingShaders(): boolean;
  111780. set computeBonesUsingShaders(value: boolean);
  111781. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  111782. get numBoneInfluencers(): number;
  111783. set numBoneInfluencers(value: number);
  111784. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  111785. get applyFog(): boolean;
  111786. set applyFog(value: boolean);
  111787. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  111788. useOctreeForRenderingSelection: boolean;
  111789. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  111790. useOctreeForPicking: boolean;
  111791. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  111792. useOctreeForCollisions: boolean;
  111793. /**
  111794. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  111795. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  111796. */
  111797. get layerMask(): number;
  111798. set layerMask(value: number);
  111799. /**
  111800. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  111801. */
  111802. alwaysSelectAsActiveMesh: boolean;
  111803. /**
  111804. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  111805. */
  111806. doNotSyncBoundingInfo: boolean;
  111807. /**
  111808. * Gets or sets the current action manager
  111809. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  111810. */
  111811. actionManager: Nullable<AbstractActionManager>;
  111812. private _meshCollisionData;
  111813. /**
  111814. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  111815. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111816. */
  111817. ellipsoid: Vector3;
  111818. /**
  111819. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  111820. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111821. */
  111822. ellipsoidOffset: Vector3;
  111823. /**
  111824. * Gets or sets a collision mask used to mask collisions (default is -1).
  111825. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  111826. */
  111827. get collisionMask(): number;
  111828. set collisionMask(mask: number);
  111829. /**
  111830. * Gets or sets the current collision group mask (-1 by default).
  111831. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  111832. */
  111833. get collisionGroup(): number;
  111834. set collisionGroup(mask: number);
  111835. /**
  111836. * Gets or sets current surrounding meshes (null by default).
  111837. *
  111838. * By default collision detection is tested against every mesh in the scene.
  111839. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  111840. * meshes will be tested for the collision.
  111841. *
  111842. * Note: if set to an empty array no collision will happen when this mesh is moved.
  111843. */
  111844. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  111845. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  111846. /**
  111847. * Defines edge width used when edgesRenderer is enabled
  111848. * @see https://www.babylonjs-playground.com/#10OJSG#13
  111849. */
  111850. edgesWidth: number;
  111851. /**
  111852. * Defines edge color used when edgesRenderer is enabled
  111853. * @see https://www.babylonjs-playground.com/#10OJSG#13
  111854. */
  111855. edgesColor: Color4;
  111856. /** @hidden */
  111857. _edgesRenderer: Nullable<IEdgesRenderer>;
  111858. /** @hidden */
  111859. _masterMesh: Nullable<AbstractMesh>;
  111860. /** @hidden */
  111861. _boundingInfo: Nullable<BoundingInfo>;
  111862. /** @hidden */
  111863. _renderId: number;
  111864. /**
  111865. * Gets or sets the list of subMeshes
  111866. * @see https://doc.babylonjs.com/how_to/multi_materials
  111867. */
  111868. subMeshes: SubMesh[];
  111869. /** @hidden */
  111870. _intersectionsInProgress: AbstractMesh[];
  111871. /** @hidden */
  111872. _unIndexed: boolean;
  111873. /** @hidden */
  111874. _lightSources: Light[];
  111875. /** Gets the list of lights affecting that mesh */
  111876. get lightSources(): Light[];
  111877. /** @hidden */
  111878. get _positions(): Nullable<Vector3[]>;
  111879. /** @hidden */
  111880. _waitingData: {
  111881. lods: Nullable<any>;
  111882. actions: Nullable<any>;
  111883. freezeWorldMatrix: Nullable<boolean>;
  111884. };
  111885. /** @hidden */
  111886. _bonesTransformMatrices: Nullable<Float32Array>;
  111887. /** @hidden */
  111888. _transformMatrixTexture: Nullable<RawTexture>;
  111889. /**
  111890. * Gets or sets a skeleton to apply skining transformations
  111891. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  111892. */
  111893. set skeleton(value: Nullable<Skeleton>);
  111894. get skeleton(): Nullable<Skeleton>;
  111895. /**
  111896. * An event triggered when the mesh is rebuilt.
  111897. */
  111898. onRebuildObservable: Observable<AbstractMesh>;
  111899. /**
  111900. * Creates a new AbstractMesh
  111901. * @param name defines the name of the mesh
  111902. * @param scene defines the hosting scene
  111903. */
  111904. constructor(name: string, scene?: Nullable<Scene>);
  111905. /**
  111906. * Returns the string "AbstractMesh"
  111907. * @returns "AbstractMesh"
  111908. */
  111909. getClassName(): string;
  111910. /**
  111911. * Gets a string representation of the current mesh
  111912. * @param fullDetails defines a boolean indicating if full details must be included
  111913. * @returns a string representation of the current mesh
  111914. */
  111915. toString(fullDetails?: boolean): string;
  111916. /**
  111917. * @hidden
  111918. */
  111919. protected _getEffectiveParent(): Nullable<Node>;
  111920. /** @hidden */
  111921. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  111922. /** @hidden */
  111923. _rebuild(): void;
  111924. /** @hidden */
  111925. _resyncLightSources(): void;
  111926. /** @hidden */
  111927. _resyncLightSource(light: Light): void;
  111928. /** @hidden */
  111929. _unBindEffect(): void;
  111930. /** @hidden */
  111931. _removeLightSource(light: Light, dispose: boolean): void;
  111932. private _markSubMeshesAsDirty;
  111933. /** @hidden */
  111934. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  111935. /** @hidden */
  111936. _markSubMeshesAsAttributesDirty(): void;
  111937. /** @hidden */
  111938. _markSubMeshesAsMiscDirty(): void;
  111939. /**
  111940. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  111941. */
  111942. get scaling(): Vector3;
  111943. set scaling(newScaling: Vector3);
  111944. /**
  111945. * Returns true if the mesh is blocked. Implemented by child classes
  111946. */
  111947. get isBlocked(): boolean;
  111948. /**
  111949. * Returns the mesh itself by default. Implemented by child classes
  111950. * @param camera defines the camera to use to pick the right LOD level
  111951. * @returns the currentAbstractMesh
  111952. */
  111953. getLOD(camera: Camera): Nullable<AbstractMesh>;
  111954. /**
  111955. * Returns 0 by default. Implemented by child classes
  111956. * @returns an integer
  111957. */
  111958. getTotalVertices(): number;
  111959. /**
  111960. * Returns a positive integer : the total number of indices in this mesh geometry.
  111961. * @returns the numner of indices or zero if the mesh has no geometry.
  111962. */
  111963. getTotalIndices(): number;
  111964. /**
  111965. * Returns null by default. Implemented by child classes
  111966. * @returns null
  111967. */
  111968. getIndices(): Nullable<IndicesArray>;
  111969. /**
  111970. * Returns the array of the requested vertex data kind. Implemented by child classes
  111971. * @param kind defines the vertex data kind to use
  111972. * @returns null
  111973. */
  111974. getVerticesData(kind: string): Nullable<FloatArray>;
  111975. /**
  111976. * Sets the vertex data of the mesh geometry for the requested `kind`.
  111977. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  111978. * Note that a new underlying VertexBuffer object is created each call.
  111979. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  111980. * @param kind defines vertex data kind:
  111981. * * VertexBuffer.PositionKind
  111982. * * VertexBuffer.UVKind
  111983. * * VertexBuffer.UV2Kind
  111984. * * VertexBuffer.UV3Kind
  111985. * * VertexBuffer.UV4Kind
  111986. * * VertexBuffer.UV5Kind
  111987. * * VertexBuffer.UV6Kind
  111988. * * VertexBuffer.ColorKind
  111989. * * VertexBuffer.MatricesIndicesKind
  111990. * * VertexBuffer.MatricesIndicesExtraKind
  111991. * * VertexBuffer.MatricesWeightsKind
  111992. * * VertexBuffer.MatricesWeightsExtraKind
  111993. * @param data defines the data source
  111994. * @param updatable defines if the data must be flagged as updatable (or static)
  111995. * @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
  111996. * @returns the current mesh
  111997. */
  111998. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  111999. /**
  112000. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  112001. * If the mesh has no geometry, it is simply returned as it is.
  112002. * @param kind defines vertex data kind:
  112003. * * VertexBuffer.PositionKind
  112004. * * VertexBuffer.UVKind
  112005. * * VertexBuffer.UV2Kind
  112006. * * VertexBuffer.UV3Kind
  112007. * * VertexBuffer.UV4Kind
  112008. * * VertexBuffer.UV5Kind
  112009. * * VertexBuffer.UV6Kind
  112010. * * VertexBuffer.ColorKind
  112011. * * VertexBuffer.MatricesIndicesKind
  112012. * * VertexBuffer.MatricesIndicesExtraKind
  112013. * * VertexBuffer.MatricesWeightsKind
  112014. * * VertexBuffer.MatricesWeightsExtraKind
  112015. * @param data defines the data source
  112016. * @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
  112017. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  112018. * @returns the current mesh
  112019. */
  112020. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  112021. /**
  112022. * Sets the mesh indices,
  112023. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  112024. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  112025. * @param totalVertices Defines the total number of vertices
  112026. * @returns the current mesh
  112027. */
  112028. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  112029. /**
  112030. * Gets a boolean indicating if specific vertex data is present
  112031. * @param kind defines the vertex data kind to use
  112032. * @returns true is data kind is present
  112033. */
  112034. isVerticesDataPresent(kind: string): boolean;
  112035. /**
  112036. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  112037. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  112038. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  112039. * @returns a BoundingInfo
  112040. */
  112041. getBoundingInfo(): BoundingInfo;
  112042. /**
  112043. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  112044. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  112045. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  112046. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  112047. * @returns the current mesh
  112048. */
  112049. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  112050. /**
  112051. * Overwrite the current bounding info
  112052. * @param boundingInfo defines the new bounding info
  112053. * @returns the current mesh
  112054. */
  112055. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  112056. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  112057. get useBones(): boolean;
  112058. /** @hidden */
  112059. _preActivate(): void;
  112060. /** @hidden */
  112061. _preActivateForIntermediateRendering(renderId: number): void;
  112062. /** @hidden */
  112063. _activate(renderId: number, intermediateRendering: boolean): boolean;
  112064. /** @hidden */
  112065. _postActivate(): void;
  112066. /** @hidden */
  112067. _freeze(): void;
  112068. /** @hidden */
  112069. _unFreeze(): void;
  112070. /**
  112071. * Gets the current world matrix
  112072. * @returns a Matrix
  112073. */
  112074. getWorldMatrix(): Matrix;
  112075. /** @hidden */
  112076. _getWorldMatrixDeterminant(): number;
  112077. /**
  112078. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  112079. */
  112080. get isAnInstance(): boolean;
  112081. /**
  112082. * Gets a boolean indicating if this mesh has instances
  112083. */
  112084. get hasInstances(): boolean;
  112085. /**
  112086. * Gets a boolean indicating if this mesh has thin instances
  112087. */
  112088. get hasThinInstances(): boolean;
  112089. /**
  112090. * Perform relative position change from the point of view of behind the front of the mesh.
  112091. * This is performed taking into account the meshes current rotation, so you do not have to care.
  112092. * Supports definition of mesh facing forward or backward
  112093. * @param amountRight defines the distance on the right axis
  112094. * @param amountUp defines the distance on the up axis
  112095. * @param amountForward defines the distance on the forward axis
  112096. * @returns the current mesh
  112097. */
  112098. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  112099. /**
  112100. * Calculate relative position change from the point of view of behind the front of the mesh.
  112101. * This is performed taking into account the meshes current rotation, so you do not have to care.
  112102. * Supports definition of mesh facing forward or backward
  112103. * @param amountRight defines the distance on the right axis
  112104. * @param amountUp defines the distance on the up axis
  112105. * @param amountForward defines the distance on the forward axis
  112106. * @returns the new displacement vector
  112107. */
  112108. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  112109. /**
  112110. * Perform relative rotation change from the point of view of behind the front of the mesh.
  112111. * Supports definition of mesh facing forward or backward
  112112. * @param flipBack defines the flip
  112113. * @param twirlClockwise defines the twirl
  112114. * @param tiltRight defines the tilt
  112115. * @returns the current mesh
  112116. */
  112117. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  112118. /**
  112119. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  112120. * Supports definition of mesh facing forward or backward.
  112121. * @param flipBack defines the flip
  112122. * @param twirlClockwise defines the twirl
  112123. * @param tiltRight defines the tilt
  112124. * @returns the new rotation vector
  112125. */
  112126. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  112127. /**
  112128. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  112129. * This means the mesh underlying bounding box and sphere are recomputed.
  112130. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  112131. * @returns the current mesh
  112132. */
  112133. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  112134. /** @hidden */
  112135. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  112136. /** @hidden */
  112137. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  112138. /** @hidden */
  112139. _updateBoundingInfo(): AbstractMesh;
  112140. /** @hidden */
  112141. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  112142. /** @hidden */
  112143. protected _afterComputeWorldMatrix(): void;
  112144. /** @hidden */
  112145. get _effectiveMesh(): AbstractMesh;
  112146. /**
  112147. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  112148. * A mesh is in the frustum if its bounding box intersects the frustum
  112149. * @param frustumPlanes defines the frustum to test
  112150. * @returns true if the mesh is in the frustum planes
  112151. */
  112152. isInFrustum(frustumPlanes: Plane[]): boolean;
  112153. /**
  112154. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  112155. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  112156. * @param frustumPlanes defines the frustum to test
  112157. * @returns true if the mesh is completely in the frustum planes
  112158. */
  112159. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  112160. /**
  112161. * True if the mesh intersects another mesh or a SolidParticle object
  112162. * @param mesh defines a target mesh or SolidParticle to test
  112163. * @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)
  112164. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  112165. * @returns true if there is an intersection
  112166. */
  112167. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  112168. /**
  112169. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  112170. * @param point defines the point to test
  112171. * @returns true if there is an intersection
  112172. */
  112173. intersectsPoint(point: Vector3): boolean;
  112174. /**
  112175. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  112176. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112177. */
  112178. get checkCollisions(): boolean;
  112179. set checkCollisions(collisionEnabled: boolean);
  112180. /**
  112181. * Gets Collider object used to compute collisions (not physics)
  112182. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112183. */
  112184. get collider(): Nullable<Collider>;
  112185. /**
  112186. * Move the mesh using collision engine
  112187. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112188. * @param displacement defines the requested displacement vector
  112189. * @returns the current mesh
  112190. */
  112191. moveWithCollisions(displacement: Vector3): AbstractMesh;
  112192. private _onCollisionPositionChange;
  112193. /** @hidden */
  112194. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  112195. /** @hidden */
  112196. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  112197. /** @hidden */
  112198. _checkCollision(collider: Collider): AbstractMesh;
  112199. /** @hidden */
  112200. _generatePointsArray(): boolean;
  112201. /**
  112202. * Checks if the passed Ray intersects with the mesh
  112203. * @param ray defines the ray to use
  112204. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  112205. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  112206. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  112207. * @param worldToUse defines the world matrix to use to get the world coordinate of the intersection point
  112208. * @returns the picking info
  112209. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  112210. */
  112211. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean, worldToUse?: Matrix): PickingInfo;
  112212. /**
  112213. * Clones the current mesh
  112214. * @param name defines the mesh name
  112215. * @param newParent defines the new mesh parent
  112216. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  112217. * @returns the new mesh
  112218. */
  112219. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  112220. /**
  112221. * Disposes all the submeshes of the current meshnp
  112222. * @returns the current mesh
  112223. */
  112224. releaseSubMeshes(): AbstractMesh;
  112225. /**
  112226. * Releases resources associated with this abstract mesh.
  112227. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  112228. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  112229. */
  112230. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  112231. /**
  112232. * Adds the passed mesh as a child to the current mesh
  112233. * @param mesh defines the child mesh
  112234. * @returns the current mesh
  112235. */
  112236. addChild(mesh: AbstractMesh): AbstractMesh;
  112237. /**
  112238. * Removes the passed mesh from the current mesh children list
  112239. * @param mesh defines the child mesh
  112240. * @returns the current mesh
  112241. */
  112242. removeChild(mesh: AbstractMesh): AbstractMesh;
  112243. /** @hidden */
  112244. private _initFacetData;
  112245. /**
  112246. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  112247. * This method can be called within the render loop.
  112248. * 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
  112249. * @returns the current mesh
  112250. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112251. */
  112252. updateFacetData(): AbstractMesh;
  112253. /**
  112254. * Returns the facetLocalNormals array.
  112255. * The normals are expressed in the mesh local spac
  112256. * @returns an array of Vector3
  112257. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112258. */
  112259. getFacetLocalNormals(): Vector3[];
  112260. /**
  112261. * Returns the facetLocalPositions array.
  112262. * The facet positions are expressed in the mesh local space
  112263. * @returns an array of Vector3
  112264. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112265. */
  112266. getFacetLocalPositions(): Vector3[];
  112267. /**
  112268. * Returns the facetLocalPartioning array
  112269. * @returns an array of array of numbers
  112270. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112271. */
  112272. getFacetLocalPartitioning(): number[][];
  112273. /**
  112274. * Returns the i-th facet position in the world system.
  112275. * This method allocates a new Vector3 per call
  112276. * @param i defines the facet index
  112277. * @returns a new Vector3
  112278. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112279. */
  112280. getFacetPosition(i: number): Vector3;
  112281. /**
  112282. * Sets the reference Vector3 with the i-th facet position in the world system
  112283. * @param i defines the facet index
  112284. * @param ref defines the target vector
  112285. * @returns the current mesh
  112286. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112287. */
  112288. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  112289. /**
  112290. * Returns the i-th facet normal in the world system.
  112291. * This method allocates a new Vector3 per call
  112292. * @param i defines the facet index
  112293. * @returns a new Vector3
  112294. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112295. */
  112296. getFacetNormal(i: number): Vector3;
  112297. /**
  112298. * Sets the reference Vector3 with the i-th facet normal in the world system
  112299. * @param i defines the facet index
  112300. * @param ref defines the target vector
  112301. * @returns the current mesh
  112302. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112303. */
  112304. getFacetNormalToRef(i: number, ref: Vector3): this;
  112305. /**
  112306. * 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)
  112307. * @param x defines x coordinate
  112308. * @param y defines y coordinate
  112309. * @param z defines z coordinate
  112310. * @returns the array of facet indexes
  112311. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112312. */
  112313. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  112314. /**
  112315. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  112316. * @param projected sets as the (x,y,z) world projection on the facet
  112317. * @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
  112318. * @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
  112319. * @param x defines x coordinate
  112320. * @param y defines y coordinate
  112321. * @param z defines z coordinate
  112322. * @returns the face index if found (or null instead)
  112323. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112324. */
  112325. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  112326. /**
  112327. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  112328. * @param projected sets as the (x,y,z) local projection on the facet
  112329. * @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
  112330. * @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
  112331. * @param x defines x coordinate
  112332. * @param y defines y coordinate
  112333. * @param z defines z coordinate
  112334. * @returns the face index if found (or null instead)
  112335. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112336. */
  112337. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  112338. /**
  112339. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  112340. * @returns the parameters
  112341. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112342. */
  112343. getFacetDataParameters(): any;
  112344. /**
  112345. * Disables the feature FacetData and frees the related memory
  112346. * @returns the current mesh
  112347. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112348. */
  112349. disableFacetData(): AbstractMesh;
  112350. /**
  112351. * Updates the AbstractMesh indices array
  112352. * @param indices defines the data source
  112353. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  112354. * @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)
  112355. * @returns the current mesh
  112356. */
  112357. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  112358. /**
  112359. * Creates new normals data for the mesh
  112360. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  112361. * @returns the current mesh
  112362. */
  112363. createNormals(updatable: boolean): AbstractMesh;
  112364. /**
  112365. * Align the mesh with a normal
  112366. * @param normal defines the normal to use
  112367. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  112368. * @returns the current mesh
  112369. */
  112370. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  112371. /** @hidden */
  112372. _checkOcclusionQuery(): boolean;
  112373. /**
  112374. * Disables the mesh edge rendering mode
  112375. * @returns the currentAbstractMesh
  112376. */
  112377. disableEdgesRendering(): AbstractMesh;
  112378. /**
  112379. * Enables the edge rendering mode on the mesh.
  112380. * This mode makes the mesh edges visible
  112381. * @param epsilon defines the maximal distance between two angles to detect a face
  112382. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  112383. * @returns the currentAbstractMesh
  112384. * @see https://www.babylonjs-playground.com/#19O9TU#0
  112385. */
  112386. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  112387. /**
  112388. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  112389. * @returns an array of particle systems in the scene that use the mesh as an emitter
  112390. */
  112391. getConnectedParticleSystems(): IParticleSystem[];
  112392. }
  112393. }
  112394. declare module BABYLON {
  112395. /**
  112396. * Interface used to define ActionEvent
  112397. */
  112398. export interface IActionEvent {
  112399. /** The mesh or sprite that triggered the action */
  112400. source: any;
  112401. /** The X mouse cursor position at the time of the event */
  112402. pointerX: number;
  112403. /** The Y mouse cursor position at the time of the event */
  112404. pointerY: number;
  112405. /** The mesh that is currently pointed at (can be null) */
  112406. meshUnderPointer: Nullable<AbstractMesh>;
  112407. /** the original (browser) event that triggered the ActionEvent */
  112408. sourceEvent?: any;
  112409. /** additional data for the event */
  112410. additionalData?: any;
  112411. }
  112412. /**
  112413. * ActionEvent is the event being sent when an action is triggered.
  112414. */
  112415. export class ActionEvent implements IActionEvent {
  112416. /** The mesh or sprite that triggered the action */
  112417. source: any;
  112418. /** The X mouse cursor position at the time of the event */
  112419. pointerX: number;
  112420. /** The Y mouse cursor position at the time of the event */
  112421. pointerY: number;
  112422. /** The mesh that is currently pointed at (can be null) */
  112423. meshUnderPointer: Nullable<AbstractMesh>;
  112424. /** the original (browser) event that triggered the ActionEvent */
  112425. sourceEvent?: any;
  112426. /** additional data for the event */
  112427. additionalData?: any;
  112428. /**
  112429. * Creates a new ActionEvent
  112430. * @param source The mesh or sprite that triggered the action
  112431. * @param pointerX The X mouse cursor position at the time of the event
  112432. * @param pointerY The Y mouse cursor position at the time of the event
  112433. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  112434. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  112435. * @param additionalData additional data for the event
  112436. */
  112437. constructor(
  112438. /** The mesh or sprite that triggered the action */
  112439. source: any,
  112440. /** The X mouse cursor position at the time of the event */
  112441. pointerX: number,
  112442. /** The Y mouse cursor position at the time of the event */
  112443. pointerY: number,
  112444. /** The mesh that is currently pointed at (can be null) */
  112445. meshUnderPointer: Nullable<AbstractMesh>,
  112446. /** the original (browser) event that triggered the ActionEvent */
  112447. sourceEvent?: any,
  112448. /** additional data for the event */
  112449. additionalData?: any);
  112450. /**
  112451. * Helper function to auto-create an ActionEvent from a source mesh.
  112452. * @param source The source mesh that triggered the event
  112453. * @param evt The original (browser) event
  112454. * @param additionalData additional data for the event
  112455. * @returns the new ActionEvent
  112456. */
  112457. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  112458. /**
  112459. * Helper function to auto-create an ActionEvent from a source sprite
  112460. * @param source The source sprite that triggered the event
  112461. * @param scene Scene associated with the sprite
  112462. * @param evt The original (browser) event
  112463. * @param additionalData additional data for the event
  112464. * @returns the new ActionEvent
  112465. */
  112466. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  112467. /**
  112468. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  112469. * @param scene the scene where the event occurred
  112470. * @param evt The original (browser) event
  112471. * @returns the new ActionEvent
  112472. */
  112473. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  112474. /**
  112475. * Helper function to auto-create an ActionEvent from a primitive
  112476. * @param prim defines the target primitive
  112477. * @param pointerPos defines the pointer position
  112478. * @param evt The original (browser) event
  112479. * @param additionalData additional data for the event
  112480. * @returns the new ActionEvent
  112481. */
  112482. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  112483. }
  112484. }
  112485. declare module BABYLON {
  112486. /**
  112487. * Abstract class used to decouple action Manager from scene and meshes.
  112488. * Do not instantiate.
  112489. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  112490. */
  112491. export abstract class AbstractActionManager implements IDisposable {
  112492. /** Gets the list of active triggers */
  112493. static Triggers: {
  112494. [key: string]: number;
  112495. };
  112496. /** Gets the cursor to use when hovering items */
  112497. hoverCursor: string;
  112498. /** Gets the list of actions */
  112499. actions: IAction[];
  112500. /**
  112501. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  112502. */
  112503. isRecursive: boolean;
  112504. /**
  112505. * Releases all associated resources
  112506. */
  112507. abstract dispose(): void;
  112508. /**
  112509. * Does this action manager has pointer triggers
  112510. */
  112511. abstract get hasPointerTriggers(): boolean;
  112512. /**
  112513. * Does this action manager has pick triggers
  112514. */
  112515. abstract get hasPickTriggers(): boolean;
  112516. /**
  112517. * Process a specific trigger
  112518. * @param trigger defines the trigger to process
  112519. * @param evt defines the event details to be processed
  112520. */
  112521. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  112522. /**
  112523. * Does this action manager handles actions of any of the given triggers
  112524. * @param triggers defines the triggers to be tested
  112525. * @return a boolean indicating whether one (or more) of the triggers is handled
  112526. */
  112527. abstract hasSpecificTriggers(triggers: number[]): boolean;
  112528. /**
  112529. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  112530. * speed.
  112531. * @param triggerA defines the trigger to be tested
  112532. * @param triggerB defines the trigger to be tested
  112533. * @return a boolean indicating whether one (or more) of the triggers is handled
  112534. */
  112535. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  112536. /**
  112537. * Does this action manager handles actions of a given trigger
  112538. * @param trigger defines the trigger to be tested
  112539. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  112540. * @return whether the trigger is handled
  112541. */
  112542. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  112543. /**
  112544. * Serialize this manager to a JSON object
  112545. * @param name defines the property name to store this manager
  112546. * @returns a JSON representation of this manager
  112547. */
  112548. abstract serialize(name: string): any;
  112549. /**
  112550. * Registers an action to this action manager
  112551. * @param action defines the action to be registered
  112552. * @return the action amended (prepared) after registration
  112553. */
  112554. abstract registerAction(action: IAction): Nullable<IAction>;
  112555. /**
  112556. * Unregisters an action to this action manager
  112557. * @param action defines the action to be unregistered
  112558. * @return a boolean indicating whether the action has been unregistered
  112559. */
  112560. abstract unregisterAction(action: IAction): Boolean;
  112561. /**
  112562. * Does exist one action manager with at least one trigger
  112563. **/
  112564. static get HasTriggers(): boolean;
  112565. /**
  112566. * Does exist one action manager with at least one pick trigger
  112567. **/
  112568. static get HasPickTriggers(): boolean;
  112569. /**
  112570. * Does exist one action manager that handles actions of a given trigger
  112571. * @param trigger defines the trigger to be tested
  112572. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  112573. **/
  112574. static HasSpecificTrigger(trigger: number): boolean;
  112575. }
  112576. }
  112577. declare module BABYLON {
  112578. /**
  112579. * Defines how a node can be built from a string name.
  112580. */
  112581. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  112582. /**
  112583. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  112584. */
  112585. export class Node implements IBehaviorAware<Node> {
  112586. /** @hidden */
  112587. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  112588. private static _NodeConstructors;
  112589. /**
  112590. * Add a new node constructor
  112591. * @param type defines the type name of the node to construct
  112592. * @param constructorFunc defines the constructor function
  112593. */
  112594. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  112595. /**
  112596. * Returns a node constructor based on type name
  112597. * @param type defines the type name
  112598. * @param name defines the new node name
  112599. * @param scene defines the hosting scene
  112600. * @param options defines optional options to transmit to constructors
  112601. * @returns the new constructor or null
  112602. */
  112603. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  112604. /**
  112605. * Gets or sets the name of the node
  112606. */
  112607. name: string;
  112608. /**
  112609. * Gets or sets the id of the node
  112610. */
  112611. id: string;
  112612. /**
  112613. * Gets or sets the unique id of the node
  112614. */
  112615. uniqueId: number;
  112616. /**
  112617. * Gets or sets a string used to store user defined state for the node
  112618. */
  112619. state: string;
  112620. /**
  112621. * Gets or sets an object used to store user defined information for the node
  112622. */
  112623. metadata: any;
  112624. /**
  112625. * For internal use only. Please do not use.
  112626. */
  112627. reservedDataStore: any;
  112628. /**
  112629. * List of inspectable custom properties (used by the Inspector)
  112630. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  112631. */
  112632. inspectableCustomProperties: IInspectable[];
  112633. private _doNotSerialize;
  112634. /**
  112635. * Gets or sets a boolean used to define if the node must be serialized
  112636. */
  112637. get doNotSerialize(): boolean;
  112638. set doNotSerialize(value: boolean);
  112639. /** @hidden */
  112640. _isDisposed: boolean;
  112641. /**
  112642. * Gets a list of Animations associated with the node
  112643. */
  112644. animations: Animation[];
  112645. protected _ranges: {
  112646. [name: string]: Nullable<AnimationRange>;
  112647. };
  112648. /**
  112649. * Callback raised when the node is ready to be used
  112650. */
  112651. onReady: Nullable<(node: Node) => void>;
  112652. private _isEnabled;
  112653. private _isParentEnabled;
  112654. private _isReady;
  112655. /** @hidden */
  112656. _currentRenderId: number;
  112657. private _parentUpdateId;
  112658. /** @hidden */
  112659. _childUpdateId: number;
  112660. /** @hidden */
  112661. _waitingParentId: Nullable<string>;
  112662. /** @hidden */
  112663. _scene: Scene;
  112664. /** @hidden */
  112665. _cache: any;
  112666. private _parentNode;
  112667. private _children;
  112668. /** @hidden */
  112669. _worldMatrix: Matrix;
  112670. /** @hidden */
  112671. _worldMatrixDeterminant: number;
  112672. /** @hidden */
  112673. _worldMatrixDeterminantIsDirty: boolean;
  112674. /** @hidden */
  112675. private _sceneRootNodesIndex;
  112676. /**
  112677. * Gets a boolean indicating if the node has been disposed
  112678. * @returns true if the node was disposed
  112679. */
  112680. isDisposed(): boolean;
  112681. /**
  112682. * Gets or sets the parent of the node (without keeping the current position in the scene)
  112683. * @see https://doc.babylonjs.com/how_to/parenting
  112684. */
  112685. set parent(parent: Nullable<Node>);
  112686. get parent(): Nullable<Node>;
  112687. /** @hidden */
  112688. _addToSceneRootNodes(): void;
  112689. /** @hidden */
  112690. _removeFromSceneRootNodes(): void;
  112691. private _animationPropertiesOverride;
  112692. /**
  112693. * Gets or sets the animation properties override
  112694. */
  112695. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  112696. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  112697. /**
  112698. * Gets a string identifying the name of the class
  112699. * @returns "Node" string
  112700. */
  112701. getClassName(): string;
  112702. /** @hidden */
  112703. readonly _isNode: boolean;
  112704. /**
  112705. * An event triggered when the mesh is disposed
  112706. */
  112707. onDisposeObservable: Observable<Node>;
  112708. private _onDisposeObserver;
  112709. /**
  112710. * Sets a callback that will be raised when the node will be disposed
  112711. */
  112712. set onDispose(callback: () => void);
  112713. /**
  112714. * Creates a new Node
  112715. * @param name the name and id to be given to this node
  112716. * @param scene the scene this node will be added to
  112717. */
  112718. constructor(name: string, scene?: Nullable<Scene>);
  112719. /**
  112720. * Gets the scene of the node
  112721. * @returns a scene
  112722. */
  112723. getScene(): Scene;
  112724. /**
  112725. * Gets the engine of the node
  112726. * @returns a Engine
  112727. */
  112728. getEngine(): Engine;
  112729. private _behaviors;
  112730. /**
  112731. * Attach a behavior to the node
  112732. * @see https://doc.babylonjs.com/features/behaviour
  112733. * @param behavior defines the behavior to attach
  112734. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  112735. * @returns the current Node
  112736. */
  112737. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  112738. /**
  112739. * Remove an attached behavior
  112740. * @see https://doc.babylonjs.com/features/behaviour
  112741. * @param behavior defines the behavior to attach
  112742. * @returns the current Node
  112743. */
  112744. removeBehavior(behavior: Behavior<Node>): Node;
  112745. /**
  112746. * Gets the list of attached behaviors
  112747. * @see https://doc.babylonjs.com/features/behaviour
  112748. */
  112749. get behaviors(): Behavior<Node>[];
  112750. /**
  112751. * Gets an attached behavior by name
  112752. * @param name defines the name of the behavior to look for
  112753. * @see https://doc.babylonjs.com/features/behaviour
  112754. * @returns null if behavior was not found else the requested behavior
  112755. */
  112756. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  112757. /**
  112758. * Returns the latest update of the World matrix
  112759. * @returns a Matrix
  112760. */
  112761. getWorldMatrix(): Matrix;
  112762. /** @hidden */
  112763. _getWorldMatrixDeterminant(): number;
  112764. /**
  112765. * Returns directly the latest state of the mesh World matrix.
  112766. * A Matrix is returned.
  112767. */
  112768. get worldMatrixFromCache(): Matrix;
  112769. /** @hidden */
  112770. _initCache(): void;
  112771. /** @hidden */
  112772. updateCache(force?: boolean): void;
  112773. /** @hidden */
  112774. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  112775. /** @hidden */
  112776. _updateCache(ignoreParentClass?: boolean): void;
  112777. /** @hidden */
  112778. _isSynchronized(): boolean;
  112779. /** @hidden */
  112780. _markSyncedWithParent(): void;
  112781. /** @hidden */
  112782. isSynchronizedWithParent(): boolean;
  112783. /** @hidden */
  112784. isSynchronized(): boolean;
  112785. /**
  112786. * Is this node ready to be used/rendered
  112787. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  112788. * @return true if the node is ready
  112789. */
  112790. isReady(completeCheck?: boolean): boolean;
  112791. /**
  112792. * Is this node enabled?
  112793. * 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
  112794. * @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
  112795. * @return whether this node (and its parent) is enabled
  112796. */
  112797. isEnabled(checkAncestors?: boolean): boolean;
  112798. /** @hidden */
  112799. protected _syncParentEnabledState(): void;
  112800. /**
  112801. * Set the enabled state of this node
  112802. * @param value defines the new enabled state
  112803. */
  112804. setEnabled(value: boolean): void;
  112805. /**
  112806. * Is this node a descendant of the given node?
  112807. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  112808. * @param ancestor defines the parent node to inspect
  112809. * @returns a boolean indicating if this node is a descendant of the given node
  112810. */
  112811. isDescendantOf(ancestor: Node): boolean;
  112812. /** @hidden */
  112813. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  112814. /**
  112815. * Will return all nodes that have this node as ascendant
  112816. * @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
  112817. * @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
  112818. * @return all children nodes of all types
  112819. */
  112820. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  112821. /**
  112822. * Get all child-meshes of this node
  112823. * @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)
  112824. * @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
  112825. * @returns an array of AbstractMesh
  112826. */
  112827. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  112828. /**
  112829. * Get all direct children of this node
  112830. * @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
  112831. * @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)
  112832. * @returns an array of Node
  112833. */
  112834. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  112835. /** @hidden */
  112836. _setReady(state: boolean): void;
  112837. /**
  112838. * Get an animation by name
  112839. * @param name defines the name of the animation to look for
  112840. * @returns null if not found else the requested animation
  112841. */
  112842. getAnimationByName(name: string): Nullable<Animation>;
  112843. /**
  112844. * Creates an animation range for this node
  112845. * @param name defines the name of the range
  112846. * @param from defines the starting key
  112847. * @param to defines the end key
  112848. */
  112849. createAnimationRange(name: string, from: number, to: number): void;
  112850. /**
  112851. * Delete a specific animation range
  112852. * @param name defines the name of the range to delete
  112853. * @param deleteFrames defines if animation frames from the range must be deleted as well
  112854. */
  112855. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  112856. /**
  112857. * Get an animation range by name
  112858. * @param name defines the name of the animation range to look for
  112859. * @returns null if not found else the requested animation range
  112860. */
  112861. getAnimationRange(name: string): Nullable<AnimationRange>;
  112862. /**
  112863. * Gets the list of all animation ranges defined on this node
  112864. * @returns an array
  112865. */
  112866. getAnimationRanges(): Nullable<AnimationRange>[];
  112867. /**
  112868. * Will start the animation sequence
  112869. * @param name defines the range frames for animation sequence
  112870. * @param loop defines if the animation should loop (false by default)
  112871. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  112872. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  112873. * @returns the object created for this animation. If range does not exist, it will return null
  112874. */
  112875. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  112876. /**
  112877. * Serialize animation ranges into a JSON compatible object
  112878. * @returns serialization object
  112879. */
  112880. serializeAnimationRanges(): any;
  112881. /**
  112882. * Computes the world matrix of the node
  112883. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  112884. * @returns the world matrix
  112885. */
  112886. computeWorldMatrix(force?: boolean): Matrix;
  112887. /**
  112888. * Releases resources associated with this node.
  112889. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  112890. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  112891. */
  112892. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  112893. /**
  112894. * Parse animation range data from a serialization object and store them into a given node
  112895. * @param node defines where to store the animation ranges
  112896. * @param parsedNode defines the serialization object to read data from
  112897. * @param scene defines the hosting scene
  112898. */
  112899. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  112900. /**
  112901. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  112902. * @param includeDescendants Include bounding info from descendants as well (true by default)
  112903. * @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
  112904. * @returns the new bounding vectors
  112905. */
  112906. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  112907. min: Vector3;
  112908. max: Vector3;
  112909. };
  112910. }
  112911. }
  112912. declare module BABYLON {
  112913. /**
  112914. * @hidden
  112915. */
  112916. export class _IAnimationState {
  112917. key: number;
  112918. repeatCount: number;
  112919. workValue?: any;
  112920. loopMode?: number;
  112921. offsetValue?: any;
  112922. highLimitValue?: any;
  112923. }
  112924. /**
  112925. * Class used to store any kind of animation
  112926. */
  112927. export class Animation {
  112928. /**Name of the animation */
  112929. name: string;
  112930. /**Property to animate */
  112931. targetProperty: string;
  112932. /**The frames per second of the animation */
  112933. framePerSecond: number;
  112934. /**The data type of the animation */
  112935. dataType: number;
  112936. /**The loop mode of the animation */
  112937. loopMode?: number | undefined;
  112938. /**Specifies if blending should be enabled */
  112939. enableBlending?: boolean | undefined;
  112940. /**
  112941. * Use matrix interpolation instead of using direct key value when animating matrices
  112942. */
  112943. static AllowMatricesInterpolation: boolean;
  112944. /**
  112945. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  112946. */
  112947. static AllowMatrixDecomposeForInterpolation: boolean;
  112948. /** Define the Url to load snippets */
  112949. static SnippetUrl: string;
  112950. /** Snippet ID if the animation was created from the snippet server */
  112951. snippetId: string;
  112952. /**
  112953. * Stores the key frames of the animation
  112954. */
  112955. private _keys;
  112956. /**
  112957. * Stores the easing function of the animation
  112958. */
  112959. private _easingFunction;
  112960. /**
  112961. * @hidden Internal use only
  112962. */
  112963. _runtimeAnimations: RuntimeAnimation[];
  112964. /**
  112965. * The set of event that will be linked to this animation
  112966. */
  112967. private _events;
  112968. /**
  112969. * Stores an array of target property paths
  112970. */
  112971. targetPropertyPath: string[];
  112972. /**
  112973. * Stores the blending speed of the animation
  112974. */
  112975. blendingSpeed: number;
  112976. /**
  112977. * Stores the animation ranges for the animation
  112978. */
  112979. private _ranges;
  112980. /**
  112981. * @hidden Internal use
  112982. */
  112983. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  112984. /**
  112985. * Sets up an animation
  112986. * @param property The property to animate
  112987. * @param animationType The animation type to apply
  112988. * @param framePerSecond The frames per second of the animation
  112989. * @param easingFunction The easing function used in the animation
  112990. * @returns The created animation
  112991. */
  112992. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  112993. /**
  112994. * Create and start an animation on a node
  112995. * @param name defines the name of the global animation that will be run on all nodes
  112996. * @param node defines the root node where the animation will take place
  112997. * @param targetProperty defines property to animate
  112998. * @param framePerSecond defines the number of frame per second yo use
  112999. * @param totalFrame defines the number of frames in total
  113000. * @param from defines the initial value
  113001. * @param to defines the final value
  113002. * @param loopMode defines which loop mode you want to use (off by default)
  113003. * @param easingFunction defines the easing function to use (linear by default)
  113004. * @param onAnimationEnd defines the callback to call when animation end
  113005. * @returns the animatable created for this animation
  113006. */
  113007. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  113008. /**
  113009. * Create and start an animation on a node and its descendants
  113010. * @param name defines the name of the global animation that will be run on all nodes
  113011. * @param node defines the root node where the animation will take place
  113012. * @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
  113013. * @param targetProperty defines property to animate
  113014. * @param framePerSecond defines the number of frame per second to use
  113015. * @param totalFrame defines the number of frames in total
  113016. * @param from defines the initial value
  113017. * @param to defines the final value
  113018. * @param loopMode defines which loop mode you want to use (off by default)
  113019. * @param easingFunction defines the easing function to use (linear by default)
  113020. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  113021. * @returns the list of animatables created for all nodes
  113022. * @example https://www.babylonjs-playground.com/#MH0VLI
  113023. */
  113024. 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[]>;
  113025. /**
  113026. * Creates a new animation, merges it with the existing animations and starts it
  113027. * @param name Name of the animation
  113028. * @param node Node which contains the scene that begins the animations
  113029. * @param targetProperty Specifies which property to animate
  113030. * @param framePerSecond The frames per second of the animation
  113031. * @param totalFrame The total number of frames
  113032. * @param from The frame at the beginning of the animation
  113033. * @param to The frame at the end of the animation
  113034. * @param loopMode Specifies the loop mode of the animation
  113035. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  113036. * @param onAnimationEnd Callback to run once the animation is complete
  113037. * @returns Nullable animation
  113038. */
  113039. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  113040. /**
  113041. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  113042. * @param sourceAnimation defines the Animation containing keyframes to convert
  113043. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  113044. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  113045. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  113046. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  113047. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  113048. */
  113049. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  113050. /**
  113051. * Transition property of an host to the target Value
  113052. * @param property The property to transition
  113053. * @param targetValue The target Value of the property
  113054. * @param host The object where the property to animate belongs
  113055. * @param scene Scene used to run the animation
  113056. * @param frameRate Framerate (in frame/s) to use
  113057. * @param transition The transition type we want to use
  113058. * @param duration The duration of the animation, in milliseconds
  113059. * @param onAnimationEnd Callback trigger at the end of the animation
  113060. * @returns Nullable animation
  113061. */
  113062. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  113063. /**
  113064. * Return the array of runtime animations currently using this animation
  113065. */
  113066. get runtimeAnimations(): RuntimeAnimation[];
  113067. /**
  113068. * Specifies if any of the runtime animations are currently running
  113069. */
  113070. get hasRunningRuntimeAnimations(): boolean;
  113071. /**
  113072. * Initializes the animation
  113073. * @param name Name of the animation
  113074. * @param targetProperty Property to animate
  113075. * @param framePerSecond The frames per second of the animation
  113076. * @param dataType The data type of the animation
  113077. * @param loopMode The loop mode of the animation
  113078. * @param enableBlending Specifies if blending should be enabled
  113079. */
  113080. constructor(
  113081. /**Name of the animation */
  113082. name: string,
  113083. /**Property to animate */
  113084. targetProperty: string,
  113085. /**The frames per second of the animation */
  113086. framePerSecond: number,
  113087. /**The data type of the animation */
  113088. dataType: number,
  113089. /**The loop mode of the animation */
  113090. loopMode?: number | undefined,
  113091. /**Specifies if blending should be enabled */
  113092. enableBlending?: boolean | undefined);
  113093. /**
  113094. * Converts the animation to a string
  113095. * @param fullDetails support for multiple levels of logging within scene loading
  113096. * @returns String form of the animation
  113097. */
  113098. toString(fullDetails?: boolean): string;
  113099. /**
  113100. * Add an event to this animation
  113101. * @param event Event to add
  113102. */
  113103. addEvent(event: AnimationEvent): void;
  113104. /**
  113105. * Remove all events found at the given frame
  113106. * @param frame The frame to remove events from
  113107. */
  113108. removeEvents(frame: number): void;
  113109. /**
  113110. * Retrieves all the events from the animation
  113111. * @returns Events from the animation
  113112. */
  113113. getEvents(): AnimationEvent[];
  113114. /**
  113115. * Creates an animation range
  113116. * @param name Name of the animation range
  113117. * @param from Starting frame of the animation range
  113118. * @param to Ending frame of the animation
  113119. */
  113120. createRange(name: string, from: number, to: number): void;
  113121. /**
  113122. * Deletes an animation range by name
  113123. * @param name Name of the animation range to delete
  113124. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  113125. */
  113126. deleteRange(name: string, deleteFrames?: boolean): void;
  113127. /**
  113128. * Gets the animation range by name, or null if not defined
  113129. * @param name Name of the animation range
  113130. * @returns Nullable animation range
  113131. */
  113132. getRange(name: string): Nullable<AnimationRange>;
  113133. /**
  113134. * Gets the key frames from the animation
  113135. * @returns The key frames of the animation
  113136. */
  113137. getKeys(): Array<IAnimationKey>;
  113138. /**
  113139. * Gets the highest frame rate of the animation
  113140. * @returns Highest frame rate of the animation
  113141. */
  113142. getHighestFrame(): number;
  113143. /**
  113144. * Gets the easing function of the animation
  113145. * @returns Easing function of the animation
  113146. */
  113147. getEasingFunction(): IEasingFunction;
  113148. /**
  113149. * Sets the easing function of the animation
  113150. * @param easingFunction A custom mathematical formula for animation
  113151. */
  113152. setEasingFunction(easingFunction: EasingFunction): void;
  113153. /**
  113154. * Interpolates a scalar linearly
  113155. * @param startValue Start value of the animation curve
  113156. * @param endValue End value of the animation curve
  113157. * @param gradient Scalar amount to interpolate
  113158. * @returns Interpolated scalar value
  113159. */
  113160. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  113161. /**
  113162. * Interpolates a scalar cubically
  113163. * @param startValue Start value of the animation curve
  113164. * @param outTangent End tangent of the animation
  113165. * @param endValue End value of the animation curve
  113166. * @param inTangent Start tangent of the animation curve
  113167. * @param gradient Scalar amount to interpolate
  113168. * @returns Interpolated scalar value
  113169. */
  113170. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  113171. /**
  113172. * Interpolates a quaternion using a spherical linear interpolation
  113173. * @param startValue Start value of the animation curve
  113174. * @param endValue End value of the animation curve
  113175. * @param gradient Scalar amount to interpolate
  113176. * @returns Interpolated quaternion value
  113177. */
  113178. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  113179. /**
  113180. * Interpolates a quaternion cubically
  113181. * @param startValue Start value of the animation curve
  113182. * @param outTangent End tangent of the animation curve
  113183. * @param endValue End value of the animation curve
  113184. * @param inTangent Start tangent of the animation curve
  113185. * @param gradient Scalar amount to interpolate
  113186. * @returns Interpolated quaternion value
  113187. */
  113188. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  113189. /**
  113190. * Interpolates a Vector3 linearl
  113191. * @param startValue Start value of the animation curve
  113192. * @param endValue End value of the animation curve
  113193. * @param gradient Scalar amount to interpolate
  113194. * @returns Interpolated scalar value
  113195. */
  113196. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  113197. /**
  113198. * Interpolates a Vector3 cubically
  113199. * @param startValue Start value of the animation curve
  113200. * @param outTangent End tangent of the animation
  113201. * @param endValue End value of the animation curve
  113202. * @param inTangent Start tangent of the animation curve
  113203. * @param gradient Scalar amount to interpolate
  113204. * @returns InterpolatedVector3 value
  113205. */
  113206. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  113207. /**
  113208. * Interpolates a Vector2 linearly
  113209. * @param startValue Start value of the animation curve
  113210. * @param endValue End value of the animation curve
  113211. * @param gradient Scalar amount to interpolate
  113212. * @returns Interpolated Vector2 value
  113213. */
  113214. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  113215. /**
  113216. * Interpolates a Vector2 cubically
  113217. * @param startValue Start value of the animation curve
  113218. * @param outTangent End tangent of the animation
  113219. * @param endValue End value of the animation curve
  113220. * @param inTangent Start tangent of the animation curve
  113221. * @param gradient Scalar amount to interpolate
  113222. * @returns Interpolated Vector2 value
  113223. */
  113224. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  113225. /**
  113226. * Interpolates a size linearly
  113227. * @param startValue Start value of the animation curve
  113228. * @param endValue End value of the animation curve
  113229. * @param gradient Scalar amount to interpolate
  113230. * @returns Interpolated Size value
  113231. */
  113232. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  113233. /**
  113234. * Interpolates a Color3 linearly
  113235. * @param startValue Start value of the animation curve
  113236. * @param endValue End value of the animation curve
  113237. * @param gradient Scalar amount to interpolate
  113238. * @returns Interpolated Color3 value
  113239. */
  113240. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  113241. /**
  113242. * Interpolates a Color4 linearly
  113243. * @param startValue Start value of the animation curve
  113244. * @param endValue End value of the animation curve
  113245. * @param gradient Scalar amount to interpolate
  113246. * @returns Interpolated Color3 value
  113247. */
  113248. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  113249. /**
  113250. * @hidden Internal use only
  113251. */
  113252. _getKeyValue(value: any): any;
  113253. /**
  113254. * @hidden Internal use only
  113255. */
  113256. _interpolate(currentFrame: number, state: _IAnimationState): any;
  113257. /**
  113258. * Defines the function to use to interpolate matrices
  113259. * @param startValue defines the start matrix
  113260. * @param endValue defines the end matrix
  113261. * @param gradient defines the gradient between both matrices
  113262. * @param result defines an optional target matrix where to store the interpolation
  113263. * @returns the interpolated matrix
  113264. */
  113265. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  113266. /**
  113267. * Makes a copy of the animation
  113268. * @returns Cloned animation
  113269. */
  113270. clone(): Animation;
  113271. /**
  113272. * Sets the key frames of the animation
  113273. * @param values The animation key frames to set
  113274. */
  113275. setKeys(values: Array<IAnimationKey>): void;
  113276. /**
  113277. * Serializes the animation to an object
  113278. * @returns Serialized object
  113279. */
  113280. serialize(): any;
  113281. /**
  113282. * Float animation type
  113283. */
  113284. static readonly ANIMATIONTYPE_FLOAT: number;
  113285. /**
  113286. * Vector3 animation type
  113287. */
  113288. static readonly ANIMATIONTYPE_VECTOR3: number;
  113289. /**
  113290. * Quaternion animation type
  113291. */
  113292. static readonly ANIMATIONTYPE_QUATERNION: number;
  113293. /**
  113294. * Matrix animation type
  113295. */
  113296. static readonly ANIMATIONTYPE_MATRIX: number;
  113297. /**
  113298. * Color3 animation type
  113299. */
  113300. static readonly ANIMATIONTYPE_COLOR3: number;
  113301. /**
  113302. * Color3 animation type
  113303. */
  113304. static readonly ANIMATIONTYPE_COLOR4: number;
  113305. /**
  113306. * Vector2 animation type
  113307. */
  113308. static readonly ANIMATIONTYPE_VECTOR2: number;
  113309. /**
  113310. * Size animation type
  113311. */
  113312. static readonly ANIMATIONTYPE_SIZE: number;
  113313. /**
  113314. * Relative Loop Mode
  113315. */
  113316. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  113317. /**
  113318. * Cycle Loop Mode
  113319. */
  113320. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  113321. /**
  113322. * Constant Loop Mode
  113323. */
  113324. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  113325. /** @hidden */
  113326. static _UniversalLerp(left: any, right: any, amount: number): any;
  113327. /**
  113328. * Parses an animation object and creates an animation
  113329. * @param parsedAnimation Parsed animation object
  113330. * @returns Animation object
  113331. */
  113332. static Parse(parsedAnimation: any): Animation;
  113333. /**
  113334. * Appends the serialized animations from the source animations
  113335. * @param source Source containing the animations
  113336. * @param destination Target to store the animations
  113337. */
  113338. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  113339. /**
  113340. * Creates a new animation or an array of animations from a snippet saved in a remote file
  113341. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  113342. * @param url defines the url to load from
  113343. * @returns a promise that will resolve to the new animation or an array of animations
  113344. */
  113345. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  113346. /**
  113347. * Creates an animation or an array of animations from a snippet saved by the Inspector
  113348. * @param snippetId defines the snippet to load
  113349. * @returns a promise that will resolve to the new animation or a new array of animations
  113350. */
  113351. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  113352. }
  113353. }
  113354. declare module BABYLON {
  113355. /**
  113356. * Interface containing an array of animations
  113357. */
  113358. export interface IAnimatable {
  113359. /**
  113360. * Array of animations
  113361. */
  113362. animations: Nullable<Array<Animation>>;
  113363. }
  113364. }
  113365. declare module BABYLON {
  113366. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  113367. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113368. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113369. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113370. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113371. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113372. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113373. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113374. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113375. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113376. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113377. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113378. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113379. /**
  113380. * Decorator used to define property that can be serialized as reference to a camera
  113381. * @param sourceName defines the name of the property to decorate
  113382. */
  113383. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113384. /**
  113385. * Class used to help serialization objects
  113386. */
  113387. export class SerializationHelper {
  113388. /** @hidden */
  113389. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  113390. /** @hidden */
  113391. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  113392. /** @hidden */
  113393. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  113394. /** @hidden */
  113395. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  113396. /**
  113397. * Appends the serialized animations from the source animations
  113398. * @param source Source containing the animations
  113399. * @param destination Target to store the animations
  113400. */
  113401. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  113402. /**
  113403. * Static function used to serialized a specific entity
  113404. * @param entity defines the entity to serialize
  113405. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  113406. * @returns a JSON compatible object representing the serialization of the entity
  113407. */
  113408. static Serialize<T>(entity: T, serializationObject?: any): any;
  113409. /**
  113410. * Creates a new entity from a serialization data object
  113411. * @param creationFunction defines a function used to instanciated the new entity
  113412. * @param source defines the source serialization data
  113413. * @param scene defines the hosting scene
  113414. * @param rootUrl defines the root url for resources
  113415. * @returns a new entity
  113416. */
  113417. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  113418. /**
  113419. * Clones an object
  113420. * @param creationFunction defines the function used to instanciate the new object
  113421. * @param source defines the source object
  113422. * @returns the cloned object
  113423. */
  113424. static Clone<T>(creationFunction: () => T, source: T): T;
  113425. /**
  113426. * Instanciates a new object based on a source one (some data will be shared between both object)
  113427. * @param creationFunction defines the function used to instanciate the new object
  113428. * @param source defines the source object
  113429. * @returns the new object
  113430. */
  113431. static Instanciate<T>(creationFunction: () => T, source: T): T;
  113432. }
  113433. }
  113434. declare module BABYLON {
  113435. /**
  113436. * Base class of all the textures in babylon.
  113437. * It groups all the common properties the materials, post process, lights... might need
  113438. * in order to make a correct use of the texture.
  113439. */
  113440. export class BaseTexture implements IAnimatable {
  113441. /**
  113442. * Default anisotropic filtering level for the application.
  113443. * It is set to 4 as a good tradeoff between perf and quality.
  113444. */
  113445. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  113446. /**
  113447. * Gets or sets the unique id of the texture
  113448. */
  113449. uniqueId: number;
  113450. /**
  113451. * Define the name of the texture.
  113452. */
  113453. name: string;
  113454. /**
  113455. * Gets or sets an object used to store user defined information.
  113456. */
  113457. metadata: any;
  113458. /**
  113459. * For internal use only. Please do not use.
  113460. */
  113461. reservedDataStore: any;
  113462. private _hasAlpha;
  113463. /**
  113464. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  113465. */
  113466. set hasAlpha(value: boolean);
  113467. get hasAlpha(): boolean;
  113468. /**
  113469. * Defines if the alpha value should be determined via the rgb values.
  113470. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  113471. */
  113472. getAlphaFromRGB: boolean;
  113473. /**
  113474. * Intensity or strength of the texture.
  113475. * It is commonly used by materials to fine tune the intensity of the texture
  113476. */
  113477. level: number;
  113478. /**
  113479. * Define the UV chanel to use starting from 0 and defaulting to 0.
  113480. * This is part of the texture as textures usually maps to one uv set.
  113481. */
  113482. coordinatesIndex: number;
  113483. protected _coordinatesMode: number;
  113484. /**
  113485. * How a texture is mapped.
  113486. *
  113487. * | Value | Type | Description |
  113488. * | ----- | ----------------------------------- | ----------- |
  113489. * | 0 | EXPLICIT_MODE | |
  113490. * | 1 | SPHERICAL_MODE | |
  113491. * | 2 | PLANAR_MODE | |
  113492. * | 3 | CUBIC_MODE | |
  113493. * | 4 | PROJECTION_MODE | |
  113494. * | 5 | SKYBOX_MODE | |
  113495. * | 6 | INVCUBIC_MODE | |
  113496. * | 7 | EQUIRECTANGULAR_MODE | |
  113497. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  113498. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  113499. */
  113500. set coordinatesMode(value: number);
  113501. get coordinatesMode(): number;
  113502. private _wrapU;
  113503. /**
  113504. * | Value | Type | Description |
  113505. * | ----- | ------------------ | ----------- |
  113506. * | 0 | CLAMP_ADDRESSMODE | |
  113507. * | 1 | WRAP_ADDRESSMODE | |
  113508. * | 2 | MIRROR_ADDRESSMODE | |
  113509. */
  113510. get wrapU(): number;
  113511. set wrapU(value: number);
  113512. private _wrapV;
  113513. /**
  113514. * | Value | Type | Description |
  113515. * | ----- | ------------------ | ----------- |
  113516. * | 0 | CLAMP_ADDRESSMODE | |
  113517. * | 1 | WRAP_ADDRESSMODE | |
  113518. * | 2 | MIRROR_ADDRESSMODE | |
  113519. */
  113520. get wrapV(): number;
  113521. set wrapV(value: number);
  113522. /**
  113523. * | Value | Type | Description |
  113524. * | ----- | ------------------ | ----------- |
  113525. * | 0 | CLAMP_ADDRESSMODE | |
  113526. * | 1 | WRAP_ADDRESSMODE | |
  113527. * | 2 | MIRROR_ADDRESSMODE | |
  113528. */
  113529. wrapR: number;
  113530. /**
  113531. * With compliant hardware and browser (supporting anisotropic filtering)
  113532. * this defines the level of anisotropic filtering in the texture.
  113533. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  113534. */
  113535. anisotropicFilteringLevel: number;
  113536. /**
  113537. * Define if the texture is a cube texture or if false a 2d texture.
  113538. */
  113539. get isCube(): boolean;
  113540. set isCube(value: boolean);
  113541. /**
  113542. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  113543. */
  113544. get is3D(): boolean;
  113545. set is3D(value: boolean);
  113546. /**
  113547. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  113548. */
  113549. get is2DArray(): boolean;
  113550. set is2DArray(value: boolean);
  113551. /**
  113552. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  113553. * HDR texture are usually stored in linear space.
  113554. * This only impacts the PBR and Background materials
  113555. */
  113556. gammaSpace: boolean;
  113557. /**
  113558. * Gets or sets whether or not the texture contains RGBD data.
  113559. */
  113560. get isRGBD(): boolean;
  113561. set isRGBD(value: boolean);
  113562. /**
  113563. * Is Z inverted in the texture (useful in a cube texture).
  113564. */
  113565. invertZ: boolean;
  113566. /**
  113567. * Are mip maps generated for this texture or not.
  113568. */
  113569. get noMipmap(): boolean;
  113570. /**
  113571. * @hidden
  113572. */
  113573. lodLevelInAlpha: boolean;
  113574. /**
  113575. * With prefiltered texture, defined the offset used during the prefiltering steps.
  113576. */
  113577. get lodGenerationOffset(): number;
  113578. set lodGenerationOffset(value: number);
  113579. /**
  113580. * With prefiltered texture, defined the scale used during the prefiltering steps.
  113581. */
  113582. get lodGenerationScale(): number;
  113583. set lodGenerationScale(value: number);
  113584. /**
  113585. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  113586. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  113587. * average roughness values.
  113588. */
  113589. get linearSpecularLOD(): boolean;
  113590. set linearSpecularLOD(value: boolean);
  113591. /**
  113592. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  113593. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  113594. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  113595. */
  113596. get irradianceTexture(): Nullable<BaseTexture>;
  113597. set irradianceTexture(value: Nullable<BaseTexture>);
  113598. /**
  113599. * Define if the texture is a render target.
  113600. */
  113601. isRenderTarget: boolean;
  113602. /**
  113603. * Define the unique id of the texture in the scene.
  113604. */
  113605. get uid(): string;
  113606. /** @hidden */
  113607. _prefiltered: boolean;
  113608. /**
  113609. * Return a string representation of the texture.
  113610. * @returns the texture as a string
  113611. */
  113612. toString(): string;
  113613. /**
  113614. * Get the class name of the texture.
  113615. * @returns "BaseTexture"
  113616. */
  113617. getClassName(): string;
  113618. /**
  113619. * Define the list of animation attached to the texture.
  113620. */
  113621. animations: Animation[];
  113622. /**
  113623. * An event triggered when the texture is disposed.
  113624. */
  113625. onDisposeObservable: Observable<BaseTexture>;
  113626. private _onDisposeObserver;
  113627. /**
  113628. * Callback triggered when the texture has been disposed.
  113629. * Kept for back compatibility, you can use the onDisposeObservable instead.
  113630. */
  113631. set onDispose(callback: () => void);
  113632. /**
  113633. * Define the current state of the loading sequence when in delayed load mode.
  113634. */
  113635. delayLoadState: number;
  113636. protected _scene: Nullable<Scene>;
  113637. protected _engine: Nullable<ThinEngine>;
  113638. /** @hidden */
  113639. _texture: Nullable<InternalTexture>;
  113640. private _uid;
  113641. /**
  113642. * Define if the texture is preventinga material to render or not.
  113643. * If not and the texture is not ready, the engine will use a default black texture instead.
  113644. */
  113645. get isBlocking(): boolean;
  113646. /**
  113647. * Instantiates a new BaseTexture.
  113648. * Base class of all the textures in babylon.
  113649. * It groups all the common properties the materials, post process, lights... might need
  113650. * in order to make a correct use of the texture.
  113651. * @param sceneOrEngine Define the scene or engine the texture blongs to
  113652. */
  113653. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  113654. /**
  113655. * Get the scene the texture belongs to.
  113656. * @returns the scene or null if undefined
  113657. */
  113658. getScene(): Nullable<Scene>;
  113659. /** @hidden */
  113660. protected _getEngine(): Nullable<ThinEngine>;
  113661. /**
  113662. * Get the texture transform matrix used to offset tile the texture for istance.
  113663. * @returns the transformation matrix
  113664. */
  113665. getTextureMatrix(): Matrix;
  113666. /**
  113667. * Get the texture reflection matrix used to rotate/transform the reflection.
  113668. * @returns the reflection matrix
  113669. */
  113670. getReflectionTextureMatrix(): Matrix;
  113671. /**
  113672. * Get the underlying lower level texture from Babylon.
  113673. * @returns the insternal texture
  113674. */
  113675. getInternalTexture(): Nullable<InternalTexture>;
  113676. /**
  113677. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  113678. * @returns true if ready or not blocking
  113679. */
  113680. isReadyOrNotBlocking(): boolean;
  113681. /**
  113682. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  113683. * @returns true if fully ready
  113684. */
  113685. isReady(): boolean;
  113686. private _cachedSize;
  113687. /**
  113688. * Get the size of the texture.
  113689. * @returns the texture size.
  113690. */
  113691. getSize(): ISize;
  113692. /**
  113693. * Get the base size of the texture.
  113694. * It can be different from the size if the texture has been resized for POT for instance
  113695. * @returns the base size
  113696. */
  113697. getBaseSize(): ISize;
  113698. /**
  113699. * Update the sampling mode of the texture.
  113700. * Default is Trilinear mode.
  113701. *
  113702. * | Value | Type | Description |
  113703. * | ----- | ------------------ | ----------- |
  113704. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  113705. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  113706. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  113707. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  113708. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  113709. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  113710. * | 7 | NEAREST_LINEAR | |
  113711. * | 8 | NEAREST_NEAREST | |
  113712. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  113713. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  113714. * | 11 | LINEAR_LINEAR | |
  113715. * | 12 | LINEAR_NEAREST | |
  113716. *
  113717. * > _mag_: magnification filter (close to the viewer)
  113718. * > _min_: minification filter (far from the viewer)
  113719. * > _mip_: filter used between mip map levels
  113720. *@param samplingMode Define the new sampling mode of the texture
  113721. */
  113722. updateSamplingMode(samplingMode: number): void;
  113723. /**
  113724. * Scales the texture if is `canRescale()`
  113725. * @param ratio the resize factor we want to use to rescale
  113726. */
  113727. scale(ratio: number): void;
  113728. /**
  113729. * Get if the texture can rescale.
  113730. */
  113731. get canRescale(): boolean;
  113732. /** @hidden */
  113733. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  113734. /** @hidden */
  113735. _rebuild(): void;
  113736. /**
  113737. * Triggers the load sequence in delayed load mode.
  113738. */
  113739. delayLoad(): void;
  113740. /**
  113741. * Clones the texture.
  113742. * @returns the cloned texture
  113743. */
  113744. clone(): Nullable<BaseTexture>;
  113745. /**
  113746. * Get the texture underlying type (INT, FLOAT...)
  113747. */
  113748. get textureType(): number;
  113749. /**
  113750. * Get the texture underlying format (RGB, RGBA...)
  113751. */
  113752. get textureFormat(): number;
  113753. /**
  113754. * Indicates that textures need to be re-calculated for all materials
  113755. */
  113756. protected _markAllSubMeshesAsTexturesDirty(): void;
  113757. /**
  113758. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  113759. * This will returns an RGBA array buffer containing either in values (0-255) or
  113760. * float values (0-1) depending of the underlying buffer type.
  113761. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  113762. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  113763. * @param buffer defines a user defined buffer to fill with data (can be null)
  113764. * @returns The Array buffer containing the pixels data.
  113765. */
  113766. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  113767. /**
  113768. * Release and destroy the underlying lower level texture aka internalTexture.
  113769. */
  113770. releaseInternalTexture(): void;
  113771. /** @hidden */
  113772. get _lodTextureHigh(): Nullable<BaseTexture>;
  113773. /** @hidden */
  113774. get _lodTextureMid(): Nullable<BaseTexture>;
  113775. /** @hidden */
  113776. get _lodTextureLow(): Nullable<BaseTexture>;
  113777. /**
  113778. * Dispose the texture and release its associated resources.
  113779. */
  113780. dispose(): void;
  113781. /**
  113782. * Serialize the texture into a JSON representation that can be parsed later on.
  113783. * @returns the JSON representation of the texture
  113784. */
  113785. serialize(): any;
  113786. /**
  113787. * Helper function to be called back once a list of texture contains only ready textures.
  113788. * @param textures Define the list of textures to wait for
  113789. * @param callback Define the callback triggered once the entire list will be ready
  113790. */
  113791. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  113792. private static _isScene;
  113793. }
  113794. }
  113795. declare module BABYLON {
  113796. /**
  113797. * Options to be used when creating an effect.
  113798. */
  113799. export interface IEffectCreationOptions {
  113800. /**
  113801. * Atrributes that will be used in the shader.
  113802. */
  113803. attributes: string[];
  113804. /**
  113805. * Uniform varible names that will be set in the shader.
  113806. */
  113807. uniformsNames: string[];
  113808. /**
  113809. * Uniform buffer variable names that will be set in the shader.
  113810. */
  113811. uniformBuffersNames: string[];
  113812. /**
  113813. * Sampler texture variable names that will be set in the shader.
  113814. */
  113815. samplers: string[];
  113816. /**
  113817. * Define statements that will be set in the shader.
  113818. */
  113819. defines: any;
  113820. /**
  113821. * Possible fallbacks for this effect to improve performance when needed.
  113822. */
  113823. fallbacks: Nullable<IEffectFallbacks>;
  113824. /**
  113825. * Callback that will be called when the shader is compiled.
  113826. */
  113827. onCompiled: Nullable<(effect: Effect) => void>;
  113828. /**
  113829. * Callback that will be called if an error occurs during shader compilation.
  113830. */
  113831. onError: Nullable<(effect: Effect, errors: string) => void>;
  113832. /**
  113833. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  113834. */
  113835. indexParameters?: any;
  113836. /**
  113837. * Max number of lights that can be used in the shader.
  113838. */
  113839. maxSimultaneousLights?: number;
  113840. /**
  113841. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  113842. */
  113843. transformFeedbackVaryings?: Nullable<string[]>;
  113844. /**
  113845. * 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
  113846. */
  113847. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  113848. /**
  113849. * Is this effect rendering to several color attachments ?
  113850. */
  113851. multiTarget?: boolean;
  113852. }
  113853. /**
  113854. * Effect containing vertex and fragment shader that can be executed on an object.
  113855. */
  113856. export class Effect implements IDisposable {
  113857. /**
  113858. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  113859. */
  113860. static ShadersRepository: string;
  113861. /**
  113862. * Enable logging of the shader code when a compilation error occurs
  113863. */
  113864. static LogShaderCodeOnCompilationError: boolean;
  113865. /**
  113866. * Name of the effect.
  113867. */
  113868. name: any;
  113869. /**
  113870. * String container all the define statements that should be set on the shader.
  113871. */
  113872. defines: string;
  113873. /**
  113874. * Callback that will be called when the shader is compiled.
  113875. */
  113876. onCompiled: Nullable<(effect: Effect) => void>;
  113877. /**
  113878. * Callback that will be called if an error occurs during shader compilation.
  113879. */
  113880. onError: Nullable<(effect: Effect, errors: string) => void>;
  113881. /**
  113882. * Callback that will be called when effect is bound.
  113883. */
  113884. onBind: Nullable<(effect: Effect) => void>;
  113885. /**
  113886. * Unique ID of the effect.
  113887. */
  113888. uniqueId: number;
  113889. /**
  113890. * Observable that will be called when the shader is compiled.
  113891. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  113892. */
  113893. onCompileObservable: Observable<Effect>;
  113894. /**
  113895. * Observable that will be called if an error occurs during shader compilation.
  113896. */
  113897. onErrorObservable: Observable<Effect>;
  113898. /** @hidden */
  113899. _onBindObservable: Nullable<Observable<Effect>>;
  113900. /**
  113901. * @hidden
  113902. * Specifies if the effect was previously ready
  113903. */
  113904. _wasPreviouslyReady: boolean;
  113905. /**
  113906. * Observable that will be called when effect is bound.
  113907. */
  113908. get onBindObservable(): Observable<Effect>;
  113909. /** @hidden */
  113910. _bonesComputationForcedToCPU: boolean;
  113911. /** @hidden */
  113912. _multiTarget: boolean;
  113913. private static _uniqueIdSeed;
  113914. private _engine;
  113915. private _uniformBuffersNames;
  113916. private _uniformBuffersNamesList;
  113917. private _uniformsNames;
  113918. private _samplerList;
  113919. private _samplers;
  113920. private _isReady;
  113921. private _compilationError;
  113922. private _allFallbacksProcessed;
  113923. private _attributesNames;
  113924. private _attributes;
  113925. private _attributeLocationByName;
  113926. private _uniforms;
  113927. /**
  113928. * Key for the effect.
  113929. * @hidden
  113930. */
  113931. _key: string;
  113932. private _indexParameters;
  113933. private _fallbacks;
  113934. private _vertexSourceCode;
  113935. private _fragmentSourceCode;
  113936. private _vertexSourceCodeOverride;
  113937. private _fragmentSourceCodeOverride;
  113938. private _transformFeedbackVaryings;
  113939. /**
  113940. * Compiled shader to webGL program.
  113941. * @hidden
  113942. */
  113943. _pipelineContext: Nullable<IPipelineContext>;
  113944. private _valueCache;
  113945. private static _baseCache;
  113946. /**
  113947. * Instantiates an effect.
  113948. * An effect can be used to create/manage/execute vertex and fragment shaders.
  113949. * @param baseName Name of the effect.
  113950. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  113951. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  113952. * @param samplers List of sampler variables that will be passed to the shader.
  113953. * @param engine Engine to be used to render the effect
  113954. * @param defines Define statements to be added to the shader.
  113955. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  113956. * @param onCompiled Callback that will be called when the shader is compiled.
  113957. * @param onError Callback that will be called if an error occurs during shader compilation.
  113958. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  113959. */
  113960. 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);
  113961. private _useFinalCode;
  113962. /**
  113963. * Unique key for this effect
  113964. */
  113965. get key(): string;
  113966. /**
  113967. * If the effect has been compiled and prepared.
  113968. * @returns if the effect is compiled and prepared.
  113969. */
  113970. isReady(): boolean;
  113971. private _isReadyInternal;
  113972. /**
  113973. * The engine the effect was initialized with.
  113974. * @returns the engine.
  113975. */
  113976. getEngine(): Engine;
  113977. /**
  113978. * The pipeline context for this effect
  113979. * @returns the associated pipeline context
  113980. */
  113981. getPipelineContext(): Nullable<IPipelineContext>;
  113982. /**
  113983. * The set of names of attribute variables for the shader.
  113984. * @returns An array of attribute names.
  113985. */
  113986. getAttributesNames(): string[];
  113987. /**
  113988. * Returns the attribute at the given index.
  113989. * @param index The index of the attribute.
  113990. * @returns The location of the attribute.
  113991. */
  113992. getAttributeLocation(index: number): number;
  113993. /**
  113994. * Returns the attribute based on the name of the variable.
  113995. * @param name of the attribute to look up.
  113996. * @returns the attribute location.
  113997. */
  113998. getAttributeLocationByName(name: string): number;
  113999. /**
  114000. * The number of attributes.
  114001. * @returns the numnber of attributes.
  114002. */
  114003. getAttributesCount(): number;
  114004. /**
  114005. * Gets the index of a uniform variable.
  114006. * @param uniformName of the uniform to look up.
  114007. * @returns the index.
  114008. */
  114009. getUniformIndex(uniformName: string): number;
  114010. /**
  114011. * Returns the attribute based on the name of the variable.
  114012. * @param uniformName of the uniform to look up.
  114013. * @returns the location of the uniform.
  114014. */
  114015. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  114016. /**
  114017. * Returns an array of sampler variable names
  114018. * @returns The array of sampler variable names.
  114019. */
  114020. getSamplers(): string[];
  114021. /**
  114022. * Returns an array of uniform variable names
  114023. * @returns The array of uniform variable names.
  114024. */
  114025. getUniformNames(): string[];
  114026. /**
  114027. * Returns an array of uniform buffer variable names
  114028. * @returns The array of uniform buffer variable names.
  114029. */
  114030. getUniformBuffersNames(): string[];
  114031. /**
  114032. * Returns the index parameters used to create the effect
  114033. * @returns The index parameters object
  114034. */
  114035. getIndexParameters(): any;
  114036. /**
  114037. * The error from the last compilation.
  114038. * @returns the error string.
  114039. */
  114040. getCompilationError(): string;
  114041. /**
  114042. * Gets a boolean indicating that all fallbacks were used during compilation
  114043. * @returns true if all fallbacks were used
  114044. */
  114045. allFallbacksProcessed(): boolean;
  114046. /**
  114047. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  114048. * @param func The callback to be used.
  114049. */
  114050. executeWhenCompiled(func: (effect: Effect) => void): void;
  114051. private _checkIsReady;
  114052. private _loadShader;
  114053. /**
  114054. * Gets the vertex shader source code of this effect
  114055. */
  114056. get vertexSourceCode(): string;
  114057. /**
  114058. * Gets the fragment shader source code of this effect
  114059. */
  114060. get fragmentSourceCode(): string;
  114061. /**
  114062. * Recompiles the webGL program
  114063. * @param vertexSourceCode The source code for the vertex shader.
  114064. * @param fragmentSourceCode The source code for the fragment shader.
  114065. * @param onCompiled Callback called when completed.
  114066. * @param onError Callback called on error.
  114067. * @hidden
  114068. */
  114069. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  114070. /**
  114071. * Prepares the effect
  114072. * @hidden
  114073. */
  114074. _prepareEffect(): void;
  114075. private _getShaderCodeAndErrorLine;
  114076. private _processCompilationErrors;
  114077. /**
  114078. * Checks if the effect is supported. (Must be called after compilation)
  114079. */
  114080. get isSupported(): boolean;
  114081. /**
  114082. * Binds a texture to the engine to be used as output of the shader.
  114083. * @param channel Name of the output variable.
  114084. * @param texture Texture to bind.
  114085. * @hidden
  114086. */
  114087. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  114088. /**
  114089. * Sets a texture on the engine to be used in the shader.
  114090. * @param channel Name of the sampler variable.
  114091. * @param texture Texture to set.
  114092. */
  114093. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  114094. /**
  114095. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  114096. * @param channel Name of the sampler variable.
  114097. * @param texture Texture to set.
  114098. */
  114099. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  114100. /**
  114101. * Sets an array of textures on the engine to be used in the shader.
  114102. * @param channel Name of the variable.
  114103. * @param textures Textures to set.
  114104. */
  114105. setTextureArray(channel: string, textures: BaseTexture[]): void;
  114106. /**
  114107. * 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)
  114108. * @param channel Name of the sampler variable.
  114109. * @param postProcess Post process to get the input texture from.
  114110. */
  114111. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  114112. /**
  114113. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  114114. * 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)
  114115. * @param channel Name of the sampler variable.
  114116. * @param postProcess Post process to get the output texture from.
  114117. */
  114118. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  114119. /** @hidden */
  114120. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  114121. /** @hidden */
  114122. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  114123. /** @hidden */
  114124. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  114125. /** @hidden */
  114126. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  114127. /**
  114128. * Binds a buffer to a uniform.
  114129. * @param buffer Buffer to bind.
  114130. * @param name Name of the uniform variable to bind to.
  114131. */
  114132. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  114133. /**
  114134. * Binds block to a uniform.
  114135. * @param blockName Name of the block to bind.
  114136. * @param index Index to bind.
  114137. */
  114138. bindUniformBlock(blockName: string, index: number): void;
  114139. /**
  114140. * Sets an interger value on a uniform variable.
  114141. * @param uniformName Name of the variable.
  114142. * @param value Value to be set.
  114143. * @returns this effect.
  114144. */
  114145. setInt(uniformName: string, value: number): Effect;
  114146. /**
  114147. * Sets an int array on a uniform variable.
  114148. * @param uniformName Name of the variable.
  114149. * @param array array to be set.
  114150. * @returns this effect.
  114151. */
  114152. setIntArray(uniformName: string, array: Int32Array): Effect;
  114153. /**
  114154. * 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)
  114155. * @param uniformName Name of the variable.
  114156. * @param array array to be set.
  114157. * @returns this effect.
  114158. */
  114159. setIntArray2(uniformName: string, array: Int32Array): Effect;
  114160. /**
  114161. * 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)
  114162. * @param uniformName Name of the variable.
  114163. * @param array array to be set.
  114164. * @returns this effect.
  114165. */
  114166. setIntArray3(uniformName: string, array: Int32Array): Effect;
  114167. /**
  114168. * 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)
  114169. * @param uniformName Name of the variable.
  114170. * @param array array to be set.
  114171. * @returns this effect.
  114172. */
  114173. setIntArray4(uniformName: string, array: Int32Array): Effect;
  114174. /**
  114175. * Sets an float array on a uniform variable.
  114176. * @param uniformName Name of the variable.
  114177. * @param array array to be set.
  114178. * @returns this effect.
  114179. */
  114180. setFloatArray(uniformName: string, array: Float32Array): Effect;
  114181. /**
  114182. * 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)
  114183. * @param uniformName Name of the variable.
  114184. * @param array array to be set.
  114185. * @returns this effect.
  114186. */
  114187. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  114188. /**
  114189. * 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)
  114190. * @param uniformName Name of the variable.
  114191. * @param array array to be set.
  114192. * @returns this effect.
  114193. */
  114194. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  114195. /**
  114196. * 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)
  114197. * @param uniformName Name of the variable.
  114198. * @param array array to be set.
  114199. * @returns this effect.
  114200. */
  114201. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  114202. /**
  114203. * Sets an array on a uniform variable.
  114204. * @param uniformName Name of the variable.
  114205. * @param array array to be set.
  114206. * @returns this effect.
  114207. */
  114208. setArray(uniformName: string, array: number[]): Effect;
  114209. /**
  114210. * 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)
  114211. * @param uniformName Name of the variable.
  114212. * @param array array to be set.
  114213. * @returns this effect.
  114214. */
  114215. setArray2(uniformName: string, array: number[]): Effect;
  114216. /**
  114217. * 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)
  114218. * @param uniformName Name of the variable.
  114219. * @param array array to be set.
  114220. * @returns this effect.
  114221. */
  114222. setArray3(uniformName: string, array: number[]): Effect;
  114223. /**
  114224. * 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)
  114225. * @param uniformName Name of the variable.
  114226. * @param array array to be set.
  114227. * @returns this effect.
  114228. */
  114229. setArray4(uniformName: string, array: number[]): Effect;
  114230. /**
  114231. * Sets matrices on a uniform variable.
  114232. * @param uniformName Name of the variable.
  114233. * @param matrices matrices to be set.
  114234. * @returns this effect.
  114235. */
  114236. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  114237. /**
  114238. * Sets matrix on a uniform variable.
  114239. * @param uniformName Name of the variable.
  114240. * @param matrix matrix to be set.
  114241. * @returns this effect.
  114242. */
  114243. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  114244. /**
  114245. * 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)
  114246. * @param uniformName Name of the variable.
  114247. * @param matrix matrix to be set.
  114248. * @returns this effect.
  114249. */
  114250. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  114251. /**
  114252. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  114253. * @param uniformName Name of the variable.
  114254. * @param matrix matrix to be set.
  114255. * @returns this effect.
  114256. */
  114257. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  114258. /**
  114259. * Sets a float on a uniform variable.
  114260. * @param uniformName Name of the variable.
  114261. * @param value value to be set.
  114262. * @returns this effect.
  114263. */
  114264. setFloat(uniformName: string, value: number): Effect;
  114265. /**
  114266. * Sets a boolean on a uniform variable.
  114267. * @param uniformName Name of the variable.
  114268. * @param bool value to be set.
  114269. * @returns this effect.
  114270. */
  114271. setBool(uniformName: string, bool: boolean): Effect;
  114272. /**
  114273. * Sets a Vector2 on a uniform variable.
  114274. * @param uniformName Name of the variable.
  114275. * @param vector2 vector2 to be set.
  114276. * @returns this effect.
  114277. */
  114278. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  114279. /**
  114280. * Sets a float2 on a uniform variable.
  114281. * @param uniformName Name of the variable.
  114282. * @param x First float in float2.
  114283. * @param y Second float in float2.
  114284. * @returns this effect.
  114285. */
  114286. setFloat2(uniformName: string, x: number, y: number): Effect;
  114287. /**
  114288. * Sets a Vector3 on a uniform variable.
  114289. * @param uniformName Name of the variable.
  114290. * @param vector3 Value to be set.
  114291. * @returns this effect.
  114292. */
  114293. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  114294. /**
  114295. * Sets a float3 on a uniform variable.
  114296. * @param uniformName Name of the variable.
  114297. * @param x First float in float3.
  114298. * @param y Second float in float3.
  114299. * @param z Third float in float3.
  114300. * @returns this effect.
  114301. */
  114302. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  114303. /**
  114304. * Sets a Vector4 on a uniform variable.
  114305. * @param uniformName Name of the variable.
  114306. * @param vector4 Value to be set.
  114307. * @returns this effect.
  114308. */
  114309. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  114310. /**
  114311. * Sets a float4 on a uniform variable.
  114312. * @param uniformName Name of the variable.
  114313. * @param x First float in float4.
  114314. * @param y Second float in float4.
  114315. * @param z Third float in float4.
  114316. * @param w Fourth float in float4.
  114317. * @returns this effect.
  114318. */
  114319. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  114320. /**
  114321. * Sets a Color3 on a uniform variable.
  114322. * @param uniformName Name of the variable.
  114323. * @param color3 Value to be set.
  114324. * @returns this effect.
  114325. */
  114326. setColor3(uniformName: string, color3: IColor3Like): Effect;
  114327. /**
  114328. * Sets a Color4 on a uniform variable.
  114329. * @param uniformName Name of the variable.
  114330. * @param color3 Value to be set.
  114331. * @param alpha Alpha value to be set.
  114332. * @returns this effect.
  114333. */
  114334. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  114335. /**
  114336. * Sets a Color4 on a uniform variable
  114337. * @param uniformName defines the name of the variable
  114338. * @param color4 defines the value to be set
  114339. * @returns this effect.
  114340. */
  114341. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  114342. /** Release all associated resources */
  114343. dispose(): void;
  114344. /**
  114345. * This function will add a new shader to the shader store
  114346. * @param name the name of the shader
  114347. * @param pixelShader optional pixel shader content
  114348. * @param vertexShader optional vertex shader content
  114349. */
  114350. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  114351. /**
  114352. * Store of each shader (The can be looked up using effect.key)
  114353. */
  114354. static ShadersStore: {
  114355. [key: string]: string;
  114356. };
  114357. /**
  114358. * Store of each included file for a shader (The can be looked up using effect.key)
  114359. */
  114360. static IncludesShadersStore: {
  114361. [key: string]: string;
  114362. };
  114363. /**
  114364. * Resets the cache of effects.
  114365. */
  114366. static ResetCache(): void;
  114367. }
  114368. }
  114369. declare module BABYLON {
  114370. /**
  114371. * Interface used to describe the capabilities of the engine relatively to the current browser
  114372. */
  114373. export interface EngineCapabilities {
  114374. /** Maximum textures units per fragment shader */
  114375. maxTexturesImageUnits: number;
  114376. /** Maximum texture units per vertex shader */
  114377. maxVertexTextureImageUnits: number;
  114378. /** Maximum textures units in the entire pipeline */
  114379. maxCombinedTexturesImageUnits: number;
  114380. /** Maximum texture size */
  114381. maxTextureSize: number;
  114382. /** Maximum texture samples */
  114383. maxSamples?: number;
  114384. /** Maximum cube texture size */
  114385. maxCubemapTextureSize: number;
  114386. /** Maximum render texture size */
  114387. maxRenderTextureSize: number;
  114388. /** Maximum number of vertex attributes */
  114389. maxVertexAttribs: number;
  114390. /** Maximum number of varyings */
  114391. maxVaryingVectors: number;
  114392. /** Maximum number of uniforms per vertex shader */
  114393. maxVertexUniformVectors: number;
  114394. /** Maximum number of uniforms per fragment shader */
  114395. maxFragmentUniformVectors: number;
  114396. /** Defines if standard derivates (dx/dy) are supported */
  114397. standardDerivatives: boolean;
  114398. /** Defines if s3tc texture compression is supported */
  114399. s3tc?: WEBGL_compressed_texture_s3tc;
  114400. /** Defines if pvrtc texture compression is supported */
  114401. pvrtc: any;
  114402. /** Defines if etc1 texture compression is supported */
  114403. etc1: any;
  114404. /** Defines if etc2 texture compression is supported */
  114405. etc2: any;
  114406. /** Defines if astc texture compression is supported */
  114407. astc: any;
  114408. /** Defines if float textures are supported */
  114409. textureFloat: boolean;
  114410. /** Defines if vertex array objects are supported */
  114411. vertexArrayObject: boolean;
  114412. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  114413. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  114414. /** Gets the maximum level of anisotropy supported */
  114415. maxAnisotropy: number;
  114416. /** Defines if instancing is supported */
  114417. instancedArrays: boolean;
  114418. /** Defines if 32 bits indices are supported */
  114419. uintIndices: boolean;
  114420. /** Defines if high precision shaders are supported */
  114421. highPrecisionShaderSupported: boolean;
  114422. /** Defines if depth reading in the fragment shader is supported */
  114423. fragmentDepthSupported: boolean;
  114424. /** Defines if float texture linear filtering is supported*/
  114425. textureFloatLinearFiltering: boolean;
  114426. /** Defines if rendering to float textures is supported */
  114427. textureFloatRender: boolean;
  114428. /** Defines if half float textures are supported*/
  114429. textureHalfFloat: boolean;
  114430. /** Defines if half float texture linear filtering is supported*/
  114431. textureHalfFloatLinearFiltering: boolean;
  114432. /** Defines if rendering to half float textures is supported */
  114433. textureHalfFloatRender: boolean;
  114434. /** Defines if textureLOD shader command is supported */
  114435. textureLOD: boolean;
  114436. /** Defines if draw buffers extension is supported */
  114437. drawBuffersExtension: boolean;
  114438. /** Defines if depth textures are supported */
  114439. depthTextureExtension: boolean;
  114440. /** Defines if float color buffer are supported */
  114441. colorBufferFloat: boolean;
  114442. /** Gets disjoint timer query extension (null if not supported) */
  114443. timerQuery?: EXT_disjoint_timer_query;
  114444. /** Defines if timestamp can be used with timer query */
  114445. canUseTimestampForTimerQuery: boolean;
  114446. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  114447. multiview?: any;
  114448. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  114449. oculusMultiview?: any;
  114450. /** Function used to let the system compiles shaders in background */
  114451. parallelShaderCompile?: {
  114452. COMPLETION_STATUS_KHR: number;
  114453. };
  114454. /** Max number of texture samples for MSAA */
  114455. maxMSAASamples: number;
  114456. /** Defines if the blend min max extension is supported */
  114457. blendMinMax: boolean;
  114458. }
  114459. }
  114460. declare module BABYLON {
  114461. /**
  114462. * @hidden
  114463. **/
  114464. export class DepthCullingState {
  114465. private _isDepthTestDirty;
  114466. private _isDepthMaskDirty;
  114467. private _isDepthFuncDirty;
  114468. private _isCullFaceDirty;
  114469. private _isCullDirty;
  114470. private _isZOffsetDirty;
  114471. private _isFrontFaceDirty;
  114472. private _depthTest;
  114473. private _depthMask;
  114474. private _depthFunc;
  114475. private _cull;
  114476. private _cullFace;
  114477. private _zOffset;
  114478. private _frontFace;
  114479. /**
  114480. * Initializes the state.
  114481. */
  114482. constructor();
  114483. get isDirty(): boolean;
  114484. get zOffset(): number;
  114485. set zOffset(value: number);
  114486. get cullFace(): Nullable<number>;
  114487. set cullFace(value: Nullable<number>);
  114488. get cull(): Nullable<boolean>;
  114489. set cull(value: Nullable<boolean>);
  114490. get depthFunc(): Nullable<number>;
  114491. set depthFunc(value: Nullable<number>);
  114492. get depthMask(): boolean;
  114493. set depthMask(value: boolean);
  114494. get depthTest(): boolean;
  114495. set depthTest(value: boolean);
  114496. get frontFace(): Nullable<number>;
  114497. set frontFace(value: Nullable<number>);
  114498. reset(): void;
  114499. apply(gl: WebGLRenderingContext): void;
  114500. }
  114501. }
  114502. declare module BABYLON {
  114503. /**
  114504. * @hidden
  114505. **/
  114506. export class StencilState {
  114507. /** 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 */
  114508. static readonly ALWAYS: number;
  114509. /** Passed to stencilOperation to specify that stencil value must be kept */
  114510. static readonly KEEP: number;
  114511. /** Passed to stencilOperation to specify that stencil value must be replaced */
  114512. static readonly REPLACE: number;
  114513. private _isStencilTestDirty;
  114514. private _isStencilMaskDirty;
  114515. private _isStencilFuncDirty;
  114516. private _isStencilOpDirty;
  114517. private _stencilTest;
  114518. private _stencilMask;
  114519. private _stencilFunc;
  114520. private _stencilFuncRef;
  114521. private _stencilFuncMask;
  114522. private _stencilOpStencilFail;
  114523. private _stencilOpDepthFail;
  114524. private _stencilOpStencilDepthPass;
  114525. get isDirty(): boolean;
  114526. get stencilFunc(): number;
  114527. set stencilFunc(value: number);
  114528. get stencilFuncRef(): number;
  114529. set stencilFuncRef(value: number);
  114530. get stencilFuncMask(): number;
  114531. set stencilFuncMask(value: number);
  114532. get stencilOpStencilFail(): number;
  114533. set stencilOpStencilFail(value: number);
  114534. get stencilOpDepthFail(): number;
  114535. set stencilOpDepthFail(value: number);
  114536. get stencilOpStencilDepthPass(): number;
  114537. set stencilOpStencilDepthPass(value: number);
  114538. get stencilMask(): number;
  114539. set stencilMask(value: number);
  114540. get stencilTest(): boolean;
  114541. set stencilTest(value: boolean);
  114542. constructor();
  114543. reset(): void;
  114544. apply(gl: WebGLRenderingContext): void;
  114545. }
  114546. }
  114547. declare module BABYLON {
  114548. /**
  114549. * @hidden
  114550. **/
  114551. export class AlphaState {
  114552. private _isAlphaBlendDirty;
  114553. private _isBlendFunctionParametersDirty;
  114554. private _isBlendEquationParametersDirty;
  114555. private _isBlendConstantsDirty;
  114556. private _alphaBlend;
  114557. private _blendFunctionParameters;
  114558. private _blendEquationParameters;
  114559. private _blendConstants;
  114560. /**
  114561. * Initializes the state.
  114562. */
  114563. constructor();
  114564. get isDirty(): boolean;
  114565. get alphaBlend(): boolean;
  114566. set alphaBlend(value: boolean);
  114567. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  114568. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  114569. setAlphaEquationParameters(rgb: number, alpha: number): void;
  114570. reset(): void;
  114571. apply(gl: WebGLRenderingContext): void;
  114572. }
  114573. }
  114574. declare module BABYLON {
  114575. /** @hidden */
  114576. export class WebGL2ShaderProcessor implements IShaderProcessor {
  114577. attributeProcessor(attribute: string): string;
  114578. varyingProcessor(varying: string, isFragment: boolean): string;
  114579. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  114580. }
  114581. }
  114582. declare module BABYLON {
  114583. /**
  114584. * Interface for attribute information associated with buffer instanciation
  114585. */
  114586. export interface InstancingAttributeInfo {
  114587. /**
  114588. * Name of the GLSL attribute
  114589. * if attribute index is not specified, this is used to retrieve the index from the effect
  114590. */
  114591. attributeName: string;
  114592. /**
  114593. * Index/offset of the attribute in the vertex shader
  114594. * if not specified, this will be computes from the name.
  114595. */
  114596. index?: number;
  114597. /**
  114598. * size of the attribute, 1, 2, 3 or 4
  114599. */
  114600. attributeSize: number;
  114601. /**
  114602. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  114603. */
  114604. offset: number;
  114605. /**
  114606. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  114607. * default to 1
  114608. */
  114609. divisor?: number;
  114610. /**
  114611. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  114612. * default is FLOAT
  114613. */
  114614. attributeType?: number;
  114615. /**
  114616. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  114617. */
  114618. normalized?: boolean;
  114619. }
  114620. }
  114621. declare module BABYLON {
  114622. interface ThinEngine {
  114623. /**
  114624. * Update a video texture
  114625. * @param texture defines the texture to update
  114626. * @param video defines the video element to use
  114627. * @param invertY defines if data must be stored with Y axis inverted
  114628. */
  114629. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  114630. }
  114631. }
  114632. declare module BABYLON {
  114633. interface ThinEngine {
  114634. /**
  114635. * Creates a dynamic texture
  114636. * @param width defines the width of the texture
  114637. * @param height defines the height of the texture
  114638. * @param generateMipMaps defines if the engine should generate the mip levels
  114639. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  114640. * @returns the dynamic texture inside an InternalTexture
  114641. */
  114642. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  114643. /**
  114644. * Update the content of a dynamic texture
  114645. * @param texture defines the texture to update
  114646. * @param canvas defines the canvas containing the source
  114647. * @param invertY defines if data must be stored with Y axis inverted
  114648. * @param premulAlpha defines if alpha is stored as premultiplied
  114649. * @param format defines the format of the data
  114650. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  114651. */
  114652. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  114653. }
  114654. }
  114655. declare module BABYLON {
  114656. /**
  114657. * Settings for finer control over video usage
  114658. */
  114659. export interface VideoTextureSettings {
  114660. /**
  114661. * Applies `autoplay` to video, if specified
  114662. */
  114663. autoPlay?: boolean;
  114664. /**
  114665. * Applies `loop` to video, if specified
  114666. */
  114667. loop?: boolean;
  114668. /**
  114669. * Automatically updates internal texture from video at every frame in the render loop
  114670. */
  114671. autoUpdateTexture: boolean;
  114672. /**
  114673. * Image src displayed during the video loading or until the user interacts with the video.
  114674. */
  114675. poster?: string;
  114676. }
  114677. /**
  114678. * If you want to display a video in your scene, this is the special texture for that.
  114679. * This special texture works similar to other textures, with the exception of a few parameters.
  114680. * @see https://doc.babylonjs.com/how_to/video_texture
  114681. */
  114682. export class VideoTexture extends Texture {
  114683. /**
  114684. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  114685. */
  114686. readonly autoUpdateTexture: boolean;
  114687. /**
  114688. * The video instance used by the texture internally
  114689. */
  114690. readonly video: HTMLVideoElement;
  114691. private _onUserActionRequestedObservable;
  114692. /**
  114693. * Event triggerd when a dom action is required by the user to play the video.
  114694. * This happens due to recent changes in browser policies preventing video to auto start.
  114695. */
  114696. get onUserActionRequestedObservable(): Observable<Texture>;
  114697. private _generateMipMaps;
  114698. private _stillImageCaptured;
  114699. private _displayingPosterTexture;
  114700. private _settings;
  114701. private _createInternalTextureOnEvent;
  114702. private _frameId;
  114703. private _currentSrc;
  114704. /**
  114705. * Creates a video texture.
  114706. * If you want to display a video in your scene, this is the special texture for that.
  114707. * This special texture works similar to other textures, with the exception of a few parameters.
  114708. * @see https://doc.babylonjs.com/how_to/video_texture
  114709. * @param name optional name, will detect from video source, if not defined
  114710. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  114711. * @param scene is obviously the current scene.
  114712. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  114713. * @param invertY is false by default but can be used to invert video on Y axis
  114714. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  114715. * @param settings allows finer control over video usage
  114716. */
  114717. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  114718. private _getName;
  114719. private _getVideo;
  114720. private _createInternalTexture;
  114721. private reset;
  114722. /**
  114723. * @hidden Internal method to initiate `update`.
  114724. */
  114725. _rebuild(): void;
  114726. /**
  114727. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  114728. */
  114729. update(): void;
  114730. /**
  114731. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  114732. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  114733. */
  114734. updateTexture(isVisible: boolean): void;
  114735. protected _updateInternalTexture: () => void;
  114736. /**
  114737. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  114738. * @param url New url.
  114739. */
  114740. updateURL(url: string): void;
  114741. /**
  114742. * Clones the texture.
  114743. * @returns the cloned texture
  114744. */
  114745. clone(): VideoTexture;
  114746. /**
  114747. * Dispose the texture and release its associated resources.
  114748. */
  114749. dispose(): void;
  114750. /**
  114751. * Creates a video texture straight from a stream.
  114752. * @param scene Define the scene the texture should be created in
  114753. * @param stream Define the stream the texture should be created from
  114754. * @returns The created video texture as a promise
  114755. */
  114756. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  114757. /**
  114758. * Creates a video texture straight from your WebCam video feed.
  114759. * @param scene Define the scene the texture should be created in
  114760. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  114761. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  114762. * @returns The created video texture as a promise
  114763. */
  114764. static CreateFromWebCamAsync(scene: Scene, constraints: {
  114765. minWidth: number;
  114766. maxWidth: number;
  114767. minHeight: number;
  114768. maxHeight: number;
  114769. deviceId: string;
  114770. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  114771. /**
  114772. * Creates a video texture straight from your WebCam video feed.
  114773. * @param scene Define the scene the texture should be created in
  114774. * @param onReady Define a callback to triggered once the texture will be ready
  114775. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  114776. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  114777. */
  114778. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  114779. minWidth: number;
  114780. maxWidth: number;
  114781. minHeight: number;
  114782. maxHeight: number;
  114783. deviceId: string;
  114784. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  114785. }
  114786. }
  114787. declare module BABYLON {
  114788. /**
  114789. * Defines the interface used by objects working like Scene
  114790. * @hidden
  114791. */
  114792. export interface ISceneLike {
  114793. _addPendingData(data: any): void;
  114794. _removePendingData(data: any): void;
  114795. offlineProvider: IOfflineProvider;
  114796. }
  114797. /**
  114798. * Information about the current host
  114799. */
  114800. export interface HostInformation {
  114801. /**
  114802. * Defines if the current host is a mobile
  114803. */
  114804. isMobile: boolean;
  114805. }
  114806. /** Interface defining initialization parameters for Engine class */
  114807. export interface EngineOptions extends WebGLContextAttributes {
  114808. /**
  114809. * Defines if the engine should no exceed a specified device ratio
  114810. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  114811. */
  114812. limitDeviceRatio?: number;
  114813. /**
  114814. * Defines if webvr should be enabled automatically
  114815. * @see https://doc.babylonjs.com/how_to/webvr_camera
  114816. */
  114817. autoEnableWebVR?: boolean;
  114818. /**
  114819. * Defines if webgl2 should be turned off even if supported
  114820. * @see https://doc.babylonjs.com/features/webgl2
  114821. */
  114822. disableWebGL2Support?: boolean;
  114823. /**
  114824. * Defines if webaudio should be initialized as well
  114825. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  114826. */
  114827. audioEngine?: boolean;
  114828. /**
  114829. * Defines if animations should run using a deterministic lock step
  114830. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  114831. */
  114832. deterministicLockstep?: boolean;
  114833. /** Defines the maximum steps to use with deterministic lock step mode */
  114834. lockstepMaxSteps?: number;
  114835. /** Defines the seconds between each deterministic lock step */
  114836. timeStep?: number;
  114837. /**
  114838. * Defines that engine should ignore context lost events
  114839. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  114840. */
  114841. doNotHandleContextLost?: boolean;
  114842. /**
  114843. * Defines that engine should ignore modifying touch action attribute and style
  114844. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  114845. */
  114846. doNotHandleTouchAction?: boolean;
  114847. /**
  114848. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  114849. */
  114850. useHighPrecisionFloats?: boolean;
  114851. /**
  114852. * Make the canvas XR Compatible for XR sessions
  114853. */
  114854. xrCompatible?: boolean;
  114855. /**
  114856. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  114857. */
  114858. useHighPrecisionMatrix?: boolean;
  114859. }
  114860. /**
  114861. * The base engine class (root of all engines)
  114862. */
  114863. export class ThinEngine {
  114864. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  114865. static ExceptionList: ({
  114866. key: string;
  114867. capture: string;
  114868. captureConstraint: number;
  114869. targets: string[];
  114870. } | {
  114871. key: string;
  114872. capture: null;
  114873. captureConstraint: null;
  114874. targets: string[];
  114875. })[];
  114876. /** @hidden */
  114877. static _TextureLoaders: IInternalTextureLoader[];
  114878. /**
  114879. * Returns the current npm package of the sdk
  114880. */
  114881. static get NpmPackage(): string;
  114882. /**
  114883. * Returns the current version of the framework
  114884. */
  114885. static get Version(): string;
  114886. /**
  114887. * Returns a string describing the current engine
  114888. */
  114889. get description(): string;
  114890. /**
  114891. * Gets or sets the epsilon value used by collision engine
  114892. */
  114893. static CollisionsEpsilon: number;
  114894. /**
  114895. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  114896. */
  114897. static get ShadersRepository(): string;
  114898. static set ShadersRepository(value: string);
  114899. /** @hidden */
  114900. _shaderProcessor: IShaderProcessor;
  114901. /**
  114902. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  114903. */
  114904. forcePOTTextures: boolean;
  114905. /**
  114906. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  114907. */
  114908. isFullscreen: boolean;
  114909. /**
  114910. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  114911. */
  114912. cullBackFaces: boolean;
  114913. /**
  114914. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  114915. */
  114916. renderEvenInBackground: boolean;
  114917. /**
  114918. * Gets or sets a boolean indicating that cache can be kept between frames
  114919. */
  114920. preventCacheWipeBetweenFrames: boolean;
  114921. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  114922. validateShaderPrograms: boolean;
  114923. /**
  114924. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  114925. * This can provide greater z depth for distant objects.
  114926. */
  114927. useReverseDepthBuffer: boolean;
  114928. /**
  114929. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  114930. */
  114931. disableUniformBuffers: boolean;
  114932. /** @hidden */
  114933. _uniformBuffers: UniformBuffer[];
  114934. /**
  114935. * Gets a boolean indicating that the engine supports uniform buffers
  114936. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  114937. */
  114938. get supportsUniformBuffers(): boolean;
  114939. /** @hidden */
  114940. _gl: WebGLRenderingContext;
  114941. /** @hidden */
  114942. _webGLVersion: number;
  114943. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  114944. protected _windowIsBackground: boolean;
  114945. protected _creationOptions: EngineOptions;
  114946. protected _highPrecisionShadersAllowed: boolean;
  114947. /** @hidden */
  114948. get _shouldUseHighPrecisionShader(): boolean;
  114949. /**
  114950. * Gets a boolean indicating that only power of 2 textures are supported
  114951. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  114952. */
  114953. get needPOTTextures(): boolean;
  114954. /** @hidden */
  114955. _badOS: boolean;
  114956. /** @hidden */
  114957. _badDesktopOS: boolean;
  114958. private _hardwareScalingLevel;
  114959. /** @hidden */
  114960. _caps: EngineCapabilities;
  114961. private _isStencilEnable;
  114962. private _glVersion;
  114963. private _glRenderer;
  114964. private _glVendor;
  114965. /** @hidden */
  114966. _videoTextureSupported: boolean;
  114967. protected _renderingQueueLaunched: boolean;
  114968. protected _activeRenderLoops: (() => void)[];
  114969. /**
  114970. * Observable signaled when a context lost event is raised
  114971. */
  114972. onContextLostObservable: Observable<ThinEngine>;
  114973. /**
  114974. * Observable signaled when a context restored event is raised
  114975. */
  114976. onContextRestoredObservable: Observable<ThinEngine>;
  114977. private _onContextLost;
  114978. private _onContextRestored;
  114979. protected _contextWasLost: boolean;
  114980. /** @hidden */
  114981. _doNotHandleContextLost: boolean;
  114982. /**
  114983. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  114984. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  114985. */
  114986. get doNotHandleContextLost(): boolean;
  114987. set doNotHandleContextLost(value: boolean);
  114988. /**
  114989. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  114990. */
  114991. disableVertexArrayObjects: boolean;
  114992. /** @hidden */
  114993. protected _colorWrite: boolean;
  114994. /** @hidden */
  114995. protected _colorWriteChanged: boolean;
  114996. /** @hidden */
  114997. protected _depthCullingState: DepthCullingState;
  114998. /** @hidden */
  114999. protected _stencilState: StencilState;
  115000. /** @hidden */
  115001. _alphaState: AlphaState;
  115002. /** @hidden */
  115003. _alphaMode: number;
  115004. /** @hidden */
  115005. _alphaEquation: number;
  115006. /** @hidden */
  115007. _internalTexturesCache: InternalTexture[];
  115008. /** @hidden */
  115009. protected _activeChannel: number;
  115010. private _currentTextureChannel;
  115011. /** @hidden */
  115012. protected _boundTexturesCache: {
  115013. [key: string]: Nullable<InternalTexture>;
  115014. };
  115015. /** @hidden */
  115016. protected _currentEffect: Nullable<Effect>;
  115017. /** @hidden */
  115018. protected _currentProgram: Nullable<WebGLProgram>;
  115019. private _compiledEffects;
  115020. private _vertexAttribArraysEnabled;
  115021. /** @hidden */
  115022. protected _cachedViewport: Nullable<IViewportLike>;
  115023. private _cachedVertexArrayObject;
  115024. /** @hidden */
  115025. protected _cachedVertexBuffers: any;
  115026. /** @hidden */
  115027. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  115028. /** @hidden */
  115029. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  115030. /** @hidden */
  115031. _currentRenderTarget: Nullable<InternalTexture>;
  115032. private _uintIndicesCurrentlySet;
  115033. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  115034. /** @hidden */
  115035. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  115036. /** @hidden */
  115037. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  115038. private _currentBufferPointers;
  115039. private _currentInstanceLocations;
  115040. private _currentInstanceBuffers;
  115041. private _textureUnits;
  115042. /** @hidden */
  115043. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  115044. /** @hidden */
  115045. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  115046. /** @hidden */
  115047. _boundRenderFunction: any;
  115048. private _vaoRecordInProgress;
  115049. private _mustWipeVertexAttributes;
  115050. private _emptyTexture;
  115051. private _emptyCubeTexture;
  115052. private _emptyTexture3D;
  115053. private _emptyTexture2DArray;
  115054. /** @hidden */
  115055. _frameHandler: number;
  115056. private _nextFreeTextureSlots;
  115057. private _maxSimultaneousTextures;
  115058. private _activeRequests;
  115059. /** @hidden */
  115060. _transformTextureUrl: Nullable<(url: string) => string>;
  115061. /**
  115062. * Gets information about the current host
  115063. */
  115064. hostInformation: HostInformation;
  115065. protected get _supportsHardwareTextureRescaling(): boolean;
  115066. private _framebufferDimensionsObject;
  115067. /**
  115068. * sets the object from which width and height will be taken from when getting render width and height
  115069. * Will fallback to the gl object
  115070. * @param dimensions the framebuffer width and height that will be used.
  115071. */
  115072. set framebufferDimensionsObject(dimensions: Nullable<{
  115073. framebufferWidth: number;
  115074. framebufferHeight: number;
  115075. }>);
  115076. /**
  115077. * Gets the current viewport
  115078. */
  115079. get currentViewport(): Nullable<IViewportLike>;
  115080. /**
  115081. * Gets the default empty texture
  115082. */
  115083. get emptyTexture(): InternalTexture;
  115084. /**
  115085. * Gets the default empty 3D texture
  115086. */
  115087. get emptyTexture3D(): InternalTexture;
  115088. /**
  115089. * Gets the default empty 2D array texture
  115090. */
  115091. get emptyTexture2DArray(): InternalTexture;
  115092. /**
  115093. * Gets the default empty cube texture
  115094. */
  115095. get emptyCubeTexture(): InternalTexture;
  115096. /**
  115097. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  115098. */
  115099. readonly premultipliedAlpha: boolean;
  115100. /**
  115101. * Observable event triggered before each texture is initialized
  115102. */
  115103. onBeforeTextureInitObservable: Observable<Texture>;
  115104. /**
  115105. * Creates a new engine
  115106. * @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
  115107. * @param antialias defines enable antialiasing (default: false)
  115108. * @param options defines further options to be sent to the getContext() function
  115109. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  115110. */
  115111. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  115112. private _rebuildInternalTextures;
  115113. private _rebuildEffects;
  115114. /**
  115115. * Gets a boolean indicating if all created effects are ready
  115116. * @returns true if all effects are ready
  115117. */
  115118. areAllEffectsReady(): boolean;
  115119. protected _rebuildBuffers(): void;
  115120. protected _initGLContext(): void;
  115121. /**
  115122. * Gets version of the current webGL context
  115123. */
  115124. get webGLVersion(): number;
  115125. /**
  115126. * Gets a string identifying the name of the class
  115127. * @returns "Engine" string
  115128. */
  115129. getClassName(): string;
  115130. /**
  115131. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  115132. */
  115133. get isStencilEnable(): boolean;
  115134. /** @hidden */
  115135. _prepareWorkingCanvas(): void;
  115136. /**
  115137. * Reset the texture cache to empty state
  115138. */
  115139. resetTextureCache(): void;
  115140. /**
  115141. * Gets an object containing information about the current webGL context
  115142. * @returns an object containing the vender, the renderer and the version of the current webGL context
  115143. */
  115144. getGlInfo(): {
  115145. vendor: string;
  115146. renderer: string;
  115147. version: string;
  115148. };
  115149. /**
  115150. * Defines the hardware scaling level.
  115151. * By default the hardware scaling level is computed from the window device ratio.
  115152. * 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.
  115153. * @param level defines the level to use
  115154. */
  115155. setHardwareScalingLevel(level: number): void;
  115156. /**
  115157. * Gets the current hardware scaling level.
  115158. * By default the hardware scaling level is computed from the window device ratio.
  115159. * 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.
  115160. * @returns a number indicating the current hardware scaling level
  115161. */
  115162. getHardwareScalingLevel(): number;
  115163. /**
  115164. * Gets the list of loaded textures
  115165. * @returns an array containing all loaded textures
  115166. */
  115167. getLoadedTexturesCache(): InternalTexture[];
  115168. /**
  115169. * Gets the object containing all engine capabilities
  115170. * @returns the EngineCapabilities object
  115171. */
  115172. getCaps(): EngineCapabilities;
  115173. /**
  115174. * stop executing a render loop function and remove it from the execution array
  115175. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  115176. */
  115177. stopRenderLoop(renderFunction?: () => void): void;
  115178. /** @hidden */
  115179. _renderLoop(): void;
  115180. /**
  115181. * Gets the HTML canvas attached with the current webGL context
  115182. * @returns a HTML canvas
  115183. */
  115184. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  115185. /**
  115186. * Gets host window
  115187. * @returns the host window object
  115188. */
  115189. getHostWindow(): Nullable<Window>;
  115190. /**
  115191. * Gets the current render width
  115192. * @param useScreen defines if screen size must be used (or the current render target if any)
  115193. * @returns a number defining the current render width
  115194. */
  115195. getRenderWidth(useScreen?: boolean): number;
  115196. /**
  115197. * Gets the current render height
  115198. * @param useScreen defines if screen size must be used (or the current render target if any)
  115199. * @returns a number defining the current render height
  115200. */
  115201. getRenderHeight(useScreen?: boolean): number;
  115202. /**
  115203. * Can be used to override the current requestAnimationFrame requester.
  115204. * @hidden
  115205. */
  115206. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  115207. /**
  115208. * Register and execute a render loop. The engine can have more than one render function
  115209. * @param renderFunction defines the function to continuously execute
  115210. */
  115211. runRenderLoop(renderFunction: () => void): void;
  115212. /**
  115213. * Clear the current render buffer or the current render target (if any is set up)
  115214. * @param color defines the color to use
  115215. * @param backBuffer defines if the back buffer must be cleared
  115216. * @param depth defines if the depth buffer must be cleared
  115217. * @param stencil defines if the stencil buffer must be cleared
  115218. */
  115219. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  115220. private _viewportCached;
  115221. /** @hidden */
  115222. _viewport(x: number, y: number, width: number, height: number): void;
  115223. /**
  115224. * Set the WebGL's viewport
  115225. * @param viewport defines the viewport element to be used
  115226. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  115227. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  115228. */
  115229. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  115230. /**
  115231. * Begin a new frame
  115232. */
  115233. beginFrame(): void;
  115234. /**
  115235. * Enf the current frame
  115236. */
  115237. endFrame(): void;
  115238. /**
  115239. * Resize the view according to the canvas' size
  115240. */
  115241. resize(): void;
  115242. /**
  115243. * Force a specific size of the canvas
  115244. * @param width defines the new canvas' width
  115245. * @param height defines the new canvas' height
  115246. * @returns true if the size was changed
  115247. */
  115248. setSize(width: number, height: number): boolean;
  115249. /**
  115250. * Binds the frame buffer to the specified texture.
  115251. * @param texture The texture to render to or null for the default canvas
  115252. * @param faceIndex The face of the texture to render to in case of cube texture
  115253. * @param requiredWidth The width of the target to render to
  115254. * @param requiredHeight The height of the target to render to
  115255. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  115256. * @param lodLevel defines the lod level to bind to the frame buffer
  115257. * @param layer defines the 2d array index to bind to frame buffer to
  115258. */
  115259. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  115260. /** @hidden */
  115261. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  115262. /**
  115263. * Unbind the current render target texture from the webGL context
  115264. * @param texture defines the render target texture to unbind
  115265. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  115266. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  115267. */
  115268. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  115269. /**
  115270. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  115271. */
  115272. flushFramebuffer(): void;
  115273. /**
  115274. * Unbind the current render target and bind the default framebuffer
  115275. */
  115276. restoreDefaultFramebuffer(): void;
  115277. /** @hidden */
  115278. protected _resetVertexBufferBinding(): void;
  115279. /**
  115280. * Creates a vertex buffer
  115281. * @param data the data for the vertex buffer
  115282. * @returns the new WebGL static buffer
  115283. */
  115284. createVertexBuffer(data: DataArray): DataBuffer;
  115285. private _createVertexBuffer;
  115286. /**
  115287. * Creates a dynamic vertex buffer
  115288. * @param data the data for the dynamic vertex buffer
  115289. * @returns the new WebGL dynamic buffer
  115290. */
  115291. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  115292. protected _resetIndexBufferBinding(): void;
  115293. /**
  115294. * Creates a new index buffer
  115295. * @param indices defines the content of the index buffer
  115296. * @param updatable defines if the index buffer must be updatable
  115297. * @returns a new webGL buffer
  115298. */
  115299. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  115300. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  115301. /**
  115302. * Bind a webGL buffer to the webGL context
  115303. * @param buffer defines the buffer to bind
  115304. */
  115305. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  115306. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  115307. private bindBuffer;
  115308. /**
  115309. * update the bound buffer with the given data
  115310. * @param data defines the data to update
  115311. */
  115312. updateArrayBuffer(data: Float32Array): void;
  115313. private _vertexAttribPointer;
  115314. /** @hidden */
  115315. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  115316. private _bindVertexBuffersAttributes;
  115317. /**
  115318. * Records a vertex array object
  115319. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  115320. * @param vertexBuffers defines the list of vertex buffers to store
  115321. * @param indexBuffer defines the index buffer to store
  115322. * @param effect defines the effect to store
  115323. * @returns the new vertex array object
  115324. */
  115325. recordVertexArrayObject(vertexBuffers: {
  115326. [key: string]: VertexBuffer;
  115327. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  115328. /**
  115329. * Bind a specific vertex array object
  115330. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  115331. * @param vertexArrayObject defines the vertex array object to bind
  115332. * @param indexBuffer defines the index buffer to bind
  115333. */
  115334. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  115335. /**
  115336. * Bind webGl buffers directly to the webGL context
  115337. * @param vertexBuffer defines the vertex buffer to bind
  115338. * @param indexBuffer defines the index buffer to bind
  115339. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  115340. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  115341. * @param effect defines the effect associated with the vertex buffer
  115342. */
  115343. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  115344. private _unbindVertexArrayObject;
  115345. /**
  115346. * Bind a list of vertex buffers to the webGL context
  115347. * @param vertexBuffers defines the list of vertex buffers to bind
  115348. * @param indexBuffer defines the index buffer to bind
  115349. * @param effect defines the effect associated with the vertex buffers
  115350. */
  115351. bindBuffers(vertexBuffers: {
  115352. [key: string]: Nullable<VertexBuffer>;
  115353. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  115354. /**
  115355. * Unbind all instance attributes
  115356. */
  115357. unbindInstanceAttributes(): void;
  115358. /**
  115359. * Release and free the memory of a vertex array object
  115360. * @param vao defines the vertex array object to delete
  115361. */
  115362. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  115363. /** @hidden */
  115364. _releaseBuffer(buffer: DataBuffer): boolean;
  115365. protected _deleteBuffer(buffer: DataBuffer): void;
  115366. /**
  115367. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  115368. * @param instancesBuffer defines the webGL buffer to update and bind
  115369. * @param data defines the data to store in the buffer
  115370. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  115371. */
  115372. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  115373. /**
  115374. * Bind the content of a webGL buffer used with instantiation
  115375. * @param instancesBuffer defines the webGL buffer to bind
  115376. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  115377. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  115378. */
  115379. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  115380. /**
  115381. * Disable the instance attribute corresponding to the name in parameter
  115382. * @param name defines the name of the attribute to disable
  115383. */
  115384. disableInstanceAttributeByName(name: string): void;
  115385. /**
  115386. * Disable the instance attribute corresponding to the location in parameter
  115387. * @param attributeLocation defines the attribute location of the attribute to disable
  115388. */
  115389. disableInstanceAttribute(attributeLocation: number): void;
  115390. /**
  115391. * Disable the attribute corresponding to the location in parameter
  115392. * @param attributeLocation defines the attribute location of the attribute to disable
  115393. */
  115394. disableAttributeByIndex(attributeLocation: number): void;
  115395. /**
  115396. * Send a draw order
  115397. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  115398. * @param indexStart defines the starting index
  115399. * @param indexCount defines the number of index to draw
  115400. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115401. */
  115402. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  115403. /**
  115404. * Draw a list of points
  115405. * @param verticesStart defines the index of first vertex to draw
  115406. * @param verticesCount defines the count of vertices to draw
  115407. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115408. */
  115409. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115410. /**
  115411. * Draw a list of unindexed primitives
  115412. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  115413. * @param verticesStart defines the index of first vertex to draw
  115414. * @param verticesCount defines the count of vertices to draw
  115415. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115416. */
  115417. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115418. /**
  115419. * Draw a list of indexed primitives
  115420. * @param fillMode defines the primitive to use
  115421. * @param indexStart defines the starting index
  115422. * @param indexCount defines the number of index to draw
  115423. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115424. */
  115425. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  115426. /**
  115427. * Draw a list of unindexed primitives
  115428. * @param fillMode defines the primitive to use
  115429. * @param verticesStart defines the index of first vertex to draw
  115430. * @param verticesCount defines the count of vertices to draw
  115431. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115432. */
  115433. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115434. private _drawMode;
  115435. /** @hidden */
  115436. protected _reportDrawCall(): void;
  115437. /** @hidden */
  115438. _releaseEffect(effect: Effect): void;
  115439. /** @hidden */
  115440. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  115441. /**
  115442. * Create a new effect (used to store vertex/fragment shaders)
  115443. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  115444. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  115445. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  115446. * @param samplers defines an array of string used to represent textures
  115447. * @param defines defines the string containing the defines to use to compile the shaders
  115448. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  115449. * @param onCompiled defines a function to call when the effect creation is successful
  115450. * @param onError defines a function to call when the effect creation has failed
  115451. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  115452. * @returns the new Effect
  115453. */
  115454. 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;
  115455. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  115456. private _compileShader;
  115457. private _compileRawShader;
  115458. /** @hidden */
  115459. _getShaderSource(shader: WebGLShader): Nullable<string>;
  115460. /**
  115461. * Directly creates a webGL program
  115462. * @param pipelineContext defines the pipeline context to attach to
  115463. * @param vertexCode defines the vertex shader code to use
  115464. * @param fragmentCode defines the fragment shader code to use
  115465. * @param context defines the webGL context to use (if not set, the current one will be used)
  115466. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  115467. * @returns the new webGL program
  115468. */
  115469. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115470. /**
  115471. * Creates a webGL program
  115472. * @param pipelineContext defines the pipeline context to attach to
  115473. * @param vertexCode defines the vertex shader code to use
  115474. * @param fragmentCode defines the fragment shader code to use
  115475. * @param defines defines the string containing the defines to use to compile the shaders
  115476. * @param context defines the webGL context to use (if not set, the current one will be used)
  115477. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  115478. * @returns the new webGL program
  115479. */
  115480. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115481. /**
  115482. * Creates a new pipeline context
  115483. * @returns the new pipeline
  115484. */
  115485. createPipelineContext(): IPipelineContext;
  115486. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115487. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  115488. /** @hidden */
  115489. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  115490. /** @hidden */
  115491. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  115492. /** @hidden */
  115493. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  115494. /**
  115495. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  115496. * @param pipelineContext defines the pipeline context to use
  115497. * @param uniformsNames defines the list of uniform names
  115498. * @returns an array of webGL uniform locations
  115499. */
  115500. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  115501. /**
  115502. * Gets the lsit of active attributes for a given webGL program
  115503. * @param pipelineContext defines the pipeline context to use
  115504. * @param attributesNames defines the list of attribute names to get
  115505. * @returns an array of indices indicating the offset of each attribute
  115506. */
  115507. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  115508. /**
  115509. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  115510. * @param effect defines the effect to activate
  115511. */
  115512. enableEffect(effect: Nullable<Effect>): void;
  115513. /**
  115514. * Set the value of an uniform to a number (int)
  115515. * @param uniform defines the webGL uniform location where to store the value
  115516. * @param value defines the int number to store
  115517. */
  115518. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  115519. /**
  115520. * Set the value of an uniform to an array of int32
  115521. * @param uniform defines the webGL uniform location where to store the value
  115522. * @param array defines the array of int32 to store
  115523. */
  115524. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115525. /**
  115526. * Set the value of an uniform to an array of int32 (stored as vec2)
  115527. * @param uniform defines the webGL uniform location where to store the value
  115528. * @param array defines the array of int32 to store
  115529. */
  115530. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115531. /**
  115532. * Set the value of an uniform to an array of int32 (stored as vec3)
  115533. * @param uniform defines the webGL uniform location where to store the value
  115534. * @param array defines the array of int32 to store
  115535. */
  115536. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115537. /**
  115538. * Set the value of an uniform to an array of int32 (stored as vec4)
  115539. * @param uniform defines the webGL uniform location where to store the value
  115540. * @param array defines the array of int32 to store
  115541. */
  115542. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115543. /**
  115544. * Set the value of an uniform to an array of number
  115545. * @param uniform defines the webGL uniform location where to store the value
  115546. * @param array defines the array of number to store
  115547. */
  115548. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115549. /**
  115550. * Set the value of an uniform to an array of number (stored as vec2)
  115551. * @param uniform defines the webGL uniform location where to store the value
  115552. * @param array defines the array of number to store
  115553. */
  115554. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115555. /**
  115556. * Set the value of an uniform to an array of number (stored as vec3)
  115557. * @param uniform defines the webGL uniform location where to store the value
  115558. * @param array defines the array of number to store
  115559. */
  115560. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115561. /**
  115562. * Set the value of an uniform to an array of number (stored as vec4)
  115563. * @param uniform defines the webGL uniform location where to store the value
  115564. * @param array defines the array of number to store
  115565. */
  115566. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115567. /**
  115568. * Set the value of an uniform to an array of float32 (stored as matrices)
  115569. * @param uniform defines the webGL uniform location where to store the value
  115570. * @param matrices defines the array of float32 to store
  115571. */
  115572. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  115573. /**
  115574. * Set the value of an uniform to a matrix (3x3)
  115575. * @param uniform defines the webGL uniform location where to store the value
  115576. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  115577. */
  115578. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  115579. /**
  115580. * Set the value of an uniform to a matrix (2x2)
  115581. * @param uniform defines the webGL uniform location where to store the value
  115582. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  115583. */
  115584. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  115585. /**
  115586. * Set the value of an uniform to a number (float)
  115587. * @param uniform defines the webGL uniform location where to store the value
  115588. * @param value defines the float number to store
  115589. */
  115590. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  115591. /**
  115592. * Set the value of an uniform to a vec2
  115593. * @param uniform defines the webGL uniform location where to store the value
  115594. * @param x defines the 1st component of the value
  115595. * @param y defines the 2nd component of the value
  115596. */
  115597. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  115598. /**
  115599. * Set the value of an uniform to a vec3
  115600. * @param uniform defines the webGL uniform location where to store the value
  115601. * @param x defines the 1st component of the value
  115602. * @param y defines the 2nd component of the value
  115603. * @param z defines the 3rd component of the value
  115604. */
  115605. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  115606. /**
  115607. * Set the value of an uniform to a vec4
  115608. * @param uniform defines the webGL uniform location where to store the value
  115609. * @param x defines the 1st component of the value
  115610. * @param y defines the 2nd component of the value
  115611. * @param z defines the 3rd component of the value
  115612. * @param w defines the 4th component of the value
  115613. */
  115614. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  115615. /**
  115616. * Apply all cached states (depth, culling, stencil and alpha)
  115617. */
  115618. applyStates(): void;
  115619. /**
  115620. * Enable or disable color writing
  115621. * @param enable defines the state to set
  115622. */
  115623. setColorWrite(enable: boolean): void;
  115624. /**
  115625. * Gets a boolean indicating if color writing is enabled
  115626. * @returns the current color writing state
  115627. */
  115628. getColorWrite(): boolean;
  115629. /**
  115630. * Gets the depth culling state manager
  115631. */
  115632. get depthCullingState(): DepthCullingState;
  115633. /**
  115634. * Gets the alpha state manager
  115635. */
  115636. get alphaState(): AlphaState;
  115637. /**
  115638. * Gets the stencil state manager
  115639. */
  115640. get stencilState(): StencilState;
  115641. /**
  115642. * Clears the list of texture accessible through engine.
  115643. * This can help preventing texture load conflict due to name collision.
  115644. */
  115645. clearInternalTexturesCache(): void;
  115646. /**
  115647. * Force the entire cache to be cleared
  115648. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  115649. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  115650. */
  115651. wipeCaches(bruteForce?: boolean): void;
  115652. /** @hidden */
  115653. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  115654. min: number;
  115655. mag: number;
  115656. };
  115657. /** @hidden */
  115658. _createTexture(): WebGLTexture;
  115659. /**
  115660. * Usually called from Texture.ts.
  115661. * Passed information to create a WebGLTexture
  115662. * @param url defines a value which contains one of the following:
  115663. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  115664. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  115665. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  115666. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  115667. * @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)
  115668. * @param scene needed for loading to the correct scene
  115669. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  115670. * @param onLoad optional callback to be called upon successful completion
  115671. * @param onError optional callback to be called upon failure
  115672. * @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
  115673. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  115674. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  115675. * @param forcedExtension defines the extension to use to pick the right loader
  115676. * @param mimeType defines an optional mime type
  115677. * @returns a InternalTexture for assignment back into BABYLON.Texture
  115678. */
  115679. 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;
  115680. /**
  115681. * Loads an image as an HTMLImageElement.
  115682. * @param input url string, ArrayBuffer, or Blob to load
  115683. * @param onLoad callback called when the image successfully loads
  115684. * @param onError callback called when the image fails to load
  115685. * @param offlineProvider offline provider for caching
  115686. * @param mimeType optional mime type
  115687. * @returns the HTMLImageElement of the loaded image
  115688. * @hidden
  115689. */
  115690. 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>;
  115691. /**
  115692. * @hidden
  115693. */
  115694. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  115695. private _unpackFlipYCached;
  115696. /**
  115697. * In case you are sharing the context with other applications, it might
  115698. * be interested to not cache the unpack flip y state to ensure a consistent
  115699. * value would be set.
  115700. */
  115701. enableUnpackFlipYCached: boolean;
  115702. /** @hidden */
  115703. _unpackFlipY(value: boolean): void;
  115704. /** @hidden */
  115705. _getUnpackAlignement(): number;
  115706. private _getTextureTarget;
  115707. /**
  115708. * Update the sampling mode of a given texture
  115709. * @param samplingMode defines the required sampling mode
  115710. * @param texture defines the texture to update
  115711. * @param generateMipMaps defines whether to generate mipmaps for the texture
  115712. */
  115713. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  115714. /**
  115715. * Update the sampling mode of a given texture
  115716. * @param texture defines the texture to update
  115717. * @param wrapU defines the texture wrap mode of the u coordinates
  115718. * @param wrapV defines the texture wrap mode of the v coordinates
  115719. * @param wrapR defines the texture wrap mode of the r coordinates
  115720. */
  115721. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  115722. /** @hidden */
  115723. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  115724. width: number;
  115725. height: number;
  115726. layers?: number;
  115727. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  115728. /** @hidden */
  115729. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  115730. /** @hidden */
  115731. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  115732. /**
  115733. * Update a portion of an internal texture
  115734. * @param texture defines the texture to update
  115735. * @param imageData defines the data to store into the texture
  115736. * @param xOffset defines the x coordinates of the update rectangle
  115737. * @param yOffset defines the y coordinates of the update rectangle
  115738. * @param width defines the width of the update rectangle
  115739. * @param height defines the height of the update rectangle
  115740. * @param faceIndex defines the face index if texture is a cube (0 by default)
  115741. * @param lod defines the lod level to update (0 by default)
  115742. */
  115743. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  115744. /** @hidden */
  115745. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  115746. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  115747. private _prepareWebGLTexture;
  115748. /** @hidden */
  115749. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  115750. private _getDepthStencilBuffer;
  115751. /** @hidden */
  115752. _releaseFramebufferObjects(texture: InternalTexture): void;
  115753. /** @hidden */
  115754. _releaseTexture(texture: InternalTexture): void;
  115755. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  115756. protected _setProgram(program: WebGLProgram): void;
  115757. protected _boundUniforms: {
  115758. [key: number]: WebGLUniformLocation;
  115759. };
  115760. /**
  115761. * Binds an effect to the webGL context
  115762. * @param effect defines the effect to bind
  115763. */
  115764. bindSamplers(effect: Effect): void;
  115765. private _activateCurrentTexture;
  115766. /** @hidden */
  115767. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  115768. /** @hidden */
  115769. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  115770. /**
  115771. * Unbind all textures from the webGL context
  115772. */
  115773. unbindAllTextures(): void;
  115774. /**
  115775. * Sets a texture to the according uniform.
  115776. * @param channel The texture channel
  115777. * @param uniform The uniform to set
  115778. * @param texture The texture to apply
  115779. */
  115780. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  115781. private _bindSamplerUniformToChannel;
  115782. private _getTextureWrapMode;
  115783. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  115784. /**
  115785. * Sets an array of texture to the webGL context
  115786. * @param channel defines the channel where the texture array must be set
  115787. * @param uniform defines the associated uniform location
  115788. * @param textures defines the array of textures to bind
  115789. */
  115790. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  115791. /** @hidden */
  115792. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  115793. private _setTextureParameterFloat;
  115794. private _setTextureParameterInteger;
  115795. /**
  115796. * Unbind all vertex attributes from the webGL context
  115797. */
  115798. unbindAllAttributes(): void;
  115799. /**
  115800. * 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
  115801. */
  115802. releaseEffects(): void;
  115803. /**
  115804. * Dispose and release all associated resources
  115805. */
  115806. dispose(): void;
  115807. /**
  115808. * Attach a new callback raised when context lost event is fired
  115809. * @param callback defines the callback to call
  115810. */
  115811. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  115812. /**
  115813. * Attach a new callback raised when context restored event is fired
  115814. * @param callback defines the callback to call
  115815. */
  115816. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  115817. /**
  115818. * Get the current error code of the webGL context
  115819. * @returns the error code
  115820. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  115821. */
  115822. getError(): number;
  115823. private _canRenderToFloatFramebuffer;
  115824. private _canRenderToHalfFloatFramebuffer;
  115825. private _canRenderToFramebuffer;
  115826. /** @hidden */
  115827. _getWebGLTextureType(type: number): number;
  115828. /** @hidden */
  115829. _getInternalFormat(format: number): number;
  115830. /** @hidden */
  115831. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  115832. /** @hidden */
  115833. _getRGBAMultiSampleBufferFormat(type: number): number;
  115834. /** @hidden */
  115835. _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;
  115836. /**
  115837. * Loads a file from a url
  115838. * @param url url to load
  115839. * @param onSuccess callback called when the file successfully loads
  115840. * @param onProgress callback called while file is loading (if the server supports this mode)
  115841. * @param offlineProvider defines the offline provider for caching
  115842. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  115843. * @param onError callback called when the file fails to load
  115844. * @returns a file request object
  115845. * @hidden
  115846. */
  115847. 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;
  115848. /**
  115849. * Reads pixels from the current frame buffer. Please note that this function can be slow
  115850. * @param x defines the x coordinate of the rectangle where pixels must be read
  115851. * @param y defines the y coordinate of the rectangle where pixels must be read
  115852. * @param width defines the width of the rectangle where pixels must be read
  115853. * @param height defines the height of the rectangle where pixels must be read
  115854. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  115855. * @returns a Uint8Array containing RGBA colors
  115856. */
  115857. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  115858. private static _isSupported;
  115859. /**
  115860. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  115861. * @returns true if the engine can be created
  115862. * @ignorenaming
  115863. */
  115864. static isSupported(): boolean;
  115865. /**
  115866. * Find the next highest power of two.
  115867. * @param x Number to start search from.
  115868. * @return Next highest power of two.
  115869. */
  115870. static CeilingPOT(x: number): number;
  115871. /**
  115872. * Find the next lowest power of two.
  115873. * @param x Number to start search from.
  115874. * @return Next lowest power of two.
  115875. */
  115876. static FloorPOT(x: number): number;
  115877. /**
  115878. * Find the nearest power of two.
  115879. * @param x Number to start search from.
  115880. * @return Next nearest power of two.
  115881. */
  115882. static NearestPOT(x: number): number;
  115883. /**
  115884. * Get the closest exponent of two
  115885. * @param value defines the value to approximate
  115886. * @param max defines the maximum value to return
  115887. * @param mode defines how to define the closest value
  115888. * @returns closest exponent of two of the given value
  115889. */
  115890. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  115891. /**
  115892. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  115893. * @param func - the function to be called
  115894. * @param requester - the object that will request the next frame. Falls back to window.
  115895. * @returns frame number
  115896. */
  115897. static QueueNewFrame(func: () => void, requester?: any): number;
  115898. /**
  115899. * Gets host document
  115900. * @returns the host document object
  115901. */
  115902. getHostDocument(): Nullable<Document>;
  115903. }
  115904. }
  115905. declare module BABYLON {
  115906. /**
  115907. * Class representing spherical harmonics coefficients to the 3rd degree
  115908. */
  115909. export class SphericalHarmonics {
  115910. /**
  115911. * Defines whether or not the harmonics have been prescaled for rendering.
  115912. */
  115913. preScaled: boolean;
  115914. /**
  115915. * The l0,0 coefficients of the spherical harmonics
  115916. */
  115917. l00: Vector3;
  115918. /**
  115919. * The l1,-1 coefficients of the spherical harmonics
  115920. */
  115921. l1_1: Vector3;
  115922. /**
  115923. * The l1,0 coefficients of the spherical harmonics
  115924. */
  115925. l10: Vector3;
  115926. /**
  115927. * The l1,1 coefficients of the spherical harmonics
  115928. */
  115929. l11: Vector3;
  115930. /**
  115931. * The l2,-2 coefficients of the spherical harmonics
  115932. */
  115933. l2_2: Vector3;
  115934. /**
  115935. * The l2,-1 coefficients of the spherical harmonics
  115936. */
  115937. l2_1: Vector3;
  115938. /**
  115939. * The l2,0 coefficients of the spherical harmonics
  115940. */
  115941. l20: Vector3;
  115942. /**
  115943. * The l2,1 coefficients of the spherical harmonics
  115944. */
  115945. l21: Vector3;
  115946. /**
  115947. * The l2,2 coefficients of the spherical harmonics
  115948. */
  115949. l22: Vector3;
  115950. /**
  115951. * Adds a light to the spherical harmonics
  115952. * @param direction the direction of the light
  115953. * @param color the color of the light
  115954. * @param deltaSolidAngle the delta solid angle of the light
  115955. */
  115956. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  115957. /**
  115958. * Scales the spherical harmonics by the given amount
  115959. * @param scale the amount to scale
  115960. */
  115961. scaleInPlace(scale: number): void;
  115962. /**
  115963. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  115964. *
  115965. * ```
  115966. * E_lm = A_l * L_lm
  115967. * ```
  115968. *
  115969. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  115970. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  115971. * the scaling factors are given in equation 9.
  115972. */
  115973. convertIncidentRadianceToIrradiance(): void;
  115974. /**
  115975. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  115976. *
  115977. * ```
  115978. * L = (1/pi) * E * rho
  115979. * ```
  115980. *
  115981. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  115982. */
  115983. convertIrradianceToLambertianRadiance(): void;
  115984. /**
  115985. * Integrates the reconstruction coefficients directly in to the SH preventing further
  115986. * required operations at run time.
  115987. *
  115988. * This is simply done by scaling back the SH with Ylm constants parameter.
  115989. * The trigonometric part being applied by the shader at run time.
  115990. */
  115991. preScaleForRendering(): void;
  115992. /**
  115993. * Constructs a spherical harmonics from an array.
  115994. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  115995. * @returns the spherical harmonics
  115996. */
  115997. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  115998. /**
  115999. * Gets the spherical harmonics from polynomial
  116000. * @param polynomial the spherical polynomial
  116001. * @returns the spherical harmonics
  116002. */
  116003. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  116004. }
  116005. /**
  116006. * Class representing spherical polynomial coefficients to the 3rd degree
  116007. */
  116008. export class SphericalPolynomial {
  116009. private _harmonics;
  116010. /**
  116011. * The spherical harmonics used to create the polynomials.
  116012. */
  116013. get preScaledHarmonics(): SphericalHarmonics;
  116014. /**
  116015. * The x coefficients of the spherical polynomial
  116016. */
  116017. x: Vector3;
  116018. /**
  116019. * The y coefficients of the spherical polynomial
  116020. */
  116021. y: Vector3;
  116022. /**
  116023. * The z coefficients of the spherical polynomial
  116024. */
  116025. z: Vector3;
  116026. /**
  116027. * The xx coefficients of the spherical polynomial
  116028. */
  116029. xx: Vector3;
  116030. /**
  116031. * The yy coefficients of the spherical polynomial
  116032. */
  116033. yy: Vector3;
  116034. /**
  116035. * The zz coefficients of the spherical polynomial
  116036. */
  116037. zz: Vector3;
  116038. /**
  116039. * The xy coefficients of the spherical polynomial
  116040. */
  116041. xy: Vector3;
  116042. /**
  116043. * The yz coefficients of the spherical polynomial
  116044. */
  116045. yz: Vector3;
  116046. /**
  116047. * The zx coefficients of the spherical polynomial
  116048. */
  116049. zx: Vector3;
  116050. /**
  116051. * Adds an ambient color to the spherical polynomial
  116052. * @param color the color to add
  116053. */
  116054. addAmbient(color: Color3): void;
  116055. /**
  116056. * Scales the spherical polynomial by the given amount
  116057. * @param scale the amount to scale
  116058. */
  116059. scaleInPlace(scale: number): void;
  116060. /**
  116061. * Gets the spherical polynomial from harmonics
  116062. * @param harmonics the spherical harmonics
  116063. * @returns the spherical polynomial
  116064. */
  116065. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  116066. /**
  116067. * Constructs a spherical polynomial from an array.
  116068. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  116069. * @returns the spherical polynomial
  116070. */
  116071. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  116072. }
  116073. }
  116074. declare module BABYLON {
  116075. /**
  116076. * Defines the source of the internal texture
  116077. */
  116078. export enum InternalTextureSource {
  116079. /**
  116080. * The source of the texture data is unknown
  116081. */
  116082. Unknown = 0,
  116083. /**
  116084. * Texture data comes from an URL
  116085. */
  116086. Url = 1,
  116087. /**
  116088. * Texture data is only used for temporary storage
  116089. */
  116090. Temp = 2,
  116091. /**
  116092. * Texture data comes from raw data (ArrayBuffer)
  116093. */
  116094. Raw = 3,
  116095. /**
  116096. * Texture content is dynamic (video or dynamic texture)
  116097. */
  116098. Dynamic = 4,
  116099. /**
  116100. * Texture content is generated by rendering to it
  116101. */
  116102. RenderTarget = 5,
  116103. /**
  116104. * Texture content is part of a multi render target process
  116105. */
  116106. MultiRenderTarget = 6,
  116107. /**
  116108. * Texture data comes from a cube data file
  116109. */
  116110. Cube = 7,
  116111. /**
  116112. * Texture data comes from a raw cube data
  116113. */
  116114. CubeRaw = 8,
  116115. /**
  116116. * Texture data come from a prefiltered cube data file
  116117. */
  116118. CubePrefiltered = 9,
  116119. /**
  116120. * Texture content is raw 3D data
  116121. */
  116122. Raw3D = 10,
  116123. /**
  116124. * Texture content is raw 2D array data
  116125. */
  116126. Raw2DArray = 11,
  116127. /**
  116128. * Texture content is a depth texture
  116129. */
  116130. Depth = 12,
  116131. /**
  116132. * Texture data comes from a raw cube data encoded with RGBD
  116133. */
  116134. CubeRawRGBD = 13
  116135. }
  116136. /**
  116137. * Class used to store data associated with WebGL texture data for the engine
  116138. * This class should not be used directly
  116139. */
  116140. export class InternalTexture {
  116141. /** @hidden */
  116142. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  116143. /**
  116144. * Defines if the texture is ready
  116145. */
  116146. isReady: boolean;
  116147. /**
  116148. * Defines if the texture is a cube texture
  116149. */
  116150. isCube: boolean;
  116151. /**
  116152. * Defines if the texture contains 3D data
  116153. */
  116154. is3D: boolean;
  116155. /**
  116156. * Defines if the texture contains 2D array data
  116157. */
  116158. is2DArray: boolean;
  116159. /**
  116160. * Defines if the texture contains multiview data
  116161. */
  116162. isMultiview: boolean;
  116163. /**
  116164. * Gets the URL used to load this texture
  116165. */
  116166. url: string;
  116167. /**
  116168. * Gets the sampling mode of the texture
  116169. */
  116170. samplingMode: number;
  116171. /**
  116172. * Gets a boolean indicating if the texture needs mipmaps generation
  116173. */
  116174. generateMipMaps: boolean;
  116175. /**
  116176. * Gets the number of samples used by the texture (WebGL2+ only)
  116177. */
  116178. samples: number;
  116179. /**
  116180. * Gets the type of the texture (int, float...)
  116181. */
  116182. type: number;
  116183. /**
  116184. * Gets the format of the texture (RGB, RGBA...)
  116185. */
  116186. format: number;
  116187. /**
  116188. * Observable called when the texture is loaded
  116189. */
  116190. onLoadedObservable: Observable<InternalTexture>;
  116191. /**
  116192. * Gets the width of the texture
  116193. */
  116194. width: number;
  116195. /**
  116196. * Gets the height of the texture
  116197. */
  116198. height: number;
  116199. /**
  116200. * Gets the depth of the texture
  116201. */
  116202. depth: number;
  116203. /**
  116204. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  116205. */
  116206. baseWidth: number;
  116207. /**
  116208. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  116209. */
  116210. baseHeight: number;
  116211. /**
  116212. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  116213. */
  116214. baseDepth: number;
  116215. /**
  116216. * Gets a boolean indicating if the texture is inverted on Y axis
  116217. */
  116218. invertY: boolean;
  116219. /** @hidden */
  116220. _invertVScale: boolean;
  116221. /** @hidden */
  116222. _associatedChannel: number;
  116223. /** @hidden */
  116224. _source: InternalTextureSource;
  116225. /** @hidden */
  116226. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  116227. /** @hidden */
  116228. _bufferView: Nullable<ArrayBufferView>;
  116229. /** @hidden */
  116230. _bufferViewArray: Nullable<ArrayBufferView[]>;
  116231. /** @hidden */
  116232. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  116233. /** @hidden */
  116234. _size: number;
  116235. /** @hidden */
  116236. _extension: string;
  116237. /** @hidden */
  116238. _files: Nullable<string[]>;
  116239. /** @hidden */
  116240. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  116241. /** @hidden */
  116242. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  116243. /** @hidden */
  116244. _framebuffer: Nullable<WebGLFramebuffer>;
  116245. /** @hidden */
  116246. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  116247. /** @hidden */
  116248. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  116249. /** @hidden */
  116250. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  116251. /** @hidden */
  116252. _attachments: Nullable<number[]>;
  116253. /** @hidden */
  116254. _textureArray: Nullable<InternalTexture[]>;
  116255. /** @hidden */
  116256. _cachedCoordinatesMode: Nullable<number>;
  116257. /** @hidden */
  116258. _cachedWrapU: Nullable<number>;
  116259. /** @hidden */
  116260. _cachedWrapV: Nullable<number>;
  116261. /** @hidden */
  116262. _cachedWrapR: Nullable<number>;
  116263. /** @hidden */
  116264. _cachedAnisotropicFilteringLevel: Nullable<number>;
  116265. /** @hidden */
  116266. _isDisabled: boolean;
  116267. /** @hidden */
  116268. _compression: Nullable<string>;
  116269. /** @hidden */
  116270. _generateStencilBuffer: boolean;
  116271. /** @hidden */
  116272. _generateDepthBuffer: boolean;
  116273. /** @hidden */
  116274. _comparisonFunction: number;
  116275. /** @hidden */
  116276. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  116277. /** @hidden */
  116278. _lodGenerationScale: number;
  116279. /** @hidden */
  116280. _lodGenerationOffset: number;
  116281. /** @hidden */
  116282. _depthStencilTexture: Nullable<InternalTexture>;
  116283. /** @hidden */
  116284. _colorTextureArray: Nullable<WebGLTexture>;
  116285. /** @hidden */
  116286. _depthStencilTextureArray: Nullable<WebGLTexture>;
  116287. /** @hidden */
  116288. _lodTextureHigh: Nullable<BaseTexture>;
  116289. /** @hidden */
  116290. _lodTextureMid: Nullable<BaseTexture>;
  116291. /** @hidden */
  116292. _lodTextureLow: Nullable<BaseTexture>;
  116293. /** @hidden */
  116294. _isRGBD: boolean;
  116295. /** @hidden */
  116296. _linearSpecularLOD: boolean;
  116297. /** @hidden */
  116298. _irradianceTexture: Nullable<BaseTexture>;
  116299. /** @hidden */
  116300. _webGLTexture: Nullable<WebGLTexture>;
  116301. /** @hidden */
  116302. _references: number;
  116303. private _engine;
  116304. /**
  116305. * Gets the Engine the texture belongs to.
  116306. * @returns The babylon engine
  116307. */
  116308. getEngine(): ThinEngine;
  116309. /**
  116310. * Gets the data source type of the texture
  116311. */
  116312. get source(): InternalTextureSource;
  116313. /**
  116314. * Creates a new InternalTexture
  116315. * @param engine defines the engine to use
  116316. * @param source defines the type of data that will be used
  116317. * @param delayAllocation if the texture allocation should be delayed (default: false)
  116318. */
  116319. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  116320. /**
  116321. * Increments the number of references (ie. the number of Texture that point to it)
  116322. */
  116323. incrementReferences(): void;
  116324. /**
  116325. * Change the size of the texture (not the size of the content)
  116326. * @param width defines the new width
  116327. * @param height defines the new height
  116328. * @param depth defines the new depth (1 by default)
  116329. */
  116330. updateSize(width: int, height: int, depth?: int): void;
  116331. /** @hidden */
  116332. _rebuild(): void;
  116333. /** @hidden */
  116334. _swapAndDie(target: InternalTexture): void;
  116335. /**
  116336. * Dispose the current allocated resources
  116337. */
  116338. dispose(): void;
  116339. }
  116340. }
  116341. declare module BABYLON {
  116342. /**
  116343. * Class used to work with sound analyzer using fast fourier transform (FFT)
  116344. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116345. */
  116346. export class Analyser {
  116347. /**
  116348. * Gets or sets the smoothing
  116349. * @ignorenaming
  116350. */
  116351. SMOOTHING: number;
  116352. /**
  116353. * Gets or sets the FFT table size
  116354. * @ignorenaming
  116355. */
  116356. FFT_SIZE: number;
  116357. /**
  116358. * Gets or sets the bar graph amplitude
  116359. * @ignorenaming
  116360. */
  116361. BARGRAPHAMPLITUDE: number;
  116362. /**
  116363. * Gets or sets the position of the debug canvas
  116364. * @ignorenaming
  116365. */
  116366. DEBUGCANVASPOS: {
  116367. x: number;
  116368. y: number;
  116369. };
  116370. /**
  116371. * Gets or sets the debug canvas size
  116372. * @ignorenaming
  116373. */
  116374. DEBUGCANVASSIZE: {
  116375. width: number;
  116376. height: number;
  116377. };
  116378. private _byteFreqs;
  116379. private _byteTime;
  116380. private _floatFreqs;
  116381. private _webAudioAnalyser;
  116382. private _debugCanvas;
  116383. private _debugCanvasContext;
  116384. private _scene;
  116385. private _registerFunc;
  116386. private _audioEngine;
  116387. /**
  116388. * Creates a new analyser
  116389. * @param scene defines hosting scene
  116390. */
  116391. constructor(scene: Scene);
  116392. /**
  116393. * Get the number of data values you will have to play with for the visualization
  116394. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  116395. * @returns a number
  116396. */
  116397. getFrequencyBinCount(): number;
  116398. /**
  116399. * Gets the current frequency data as a byte array
  116400. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  116401. * @returns a Uint8Array
  116402. */
  116403. getByteFrequencyData(): Uint8Array;
  116404. /**
  116405. * Gets the current waveform as a byte array
  116406. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  116407. * @returns a Uint8Array
  116408. */
  116409. getByteTimeDomainData(): Uint8Array;
  116410. /**
  116411. * Gets the current frequency data as a float array
  116412. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  116413. * @returns a Float32Array
  116414. */
  116415. getFloatFrequencyData(): Float32Array;
  116416. /**
  116417. * Renders the debug canvas
  116418. */
  116419. drawDebugCanvas(): void;
  116420. /**
  116421. * Stops rendering the debug canvas and removes it
  116422. */
  116423. stopDebugCanvas(): void;
  116424. /**
  116425. * Connects two audio nodes
  116426. * @param inputAudioNode defines first node to connect
  116427. * @param outputAudioNode defines second node to connect
  116428. */
  116429. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  116430. /**
  116431. * Releases all associated resources
  116432. */
  116433. dispose(): void;
  116434. }
  116435. }
  116436. declare module BABYLON {
  116437. /**
  116438. * This represents an audio engine and it is responsible
  116439. * to play, synchronize and analyse sounds throughout the application.
  116440. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116441. */
  116442. export interface IAudioEngine extends IDisposable {
  116443. /**
  116444. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  116445. */
  116446. readonly canUseWebAudio: boolean;
  116447. /**
  116448. * Gets the current AudioContext if available.
  116449. */
  116450. readonly audioContext: Nullable<AudioContext>;
  116451. /**
  116452. * The master gain node defines the global audio volume of your audio engine.
  116453. */
  116454. readonly masterGain: GainNode;
  116455. /**
  116456. * Gets whether or not mp3 are supported by your browser.
  116457. */
  116458. readonly isMP3supported: boolean;
  116459. /**
  116460. * Gets whether or not ogg are supported by your browser.
  116461. */
  116462. readonly isOGGsupported: boolean;
  116463. /**
  116464. * Defines if Babylon should emit a warning if WebAudio is not supported.
  116465. * @ignoreNaming
  116466. */
  116467. WarnedWebAudioUnsupported: boolean;
  116468. /**
  116469. * Defines if the audio engine relies on a custom unlocked button.
  116470. * In this case, the embedded button will not be displayed.
  116471. */
  116472. useCustomUnlockedButton: boolean;
  116473. /**
  116474. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  116475. */
  116476. readonly unlocked: boolean;
  116477. /**
  116478. * Event raised when audio has been unlocked on the browser.
  116479. */
  116480. onAudioUnlockedObservable: Observable<AudioEngine>;
  116481. /**
  116482. * Event raised when audio has been locked on the browser.
  116483. */
  116484. onAudioLockedObservable: Observable<AudioEngine>;
  116485. /**
  116486. * Flags the audio engine in Locked state.
  116487. * This happens due to new browser policies preventing audio to autoplay.
  116488. */
  116489. lock(): void;
  116490. /**
  116491. * Unlocks the audio engine once a user action has been done on the dom.
  116492. * This is helpful to resume play once browser policies have been satisfied.
  116493. */
  116494. unlock(): void;
  116495. /**
  116496. * Gets the global volume sets on the master gain.
  116497. * @returns the global volume if set or -1 otherwise
  116498. */
  116499. getGlobalVolume(): number;
  116500. /**
  116501. * Sets the global volume of your experience (sets on the master gain).
  116502. * @param newVolume Defines the new global volume of the application
  116503. */
  116504. setGlobalVolume(newVolume: number): void;
  116505. /**
  116506. * Connect the audio engine to an audio analyser allowing some amazing
  116507. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  116508. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  116509. * @param analyser The analyser to connect to the engine
  116510. */
  116511. connectToAnalyser(analyser: Analyser): void;
  116512. }
  116513. /**
  116514. * This represents the default audio engine used in babylon.
  116515. * It is responsible to play, synchronize and analyse sounds throughout the application.
  116516. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116517. */
  116518. export class AudioEngine implements IAudioEngine {
  116519. private _audioContext;
  116520. private _audioContextInitialized;
  116521. private _muteButton;
  116522. private _hostElement;
  116523. /**
  116524. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  116525. */
  116526. canUseWebAudio: boolean;
  116527. /**
  116528. * The master gain node defines the global audio volume of your audio engine.
  116529. */
  116530. masterGain: GainNode;
  116531. /**
  116532. * Defines if Babylon should emit a warning if WebAudio is not supported.
  116533. * @ignoreNaming
  116534. */
  116535. WarnedWebAudioUnsupported: boolean;
  116536. /**
  116537. * Gets whether or not mp3 are supported by your browser.
  116538. */
  116539. isMP3supported: boolean;
  116540. /**
  116541. * Gets whether or not ogg are supported by your browser.
  116542. */
  116543. isOGGsupported: boolean;
  116544. /**
  116545. * Gets whether audio has been unlocked on the device.
  116546. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  116547. * a user interaction has happened.
  116548. */
  116549. unlocked: boolean;
  116550. /**
  116551. * Defines if the audio engine relies on a custom unlocked button.
  116552. * In this case, the embedded button will not be displayed.
  116553. */
  116554. useCustomUnlockedButton: boolean;
  116555. /**
  116556. * Event raised when audio has been unlocked on the browser.
  116557. */
  116558. onAudioUnlockedObservable: Observable<AudioEngine>;
  116559. /**
  116560. * Event raised when audio has been locked on the browser.
  116561. */
  116562. onAudioLockedObservable: Observable<AudioEngine>;
  116563. /**
  116564. * Gets the current AudioContext if available.
  116565. */
  116566. get audioContext(): Nullable<AudioContext>;
  116567. private _connectedAnalyser;
  116568. /**
  116569. * Instantiates a new audio engine.
  116570. *
  116571. * There should be only one per page as some browsers restrict the number
  116572. * of audio contexts you can create.
  116573. * @param hostElement defines the host element where to display the mute icon if necessary
  116574. */
  116575. constructor(hostElement?: Nullable<HTMLElement>);
  116576. /**
  116577. * Flags the audio engine in Locked state.
  116578. * This happens due to new browser policies preventing audio to autoplay.
  116579. */
  116580. lock(): void;
  116581. /**
  116582. * Unlocks the audio engine once a user action has been done on the dom.
  116583. * This is helpful to resume play once browser policies have been satisfied.
  116584. */
  116585. unlock(): void;
  116586. private _resumeAudioContext;
  116587. private _initializeAudioContext;
  116588. private _tryToRun;
  116589. private _triggerRunningState;
  116590. private _triggerSuspendedState;
  116591. private _displayMuteButton;
  116592. private _moveButtonToTopLeft;
  116593. private _onResize;
  116594. private _hideMuteButton;
  116595. /**
  116596. * Destroy and release the resources associated with the audio ccontext.
  116597. */
  116598. dispose(): void;
  116599. /**
  116600. * Gets the global volume sets on the master gain.
  116601. * @returns the global volume if set or -1 otherwise
  116602. */
  116603. getGlobalVolume(): number;
  116604. /**
  116605. * Sets the global volume of your experience (sets on the master gain).
  116606. * @param newVolume Defines the new global volume of the application
  116607. */
  116608. setGlobalVolume(newVolume: number): void;
  116609. /**
  116610. * Connect the audio engine to an audio analyser allowing some amazing
  116611. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  116612. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  116613. * @param analyser The analyser to connect to the engine
  116614. */
  116615. connectToAnalyser(analyser: Analyser): void;
  116616. }
  116617. }
  116618. declare module BABYLON {
  116619. /**
  116620. * Interface used to present a loading screen while loading a scene
  116621. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116622. */
  116623. export interface ILoadingScreen {
  116624. /**
  116625. * Function called to display the loading screen
  116626. */
  116627. displayLoadingUI: () => void;
  116628. /**
  116629. * Function called to hide the loading screen
  116630. */
  116631. hideLoadingUI: () => void;
  116632. /**
  116633. * Gets or sets the color to use for the background
  116634. */
  116635. loadingUIBackgroundColor: string;
  116636. /**
  116637. * Gets or sets the text to display while loading
  116638. */
  116639. loadingUIText: string;
  116640. }
  116641. /**
  116642. * Class used for the default loading screen
  116643. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116644. */
  116645. export class DefaultLoadingScreen implements ILoadingScreen {
  116646. private _renderingCanvas;
  116647. private _loadingText;
  116648. private _loadingDivBackgroundColor;
  116649. private _loadingDiv;
  116650. private _loadingTextDiv;
  116651. /** Gets or sets the logo url to use for the default loading screen */
  116652. static DefaultLogoUrl: string;
  116653. /** Gets or sets the spinner url to use for the default loading screen */
  116654. static DefaultSpinnerUrl: string;
  116655. /**
  116656. * Creates a new default loading screen
  116657. * @param _renderingCanvas defines the canvas used to render the scene
  116658. * @param _loadingText defines the default text to display
  116659. * @param _loadingDivBackgroundColor defines the default background color
  116660. */
  116661. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  116662. /**
  116663. * Function called to display the loading screen
  116664. */
  116665. displayLoadingUI(): void;
  116666. /**
  116667. * Function called to hide the loading screen
  116668. */
  116669. hideLoadingUI(): void;
  116670. /**
  116671. * Gets or sets the text to display while loading
  116672. */
  116673. set loadingUIText(text: string);
  116674. get loadingUIText(): string;
  116675. /**
  116676. * Gets or sets the color to use for the background
  116677. */
  116678. get loadingUIBackgroundColor(): string;
  116679. set loadingUIBackgroundColor(color: string);
  116680. private _resizeLoadingUI;
  116681. }
  116682. }
  116683. declare module BABYLON {
  116684. /**
  116685. * Interface for any object that can request an animation frame
  116686. */
  116687. export interface ICustomAnimationFrameRequester {
  116688. /**
  116689. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  116690. */
  116691. renderFunction?: Function;
  116692. /**
  116693. * Called to request the next frame to render to
  116694. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  116695. */
  116696. requestAnimationFrame: Function;
  116697. /**
  116698. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  116699. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  116700. */
  116701. requestID?: number;
  116702. }
  116703. }
  116704. declare module BABYLON {
  116705. /**
  116706. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  116707. */
  116708. export class PerformanceMonitor {
  116709. private _enabled;
  116710. private _rollingFrameTime;
  116711. private _lastFrameTimeMs;
  116712. /**
  116713. * constructor
  116714. * @param frameSampleSize The number of samples required to saturate the sliding window
  116715. */
  116716. constructor(frameSampleSize?: number);
  116717. /**
  116718. * Samples current frame
  116719. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  116720. */
  116721. sampleFrame(timeMs?: number): void;
  116722. /**
  116723. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  116724. */
  116725. get averageFrameTime(): number;
  116726. /**
  116727. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  116728. */
  116729. get averageFrameTimeVariance(): number;
  116730. /**
  116731. * Returns the frame time of the most recent frame
  116732. */
  116733. get instantaneousFrameTime(): number;
  116734. /**
  116735. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  116736. */
  116737. get averageFPS(): number;
  116738. /**
  116739. * Returns the average framerate in frames per second using the most recent frame time
  116740. */
  116741. get instantaneousFPS(): number;
  116742. /**
  116743. * Returns true if enough samples have been taken to completely fill the sliding window
  116744. */
  116745. get isSaturated(): boolean;
  116746. /**
  116747. * Enables contributions to the sliding window sample set
  116748. */
  116749. enable(): void;
  116750. /**
  116751. * Disables contributions to the sliding window sample set
  116752. * Samples will not be interpolated over the disabled period
  116753. */
  116754. disable(): void;
  116755. /**
  116756. * Returns true if sampling is enabled
  116757. */
  116758. get isEnabled(): boolean;
  116759. /**
  116760. * Resets performance monitor
  116761. */
  116762. reset(): void;
  116763. }
  116764. /**
  116765. * RollingAverage
  116766. *
  116767. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  116768. */
  116769. export class RollingAverage {
  116770. /**
  116771. * Current average
  116772. */
  116773. average: number;
  116774. /**
  116775. * Current variance
  116776. */
  116777. variance: number;
  116778. protected _samples: Array<number>;
  116779. protected _sampleCount: number;
  116780. protected _pos: number;
  116781. protected _m2: number;
  116782. /**
  116783. * constructor
  116784. * @param length The number of samples required to saturate the sliding window
  116785. */
  116786. constructor(length: number);
  116787. /**
  116788. * Adds a sample to the sample set
  116789. * @param v The sample value
  116790. */
  116791. add(v: number): void;
  116792. /**
  116793. * Returns previously added values or null if outside of history or outside the sliding window domain
  116794. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  116795. * @return Value previously recorded with add() or null if outside of range
  116796. */
  116797. history(i: number): number;
  116798. /**
  116799. * Returns true if enough samples have been taken to completely fill the sliding window
  116800. * @return true if sample-set saturated
  116801. */
  116802. isSaturated(): boolean;
  116803. /**
  116804. * Resets the rolling average (equivalent to 0 samples taken so far)
  116805. */
  116806. reset(): void;
  116807. /**
  116808. * Wraps a value around the sample range boundaries
  116809. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  116810. * @return Wrapped position in sample range
  116811. */
  116812. protected _wrapPosition(i: number): number;
  116813. }
  116814. }
  116815. declare module BABYLON {
  116816. /**
  116817. * This class is used to track a performance counter which is number based.
  116818. * The user has access to many properties which give statistics of different nature.
  116819. *
  116820. * The implementer can track two kinds of Performance Counter: time and count.
  116821. * 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.
  116822. * 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.
  116823. */
  116824. export class PerfCounter {
  116825. /**
  116826. * Gets or sets a global boolean to turn on and off all the counters
  116827. */
  116828. static Enabled: boolean;
  116829. /**
  116830. * Returns the smallest value ever
  116831. */
  116832. get min(): number;
  116833. /**
  116834. * Returns the biggest value ever
  116835. */
  116836. get max(): number;
  116837. /**
  116838. * Returns the average value since the performance counter is running
  116839. */
  116840. get average(): number;
  116841. /**
  116842. * Returns the average value of the last second the counter was monitored
  116843. */
  116844. get lastSecAverage(): number;
  116845. /**
  116846. * Returns the current value
  116847. */
  116848. get current(): number;
  116849. /**
  116850. * Gets the accumulated total
  116851. */
  116852. get total(): number;
  116853. /**
  116854. * Gets the total value count
  116855. */
  116856. get count(): number;
  116857. /**
  116858. * Creates a new counter
  116859. */
  116860. constructor();
  116861. /**
  116862. * Call this method to start monitoring a new frame.
  116863. * 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.
  116864. */
  116865. fetchNewFrame(): void;
  116866. /**
  116867. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  116868. * @param newCount the count value to add to the monitored count
  116869. * @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.
  116870. */
  116871. addCount(newCount: number, fetchResult: boolean): void;
  116872. /**
  116873. * Start monitoring this performance counter
  116874. */
  116875. beginMonitoring(): void;
  116876. /**
  116877. * Compute the time lapsed since the previous beginMonitoring() call.
  116878. * @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
  116879. */
  116880. endMonitoring(newFrame?: boolean): void;
  116881. private _fetchResult;
  116882. private _startMonitoringTime;
  116883. private _min;
  116884. private _max;
  116885. private _average;
  116886. private _current;
  116887. private _totalValueCount;
  116888. private _totalAccumulated;
  116889. private _lastSecAverage;
  116890. private _lastSecAccumulated;
  116891. private _lastSecTime;
  116892. private _lastSecValueCount;
  116893. }
  116894. }
  116895. declare module BABYLON {
  116896. interface ThinEngine {
  116897. /** @hidden */
  116898. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  116899. }
  116900. }
  116901. declare module BABYLON {
  116902. /**
  116903. * Defines the interface used by display changed events
  116904. */
  116905. export interface IDisplayChangedEventArgs {
  116906. /** Gets the vrDisplay object (if any) */
  116907. vrDisplay: Nullable<any>;
  116908. /** Gets a boolean indicating if webVR is supported */
  116909. vrSupported: boolean;
  116910. }
  116911. /**
  116912. * Defines the interface used by objects containing a viewport (like a camera)
  116913. */
  116914. interface IViewportOwnerLike {
  116915. /**
  116916. * Gets or sets the viewport
  116917. */
  116918. viewport: IViewportLike;
  116919. }
  116920. /**
  116921. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  116922. */
  116923. export class Engine extends ThinEngine {
  116924. /** Defines that alpha blending is disabled */
  116925. static readonly ALPHA_DISABLE: number;
  116926. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  116927. static readonly ALPHA_ADD: number;
  116928. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  116929. static readonly ALPHA_COMBINE: number;
  116930. /** Defines that alpha blending to DEST - SRC * DEST */
  116931. static readonly ALPHA_SUBTRACT: number;
  116932. /** Defines that alpha blending to SRC * DEST */
  116933. static readonly ALPHA_MULTIPLY: number;
  116934. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  116935. static readonly ALPHA_MAXIMIZED: number;
  116936. /** Defines that alpha blending to SRC + DEST */
  116937. static readonly ALPHA_ONEONE: number;
  116938. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  116939. static readonly ALPHA_PREMULTIPLIED: number;
  116940. /**
  116941. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  116942. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  116943. */
  116944. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  116945. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  116946. static readonly ALPHA_INTERPOLATE: number;
  116947. /**
  116948. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  116949. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  116950. */
  116951. static readonly ALPHA_SCREENMODE: number;
  116952. /** Defines that the ressource is not delayed*/
  116953. static readonly DELAYLOADSTATE_NONE: number;
  116954. /** Defines that the ressource was successfully delay loaded */
  116955. static readonly DELAYLOADSTATE_LOADED: number;
  116956. /** Defines that the ressource is currently delay loading */
  116957. static readonly DELAYLOADSTATE_LOADING: number;
  116958. /** Defines that the ressource is delayed and has not started loading */
  116959. static readonly DELAYLOADSTATE_NOTLOADED: number;
  116960. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  116961. static readonly NEVER: number;
  116962. /** 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 */
  116963. static readonly ALWAYS: number;
  116964. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  116965. static readonly LESS: number;
  116966. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  116967. static readonly EQUAL: number;
  116968. /** 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 */
  116969. static readonly LEQUAL: number;
  116970. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  116971. static readonly GREATER: number;
  116972. /** 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 */
  116973. static readonly GEQUAL: number;
  116974. /** 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 */
  116975. static readonly NOTEQUAL: number;
  116976. /** Passed to stencilOperation to specify that stencil value must be kept */
  116977. static readonly KEEP: number;
  116978. /** Passed to stencilOperation to specify that stencil value must be replaced */
  116979. static readonly REPLACE: number;
  116980. /** Passed to stencilOperation to specify that stencil value must be incremented */
  116981. static readonly INCR: number;
  116982. /** Passed to stencilOperation to specify that stencil value must be decremented */
  116983. static readonly DECR: number;
  116984. /** Passed to stencilOperation to specify that stencil value must be inverted */
  116985. static readonly INVERT: number;
  116986. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  116987. static readonly INCR_WRAP: number;
  116988. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  116989. static readonly DECR_WRAP: number;
  116990. /** Texture is not repeating outside of 0..1 UVs */
  116991. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  116992. /** Texture is repeating outside of 0..1 UVs */
  116993. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  116994. /** Texture is repeating and mirrored */
  116995. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  116996. /** ALPHA */
  116997. static readonly TEXTUREFORMAT_ALPHA: number;
  116998. /** LUMINANCE */
  116999. static readonly TEXTUREFORMAT_LUMINANCE: number;
  117000. /** LUMINANCE_ALPHA */
  117001. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  117002. /** RGB */
  117003. static readonly TEXTUREFORMAT_RGB: number;
  117004. /** RGBA */
  117005. static readonly TEXTUREFORMAT_RGBA: number;
  117006. /** RED */
  117007. static readonly TEXTUREFORMAT_RED: number;
  117008. /** RED (2nd reference) */
  117009. static readonly TEXTUREFORMAT_R: number;
  117010. /** RG */
  117011. static readonly TEXTUREFORMAT_RG: number;
  117012. /** RED_INTEGER */
  117013. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  117014. /** RED_INTEGER (2nd reference) */
  117015. static readonly TEXTUREFORMAT_R_INTEGER: number;
  117016. /** RG_INTEGER */
  117017. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  117018. /** RGB_INTEGER */
  117019. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  117020. /** RGBA_INTEGER */
  117021. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  117022. /** UNSIGNED_BYTE */
  117023. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  117024. /** UNSIGNED_BYTE (2nd reference) */
  117025. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  117026. /** FLOAT */
  117027. static readonly TEXTURETYPE_FLOAT: number;
  117028. /** HALF_FLOAT */
  117029. static readonly TEXTURETYPE_HALF_FLOAT: number;
  117030. /** BYTE */
  117031. static readonly TEXTURETYPE_BYTE: number;
  117032. /** SHORT */
  117033. static readonly TEXTURETYPE_SHORT: number;
  117034. /** UNSIGNED_SHORT */
  117035. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  117036. /** INT */
  117037. static readonly TEXTURETYPE_INT: number;
  117038. /** UNSIGNED_INT */
  117039. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  117040. /** UNSIGNED_SHORT_4_4_4_4 */
  117041. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  117042. /** UNSIGNED_SHORT_5_5_5_1 */
  117043. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  117044. /** UNSIGNED_SHORT_5_6_5 */
  117045. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  117046. /** UNSIGNED_INT_2_10_10_10_REV */
  117047. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  117048. /** UNSIGNED_INT_24_8 */
  117049. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  117050. /** UNSIGNED_INT_10F_11F_11F_REV */
  117051. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  117052. /** UNSIGNED_INT_5_9_9_9_REV */
  117053. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  117054. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  117055. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  117056. /** nearest is mag = nearest and min = nearest and mip = linear */
  117057. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  117058. /** Bilinear is mag = linear and min = linear and mip = nearest */
  117059. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  117060. /** Trilinear is mag = linear and min = linear and mip = linear */
  117061. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  117062. /** nearest is mag = nearest and min = nearest and mip = linear */
  117063. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  117064. /** Bilinear is mag = linear and min = linear and mip = nearest */
  117065. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  117066. /** Trilinear is mag = linear and min = linear and mip = linear */
  117067. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  117068. /** mag = nearest and min = nearest and mip = nearest */
  117069. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  117070. /** mag = nearest and min = linear and mip = nearest */
  117071. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  117072. /** mag = nearest and min = linear and mip = linear */
  117073. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  117074. /** mag = nearest and min = linear and mip = none */
  117075. static readonly TEXTURE_NEAREST_LINEAR: number;
  117076. /** mag = nearest and min = nearest and mip = none */
  117077. static readonly TEXTURE_NEAREST_NEAREST: number;
  117078. /** mag = linear and min = nearest and mip = nearest */
  117079. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  117080. /** mag = linear and min = nearest and mip = linear */
  117081. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  117082. /** mag = linear and min = linear and mip = none */
  117083. static readonly TEXTURE_LINEAR_LINEAR: number;
  117084. /** mag = linear and min = nearest and mip = none */
  117085. static readonly TEXTURE_LINEAR_NEAREST: number;
  117086. /** Explicit coordinates mode */
  117087. static readonly TEXTURE_EXPLICIT_MODE: number;
  117088. /** Spherical coordinates mode */
  117089. static readonly TEXTURE_SPHERICAL_MODE: number;
  117090. /** Planar coordinates mode */
  117091. static readonly TEXTURE_PLANAR_MODE: number;
  117092. /** Cubic coordinates mode */
  117093. static readonly TEXTURE_CUBIC_MODE: number;
  117094. /** Projection coordinates mode */
  117095. static readonly TEXTURE_PROJECTION_MODE: number;
  117096. /** Skybox coordinates mode */
  117097. static readonly TEXTURE_SKYBOX_MODE: number;
  117098. /** Inverse Cubic coordinates mode */
  117099. static readonly TEXTURE_INVCUBIC_MODE: number;
  117100. /** Equirectangular coordinates mode */
  117101. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  117102. /** Equirectangular Fixed coordinates mode */
  117103. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  117104. /** Equirectangular Fixed Mirrored coordinates mode */
  117105. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  117106. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  117107. static readonly SCALEMODE_FLOOR: number;
  117108. /** Defines that texture rescaling will look for the nearest power of 2 size */
  117109. static readonly SCALEMODE_NEAREST: number;
  117110. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  117111. static readonly SCALEMODE_CEILING: number;
  117112. /**
  117113. * Returns the current npm package of the sdk
  117114. */
  117115. static get NpmPackage(): string;
  117116. /**
  117117. * Returns the current version of the framework
  117118. */
  117119. static get Version(): string;
  117120. /** Gets the list of created engines */
  117121. static get Instances(): Engine[];
  117122. /**
  117123. * Gets the latest created engine
  117124. */
  117125. static get LastCreatedEngine(): Nullable<Engine>;
  117126. /**
  117127. * Gets the latest created scene
  117128. */
  117129. static get LastCreatedScene(): Nullable<Scene>;
  117130. /**
  117131. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  117132. * @param flag defines which part of the materials must be marked as dirty
  117133. * @param predicate defines a predicate used to filter which materials should be affected
  117134. */
  117135. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  117136. /**
  117137. * Method called to create the default loading screen.
  117138. * This can be overriden in your own app.
  117139. * @param canvas The rendering canvas element
  117140. * @returns The loading screen
  117141. */
  117142. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  117143. /**
  117144. * Method called to create the default rescale post process on each engine.
  117145. */
  117146. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  117147. /**
  117148. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  117149. **/
  117150. enableOfflineSupport: boolean;
  117151. /**
  117152. * 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)
  117153. **/
  117154. disableManifestCheck: boolean;
  117155. /**
  117156. * Gets the list of created scenes
  117157. */
  117158. scenes: Scene[];
  117159. /**
  117160. * Event raised when a new scene is created
  117161. */
  117162. onNewSceneAddedObservable: Observable<Scene>;
  117163. /**
  117164. * Gets the list of created postprocesses
  117165. */
  117166. postProcesses: PostProcess[];
  117167. /**
  117168. * Gets a boolean indicating if the pointer is currently locked
  117169. */
  117170. isPointerLock: boolean;
  117171. /**
  117172. * Observable event triggered each time the rendering canvas is resized
  117173. */
  117174. onResizeObservable: Observable<Engine>;
  117175. /**
  117176. * Observable event triggered each time the canvas loses focus
  117177. */
  117178. onCanvasBlurObservable: Observable<Engine>;
  117179. /**
  117180. * Observable event triggered each time the canvas gains focus
  117181. */
  117182. onCanvasFocusObservable: Observable<Engine>;
  117183. /**
  117184. * Observable event triggered each time the canvas receives pointerout event
  117185. */
  117186. onCanvasPointerOutObservable: Observable<PointerEvent>;
  117187. /**
  117188. * Observable raised when the engine begins a new frame
  117189. */
  117190. onBeginFrameObservable: Observable<Engine>;
  117191. /**
  117192. * If set, will be used to request the next animation frame for the render loop
  117193. */
  117194. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  117195. /**
  117196. * Observable raised when the engine ends the current frame
  117197. */
  117198. onEndFrameObservable: Observable<Engine>;
  117199. /**
  117200. * Observable raised when the engine is about to compile a shader
  117201. */
  117202. onBeforeShaderCompilationObservable: Observable<Engine>;
  117203. /**
  117204. * Observable raised when the engine has jsut compiled a shader
  117205. */
  117206. onAfterShaderCompilationObservable: Observable<Engine>;
  117207. /**
  117208. * Gets the audio engine
  117209. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  117210. * @ignorenaming
  117211. */
  117212. static audioEngine: IAudioEngine;
  117213. /**
  117214. * Default AudioEngine factory responsible of creating the Audio Engine.
  117215. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  117216. */
  117217. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  117218. /**
  117219. * Default offline support factory responsible of creating a tool used to store data locally.
  117220. * By default, this will create a Database object if the workload has been embedded.
  117221. */
  117222. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  117223. private _loadingScreen;
  117224. private _pointerLockRequested;
  117225. private _rescalePostProcess;
  117226. private _deterministicLockstep;
  117227. private _lockstepMaxSteps;
  117228. private _timeStep;
  117229. protected get _supportsHardwareTextureRescaling(): boolean;
  117230. private _fps;
  117231. private _deltaTime;
  117232. /** @hidden */
  117233. _drawCalls: PerfCounter;
  117234. /** 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 */
  117235. canvasTabIndex: number;
  117236. /**
  117237. * Turn this value on if you want to pause FPS computation when in background
  117238. */
  117239. disablePerformanceMonitorInBackground: boolean;
  117240. private _performanceMonitor;
  117241. /**
  117242. * Gets the performance monitor attached to this engine
  117243. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  117244. */
  117245. get performanceMonitor(): PerformanceMonitor;
  117246. private _onFocus;
  117247. private _onBlur;
  117248. private _onCanvasPointerOut;
  117249. private _onCanvasBlur;
  117250. private _onCanvasFocus;
  117251. private _onFullscreenChange;
  117252. private _onPointerLockChange;
  117253. /**
  117254. * Gets the HTML element used to attach event listeners
  117255. * @returns a HTML element
  117256. */
  117257. getInputElement(): Nullable<HTMLElement>;
  117258. /**
  117259. * Creates a new engine
  117260. * @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
  117261. * @param antialias defines enable antialiasing (default: false)
  117262. * @param options defines further options to be sent to the getContext() function
  117263. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  117264. */
  117265. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  117266. /**
  117267. * Gets current aspect ratio
  117268. * @param viewportOwner defines the camera to use to get the aspect ratio
  117269. * @param useScreen defines if screen size must be used (or the current render target if any)
  117270. * @returns a number defining the aspect ratio
  117271. */
  117272. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  117273. /**
  117274. * Gets current screen aspect ratio
  117275. * @returns a number defining the aspect ratio
  117276. */
  117277. getScreenAspectRatio(): number;
  117278. /**
  117279. * Gets the client rect of the HTML canvas attached with the current webGL context
  117280. * @returns a client rectanglee
  117281. */
  117282. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  117283. /**
  117284. * Gets the client rect of the HTML element used for events
  117285. * @returns a client rectanglee
  117286. */
  117287. getInputElementClientRect(): Nullable<ClientRect>;
  117288. /**
  117289. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  117290. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  117291. * @returns true if engine is in deterministic lock step mode
  117292. */
  117293. isDeterministicLockStep(): boolean;
  117294. /**
  117295. * Gets the max steps when engine is running in deterministic lock step
  117296. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  117297. * @returns the max steps
  117298. */
  117299. getLockstepMaxSteps(): number;
  117300. /**
  117301. * Returns the time in ms between steps when using deterministic lock step.
  117302. * @returns time step in (ms)
  117303. */
  117304. getTimeStep(): number;
  117305. /**
  117306. * Force the mipmap generation for the given render target texture
  117307. * @param texture defines the render target texture to use
  117308. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  117309. */
  117310. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  117311. /** States */
  117312. /**
  117313. * Set various states to the webGL context
  117314. * @param culling defines backface culling state
  117315. * @param zOffset defines the value to apply to zOffset (0 by default)
  117316. * @param force defines if states must be applied even if cache is up to date
  117317. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  117318. */
  117319. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  117320. /**
  117321. * Set the z offset to apply to current rendering
  117322. * @param value defines the offset to apply
  117323. */
  117324. setZOffset(value: number): void;
  117325. /**
  117326. * Gets the current value of the zOffset
  117327. * @returns the current zOffset state
  117328. */
  117329. getZOffset(): number;
  117330. /**
  117331. * Enable or disable depth buffering
  117332. * @param enable defines the state to set
  117333. */
  117334. setDepthBuffer(enable: boolean): void;
  117335. /**
  117336. * Gets a boolean indicating if depth writing is enabled
  117337. * @returns the current depth writing state
  117338. */
  117339. getDepthWrite(): boolean;
  117340. /**
  117341. * Enable or disable depth writing
  117342. * @param enable defines the state to set
  117343. */
  117344. setDepthWrite(enable: boolean): void;
  117345. /**
  117346. * Gets a boolean indicating if stencil buffer is enabled
  117347. * @returns the current stencil buffer state
  117348. */
  117349. getStencilBuffer(): boolean;
  117350. /**
  117351. * Enable or disable the stencil buffer
  117352. * @param enable defines if the stencil buffer must be enabled or disabled
  117353. */
  117354. setStencilBuffer(enable: boolean): void;
  117355. /**
  117356. * Gets the current stencil mask
  117357. * @returns a number defining the new stencil mask to use
  117358. */
  117359. getStencilMask(): number;
  117360. /**
  117361. * Sets the current stencil mask
  117362. * @param mask defines the new stencil mask to use
  117363. */
  117364. setStencilMask(mask: number): void;
  117365. /**
  117366. * Gets the current stencil function
  117367. * @returns a number defining the stencil function to use
  117368. */
  117369. getStencilFunction(): number;
  117370. /**
  117371. * Gets the current stencil reference value
  117372. * @returns a number defining the stencil reference value to use
  117373. */
  117374. getStencilFunctionReference(): number;
  117375. /**
  117376. * Gets the current stencil mask
  117377. * @returns a number defining the stencil mask to use
  117378. */
  117379. getStencilFunctionMask(): number;
  117380. /**
  117381. * Sets the current stencil function
  117382. * @param stencilFunc defines the new stencil function to use
  117383. */
  117384. setStencilFunction(stencilFunc: number): void;
  117385. /**
  117386. * Sets the current stencil reference
  117387. * @param reference defines the new stencil reference to use
  117388. */
  117389. setStencilFunctionReference(reference: number): void;
  117390. /**
  117391. * Sets the current stencil mask
  117392. * @param mask defines the new stencil mask to use
  117393. */
  117394. setStencilFunctionMask(mask: number): void;
  117395. /**
  117396. * Gets the current stencil operation when stencil fails
  117397. * @returns a number defining stencil operation to use when stencil fails
  117398. */
  117399. getStencilOperationFail(): number;
  117400. /**
  117401. * Gets the current stencil operation when depth fails
  117402. * @returns a number defining stencil operation to use when depth fails
  117403. */
  117404. getStencilOperationDepthFail(): number;
  117405. /**
  117406. * Gets the current stencil operation when stencil passes
  117407. * @returns a number defining stencil operation to use when stencil passes
  117408. */
  117409. getStencilOperationPass(): number;
  117410. /**
  117411. * Sets the stencil operation to use when stencil fails
  117412. * @param operation defines the stencil operation to use when stencil fails
  117413. */
  117414. setStencilOperationFail(operation: number): void;
  117415. /**
  117416. * Sets the stencil operation to use when depth fails
  117417. * @param operation defines the stencil operation to use when depth fails
  117418. */
  117419. setStencilOperationDepthFail(operation: number): void;
  117420. /**
  117421. * Sets the stencil operation to use when stencil passes
  117422. * @param operation defines the stencil operation to use when stencil passes
  117423. */
  117424. setStencilOperationPass(operation: number): void;
  117425. /**
  117426. * Sets a boolean indicating if the dithering state is enabled or disabled
  117427. * @param value defines the dithering state
  117428. */
  117429. setDitheringState(value: boolean): void;
  117430. /**
  117431. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  117432. * @param value defines the rasterizer state
  117433. */
  117434. setRasterizerState(value: boolean): void;
  117435. /**
  117436. * Gets the current depth function
  117437. * @returns a number defining the depth function
  117438. */
  117439. getDepthFunction(): Nullable<number>;
  117440. /**
  117441. * Sets the current depth function
  117442. * @param depthFunc defines the function to use
  117443. */
  117444. setDepthFunction(depthFunc: number): void;
  117445. /**
  117446. * Sets the current depth function to GREATER
  117447. */
  117448. setDepthFunctionToGreater(): void;
  117449. /**
  117450. * Sets the current depth function to GEQUAL
  117451. */
  117452. setDepthFunctionToGreaterOrEqual(): void;
  117453. /**
  117454. * Sets the current depth function to LESS
  117455. */
  117456. setDepthFunctionToLess(): void;
  117457. /**
  117458. * Sets the current depth function to LEQUAL
  117459. */
  117460. setDepthFunctionToLessOrEqual(): void;
  117461. private _cachedStencilBuffer;
  117462. private _cachedStencilFunction;
  117463. private _cachedStencilMask;
  117464. private _cachedStencilOperationPass;
  117465. private _cachedStencilOperationFail;
  117466. private _cachedStencilOperationDepthFail;
  117467. private _cachedStencilReference;
  117468. /**
  117469. * Caches the the state of the stencil buffer
  117470. */
  117471. cacheStencilState(): void;
  117472. /**
  117473. * Restores the state of the stencil buffer
  117474. */
  117475. restoreStencilState(): void;
  117476. /**
  117477. * Directly set the WebGL Viewport
  117478. * @param x defines the x coordinate of the viewport (in screen space)
  117479. * @param y defines the y coordinate of the viewport (in screen space)
  117480. * @param width defines the width of the viewport (in screen space)
  117481. * @param height defines the height of the viewport (in screen space)
  117482. * @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
  117483. */
  117484. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  117485. /**
  117486. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  117487. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  117488. * @param y defines the y-coordinate of the corner of the clear rectangle
  117489. * @param width defines the width of the clear rectangle
  117490. * @param height defines the height of the clear rectangle
  117491. * @param clearColor defines the clear color
  117492. */
  117493. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  117494. /**
  117495. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  117496. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  117497. * @param y defines the y-coordinate of the corner of the clear rectangle
  117498. * @param width defines the width of the clear rectangle
  117499. * @param height defines the height of the clear rectangle
  117500. */
  117501. enableScissor(x: number, y: number, width: number, height: number): void;
  117502. /**
  117503. * Disable previously set scissor test rectangle
  117504. */
  117505. disableScissor(): void;
  117506. protected _reportDrawCall(): void;
  117507. /**
  117508. * Initializes a webVR display and starts listening to display change events
  117509. * The onVRDisplayChangedObservable will be notified upon these changes
  117510. * @returns The onVRDisplayChangedObservable
  117511. */
  117512. initWebVR(): Observable<IDisplayChangedEventArgs>;
  117513. /** @hidden */
  117514. _prepareVRComponent(): void;
  117515. /** @hidden */
  117516. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  117517. /** @hidden */
  117518. _submitVRFrame(): void;
  117519. /**
  117520. * Call this function to leave webVR mode
  117521. * Will do nothing if webVR is not supported or if there is no webVR device
  117522. * @see https://doc.babylonjs.com/how_to/webvr_camera
  117523. */
  117524. disableVR(): void;
  117525. /**
  117526. * Gets a boolean indicating that the system is in VR mode and is presenting
  117527. * @returns true if VR mode is engaged
  117528. */
  117529. isVRPresenting(): boolean;
  117530. /** @hidden */
  117531. _requestVRFrame(): void;
  117532. /** @hidden */
  117533. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  117534. /**
  117535. * Gets the source code of the vertex shader associated with a specific webGL program
  117536. * @param program defines the program to use
  117537. * @returns a string containing the source code of the vertex shader associated with the program
  117538. */
  117539. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  117540. /**
  117541. * Gets the source code of the fragment shader associated with a specific webGL program
  117542. * @param program defines the program to use
  117543. * @returns a string containing the source code of the fragment shader associated with the program
  117544. */
  117545. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  117546. /**
  117547. * Sets a depth stencil texture from a render target to the according uniform.
  117548. * @param channel The texture channel
  117549. * @param uniform The uniform to set
  117550. * @param texture The render target texture containing the depth stencil texture to apply
  117551. */
  117552. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  117553. /**
  117554. * Sets a texture to the webGL context from a postprocess
  117555. * @param channel defines the channel to use
  117556. * @param postProcess defines the source postprocess
  117557. */
  117558. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  117559. /**
  117560. * Binds the output of the passed in post process to the texture channel specified
  117561. * @param channel The channel the texture should be bound to
  117562. * @param postProcess The post process which's output should be bound
  117563. */
  117564. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  117565. protected _rebuildBuffers(): void;
  117566. /** @hidden */
  117567. _renderFrame(): void;
  117568. _renderLoop(): void;
  117569. /** @hidden */
  117570. _renderViews(): boolean;
  117571. /**
  117572. * Toggle full screen mode
  117573. * @param requestPointerLock defines if a pointer lock should be requested from the user
  117574. */
  117575. switchFullscreen(requestPointerLock: boolean): void;
  117576. /**
  117577. * Enters full screen mode
  117578. * @param requestPointerLock defines if a pointer lock should be requested from the user
  117579. */
  117580. enterFullscreen(requestPointerLock: boolean): void;
  117581. /**
  117582. * Exits full screen mode
  117583. */
  117584. exitFullscreen(): void;
  117585. /**
  117586. * Enters Pointerlock mode
  117587. */
  117588. enterPointerlock(): void;
  117589. /**
  117590. * Exits Pointerlock mode
  117591. */
  117592. exitPointerlock(): void;
  117593. /**
  117594. * Begin a new frame
  117595. */
  117596. beginFrame(): void;
  117597. /**
  117598. * Enf the current frame
  117599. */
  117600. endFrame(): void;
  117601. resize(): void;
  117602. /**
  117603. * Force a specific size of the canvas
  117604. * @param width defines the new canvas' width
  117605. * @param height defines the new canvas' height
  117606. * @returns true if the size was changed
  117607. */
  117608. setSize(width: number, height: number): boolean;
  117609. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  117610. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  117611. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  117612. _releaseTexture(texture: InternalTexture): void;
  117613. /**
  117614. * @hidden
  117615. * Rescales a texture
  117616. * @param source input texutre
  117617. * @param destination destination texture
  117618. * @param scene scene to use to render the resize
  117619. * @param internalFormat format to use when resizing
  117620. * @param onComplete callback to be called when resize has completed
  117621. */
  117622. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  117623. /**
  117624. * Gets the current framerate
  117625. * @returns a number representing the framerate
  117626. */
  117627. getFps(): number;
  117628. /**
  117629. * Gets the time spent between current and previous frame
  117630. * @returns a number representing the delta time in ms
  117631. */
  117632. getDeltaTime(): number;
  117633. private _measureFps;
  117634. /** @hidden */
  117635. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  117636. /**
  117637. * Updates the sample count of a render target texture
  117638. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  117639. * @param texture defines the texture to update
  117640. * @param samples defines the sample count to set
  117641. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  117642. */
  117643. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  117644. /**
  117645. * Updates a depth texture Comparison Mode and Function.
  117646. * If the comparison Function is equal to 0, the mode will be set to none.
  117647. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  117648. * @param texture The texture to set the comparison function for
  117649. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  117650. */
  117651. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  117652. /**
  117653. * Creates a webGL buffer to use with instanciation
  117654. * @param capacity defines the size of the buffer
  117655. * @returns the webGL buffer
  117656. */
  117657. createInstancesBuffer(capacity: number): DataBuffer;
  117658. /**
  117659. * Delete a webGL buffer used with instanciation
  117660. * @param buffer defines the webGL buffer to delete
  117661. */
  117662. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  117663. private _clientWaitAsync;
  117664. /** @hidden */
  117665. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  117666. dispose(): void;
  117667. private _disableTouchAction;
  117668. /**
  117669. * Display the loading screen
  117670. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117671. */
  117672. displayLoadingUI(): void;
  117673. /**
  117674. * Hide the loading screen
  117675. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117676. */
  117677. hideLoadingUI(): void;
  117678. /**
  117679. * Gets the current loading screen object
  117680. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117681. */
  117682. get loadingScreen(): ILoadingScreen;
  117683. /**
  117684. * Sets the current loading screen object
  117685. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117686. */
  117687. set loadingScreen(loadingScreen: ILoadingScreen);
  117688. /**
  117689. * Sets the current loading screen text
  117690. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117691. */
  117692. set loadingUIText(text: string);
  117693. /**
  117694. * Sets the current loading screen background color
  117695. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117696. */
  117697. set loadingUIBackgroundColor(color: string);
  117698. /** Pointerlock and fullscreen */
  117699. /**
  117700. * Ask the browser to promote the current element to pointerlock mode
  117701. * @param element defines the DOM element to promote
  117702. */
  117703. static _RequestPointerlock(element: HTMLElement): void;
  117704. /**
  117705. * Asks the browser to exit pointerlock mode
  117706. */
  117707. static _ExitPointerlock(): void;
  117708. /**
  117709. * Ask the browser to promote the current element to fullscreen rendering mode
  117710. * @param element defines the DOM element to promote
  117711. */
  117712. static _RequestFullscreen(element: HTMLElement): void;
  117713. /**
  117714. * Asks the browser to exit fullscreen mode
  117715. */
  117716. static _ExitFullscreen(): void;
  117717. }
  117718. }
  117719. declare module BABYLON {
  117720. /**
  117721. * The engine store class is responsible to hold all the instances of Engine and Scene created
  117722. * during the life time of the application.
  117723. */
  117724. export class EngineStore {
  117725. /** Gets the list of created engines */
  117726. static Instances: Engine[];
  117727. /** @hidden */
  117728. static _LastCreatedScene: Nullable<Scene>;
  117729. /**
  117730. * Gets the latest created engine
  117731. */
  117732. static get LastCreatedEngine(): Nullable<Engine>;
  117733. /**
  117734. * Gets the latest created scene
  117735. */
  117736. static get LastCreatedScene(): Nullable<Scene>;
  117737. /**
  117738. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  117739. * @ignorenaming
  117740. */
  117741. static UseFallbackTexture: boolean;
  117742. /**
  117743. * Texture content used if a texture cannot loaded
  117744. * @ignorenaming
  117745. */
  117746. static FallbackTexture: string;
  117747. }
  117748. }
  117749. declare module BABYLON {
  117750. /**
  117751. * Helper class that provides a small promise polyfill
  117752. */
  117753. export class PromisePolyfill {
  117754. /**
  117755. * Static function used to check if the polyfill is required
  117756. * If this is the case then the function will inject the polyfill to window.Promise
  117757. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  117758. */
  117759. static Apply(force?: boolean): void;
  117760. }
  117761. }
  117762. declare module BABYLON {
  117763. /**
  117764. * Interface for screenshot methods with describe argument called `size` as object with options
  117765. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  117766. */
  117767. export interface IScreenshotSize {
  117768. /**
  117769. * number in pixels for canvas height
  117770. */
  117771. height?: number;
  117772. /**
  117773. * multiplier allowing render at a higher or lower resolution
  117774. * If value is defined then height and width will be ignored and taken from camera
  117775. */
  117776. precision?: number;
  117777. /**
  117778. * number in pixels for canvas width
  117779. */
  117780. width?: number;
  117781. }
  117782. }
  117783. declare module BABYLON {
  117784. interface IColor4Like {
  117785. r: float;
  117786. g: float;
  117787. b: float;
  117788. a: float;
  117789. }
  117790. /**
  117791. * Class containing a set of static utilities functions
  117792. */
  117793. export class Tools {
  117794. /**
  117795. * Gets or sets the base URL to use to load assets
  117796. */
  117797. static get BaseUrl(): string;
  117798. static set BaseUrl(value: string);
  117799. /**
  117800. * Enable/Disable Custom HTTP Request Headers globally.
  117801. * default = false
  117802. * @see CustomRequestHeaders
  117803. */
  117804. static UseCustomRequestHeaders: boolean;
  117805. /**
  117806. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  117807. * i.e. when loading files, where the server/service expects an Authorization header
  117808. */
  117809. static CustomRequestHeaders: {
  117810. [key: string]: string;
  117811. };
  117812. /**
  117813. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  117814. */
  117815. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  117816. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  117817. /**
  117818. * Default behaviour for cors in the application.
  117819. * It can be a string if the expected behavior is identical in the entire app.
  117820. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  117821. */
  117822. static get CorsBehavior(): string | ((url: string | string[]) => string);
  117823. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  117824. /**
  117825. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  117826. * @ignorenaming
  117827. */
  117828. static get UseFallbackTexture(): boolean;
  117829. static set UseFallbackTexture(value: boolean);
  117830. /**
  117831. * Use this object to register external classes like custom textures or material
  117832. * to allow the laoders to instantiate them
  117833. */
  117834. static get RegisteredExternalClasses(): {
  117835. [key: string]: Object;
  117836. };
  117837. static set RegisteredExternalClasses(classes: {
  117838. [key: string]: Object;
  117839. });
  117840. /**
  117841. * Texture content used if a texture cannot loaded
  117842. * @ignorenaming
  117843. */
  117844. static get fallbackTexture(): string;
  117845. static set fallbackTexture(value: string);
  117846. /**
  117847. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  117848. * @param u defines the coordinate on X axis
  117849. * @param v defines the coordinate on Y axis
  117850. * @param width defines the width of the source data
  117851. * @param height defines the height of the source data
  117852. * @param pixels defines the source byte array
  117853. * @param color defines the output color
  117854. */
  117855. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  117856. /**
  117857. * Interpolates between a and b via alpha
  117858. * @param a The lower value (returned when alpha = 0)
  117859. * @param b The upper value (returned when alpha = 1)
  117860. * @param alpha The interpolation-factor
  117861. * @return The mixed value
  117862. */
  117863. static Mix(a: number, b: number, alpha: number): number;
  117864. /**
  117865. * Tries to instantiate a new object from a given class name
  117866. * @param className defines the class name to instantiate
  117867. * @returns the new object or null if the system was not able to do the instantiation
  117868. */
  117869. static Instantiate(className: string): any;
  117870. /**
  117871. * Provides a slice function that will work even on IE
  117872. * @param data defines the array to slice
  117873. * @param start defines the start of the data (optional)
  117874. * @param end defines the end of the data (optional)
  117875. * @returns the new sliced array
  117876. */
  117877. static Slice<T>(data: T, start?: number, end?: number): T;
  117878. /**
  117879. * Polyfill for setImmediate
  117880. * @param action defines the action to execute after the current execution block
  117881. */
  117882. static SetImmediate(action: () => void): void;
  117883. /**
  117884. * Function indicating if a number is an exponent of 2
  117885. * @param value defines the value to test
  117886. * @returns true if the value is an exponent of 2
  117887. */
  117888. static IsExponentOfTwo(value: number): boolean;
  117889. private static _tmpFloatArray;
  117890. /**
  117891. * Returns the nearest 32-bit single precision float representation of a Number
  117892. * @param value A Number. If the parameter is of a different type, it will get converted
  117893. * to a number or to NaN if it cannot be converted
  117894. * @returns number
  117895. */
  117896. static FloatRound(value: number): number;
  117897. /**
  117898. * Extracts the filename from a path
  117899. * @param path defines the path to use
  117900. * @returns the filename
  117901. */
  117902. static GetFilename(path: string): string;
  117903. /**
  117904. * Extracts the "folder" part of a path (everything before the filename).
  117905. * @param uri The URI to extract the info from
  117906. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  117907. * @returns The "folder" part of the path
  117908. */
  117909. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  117910. /**
  117911. * Extracts text content from a DOM element hierarchy
  117912. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  117913. */
  117914. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  117915. /**
  117916. * Convert an angle in radians to degrees
  117917. * @param angle defines the angle to convert
  117918. * @returns the angle in degrees
  117919. */
  117920. static ToDegrees(angle: number): number;
  117921. /**
  117922. * Convert an angle in degrees to radians
  117923. * @param angle defines the angle to convert
  117924. * @returns the angle in radians
  117925. */
  117926. static ToRadians(angle: number): number;
  117927. /**
  117928. * Returns an array if obj is not an array
  117929. * @param obj defines the object to evaluate as an array
  117930. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  117931. * @returns either obj directly if obj is an array or a new array containing obj
  117932. */
  117933. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  117934. /**
  117935. * Gets the pointer prefix to use
  117936. * @param engine defines the engine we are finding the prefix for
  117937. * @returns "pointer" if touch is enabled. Else returns "mouse"
  117938. */
  117939. static GetPointerPrefix(engine: Engine): string;
  117940. /**
  117941. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  117942. * @param url define the url we are trying
  117943. * @param element define the dom element where to configure the cors policy
  117944. */
  117945. static SetCorsBehavior(url: string | string[], element: {
  117946. crossOrigin: string | null;
  117947. }): void;
  117948. /**
  117949. * Removes unwanted characters from an url
  117950. * @param url defines the url to clean
  117951. * @returns the cleaned url
  117952. */
  117953. static CleanUrl(url: string): string;
  117954. /**
  117955. * Gets or sets a function used to pre-process url before using them to load assets
  117956. */
  117957. static get PreprocessUrl(): (url: string) => string;
  117958. static set PreprocessUrl(processor: (url: string) => string);
  117959. /**
  117960. * Loads an image as an HTMLImageElement.
  117961. * @param input url string, ArrayBuffer, or Blob to load
  117962. * @param onLoad callback called when the image successfully loads
  117963. * @param onError callback called when the image fails to load
  117964. * @param offlineProvider offline provider for caching
  117965. * @param mimeType optional mime type
  117966. * @returns the HTMLImageElement of the loaded image
  117967. */
  117968. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  117969. /**
  117970. * Loads a file from a url
  117971. * @param url url string, ArrayBuffer, or Blob to load
  117972. * @param onSuccess callback called when the file successfully loads
  117973. * @param onProgress callback called while file is loading (if the server supports this mode)
  117974. * @param offlineProvider defines the offline provider for caching
  117975. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  117976. * @param onError callback called when the file fails to load
  117977. * @returns a file request object
  117978. */
  117979. 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;
  117980. /**
  117981. * Loads a file from a url
  117982. * @param url the file url to load
  117983. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  117984. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  117985. */
  117986. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  117987. /**
  117988. * Load a script (identified by an url). When the url returns, the
  117989. * content of this file is added into a new script element, attached to the DOM (body element)
  117990. * @param scriptUrl defines the url of the script to laod
  117991. * @param onSuccess defines the callback called when the script is loaded
  117992. * @param onError defines the callback to call if an error occurs
  117993. * @param scriptId defines the id of the script element
  117994. */
  117995. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  117996. /**
  117997. * Load an asynchronous script (identified by an url). When the url returns, the
  117998. * content of this file is added into a new script element, attached to the DOM (body element)
  117999. * @param scriptUrl defines the url of the script to laod
  118000. * @param scriptId defines the id of the script element
  118001. * @returns a promise request object
  118002. */
  118003. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  118004. /**
  118005. * Loads a file from a blob
  118006. * @param fileToLoad defines the blob to use
  118007. * @param callback defines the callback to call when data is loaded
  118008. * @param progressCallback defines the callback to call during loading process
  118009. * @returns a file request object
  118010. */
  118011. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  118012. /**
  118013. * Reads a file from a File object
  118014. * @param file defines the file to load
  118015. * @param onSuccess defines the callback to call when data is loaded
  118016. * @param onProgress defines the callback to call during loading process
  118017. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  118018. * @param onError defines the callback to call when an error occurs
  118019. * @returns a file request object
  118020. */
  118021. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  118022. /**
  118023. * Creates a data url from a given string content
  118024. * @param content defines the content to convert
  118025. * @returns the new data url link
  118026. */
  118027. static FileAsURL(content: string): string;
  118028. /**
  118029. * Format the given number to a specific decimal format
  118030. * @param value defines the number to format
  118031. * @param decimals defines the number of decimals to use
  118032. * @returns the formatted string
  118033. */
  118034. static Format(value: number, decimals?: number): string;
  118035. /**
  118036. * Tries to copy an object by duplicating every property
  118037. * @param source defines the source object
  118038. * @param destination defines the target object
  118039. * @param doNotCopyList defines a list of properties to avoid
  118040. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  118041. */
  118042. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  118043. /**
  118044. * Gets a boolean indicating if the given object has no own property
  118045. * @param obj defines the object to test
  118046. * @returns true if object has no own property
  118047. */
  118048. static IsEmpty(obj: any): boolean;
  118049. /**
  118050. * Function used to register events at window level
  118051. * @param windowElement defines the Window object to use
  118052. * @param events defines the events to register
  118053. */
  118054. static RegisterTopRootEvents(windowElement: Window, events: {
  118055. name: string;
  118056. handler: Nullable<(e: FocusEvent) => any>;
  118057. }[]): void;
  118058. /**
  118059. * Function used to unregister events from window level
  118060. * @param windowElement defines the Window object to use
  118061. * @param events defines the events to unregister
  118062. */
  118063. static UnregisterTopRootEvents(windowElement: Window, events: {
  118064. name: string;
  118065. handler: Nullable<(e: FocusEvent) => any>;
  118066. }[]): void;
  118067. /**
  118068. * @ignore
  118069. */
  118070. static _ScreenshotCanvas: HTMLCanvasElement;
  118071. /**
  118072. * Dumps the current bound framebuffer
  118073. * @param width defines the rendering width
  118074. * @param height defines the rendering height
  118075. * @param engine defines the hosting engine
  118076. * @param successCallback defines the callback triggered once the data are available
  118077. * @param mimeType defines the mime type of the result
  118078. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  118079. */
  118080. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  118081. /**
  118082. * Converts the canvas data to blob.
  118083. * This acts as a polyfill for browsers not supporting the to blob function.
  118084. * @param canvas Defines the canvas to extract the data from
  118085. * @param successCallback Defines the callback triggered once the data are available
  118086. * @param mimeType Defines the mime type of the result
  118087. */
  118088. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  118089. /**
  118090. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  118091. * @param successCallback defines the callback triggered once the data are available
  118092. * @param mimeType defines the mime type of the result
  118093. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  118094. */
  118095. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  118096. /**
  118097. * Downloads a blob in the browser
  118098. * @param blob defines the blob to download
  118099. * @param fileName defines the name of the downloaded file
  118100. */
  118101. static Download(blob: Blob, fileName: string): void;
  118102. /**
  118103. * Captures a screenshot of the current rendering
  118104. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118105. * @param engine defines the rendering engine
  118106. * @param camera defines the source camera
  118107. * @param size This parameter can be set to a single number or to an object with the
  118108. * following (optional) properties: precision, width, height. If a single number is passed,
  118109. * it will be used for both width and height. If an object is passed, the screenshot size
  118110. * will be derived from the parameters. The precision property is a multiplier allowing
  118111. * rendering at a higher or lower resolution
  118112. * @param successCallback defines the callback receives a single parameter which contains the
  118113. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  118114. * src parameter of an <img> to display it
  118115. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  118116. * Check your browser for supported MIME types
  118117. */
  118118. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  118119. /**
  118120. * Captures a screenshot of the current rendering
  118121. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118122. * @param engine defines the rendering engine
  118123. * @param camera defines the source camera
  118124. * @param size This parameter can be set to a single number or to an object with the
  118125. * following (optional) properties: precision, width, height. If a single number is passed,
  118126. * it will be used for both width and height. If an object is passed, the screenshot size
  118127. * will be derived from the parameters. The precision property is a multiplier allowing
  118128. * rendering at a higher or lower resolution
  118129. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  118130. * Check your browser for supported MIME types
  118131. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  118132. * to the src parameter of an <img> to display it
  118133. */
  118134. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  118135. /**
  118136. * Generates an image screenshot from the specified camera.
  118137. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118138. * @param engine The engine to use for rendering
  118139. * @param camera The camera to use for rendering
  118140. * @param size This parameter can be set to a single number or to an object with the
  118141. * following (optional) properties: precision, width, height. If a single number is passed,
  118142. * it will be used for both width and height. If an object is passed, the screenshot size
  118143. * will be derived from the parameters. The precision property is a multiplier allowing
  118144. * rendering at a higher or lower resolution
  118145. * @param successCallback The callback receives a single parameter which contains the
  118146. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  118147. * src parameter of an <img> to display it
  118148. * @param mimeType The MIME type of the screenshot image (default: image/png).
  118149. * Check your browser for supported MIME types
  118150. * @param samples Texture samples (default: 1)
  118151. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  118152. * @param fileName A name for for the downloaded file.
  118153. */
  118154. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  118155. /**
  118156. * Generates an image screenshot from the specified camera.
  118157. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118158. * @param engine The engine to use for rendering
  118159. * @param camera The camera to use for rendering
  118160. * @param size This parameter can be set to a single number or to an object with the
  118161. * following (optional) properties: precision, width, height. If a single number is passed,
  118162. * it will be used for both width and height. If an object is passed, the screenshot size
  118163. * will be derived from the parameters. The precision property is a multiplier allowing
  118164. * rendering at a higher or lower resolution
  118165. * @param mimeType The MIME type of the screenshot image (default: image/png).
  118166. * Check your browser for supported MIME types
  118167. * @param samples Texture samples (default: 1)
  118168. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  118169. * @param fileName A name for for the downloaded file.
  118170. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  118171. * to the src parameter of an <img> to display it
  118172. */
  118173. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  118174. /**
  118175. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  118176. * Be aware Math.random() could cause collisions, but:
  118177. * "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"
  118178. * @returns a pseudo random id
  118179. */
  118180. static RandomId(): string;
  118181. /**
  118182. * Test if the given uri is a base64 string
  118183. * @param uri The uri to test
  118184. * @return True if the uri is a base64 string or false otherwise
  118185. */
  118186. static IsBase64(uri: string): boolean;
  118187. /**
  118188. * Decode the given base64 uri.
  118189. * @param uri The uri to decode
  118190. * @return The decoded base64 data.
  118191. */
  118192. static DecodeBase64(uri: string): ArrayBuffer;
  118193. /**
  118194. * Gets the absolute url.
  118195. * @param url the input url
  118196. * @return the absolute url
  118197. */
  118198. static GetAbsoluteUrl(url: string): string;
  118199. /**
  118200. * No log
  118201. */
  118202. static readonly NoneLogLevel: number;
  118203. /**
  118204. * Only message logs
  118205. */
  118206. static readonly MessageLogLevel: number;
  118207. /**
  118208. * Only warning logs
  118209. */
  118210. static readonly WarningLogLevel: number;
  118211. /**
  118212. * Only error logs
  118213. */
  118214. static readonly ErrorLogLevel: number;
  118215. /**
  118216. * All logs
  118217. */
  118218. static readonly AllLogLevel: number;
  118219. /**
  118220. * Gets a value indicating the number of loading errors
  118221. * @ignorenaming
  118222. */
  118223. static get errorsCount(): number;
  118224. /**
  118225. * Callback called when a new log is added
  118226. */
  118227. static OnNewCacheEntry: (entry: string) => void;
  118228. /**
  118229. * Log a message to the console
  118230. * @param message defines the message to log
  118231. */
  118232. static Log(message: string): void;
  118233. /**
  118234. * Write a warning message to the console
  118235. * @param message defines the message to log
  118236. */
  118237. static Warn(message: string): void;
  118238. /**
  118239. * Write an error message to the console
  118240. * @param message defines the message to log
  118241. */
  118242. static Error(message: string): void;
  118243. /**
  118244. * Gets current log cache (list of logs)
  118245. */
  118246. static get LogCache(): string;
  118247. /**
  118248. * Clears the log cache
  118249. */
  118250. static ClearLogCache(): void;
  118251. /**
  118252. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  118253. */
  118254. static set LogLevels(level: number);
  118255. /**
  118256. * Checks if the window object exists
  118257. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  118258. */
  118259. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  118260. /**
  118261. * No performance log
  118262. */
  118263. static readonly PerformanceNoneLogLevel: number;
  118264. /**
  118265. * Use user marks to log performance
  118266. */
  118267. static readonly PerformanceUserMarkLogLevel: number;
  118268. /**
  118269. * Log performance to the console
  118270. */
  118271. static readonly PerformanceConsoleLogLevel: number;
  118272. private static _performance;
  118273. /**
  118274. * Sets the current performance log level
  118275. */
  118276. static set PerformanceLogLevel(level: number);
  118277. private static _StartPerformanceCounterDisabled;
  118278. private static _EndPerformanceCounterDisabled;
  118279. private static _StartUserMark;
  118280. private static _EndUserMark;
  118281. private static _StartPerformanceConsole;
  118282. private static _EndPerformanceConsole;
  118283. /**
  118284. * Starts a performance counter
  118285. */
  118286. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  118287. /**
  118288. * Ends a specific performance coutner
  118289. */
  118290. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  118291. /**
  118292. * Gets either window.performance.now() if supported or Date.now() else
  118293. */
  118294. static get Now(): number;
  118295. /**
  118296. * This method will return the name of the class used to create the instance of the given object.
  118297. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  118298. * @param object the object to get the class name from
  118299. * @param isType defines if the object is actually a type
  118300. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  118301. */
  118302. static GetClassName(object: any, isType?: boolean): string;
  118303. /**
  118304. * Gets the first element of an array satisfying a given predicate
  118305. * @param array defines the array to browse
  118306. * @param predicate defines the predicate to use
  118307. * @returns null if not found or the element
  118308. */
  118309. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  118310. /**
  118311. * This method will return the name of the full name of the class, including its owning module (if any).
  118312. * 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).
  118313. * @param object the object to get the class name from
  118314. * @param isType defines if the object is actually a type
  118315. * @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.
  118316. * @ignorenaming
  118317. */
  118318. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  118319. /**
  118320. * Returns a promise that resolves after the given amount of time.
  118321. * @param delay Number of milliseconds to delay
  118322. * @returns Promise that resolves after the given amount of time
  118323. */
  118324. static DelayAsync(delay: number): Promise<void>;
  118325. /**
  118326. * Utility function to detect if the current user agent is Safari
  118327. * @returns whether or not the current user agent is safari
  118328. */
  118329. static IsSafari(): boolean;
  118330. }
  118331. /**
  118332. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  118333. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  118334. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  118335. * @param name The name of the class, case should be preserved
  118336. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  118337. */
  118338. export function className(name: string, module?: string): (target: Object) => void;
  118339. /**
  118340. * An implementation of a loop for asynchronous functions.
  118341. */
  118342. export class AsyncLoop {
  118343. /**
  118344. * Defines the number of iterations for the loop
  118345. */
  118346. iterations: number;
  118347. /**
  118348. * Defines the current index of the loop.
  118349. */
  118350. index: number;
  118351. private _done;
  118352. private _fn;
  118353. private _successCallback;
  118354. /**
  118355. * Constructor.
  118356. * @param iterations the number of iterations.
  118357. * @param func the function to run each iteration
  118358. * @param successCallback the callback that will be called upon succesful execution
  118359. * @param offset starting offset.
  118360. */
  118361. constructor(
  118362. /**
  118363. * Defines the number of iterations for the loop
  118364. */
  118365. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  118366. /**
  118367. * Execute the next iteration. Must be called after the last iteration was finished.
  118368. */
  118369. executeNext(): void;
  118370. /**
  118371. * Break the loop and run the success callback.
  118372. */
  118373. breakLoop(): void;
  118374. /**
  118375. * Create and run an async loop.
  118376. * @param iterations the number of iterations.
  118377. * @param fn the function to run each iteration
  118378. * @param successCallback the callback that will be called upon succesful execution
  118379. * @param offset starting offset.
  118380. * @returns the created async loop object
  118381. */
  118382. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  118383. /**
  118384. * A for-loop that will run a given number of iterations synchronous and the rest async.
  118385. * @param iterations total number of iterations
  118386. * @param syncedIterations number of synchronous iterations in each async iteration.
  118387. * @param fn the function to call each iteration.
  118388. * @param callback a success call back that will be called when iterating stops.
  118389. * @param breakFunction a break condition (optional)
  118390. * @param timeout timeout settings for the setTimeout function. default - 0.
  118391. * @returns the created async loop object
  118392. */
  118393. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  118394. }
  118395. }
  118396. declare module BABYLON {
  118397. /**
  118398. * This class implement a typical dictionary using a string as key and the generic type T as value.
  118399. * The underlying implementation relies on an associative array to ensure the best performances.
  118400. * The value can be anything including 'null' but except 'undefined'
  118401. */
  118402. export class StringDictionary<T> {
  118403. /**
  118404. * This will clear this dictionary and copy the content from the 'source' one.
  118405. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  118406. * @param source the dictionary to take the content from and copy to this dictionary
  118407. */
  118408. copyFrom(source: StringDictionary<T>): void;
  118409. /**
  118410. * Get a value based from its key
  118411. * @param key the given key to get the matching value from
  118412. * @return the value if found, otherwise undefined is returned
  118413. */
  118414. get(key: string): T | undefined;
  118415. /**
  118416. * Get a value from its key or add it if it doesn't exist.
  118417. * This method will ensure you that a given key/data will be present in the dictionary.
  118418. * @param key the given key to get the matching value from
  118419. * @param factory the factory that will create the value if the key is not present in the dictionary.
  118420. * The factory will only be invoked if there's no data for the given key.
  118421. * @return the value corresponding to the key.
  118422. */
  118423. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  118424. /**
  118425. * Get a value from its key if present in the dictionary otherwise add it
  118426. * @param key the key to get the value from
  118427. * @param val if there's no such key/value pair in the dictionary add it with this value
  118428. * @return the value corresponding to the key
  118429. */
  118430. getOrAdd(key: string, val: T): T;
  118431. /**
  118432. * Check if there's a given key in the dictionary
  118433. * @param key the key to check for
  118434. * @return true if the key is present, false otherwise
  118435. */
  118436. contains(key: string): boolean;
  118437. /**
  118438. * Add a new key and its corresponding value
  118439. * @param key the key to add
  118440. * @param value the value corresponding to the key
  118441. * @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
  118442. */
  118443. add(key: string, value: T): boolean;
  118444. /**
  118445. * Update a specific value associated to a key
  118446. * @param key defines the key to use
  118447. * @param value defines the value to store
  118448. * @returns true if the value was updated (or false if the key was not found)
  118449. */
  118450. set(key: string, value: T): boolean;
  118451. /**
  118452. * Get the element of the given key and remove it from the dictionary
  118453. * @param key defines the key to search
  118454. * @returns the value associated with the key or null if not found
  118455. */
  118456. getAndRemove(key: string): Nullable<T>;
  118457. /**
  118458. * Remove a key/value from the dictionary.
  118459. * @param key the key to remove
  118460. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  118461. */
  118462. remove(key: string): boolean;
  118463. /**
  118464. * Clear the whole content of the dictionary
  118465. */
  118466. clear(): void;
  118467. /**
  118468. * Gets the current count
  118469. */
  118470. get count(): number;
  118471. /**
  118472. * Execute a callback on each key/val of the dictionary.
  118473. * Note that you can remove any element in this dictionary in the callback implementation
  118474. * @param callback the callback to execute on a given key/value pair
  118475. */
  118476. forEach(callback: (key: string, val: T) => void): void;
  118477. /**
  118478. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  118479. * If the callback returns null or undefined the method will iterate to the next key/value pair
  118480. * Note that you can remove any element in this dictionary in the callback implementation
  118481. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  118482. * @returns the first item
  118483. */
  118484. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  118485. private _count;
  118486. private _data;
  118487. }
  118488. }
  118489. declare module BABYLON {
  118490. /** @hidden */
  118491. export interface ICollisionCoordinator {
  118492. createCollider(): Collider;
  118493. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  118494. init(scene: Scene): void;
  118495. }
  118496. /** @hidden */
  118497. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  118498. private _scene;
  118499. private _scaledPosition;
  118500. private _scaledVelocity;
  118501. private _finalPosition;
  118502. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  118503. createCollider(): Collider;
  118504. init(scene: Scene): void;
  118505. private _collideWithWorld;
  118506. }
  118507. }
  118508. declare module BABYLON {
  118509. /**
  118510. * Class used to manage all inputs for the scene.
  118511. */
  118512. export class InputManager {
  118513. /** The distance in pixel that you have to move to prevent some events */
  118514. static DragMovementThreshold: number;
  118515. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  118516. static LongPressDelay: number;
  118517. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  118518. static DoubleClickDelay: number;
  118519. /** If you need to check double click without raising a single click at first click, enable this flag */
  118520. static ExclusiveDoubleClickMode: boolean;
  118521. /** 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. */
  118522. private _alreadyAttached;
  118523. private _wheelEventName;
  118524. private _onPointerMove;
  118525. private _onPointerDown;
  118526. private _onPointerUp;
  118527. private _initClickEvent;
  118528. private _initActionManager;
  118529. private _delayedSimpleClick;
  118530. private _delayedSimpleClickTimeout;
  118531. private _previousDelayedSimpleClickTimeout;
  118532. private _meshPickProceed;
  118533. private _previousButtonPressed;
  118534. private _currentPickResult;
  118535. private _previousPickResult;
  118536. private _totalPointersPressed;
  118537. private _doubleClickOccured;
  118538. private _pointerOverMesh;
  118539. private _pickedDownMesh;
  118540. private _pickedUpMesh;
  118541. private _pointerX;
  118542. private _pointerY;
  118543. private _unTranslatedPointerX;
  118544. private _unTranslatedPointerY;
  118545. private _startingPointerPosition;
  118546. private _previousStartingPointerPosition;
  118547. private _startingPointerTime;
  118548. private _previousStartingPointerTime;
  118549. private _pointerCaptures;
  118550. private _onKeyDown;
  118551. private _onKeyUp;
  118552. private _onCanvasFocusObserver;
  118553. private _onCanvasBlurObserver;
  118554. private _scene;
  118555. /**
  118556. * Creates a new InputManager
  118557. * @param scene defines the hosting scene
  118558. */
  118559. constructor(scene: Scene);
  118560. /**
  118561. * Gets the mesh that is currently under the pointer
  118562. */
  118563. get meshUnderPointer(): Nullable<AbstractMesh>;
  118564. /**
  118565. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  118566. */
  118567. get unTranslatedPointer(): Vector2;
  118568. /**
  118569. * Gets or sets the current on-screen X position of the pointer
  118570. */
  118571. get pointerX(): number;
  118572. set pointerX(value: number);
  118573. /**
  118574. * Gets or sets the current on-screen Y position of the pointer
  118575. */
  118576. get pointerY(): number;
  118577. set pointerY(value: number);
  118578. private _updatePointerPosition;
  118579. private _processPointerMove;
  118580. private _setRayOnPointerInfo;
  118581. private _checkPrePointerObservable;
  118582. /**
  118583. * Use this method to simulate a pointer move on a mesh
  118584. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118585. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118586. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118587. */
  118588. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  118589. /**
  118590. * Use this method to simulate a pointer down on a mesh
  118591. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118592. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118593. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118594. */
  118595. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  118596. private _processPointerDown;
  118597. /** @hidden */
  118598. _isPointerSwiping(): boolean;
  118599. /**
  118600. * Use this method to simulate a pointer up on a mesh
  118601. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118602. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118603. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118604. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  118605. */
  118606. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  118607. private _processPointerUp;
  118608. /**
  118609. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  118610. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  118611. * @returns true if the pointer was captured
  118612. */
  118613. isPointerCaptured(pointerId?: number): boolean;
  118614. /**
  118615. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  118616. * @param attachUp defines if you want to attach events to pointerup
  118617. * @param attachDown defines if you want to attach events to pointerdown
  118618. * @param attachMove defines if you want to attach events to pointermove
  118619. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  118620. */
  118621. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  118622. /**
  118623. * Detaches all event handlers
  118624. */
  118625. detachControl(): void;
  118626. /**
  118627. * Force the value of meshUnderPointer
  118628. * @param mesh defines the mesh to use
  118629. */
  118630. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  118631. /**
  118632. * Gets the mesh under the pointer
  118633. * @returns a Mesh or null if no mesh is under the pointer
  118634. */
  118635. getPointerOverMesh(): Nullable<AbstractMesh>;
  118636. }
  118637. }
  118638. declare module BABYLON {
  118639. /**
  118640. * This class defines the direct association between an animation and a target
  118641. */
  118642. export class TargetedAnimation {
  118643. /**
  118644. * Animation to perform
  118645. */
  118646. animation: Animation;
  118647. /**
  118648. * Target to animate
  118649. */
  118650. target: any;
  118651. /**
  118652. * Returns the string "TargetedAnimation"
  118653. * @returns "TargetedAnimation"
  118654. */
  118655. getClassName(): string;
  118656. /**
  118657. * Serialize the object
  118658. * @returns the JSON object representing the current entity
  118659. */
  118660. serialize(): any;
  118661. }
  118662. /**
  118663. * Use this class to create coordinated animations on multiple targets
  118664. */
  118665. export class AnimationGroup implements IDisposable {
  118666. /** The name of the animation group */
  118667. name: string;
  118668. private _scene;
  118669. private _targetedAnimations;
  118670. private _animatables;
  118671. private _from;
  118672. private _to;
  118673. private _isStarted;
  118674. private _isPaused;
  118675. private _speedRatio;
  118676. private _loopAnimation;
  118677. private _isAdditive;
  118678. /**
  118679. * Gets or sets the unique id of the node
  118680. */
  118681. uniqueId: number;
  118682. /**
  118683. * This observable will notify when one animation have ended
  118684. */
  118685. onAnimationEndObservable: Observable<TargetedAnimation>;
  118686. /**
  118687. * Observer raised when one animation loops
  118688. */
  118689. onAnimationLoopObservable: Observable<TargetedAnimation>;
  118690. /**
  118691. * Observer raised when all animations have looped
  118692. */
  118693. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  118694. /**
  118695. * This observable will notify when all animations have ended.
  118696. */
  118697. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  118698. /**
  118699. * This observable will notify when all animations have paused.
  118700. */
  118701. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  118702. /**
  118703. * This observable will notify when all animations are playing.
  118704. */
  118705. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  118706. /**
  118707. * Gets the first frame
  118708. */
  118709. get from(): number;
  118710. /**
  118711. * Gets the last frame
  118712. */
  118713. get to(): number;
  118714. /**
  118715. * Define if the animations are started
  118716. */
  118717. get isStarted(): boolean;
  118718. /**
  118719. * Gets a value indicating that the current group is playing
  118720. */
  118721. get isPlaying(): boolean;
  118722. /**
  118723. * Gets or sets the speed ratio to use for all animations
  118724. */
  118725. get speedRatio(): number;
  118726. /**
  118727. * Gets or sets the speed ratio to use for all animations
  118728. */
  118729. set speedRatio(value: number);
  118730. /**
  118731. * Gets or sets if all animations should loop or not
  118732. */
  118733. get loopAnimation(): boolean;
  118734. set loopAnimation(value: boolean);
  118735. /**
  118736. * Gets or sets if all animations should be evaluated additively
  118737. */
  118738. get isAdditive(): boolean;
  118739. set isAdditive(value: boolean);
  118740. /**
  118741. * Gets the targeted animations for this animation group
  118742. */
  118743. get targetedAnimations(): Array<TargetedAnimation>;
  118744. /**
  118745. * returning the list of animatables controlled by this animation group.
  118746. */
  118747. get animatables(): Array<Animatable>;
  118748. /**
  118749. * Gets the list of target animations
  118750. */
  118751. get children(): TargetedAnimation[];
  118752. /**
  118753. * Instantiates a new Animation Group.
  118754. * This helps managing several animations at once.
  118755. * @see https://doc.babylonjs.com/how_to/group
  118756. * @param name Defines the name of the group
  118757. * @param scene Defines the scene the group belongs to
  118758. */
  118759. constructor(
  118760. /** The name of the animation group */
  118761. name: string, scene?: Nullable<Scene>);
  118762. /**
  118763. * Add an animation (with its target) in the group
  118764. * @param animation defines the animation we want to add
  118765. * @param target defines the target of the animation
  118766. * @returns the TargetedAnimation object
  118767. */
  118768. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  118769. /**
  118770. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  118771. * It can add constant keys at begin or end
  118772. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  118773. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  118774. * @returns the animation group
  118775. */
  118776. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  118777. private _animationLoopCount;
  118778. private _animationLoopFlags;
  118779. private _processLoop;
  118780. /**
  118781. * Start all animations on given targets
  118782. * @param loop defines if animations must loop
  118783. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  118784. * @param from defines the from key (optional)
  118785. * @param to defines the to key (optional)
  118786. * @param isAdditive defines the additive state for the resulting animatables (optional)
  118787. * @returns the current animation group
  118788. */
  118789. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  118790. /**
  118791. * Pause all animations
  118792. * @returns the animation group
  118793. */
  118794. pause(): AnimationGroup;
  118795. /**
  118796. * Play all animations to initial state
  118797. * This function will start() the animations if they were not started or will restart() them if they were paused
  118798. * @param loop defines if animations must loop
  118799. * @returns the animation group
  118800. */
  118801. play(loop?: boolean): AnimationGroup;
  118802. /**
  118803. * Reset all animations to initial state
  118804. * @returns the animation group
  118805. */
  118806. reset(): AnimationGroup;
  118807. /**
  118808. * Restart animations from key 0
  118809. * @returns the animation group
  118810. */
  118811. restart(): AnimationGroup;
  118812. /**
  118813. * Stop all animations
  118814. * @returns the animation group
  118815. */
  118816. stop(): AnimationGroup;
  118817. /**
  118818. * Set animation weight for all animatables
  118819. * @param weight defines the weight to use
  118820. * @return the animationGroup
  118821. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  118822. */
  118823. setWeightForAllAnimatables(weight: number): AnimationGroup;
  118824. /**
  118825. * Synchronize and normalize all animatables with a source animatable
  118826. * @param root defines the root animatable to synchronize with
  118827. * @return the animationGroup
  118828. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  118829. */
  118830. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  118831. /**
  118832. * Goes to a specific frame in this animation group
  118833. * @param frame the frame number to go to
  118834. * @return the animationGroup
  118835. */
  118836. goToFrame(frame: number): AnimationGroup;
  118837. /**
  118838. * Dispose all associated resources
  118839. */
  118840. dispose(): void;
  118841. private _checkAnimationGroupEnded;
  118842. /**
  118843. * Clone the current animation group and returns a copy
  118844. * @param newName defines the name of the new group
  118845. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  118846. * @returns the new aniamtion group
  118847. */
  118848. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  118849. /**
  118850. * Serializes the animationGroup to an object
  118851. * @returns Serialized object
  118852. */
  118853. serialize(): any;
  118854. /**
  118855. * Returns a new AnimationGroup object parsed from the source provided.
  118856. * @param parsedAnimationGroup defines the source
  118857. * @param scene defines the scene that will receive the animationGroup
  118858. * @returns a new AnimationGroup
  118859. */
  118860. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  118861. /**
  118862. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  118863. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  118864. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  118865. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  118866. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  118867. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  118868. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  118869. */
  118870. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  118871. /**
  118872. * Returns the string "AnimationGroup"
  118873. * @returns "AnimationGroup"
  118874. */
  118875. getClassName(): string;
  118876. /**
  118877. * Creates a detailled string about the object
  118878. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  118879. * @returns a string representing the object
  118880. */
  118881. toString(fullDetails?: boolean): string;
  118882. }
  118883. }
  118884. declare module BABYLON {
  118885. /**
  118886. * Define an interface for all classes that will hold resources
  118887. */
  118888. export interface IDisposable {
  118889. /**
  118890. * Releases all held resources
  118891. */
  118892. dispose(): void;
  118893. }
  118894. /** Interface defining initialization parameters for Scene class */
  118895. export interface SceneOptions {
  118896. /**
  118897. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  118898. * It will improve performance when the number of geometries becomes important.
  118899. */
  118900. useGeometryUniqueIdsMap?: boolean;
  118901. /**
  118902. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  118903. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  118904. */
  118905. useMaterialMeshMap?: boolean;
  118906. /**
  118907. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  118908. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  118909. */
  118910. useClonedMeshMap?: boolean;
  118911. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  118912. virtual?: boolean;
  118913. }
  118914. /**
  118915. * Represents a scene to be rendered by the engine.
  118916. * @see https://doc.babylonjs.com/features/scene
  118917. */
  118918. export class Scene extends AbstractScene implements IAnimatable, IClipPlanesHolder {
  118919. /** The fog is deactivated */
  118920. static readonly FOGMODE_NONE: number;
  118921. /** The fog density is following an exponential function */
  118922. static readonly FOGMODE_EXP: number;
  118923. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  118924. static readonly FOGMODE_EXP2: number;
  118925. /** The fog density is following a linear function. */
  118926. static readonly FOGMODE_LINEAR: number;
  118927. /**
  118928. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  118929. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  118930. */
  118931. static MinDeltaTime: number;
  118932. /**
  118933. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  118934. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  118935. */
  118936. static MaxDeltaTime: number;
  118937. /**
  118938. * Factory used to create the default material.
  118939. * @param name The name of the material to create
  118940. * @param scene The scene to create the material for
  118941. * @returns The default material
  118942. */
  118943. static DefaultMaterialFactory(scene: Scene): Material;
  118944. /**
  118945. * Factory used to create the a collision coordinator.
  118946. * @returns The collision coordinator
  118947. */
  118948. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  118949. /** @hidden */
  118950. _inputManager: InputManager;
  118951. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  118952. cameraToUseForPointers: Nullable<Camera>;
  118953. /** @hidden */
  118954. readonly _isScene: boolean;
  118955. /** @hidden */
  118956. _blockEntityCollection: boolean;
  118957. /**
  118958. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  118959. */
  118960. autoClear: boolean;
  118961. /**
  118962. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  118963. */
  118964. autoClearDepthAndStencil: boolean;
  118965. /**
  118966. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  118967. */
  118968. clearColor: Color4;
  118969. /**
  118970. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  118971. */
  118972. ambientColor: Color3;
  118973. /**
  118974. * This is use to store the default BRDF lookup for PBR materials in your scene.
  118975. * It should only be one of the following (if not the default embedded one):
  118976. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  118977. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  118978. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  118979. * The material properties need to be setup according to the type of texture in use.
  118980. */
  118981. environmentBRDFTexture: BaseTexture;
  118982. /**
  118983. * Texture used in all pbr material as the reflection texture.
  118984. * As in the majority of the scene they are the same (exception for multi room and so on),
  118985. * this is easier to reference from here than from all the materials.
  118986. */
  118987. get environmentTexture(): Nullable<BaseTexture>;
  118988. /**
  118989. * Texture used in all pbr material as the reflection texture.
  118990. * As in the majority of the scene they are the same (exception for multi room and so on),
  118991. * this is easier to set here than in all the materials.
  118992. */
  118993. set environmentTexture(value: Nullable<BaseTexture>);
  118994. /** @hidden */
  118995. protected _environmentIntensity: number;
  118996. /**
  118997. * Intensity of the environment in all pbr material.
  118998. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  118999. * As in the majority of the scene they are the same (exception for multi room and so on),
  119000. * this is easier to reference from here than from all the materials.
  119001. */
  119002. get environmentIntensity(): number;
  119003. /**
  119004. * Intensity of the environment in all pbr material.
  119005. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  119006. * As in the majority of the scene they are the same (exception for multi room and so on),
  119007. * this is easier to set here than in all the materials.
  119008. */
  119009. set environmentIntensity(value: number);
  119010. /** @hidden */
  119011. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  119012. /**
  119013. * Default image processing configuration used either in the rendering
  119014. * Forward main pass or through the imageProcessingPostProcess if present.
  119015. * As in the majority of the scene they are the same (exception for multi camera),
  119016. * this is easier to reference from here than from all the materials and post process.
  119017. *
  119018. * No setter as we it is a shared configuration, you can set the values instead.
  119019. */
  119020. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  119021. private _forceWireframe;
  119022. /**
  119023. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  119024. */
  119025. set forceWireframe(value: boolean);
  119026. get forceWireframe(): boolean;
  119027. private _skipFrustumClipping;
  119028. /**
  119029. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  119030. */
  119031. set skipFrustumClipping(value: boolean);
  119032. get skipFrustumClipping(): boolean;
  119033. private _forcePointsCloud;
  119034. /**
  119035. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  119036. */
  119037. set forcePointsCloud(value: boolean);
  119038. get forcePointsCloud(): boolean;
  119039. /**
  119040. * Gets or sets the active clipplane 1
  119041. */
  119042. clipPlane: Nullable<Plane>;
  119043. /**
  119044. * Gets or sets the active clipplane 2
  119045. */
  119046. clipPlane2: Nullable<Plane>;
  119047. /**
  119048. * Gets or sets the active clipplane 3
  119049. */
  119050. clipPlane3: Nullable<Plane>;
  119051. /**
  119052. * Gets or sets the active clipplane 4
  119053. */
  119054. clipPlane4: Nullable<Plane>;
  119055. /**
  119056. * Gets or sets the active clipplane 5
  119057. */
  119058. clipPlane5: Nullable<Plane>;
  119059. /**
  119060. * Gets or sets the active clipplane 6
  119061. */
  119062. clipPlane6: Nullable<Plane>;
  119063. /**
  119064. * Gets or sets a boolean indicating if animations are enabled
  119065. */
  119066. animationsEnabled: boolean;
  119067. private _animationPropertiesOverride;
  119068. /**
  119069. * Gets or sets the animation properties override
  119070. */
  119071. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  119072. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  119073. /**
  119074. * Gets or sets a boolean indicating if a constant deltatime has to be used
  119075. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  119076. */
  119077. useConstantAnimationDeltaTime: boolean;
  119078. /**
  119079. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  119080. * Please note that it requires to run a ray cast through the scene on every frame
  119081. */
  119082. constantlyUpdateMeshUnderPointer: boolean;
  119083. /**
  119084. * Defines the HTML cursor to use when hovering over interactive elements
  119085. */
  119086. hoverCursor: string;
  119087. /**
  119088. * Defines the HTML default cursor to use (empty by default)
  119089. */
  119090. defaultCursor: string;
  119091. /**
  119092. * Defines whether cursors are handled by the scene.
  119093. */
  119094. doNotHandleCursors: boolean;
  119095. /**
  119096. * This is used to call preventDefault() on pointer down
  119097. * in order to block unwanted artifacts like system double clicks
  119098. */
  119099. preventDefaultOnPointerDown: boolean;
  119100. /**
  119101. * This is used to call preventDefault() on pointer up
  119102. * in order to block unwanted artifacts like system double clicks
  119103. */
  119104. preventDefaultOnPointerUp: boolean;
  119105. /**
  119106. * Gets or sets user defined metadata
  119107. */
  119108. metadata: any;
  119109. /**
  119110. * For internal use only. Please do not use.
  119111. */
  119112. reservedDataStore: any;
  119113. /**
  119114. * Gets the name of the plugin used to load this scene (null by default)
  119115. */
  119116. loadingPluginName: string;
  119117. /**
  119118. * Use this array to add regular expressions used to disable offline support for specific urls
  119119. */
  119120. disableOfflineSupportExceptionRules: RegExp[];
  119121. /**
  119122. * An event triggered when the scene is disposed.
  119123. */
  119124. onDisposeObservable: Observable<Scene>;
  119125. private _onDisposeObserver;
  119126. /** Sets a function to be executed when this scene is disposed. */
  119127. set onDispose(callback: () => void);
  119128. /**
  119129. * An event triggered before rendering the scene (right after animations and physics)
  119130. */
  119131. onBeforeRenderObservable: Observable<Scene>;
  119132. private _onBeforeRenderObserver;
  119133. /** Sets a function to be executed before rendering this scene */
  119134. set beforeRender(callback: Nullable<() => void>);
  119135. /**
  119136. * An event triggered after rendering the scene
  119137. */
  119138. onAfterRenderObservable: Observable<Scene>;
  119139. /**
  119140. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  119141. */
  119142. onAfterRenderCameraObservable: Observable<Camera>;
  119143. private _onAfterRenderObserver;
  119144. /** Sets a function to be executed after rendering this scene */
  119145. set afterRender(callback: Nullable<() => void>);
  119146. /**
  119147. * An event triggered before animating the scene
  119148. */
  119149. onBeforeAnimationsObservable: Observable<Scene>;
  119150. /**
  119151. * An event triggered after animations processing
  119152. */
  119153. onAfterAnimationsObservable: Observable<Scene>;
  119154. /**
  119155. * An event triggered before draw calls are ready to be sent
  119156. */
  119157. onBeforeDrawPhaseObservable: Observable<Scene>;
  119158. /**
  119159. * An event triggered after draw calls have been sent
  119160. */
  119161. onAfterDrawPhaseObservable: Observable<Scene>;
  119162. /**
  119163. * An event triggered when the scene is ready
  119164. */
  119165. onReadyObservable: Observable<Scene>;
  119166. /**
  119167. * An event triggered before rendering a camera
  119168. */
  119169. onBeforeCameraRenderObservable: Observable<Camera>;
  119170. private _onBeforeCameraRenderObserver;
  119171. /** Sets a function to be executed before rendering a camera*/
  119172. set beforeCameraRender(callback: () => void);
  119173. /**
  119174. * An event triggered after rendering a camera
  119175. */
  119176. onAfterCameraRenderObservable: Observable<Camera>;
  119177. private _onAfterCameraRenderObserver;
  119178. /** Sets a function to be executed after rendering a camera*/
  119179. set afterCameraRender(callback: () => void);
  119180. /**
  119181. * An event triggered when active meshes evaluation is about to start
  119182. */
  119183. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  119184. /**
  119185. * An event triggered when active meshes evaluation is done
  119186. */
  119187. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  119188. /**
  119189. * An event triggered when particles rendering is about to start
  119190. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  119191. */
  119192. onBeforeParticlesRenderingObservable: Observable<Scene>;
  119193. /**
  119194. * An event triggered when particles rendering is done
  119195. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  119196. */
  119197. onAfterParticlesRenderingObservable: Observable<Scene>;
  119198. /**
  119199. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  119200. */
  119201. onDataLoadedObservable: Observable<Scene>;
  119202. /**
  119203. * An event triggered when a camera is created
  119204. */
  119205. onNewCameraAddedObservable: Observable<Camera>;
  119206. /**
  119207. * An event triggered when a camera is removed
  119208. */
  119209. onCameraRemovedObservable: Observable<Camera>;
  119210. /**
  119211. * An event triggered when a light is created
  119212. */
  119213. onNewLightAddedObservable: Observable<Light>;
  119214. /**
  119215. * An event triggered when a light is removed
  119216. */
  119217. onLightRemovedObservable: Observable<Light>;
  119218. /**
  119219. * An event triggered when a geometry is created
  119220. */
  119221. onNewGeometryAddedObservable: Observable<Geometry>;
  119222. /**
  119223. * An event triggered when a geometry is removed
  119224. */
  119225. onGeometryRemovedObservable: Observable<Geometry>;
  119226. /**
  119227. * An event triggered when a transform node is created
  119228. */
  119229. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  119230. /**
  119231. * An event triggered when a transform node is removed
  119232. */
  119233. onTransformNodeRemovedObservable: Observable<TransformNode>;
  119234. /**
  119235. * An event triggered when a mesh is created
  119236. */
  119237. onNewMeshAddedObservable: Observable<AbstractMesh>;
  119238. /**
  119239. * An event triggered when a mesh is removed
  119240. */
  119241. onMeshRemovedObservable: Observable<AbstractMesh>;
  119242. /**
  119243. * An event triggered when a skeleton is created
  119244. */
  119245. onNewSkeletonAddedObservable: Observable<Skeleton>;
  119246. /**
  119247. * An event triggered when a skeleton is removed
  119248. */
  119249. onSkeletonRemovedObservable: Observable<Skeleton>;
  119250. /**
  119251. * An event triggered when a material is created
  119252. */
  119253. onNewMaterialAddedObservable: Observable<Material>;
  119254. /**
  119255. * An event triggered when a material is removed
  119256. */
  119257. onMaterialRemovedObservable: Observable<Material>;
  119258. /**
  119259. * An event triggered when a texture is created
  119260. */
  119261. onNewTextureAddedObservable: Observable<BaseTexture>;
  119262. /**
  119263. * An event triggered when a texture is removed
  119264. */
  119265. onTextureRemovedObservable: Observable<BaseTexture>;
  119266. /**
  119267. * An event triggered when render targets are about to be rendered
  119268. * Can happen multiple times per frame.
  119269. */
  119270. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  119271. /**
  119272. * An event triggered when render targets were rendered.
  119273. * Can happen multiple times per frame.
  119274. */
  119275. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  119276. /**
  119277. * An event triggered before calculating deterministic simulation step
  119278. */
  119279. onBeforeStepObservable: Observable<Scene>;
  119280. /**
  119281. * An event triggered after calculating deterministic simulation step
  119282. */
  119283. onAfterStepObservable: Observable<Scene>;
  119284. /**
  119285. * An event triggered when the activeCamera property is updated
  119286. */
  119287. onActiveCameraChanged: Observable<Scene>;
  119288. /**
  119289. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  119290. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  119291. * 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)
  119292. */
  119293. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  119294. /**
  119295. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  119296. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  119297. * 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)
  119298. */
  119299. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  119300. /**
  119301. * This Observable will when a mesh has been imported into the scene.
  119302. */
  119303. onMeshImportedObservable: Observable<AbstractMesh>;
  119304. /**
  119305. * This Observable will when an animation file has been imported into the scene.
  119306. */
  119307. onAnimationFileImportedObservable: Observable<Scene>;
  119308. /**
  119309. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  119310. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  119311. */
  119312. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  119313. /** @hidden */
  119314. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  119315. /**
  119316. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  119317. */
  119318. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  119319. /**
  119320. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  119321. */
  119322. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  119323. /**
  119324. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  119325. */
  119326. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  119327. /** Callback called when a pointer move is detected */
  119328. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  119329. /** Callback called when a pointer down is detected */
  119330. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  119331. /** Callback called when a pointer up is detected */
  119332. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  119333. /** Callback called when a pointer pick is detected */
  119334. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  119335. /**
  119336. * 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).
  119337. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  119338. */
  119339. onPrePointerObservable: Observable<PointerInfoPre>;
  119340. /**
  119341. * Observable event triggered each time an input event is received from the rendering canvas
  119342. */
  119343. onPointerObservable: Observable<PointerInfo>;
  119344. /**
  119345. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  119346. */
  119347. get unTranslatedPointer(): Vector2;
  119348. /**
  119349. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  119350. */
  119351. static get DragMovementThreshold(): number;
  119352. static set DragMovementThreshold(value: number);
  119353. /**
  119354. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  119355. */
  119356. static get LongPressDelay(): number;
  119357. static set LongPressDelay(value: number);
  119358. /**
  119359. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  119360. */
  119361. static get DoubleClickDelay(): number;
  119362. static set DoubleClickDelay(value: number);
  119363. /** If you need to check double click without raising a single click at first click, enable this flag */
  119364. static get ExclusiveDoubleClickMode(): boolean;
  119365. static set ExclusiveDoubleClickMode(value: boolean);
  119366. /** @hidden */
  119367. _mirroredCameraPosition: Nullable<Vector3>;
  119368. /**
  119369. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  119370. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  119371. */
  119372. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  119373. /**
  119374. * Observable event triggered each time an keyboard event is received from the hosting window
  119375. */
  119376. onKeyboardObservable: Observable<KeyboardInfo>;
  119377. private _useRightHandedSystem;
  119378. /**
  119379. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  119380. */
  119381. set useRightHandedSystem(value: boolean);
  119382. get useRightHandedSystem(): boolean;
  119383. private _timeAccumulator;
  119384. private _currentStepId;
  119385. private _currentInternalStep;
  119386. /**
  119387. * Sets the step Id used by deterministic lock step
  119388. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119389. * @param newStepId defines the step Id
  119390. */
  119391. setStepId(newStepId: number): void;
  119392. /**
  119393. * Gets the step Id used by deterministic lock step
  119394. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119395. * @returns the step Id
  119396. */
  119397. getStepId(): number;
  119398. /**
  119399. * Gets the internal step used by deterministic lock step
  119400. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119401. * @returns the internal step
  119402. */
  119403. getInternalStep(): number;
  119404. private _fogEnabled;
  119405. /**
  119406. * Gets or sets a boolean indicating if fog is enabled on this scene
  119407. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119408. * (Default is true)
  119409. */
  119410. set fogEnabled(value: boolean);
  119411. get fogEnabled(): boolean;
  119412. private _fogMode;
  119413. /**
  119414. * Gets or sets the fog mode to use
  119415. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119416. * | mode | value |
  119417. * | --- | --- |
  119418. * | FOGMODE_NONE | 0 |
  119419. * | FOGMODE_EXP | 1 |
  119420. * | FOGMODE_EXP2 | 2 |
  119421. * | FOGMODE_LINEAR | 3 |
  119422. */
  119423. set fogMode(value: number);
  119424. get fogMode(): number;
  119425. /**
  119426. * Gets or sets the fog color to use
  119427. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119428. * (Default is Color3(0.2, 0.2, 0.3))
  119429. */
  119430. fogColor: Color3;
  119431. /**
  119432. * Gets or sets the fog density to use
  119433. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119434. * (Default is 0.1)
  119435. */
  119436. fogDensity: number;
  119437. /**
  119438. * Gets or sets the fog start distance to use
  119439. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119440. * (Default is 0)
  119441. */
  119442. fogStart: number;
  119443. /**
  119444. * Gets or sets the fog end distance to use
  119445. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119446. * (Default is 1000)
  119447. */
  119448. fogEnd: number;
  119449. /**
  119450. * Flag indicating that the frame buffer binding is handled by another component
  119451. */
  119452. prePass: boolean;
  119453. private _shadowsEnabled;
  119454. /**
  119455. * Gets or sets a boolean indicating if shadows are enabled on this scene
  119456. */
  119457. set shadowsEnabled(value: boolean);
  119458. get shadowsEnabled(): boolean;
  119459. private _lightsEnabled;
  119460. /**
  119461. * Gets or sets a boolean indicating if lights are enabled on this scene
  119462. */
  119463. set lightsEnabled(value: boolean);
  119464. get lightsEnabled(): boolean;
  119465. /** All of the active cameras added to this scene. */
  119466. activeCameras: Camera[];
  119467. /** @hidden */
  119468. _activeCamera: Nullable<Camera>;
  119469. /** Gets or sets the current active camera */
  119470. get activeCamera(): Nullable<Camera>;
  119471. set activeCamera(value: Nullable<Camera>);
  119472. private _defaultMaterial;
  119473. /** The default material used on meshes when no material is affected */
  119474. get defaultMaterial(): Material;
  119475. /** The default material used on meshes when no material is affected */
  119476. set defaultMaterial(value: Material);
  119477. private _texturesEnabled;
  119478. /**
  119479. * Gets or sets a boolean indicating if textures are enabled on this scene
  119480. */
  119481. set texturesEnabled(value: boolean);
  119482. get texturesEnabled(): boolean;
  119483. /**
  119484. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  119485. */
  119486. physicsEnabled: boolean;
  119487. /**
  119488. * Gets or sets a boolean indicating if particles are enabled on this scene
  119489. */
  119490. particlesEnabled: boolean;
  119491. /**
  119492. * Gets or sets a boolean indicating if sprites are enabled on this scene
  119493. */
  119494. spritesEnabled: boolean;
  119495. private _skeletonsEnabled;
  119496. /**
  119497. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  119498. */
  119499. set skeletonsEnabled(value: boolean);
  119500. get skeletonsEnabled(): boolean;
  119501. /**
  119502. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  119503. */
  119504. lensFlaresEnabled: boolean;
  119505. /**
  119506. * Gets or sets a boolean indicating if collisions are enabled on this scene
  119507. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  119508. */
  119509. collisionsEnabled: boolean;
  119510. private _collisionCoordinator;
  119511. /** @hidden */
  119512. get collisionCoordinator(): ICollisionCoordinator;
  119513. /**
  119514. * Defines the gravity applied to this scene (used only for collisions)
  119515. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  119516. */
  119517. gravity: Vector3;
  119518. /**
  119519. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  119520. */
  119521. postProcessesEnabled: boolean;
  119522. /**
  119523. * Gets the current postprocess manager
  119524. */
  119525. postProcessManager: PostProcessManager;
  119526. /**
  119527. * Gets or sets a boolean indicating if render targets are enabled on this scene
  119528. */
  119529. renderTargetsEnabled: boolean;
  119530. /**
  119531. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  119532. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  119533. */
  119534. dumpNextRenderTargets: boolean;
  119535. /**
  119536. * The list of user defined render targets added to the scene
  119537. */
  119538. customRenderTargets: RenderTargetTexture[];
  119539. /**
  119540. * Defines if texture loading must be delayed
  119541. * If true, textures will only be loaded when they need to be rendered
  119542. */
  119543. useDelayedTextureLoading: boolean;
  119544. /**
  119545. * Gets the list of meshes imported to the scene through SceneLoader
  119546. */
  119547. importedMeshesFiles: String[];
  119548. /**
  119549. * Gets or sets a boolean indicating if probes are enabled on this scene
  119550. */
  119551. probesEnabled: boolean;
  119552. /**
  119553. * Gets or sets the current offline provider to use to store scene data
  119554. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  119555. */
  119556. offlineProvider: IOfflineProvider;
  119557. /**
  119558. * Gets or sets the action manager associated with the scene
  119559. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  119560. */
  119561. actionManager: AbstractActionManager;
  119562. private _meshesForIntersections;
  119563. /**
  119564. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  119565. */
  119566. proceduralTexturesEnabled: boolean;
  119567. private _engine;
  119568. private _totalVertices;
  119569. /** @hidden */
  119570. _activeIndices: PerfCounter;
  119571. /** @hidden */
  119572. _activeParticles: PerfCounter;
  119573. /** @hidden */
  119574. _activeBones: PerfCounter;
  119575. private _animationRatio;
  119576. /** @hidden */
  119577. _animationTimeLast: number;
  119578. /** @hidden */
  119579. _animationTime: number;
  119580. /**
  119581. * Gets or sets a general scale for animation speed
  119582. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  119583. */
  119584. animationTimeScale: number;
  119585. /** @hidden */
  119586. _cachedMaterial: Nullable<Material>;
  119587. /** @hidden */
  119588. _cachedEffect: Nullable<Effect>;
  119589. /** @hidden */
  119590. _cachedVisibility: Nullable<number>;
  119591. private _renderId;
  119592. private _frameId;
  119593. private _executeWhenReadyTimeoutId;
  119594. private _intermediateRendering;
  119595. private _viewUpdateFlag;
  119596. private _projectionUpdateFlag;
  119597. /** @hidden */
  119598. _toBeDisposed: Nullable<IDisposable>[];
  119599. private _activeRequests;
  119600. /** @hidden */
  119601. _pendingData: any[];
  119602. private _isDisposed;
  119603. /**
  119604. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  119605. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  119606. */
  119607. dispatchAllSubMeshesOfActiveMeshes: boolean;
  119608. private _activeMeshes;
  119609. private _processedMaterials;
  119610. private _renderTargets;
  119611. /** @hidden */
  119612. _activeParticleSystems: SmartArray<IParticleSystem>;
  119613. private _activeSkeletons;
  119614. private _softwareSkinnedMeshes;
  119615. private _renderingManager;
  119616. /** @hidden */
  119617. _activeAnimatables: Animatable[];
  119618. private _transformMatrix;
  119619. private _sceneUbo;
  119620. /** @hidden */
  119621. _viewMatrix: Matrix;
  119622. private _projectionMatrix;
  119623. /** @hidden */
  119624. _forcedViewPosition: Nullable<Vector3>;
  119625. /** @hidden */
  119626. _frustumPlanes: Plane[];
  119627. /**
  119628. * Gets the list of frustum planes (built from the active camera)
  119629. */
  119630. get frustumPlanes(): Plane[];
  119631. /**
  119632. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  119633. * This is useful if there are more lights that the maximum simulteanous authorized
  119634. */
  119635. requireLightSorting: boolean;
  119636. /** @hidden */
  119637. readonly useMaterialMeshMap: boolean;
  119638. /** @hidden */
  119639. readonly useClonedMeshMap: boolean;
  119640. private _externalData;
  119641. private _uid;
  119642. /**
  119643. * @hidden
  119644. * Backing store of defined scene components.
  119645. */
  119646. _components: ISceneComponent[];
  119647. /**
  119648. * @hidden
  119649. * Backing store of defined scene components.
  119650. */
  119651. _serializableComponents: ISceneSerializableComponent[];
  119652. /**
  119653. * List of components to register on the next registration step.
  119654. */
  119655. private _transientComponents;
  119656. /**
  119657. * Registers the transient components if needed.
  119658. */
  119659. private _registerTransientComponents;
  119660. /**
  119661. * @hidden
  119662. * Add a component to the scene.
  119663. * Note that the ccomponent could be registered on th next frame if this is called after
  119664. * the register component stage.
  119665. * @param component Defines the component to add to the scene
  119666. */
  119667. _addComponent(component: ISceneComponent): void;
  119668. /**
  119669. * @hidden
  119670. * Gets a component from the scene.
  119671. * @param name defines the name of the component to retrieve
  119672. * @returns the component or null if not present
  119673. */
  119674. _getComponent(name: string): Nullable<ISceneComponent>;
  119675. /**
  119676. * @hidden
  119677. * Defines the actions happening before camera updates.
  119678. */
  119679. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  119680. /**
  119681. * @hidden
  119682. * Defines the actions happening before clear the canvas.
  119683. */
  119684. _beforeClearStage: Stage<SimpleStageAction>;
  119685. /**
  119686. * @hidden
  119687. * Defines the actions when collecting render targets for the frame.
  119688. */
  119689. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  119690. /**
  119691. * @hidden
  119692. * Defines the actions happening for one camera in the frame.
  119693. */
  119694. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  119695. /**
  119696. * @hidden
  119697. * Defines the actions happening during the per mesh ready checks.
  119698. */
  119699. _isReadyForMeshStage: Stage<MeshStageAction>;
  119700. /**
  119701. * @hidden
  119702. * Defines the actions happening before evaluate active mesh checks.
  119703. */
  119704. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  119705. /**
  119706. * @hidden
  119707. * Defines the actions happening during the evaluate sub mesh checks.
  119708. */
  119709. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  119710. /**
  119711. * @hidden
  119712. * Defines the actions happening during the active mesh stage.
  119713. */
  119714. _activeMeshStage: Stage<ActiveMeshStageAction>;
  119715. /**
  119716. * @hidden
  119717. * Defines the actions happening during the per camera render target step.
  119718. */
  119719. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  119720. /**
  119721. * @hidden
  119722. * Defines the actions happening just before the active camera is drawing.
  119723. */
  119724. _beforeCameraDrawStage: Stage<CameraStageAction>;
  119725. /**
  119726. * @hidden
  119727. * Defines the actions happening just before a render target is drawing.
  119728. */
  119729. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  119730. /**
  119731. * @hidden
  119732. * Defines the actions happening just before a rendering group is drawing.
  119733. */
  119734. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  119735. /**
  119736. * @hidden
  119737. * Defines the actions happening just before a mesh is drawing.
  119738. */
  119739. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  119740. /**
  119741. * @hidden
  119742. * Defines the actions happening just after a mesh has been drawn.
  119743. */
  119744. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  119745. /**
  119746. * @hidden
  119747. * Defines the actions happening just after a rendering group has been drawn.
  119748. */
  119749. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  119750. /**
  119751. * @hidden
  119752. * Defines the actions happening just after the active camera has been drawn.
  119753. */
  119754. _afterCameraDrawStage: Stage<CameraStageAction>;
  119755. /**
  119756. * @hidden
  119757. * Defines the actions happening just after a render target has been drawn.
  119758. */
  119759. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  119760. /**
  119761. * @hidden
  119762. * Defines the actions happening just after rendering all cameras and computing intersections.
  119763. */
  119764. _afterRenderStage: Stage<SimpleStageAction>;
  119765. /**
  119766. * @hidden
  119767. * Defines the actions happening when a pointer move event happens.
  119768. */
  119769. _pointerMoveStage: Stage<PointerMoveStageAction>;
  119770. /**
  119771. * @hidden
  119772. * Defines the actions happening when a pointer down event happens.
  119773. */
  119774. _pointerDownStage: Stage<PointerUpDownStageAction>;
  119775. /**
  119776. * @hidden
  119777. * Defines the actions happening when a pointer up event happens.
  119778. */
  119779. _pointerUpStage: Stage<PointerUpDownStageAction>;
  119780. /**
  119781. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  119782. */
  119783. private geometriesByUniqueId;
  119784. /**
  119785. * Creates a new Scene
  119786. * @param engine defines the engine to use to render this scene
  119787. * @param options defines the scene options
  119788. */
  119789. constructor(engine: Engine, options?: SceneOptions);
  119790. /**
  119791. * Gets a string identifying the name of the class
  119792. * @returns "Scene" string
  119793. */
  119794. getClassName(): string;
  119795. private _defaultMeshCandidates;
  119796. /**
  119797. * @hidden
  119798. */
  119799. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  119800. private _defaultSubMeshCandidates;
  119801. /**
  119802. * @hidden
  119803. */
  119804. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  119805. /**
  119806. * Sets the default candidate providers for the scene.
  119807. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  119808. * and getCollidingSubMeshCandidates to their default function
  119809. */
  119810. setDefaultCandidateProviders(): void;
  119811. /**
  119812. * Gets the mesh that is currently under the pointer
  119813. */
  119814. get meshUnderPointer(): Nullable<AbstractMesh>;
  119815. /**
  119816. * Gets or sets the current on-screen X position of the pointer
  119817. */
  119818. get pointerX(): number;
  119819. set pointerX(value: number);
  119820. /**
  119821. * Gets or sets the current on-screen Y position of the pointer
  119822. */
  119823. get pointerY(): number;
  119824. set pointerY(value: number);
  119825. /**
  119826. * Gets the cached material (ie. the latest rendered one)
  119827. * @returns the cached material
  119828. */
  119829. getCachedMaterial(): Nullable<Material>;
  119830. /**
  119831. * Gets the cached effect (ie. the latest rendered one)
  119832. * @returns the cached effect
  119833. */
  119834. getCachedEffect(): Nullable<Effect>;
  119835. /**
  119836. * Gets the cached visibility state (ie. the latest rendered one)
  119837. * @returns the cached visibility state
  119838. */
  119839. getCachedVisibility(): Nullable<number>;
  119840. /**
  119841. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  119842. * @param material defines the current material
  119843. * @param effect defines the current effect
  119844. * @param visibility defines the current visibility state
  119845. * @returns true if one parameter is not cached
  119846. */
  119847. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  119848. /**
  119849. * Gets the engine associated with the scene
  119850. * @returns an Engine
  119851. */
  119852. getEngine(): Engine;
  119853. /**
  119854. * Gets the total number of vertices rendered per frame
  119855. * @returns the total number of vertices rendered per frame
  119856. */
  119857. getTotalVertices(): number;
  119858. /**
  119859. * Gets the performance counter for total vertices
  119860. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119861. */
  119862. get totalVerticesPerfCounter(): PerfCounter;
  119863. /**
  119864. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  119865. * @returns the total number of active indices rendered per frame
  119866. */
  119867. getActiveIndices(): number;
  119868. /**
  119869. * Gets the performance counter for active indices
  119870. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119871. */
  119872. get totalActiveIndicesPerfCounter(): PerfCounter;
  119873. /**
  119874. * Gets the total number of active particles rendered per frame
  119875. * @returns the total number of active particles rendered per frame
  119876. */
  119877. getActiveParticles(): number;
  119878. /**
  119879. * Gets the performance counter for active particles
  119880. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119881. */
  119882. get activeParticlesPerfCounter(): PerfCounter;
  119883. /**
  119884. * Gets the total number of active bones rendered per frame
  119885. * @returns the total number of active bones rendered per frame
  119886. */
  119887. getActiveBones(): number;
  119888. /**
  119889. * Gets the performance counter for active bones
  119890. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119891. */
  119892. get activeBonesPerfCounter(): PerfCounter;
  119893. /**
  119894. * Gets the array of active meshes
  119895. * @returns an array of AbstractMesh
  119896. */
  119897. getActiveMeshes(): SmartArray<AbstractMesh>;
  119898. /**
  119899. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  119900. * @returns a number
  119901. */
  119902. getAnimationRatio(): number;
  119903. /**
  119904. * Gets an unique Id for the current render phase
  119905. * @returns a number
  119906. */
  119907. getRenderId(): number;
  119908. /**
  119909. * Gets an unique Id for the current frame
  119910. * @returns a number
  119911. */
  119912. getFrameId(): number;
  119913. /** Call this function if you want to manually increment the render Id*/
  119914. incrementRenderId(): void;
  119915. private _createUbo;
  119916. /**
  119917. * Use this method to simulate a pointer move on a mesh
  119918. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119919. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119920. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119921. * @returns the current scene
  119922. */
  119923. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  119924. /**
  119925. * Use this method to simulate a pointer down on a mesh
  119926. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119927. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119928. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119929. * @returns the current scene
  119930. */
  119931. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  119932. /**
  119933. * Use this method to simulate a pointer up on a mesh
  119934. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119935. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119936. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119937. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  119938. * @returns the current scene
  119939. */
  119940. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  119941. /**
  119942. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  119943. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  119944. * @returns true if the pointer was captured
  119945. */
  119946. isPointerCaptured(pointerId?: number): boolean;
  119947. /**
  119948. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  119949. * @param attachUp defines if you want to attach events to pointerup
  119950. * @param attachDown defines if you want to attach events to pointerdown
  119951. * @param attachMove defines if you want to attach events to pointermove
  119952. */
  119953. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  119954. /** Detaches all event handlers*/
  119955. detachControl(): void;
  119956. /**
  119957. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  119958. * Delay loaded resources are not taking in account
  119959. * @return true if all required resources are ready
  119960. */
  119961. isReady(): boolean;
  119962. /** Resets all cached information relative to material (including effect and visibility) */
  119963. resetCachedMaterial(): void;
  119964. /**
  119965. * Registers a function to be called before every frame render
  119966. * @param func defines the function to register
  119967. */
  119968. registerBeforeRender(func: () => void): void;
  119969. /**
  119970. * Unregisters a function called before every frame render
  119971. * @param func defines the function to unregister
  119972. */
  119973. unregisterBeforeRender(func: () => void): void;
  119974. /**
  119975. * Registers a function to be called after every frame render
  119976. * @param func defines the function to register
  119977. */
  119978. registerAfterRender(func: () => void): void;
  119979. /**
  119980. * Unregisters a function called after every frame render
  119981. * @param func defines the function to unregister
  119982. */
  119983. unregisterAfterRender(func: () => void): void;
  119984. private _executeOnceBeforeRender;
  119985. /**
  119986. * The provided function will run before render once and will be disposed afterwards.
  119987. * A timeout delay can be provided so that the function will be executed in N ms.
  119988. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  119989. * @param func The function to be executed.
  119990. * @param timeout optional delay in ms
  119991. */
  119992. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  119993. /** @hidden */
  119994. _addPendingData(data: any): void;
  119995. /** @hidden */
  119996. _removePendingData(data: any): void;
  119997. /**
  119998. * Returns the number of items waiting to be loaded
  119999. * @returns the number of items waiting to be loaded
  120000. */
  120001. getWaitingItemsCount(): number;
  120002. /**
  120003. * Returns a boolean indicating if the scene is still loading data
  120004. */
  120005. get isLoading(): boolean;
  120006. /**
  120007. * Registers a function to be executed when the scene is ready
  120008. * @param {Function} func - the function to be executed
  120009. */
  120010. executeWhenReady(func: () => void): void;
  120011. /**
  120012. * Returns a promise that resolves when the scene is ready
  120013. * @returns A promise that resolves when the scene is ready
  120014. */
  120015. whenReadyAsync(): Promise<void>;
  120016. /** @hidden */
  120017. _checkIsReady(): void;
  120018. /**
  120019. * Gets all animatable attached to the scene
  120020. */
  120021. get animatables(): Animatable[];
  120022. /**
  120023. * Resets the last animation time frame.
  120024. * Useful to override when animations start running when loading a scene for the first time.
  120025. */
  120026. resetLastAnimationTimeFrame(): void;
  120027. /**
  120028. * Gets the current view matrix
  120029. * @returns a Matrix
  120030. */
  120031. getViewMatrix(): Matrix;
  120032. /**
  120033. * Gets the current projection matrix
  120034. * @returns a Matrix
  120035. */
  120036. getProjectionMatrix(): Matrix;
  120037. /**
  120038. * Gets the current transform matrix
  120039. * @returns a Matrix made of View * Projection
  120040. */
  120041. getTransformMatrix(): Matrix;
  120042. /**
  120043. * Sets the current transform matrix
  120044. * @param viewL defines the View matrix to use
  120045. * @param projectionL defines the Projection matrix to use
  120046. * @param viewR defines the right View matrix to use (if provided)
  120047. * @param projectionR defines the right Projection matrix to use (if provided)
  120048. */
  120049. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  120050. /**
  120051. * Gets the uniform buffer used to store scene data
  120052. * @returns a UniformBuffer
  120053. */
  120054. getSceneUniformBuffer(): UniformBuffer;
  120055. /**
  120056. * Gets an unique (relatively to the current scene) Id
  120057. * @returns an unique number for the scene
  120058. */
  120059. getUniqueId(): number;
  120060. /**
  120061. * Add a mesh to the list of scene's meshes
  120062. * @param newMesh defines the mesh to add
  120063. * @param recursive if all child meshes should also be added to the scene
  120064. */
  120065. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  120066. /**
  120067. * Remove a mesh for the list of scene's meshes
  120068. * @param toRemove defines the mesh to remove
  120069. * @param recursive if all child meshes should also be removed from the scene
  120070. * @returns the index where the mesh was in the mesh list
  120071. */
  120072. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  120073. /**
  120074. * Add a transform node to the list of scene's transform nodes
  120075. * @param newTransformNode defines the transform node to add
  120076. */
  120077. addTransformNode(newTransformNode: TransformNode): void;
  120078. /**
  120079. * Remove a transform node for the list of scene's transform nodes
  120080. * @param toRemove defines the transform node to remove
  120081. * @returns the index where the transform node was in the transform node list
  120082. */
  120083. removeTransformNode(toRemove: TransformNode): number;
  120084. /**
  120085. * Remove a skeleton for the list of scene's skeletons
  120086. * @param toRemove defines the skeleton to remove
  120087. * @returns the index where the skeleton was in the skeleton list
  120088. */
  120089. removeSkeleton(toRemove: Skeleton): number;
  120090. /**
  120091. * Remove a morph target for the list of scene's morph targets
  120092. * @param toRemove defines the morph target to remove
  120093. * @returns the index where the morph target was in the morph target list
  120094. */
  120095. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  120096. /**
  120097. * Remove a light for the list of scene's lights
  120098. * @param toRemove defines the light to remove
  120099. * @returns the index where the light was in the light list
  120100. */
  120101. removeLight(toRemove: Light): number;
  120102. /**
  120103. * Remove a camera for the list of scene's cameras
  120104. * @param toRemove defines the camera to remove
  120105. * @returns the index where the camera was in the camera list
  120106. */
  120107. removeCamera(toRemove: Camera): number;
  120108. /**
  120109. * Remove a particle system for the list of scene's particle systems
  120110. * @param toRemove defines the particle system to remove
  120111. * @returns the index where the particle system was in the particle system list
  120112. */
  120113. removeParticleSystem(toRemove: IParticleSystem): number;
  120114. /**
  120115. * Remove a animation for the list of scene's animations
  120116. * @param toRemove defines the animation to remove
  120117. * @returns the index where the animation was in the animation list
  120118. */
  120119. removeAnimation(toRemove: Animation): number;
  120120. /**
  120121. * Will stop the animation of the given target
  120122. * @param target - the target
  120123. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  120124. * @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)
  120125. */
  120126. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  120127. /**
  120128. * Removes the given animation group from this scene.
  120129. * @param toRemove The animation group to remove
  120130. * @returns The index of the removed animation group
  120131. */
  120132. removeAnimationGroup(toRemove: AnimationGroup): number;
  120133. /**
  120134. * Removes the given multi-material from this scene.
  120135. * @param toRemove The multi-material to remove
  120136. * @returns The index of the removed multi-material
  120137. */
  120138. removeMultiMaterial(toRemove: MultiMaterial): number;
  120139. /**
  120140. * Removes the given material from this scene.
  120141. * @param toRemove The material to remove
  120142. * @returns The index of the removed material
  120143. */
  120144. removeMaterial(toRemove: Material): number;
  120145. /**
  120146. * Removes the given action manager from this scene.
  120147. * @param toRemove The action manager to remove
  120148. * @returns The index of the removed action manager
  120149. */
  120150. removeActionManager(toRemove: AbstractActionManager): number;
  120151. /**
  120152. * Removes the given texture from this scene.
  120153. * @param toRemove The texture to remove
  120154. * @returns The index of the removed texture
  120155. */
  120156. removeTexture(toRemove: BaseTexture): number;
  120157. /**
  120158. * Adds the given light to this scene
  120159. * @param newLight The light to add
  120160. */
  120161. addLight(newLight: Light): void;
  120162. /**
  120163. * Sorts the list list based on light priorities
  120164. */
  120165. sortLightsByPriority(): void;
  120166. /**
  120167. * Adds the given camera to this scene
  120168. * @param newCamera The camera to add
  120169. */
  120170. addCamera(newCamera: Camera): void;
  120171. /**
  120172. * Adds the given skeleton to this scene
  120173. * @param newSkeleton The skeleton to add
  120174. */
  120175. addSkeleton(newSkeleton: Skeleton): void;
  120176. /**
  120177. * Adds the given particle system to this scene
  120178. * @param newParticleSystem The particle system to add
  120179. */
  120180. addParticleSystem(newParticleSystem: IParticleSystem): void;
  120181. /**
  120182. * Adds the given animation to this scene
  120183. * @param newAnimation The animation to add
  120184. */
  120185. addAnimation(newAnimation: Animation): void;
  120186. /**
  120187. * Adds the given animation group to this scene.
  120188. * @param newAnimationGroup The animation group to add
  120189. */
  120190. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  120191. /**
  120192. * Adds the given multi-material to this scene
  120193. * @param newMultiMaterial The multi-material to add
  120194. */
  120195. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  120196. /**
  120197. * Adds the given material to this scene
  120198. * @param newMaterial The material to add
  120199. */
  120200. addMaterial(newMaterial: Material): void;
  120201. /**
  120202. * Adds the given morph target to this scene
  120203. * @param newMorphTargetManager The morph target to add
  120204. */
  120205. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  120206. /**
  120207. * Adds the given geometry to this scene
  120208. * @param newGeometry The geometry to add
  120209. */
  120210. addGeometry(newGeometry: Geometry): void;
  120211. /**
  120212. * Adds the given action manager to this scene
  120213. * @param newActionManager The action manager to add
  120214. */
  120215. addActionManager(newActionManager: AbstractActionManager): void;
  120216. /**
  120217. * Adds the given texture to this scene.
  120218. * @param newTexture The texture to add
  120219. */
  120220. addTexture(newTexture: BaseTexture): void;
  120221. /**
  120222. * Switch active camera
  120223. * @param newCamera defines the new active camera
  120224. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  120225. */
  120226. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  120227. /**
  120228. * sets the active camera of the scene using its ID
  120229. * @param id defines the camera's ID
  120230. * @return the new active camera or null if none found.
  120231. */
  120232. setActiveCameraByID(id: string): Nullable<Camera>;
  120233. /**
  120234. * sets the active camera of the scene using its name
  120235. * @param name defines the camera's name
  120236. * @returns the new active camera or null if none found.
  120237. */
  120238. setActiveCameraByName(name: string): Nullable<Camera>;
  120239. /**
  120240. * get an animation group using its name
  120241. * @param name defines the material's name
  120242. * @return the animation group or null if none found.
  120243. */
  120244. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  120245. /**
  120246. * Get a material using its unique id
  120247. * @param uniqueId defines the material's unique id
  120248. * @return the material or null if none found.
  120249. */
  120250. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  120251. /**
  120252. * get a material using its id
  120253. * @param id defines the material's ID
  120254. * @return the material or null if none found.
  120255. */
  120256. getMaterialByID(id: string): Nullable<Material>;
  120257. /**
  120258. * Gets a the last added material using a given id
  120259. * @param id defines the material's ID
  120260. * @return the last material with the given id or null if none found.
  120261. */
  120262. getLastMaterialByID(id: string): Nullable<Material>;
  120263. /**
  120264. * Gets a material using its name
  120265. * @param name defines the material's name
  120266. * @return the material or null if none found.
  120267. */
  120268. getMaterialByName(name: string): Nullable<Material>;
  120269. /**
  120270. * Get a texture using its unique id
  120271. * @param uniqueId defines the texture's unique id
  120272. * @return the texture or null if none found.
  120273. */
  120274. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  120275. /**
  120276. * Gets a camera using its id
  120277. * @param id defines the id to look for
  120278. * @returns the camera or null if not found
  120279. */
  120280. getCameraByID(id: string): Nullable<Camera>;
  120281. /**
  120282. * Gets a camera using its unique id
  120283. * @param uniqueId defines the unique id to look for
  120284. * @returns the camera or null if not found
  120285. */
  120286. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  120287. /**
  120288. * Gets a camera using its name
  120289. * @param name defines the camera's name
  120290. * @return the camera or null if none found.
  120291. */
  120292. getCameraByName(name: string): Nullable<Camera>;
  120293. /**
  120294. * Gets a bone using its id
  120295. * @param id defines the bone's id
  120296. * @return the bone or null if not found
  120297. */
  120298. getBoneByID(id: string): Nullable<Bone>;
  120299. /**
  120300. * Gets a bone using its id
  120301. * @param name defines the bone's name
  120302. * @return the bone or null if not found
  120303. */
  120304. getBoneByName(name: string): Nullable<Bone>;
  120305. /**
  120306. * Gets a light node using its name
  120307. * @param name defines the the light's name
  120308. * @return the light or null if none found.
  120309. */
  120310. getLightByName(name: string): Nullable<Light>;
  120311. /**
  120312. * Gets a light node using its id
  120313. * @param id defines the light's id
  120314. * @return the light or null if none found.
  120315. */
  120316. getLightByID(id: string): Nullable<Light>;
  120317. /**
  120318. * Gets a light node using its scene-generated unique ID
  120319. * @param uniqueId defines the light's unique id
  120320. * @return the light or null if none found.
  120321. */
  120322. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  120323. /**
  120324. * Gets a particle system by id
  120325. * @param id defines the particle system id
  120326. * @return the corresponding system or null if none found
  120327. */
  120328. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  120329. /**
  120330. * Gets a geometry using its ID
  120331. * @param id defines the geometry's id
  120332. * @return the geometry or null if none found.
  120333. */
  120334. getGeometryByID(id: string): Nullable<Geometry>;
  120335. private _getGeometryByUniqueID;
  120336. /**
  120337. * Add a new geometry to this scene
  120338. * @param geometry defines the geometry to be added to the scene.
  120339. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  120340. * @return a boolean defining if the geometry was added or not
  120341. */
  120342. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  120343. /**
  120344. * Removes an existing geometry
  120345. * @param geometry defines the geometry to be removed from the scene
  120346. * @return a boolean defining if the geometry was removed or not
  120347. */
  120348. removeGeometry(geometry: Geometry): boolean;
  120349. /**
  120350. * Gets the list of geometries attached to the scene
  120351. * @returns an array of Geometry
  120352. */
  120353. getGeometries(): Geometry[];
  120354. /**
  120355. * Gets the first added mesh found of a given ID
  120356. * @param id defines the id to search for
  120357. * @return the mesh found or null if not found at all
  120358. */
  120359. getMeshByID(id: string): Nullable<AbstractMesh>;
  120360. /**
  120361. * Gets a list of meshes using their id
  120362. * @param id defines the id to search for
  120363. * @returns a list of meshes
  120364. */
  120365. getMeshesByID(id: string): Array<AbstractMesh>;
  120366. /**
  120367. * Gets the first added transform node found of a given ID
  120368. * @param id defines the id to search for
  120369. * @return the found transform node or null if not found at all.
  120370. */
  120371. getTransformNodeByID(id: string): Nullable<TransformNode>;
  120372. /**
  120373. * Gets a transform node with its auto-generated unique id
  120374. * @param uniqueId efines the unique id to search for
  120375. * @return the found transform node or null if not found at all.
  120376. */
  120377. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  120378. /**
  120379. * Gets a list of transform nodes using their id
  120380. * @param id defines the id to search for
  120381. * @returns a list of transform nodes
  120382. */
  120383. getTransformNodesByID(id: string): Array<TransformNode>;
  120384. /**
  120385. * Gets a mesh with its auto-generated unique id
  120386. * @param uniqueId defines the unique id to search for
  120387. * @return the found mesh or null if not found at all.
  120388. */
  120389. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  120390. /**
  120391. * Gets a the last added mesh using a given id
  120392. * @param id defines the id to search for
  120393. * @return the found mesh or null if not found at all.
  120394. */
  120395. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  120396. /**
  120397. * Gets a the last added node (Mesh, Camera, Light) using a given id
  120398. * @param id defines the id to search for
  120399. * @return the found node or null if not found at all
  120400. */
  120401. getLastEntryByID(id: string): Nullable<Node>;
  120402. /**
  120403. * Gets a node (Mesh, Camera, Light) using a given id
  120404. * @param id defines the id to search for
  120405. * @return the found node or null if not found at all
  120406. */
  120407. getNodeByID(id: string): Nullable<Node>;
  120408. /**
  120409. * Gets a node (Mesh, Camera, Light) using a given name
  120410. * @param name defines the name to search for
  120411. * @return the found node or null if not found at all.
  120412. */
  120413. getNodeByName(name: string): Nullable<Node>;
  120414. /**
  120415. * Gets a mesh using a given name
  120416. * @param name defines the name to search for
  120417. * @return the found mesh or null if not found at all.
  120418. */
  120419. getMeshByName(name: string): Nullable<AbstractMesh>;
  120420. /**
  120421. * Gets a transform node using a given name
  120422. * @param name defines the name to search for
  120423. * @return the found transform node or null if not found at all.
  120424. */
  120425. getTransformNodeByName(name: string): Nullable<TransformNode>;
  120426. /**
  120427. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  120428. * @param id defines the id to search for
  120429. * @return the found skeleton or null if not found at all.
  120430. */
  120431. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  120432. /**
  120433. * Gets a skeleton using a given auto generated unique id
  120434. * @param uniqueId defines the unique id to search for
  120435. * @return the found skeleton or null if not found at all.
  120436. */
  120437. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  120438. /**
  120439. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  120440. * @param id defines the id to search for
  120441. * @return the found skeleton or null if not found at all.
  120442. */
  120443. getSkeletonById(id: string): Nullable<Skeleton>;
  120444. /**
  120445. * Gets a skeleton using a given name
  120446. * @param name defines the name to search for
  120447. * @return the found skeleton or null if not found at all.
  120448. */
  120449. getSkeletonByName(name: string): Nullable<Skeleton>;
  120450. /**
  120451. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  120452. * @param id defines the id to search for
  120453. * @return the found morph target manager or null if not found at all.
  120454. */
  120455. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  120456. /**
  120457. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  120458. * @param id defines the id to search for
  120459. * @return the found morph target or null if not found at all.
  120460. */
  120461. getMorphTargetById(id: string): Nullable<MorphTarget>;
  120462. /**
  120463. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  120464. * @param name defines the name to search for
  120465. * @return the found morph target or null if not found at all.
  120466. */
  120467. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  120468. /**
  120469. * Gets a post process using a given name (if many are found, this function will pick the first one)
  120470. * @param name defines the name to search for
  120471. * @return the found post process or null if not found at all.
  120472. */
  120473. getPostProcessByName(name: string): Nullable<PostProcess>;
  120474. /**
  120475. * Gets a boolean indicating if the given mesh is active
  120476. * @param mesh defines the mesh to look for
  120477. * @returns true if the mesh is in the active list
  120478. */
  120479. isActiveMesh(mesh: AbstractMesh): boolean;
  120480. /**
  120481. * Return a unique id as a string which can serve as an identifier for the scene
  120482. */
  120483. get uid(): string;
  120484. /**
  120485. * Add an externaly attached data from its key.
  120486. * This method call will fail and return false, if such key already exists.
  120487. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  120488. * @param key the unique key that identifies the data
  120489. * @param data the data object to associate to the key for this Engine instance
  120490. * @return true if no such key were already present and the data was added successfully, false otherwise
  120491. */
  120492. addExternalData<T>(key: string, data: T): boolean;
  120493. /**
  120494. * Get an externaly attached data from its key
  120495. * @param key the unique key that identifies the data
  120496. * @return the associated data, if present (can be null), or undefined if not present
  120497. */
  120498. getExternalData<T>(key: string): Nullable<T>;
  120499. /**
  120500. * Get an externaly attached data from its key, create it using a factory if it's not already present
  120501. * @param key the unique key that identifies the data
  120502. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  120503. * @return the associated data, can be null if the factory returned null.
  120504. */
  120505. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  120506. /**
  120507. * Remove an externaly attached data from the Engine instance
  120508. * @param key the unique key that identifies the data
  120509. * @return true if the data was successfully removed, false if it doesn't exist
  120510. */
  120511. removeExternalData(key: string): boolean;
  120512. private _evaluateSubMesh;
  120513. /**
  120514. * Clear the processed materials smart array preventing retention point in material dispose.
  120515. */
  120516. freeProcessedMaterials(): void;
  120517. private _preventFreeActiveMeshesAndRenderingGroups;
  120518. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  120519. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  120520. * when disposing several meshes in a row or a hierarchy of meshes.
  120521. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  120522. */
  120523. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  120524. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  120525. /**
  120526. * Clear the active meshes smart array preventing retention point in mesh dispose.
  120527. */
  120528. freeActiveMeshes(): void;
  120529. /**
  120530. * Clear the info related to rendering groups preventing retention points during dispose.
  120531. */
  120532. freeRenderingGroups(): void;
  120533. /** @hidden */
  120534. _isInIntermediateRendering(): boolean;
  120535. /**
  120536. * Lambda returning the list of potentially active meshes.
  120537. */
  120538. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  120539. /**
  120540. * Lambda returning the list of potentially active sub meshes.
  120541. */
  120542. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  120543. /**
  120544. * Lambda returning the list of potentially intersecting sub meshes.
  120545. */
  120546. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  120547. /**
  120548. * Lambda returning the list of potentially colliding sub meshes.
  120549. */
  120550. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  120551. private _activeMeshesFrozen;
  120552. private _skipEvaluateActiveMeshesCompletely;
  120553. /**
  120554. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  120555. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  120556. * @returns the current scene
  120557. */
  120558. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  120559. /**
  120560. * Use this function to restart evaluating active meshes on every frame
  120561. * @returns the current scene
  120562. */
  120563. unfreezeActiveMeshes(): Scene;
  120564. private _evaluateActiveMeshes;
  120565. private _activeMesh;
  120566. /**
  120567. * Update the transform matrix to update from the current active camera
  120568. * @param force defines a boolean used to force the update even if cache is up to date
  120569. */
  120570. updateTransformMatrix(force?: boolean): void;
  120571. private _bindFrameBuffer;
  120572. /** @hidden */
  120573. _allowPostProcessClearColor: boolean;
  120574. /** @hidden */
  120575. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  120576. private _processSubCameras;
  120577. private _checkIntersections;
  120578. /** @hidden */
  120579. _advancePhysicsEngineStep(step: number): void;
  120580. /**
  120581. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  120582. */
  120583. getDeterministicFrameTime: () => number;
  120584. /** @hidden */
  120585. _animate(): void;
  120586. /** Execute all animations (for a frame) */
  120587. animate(): void;
  120588. /**
  120589. * Render the scene
  120590. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  120591. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  120592. */
  120593. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  120594. /**
  120595. * Freeze all materials
  120596. * A frozen material will not be updatable but should be faster to render
  120597. */
  120598. freezeMaterials(): void;
  120599. /**
  120600. * Unfreeze all materials
  120601. * A frozen material will not be updatable but should be faster to render
  120602. */
  120603. unfreezeMaterials(): void;
  120604. /**
  120605. * Releases all held ressources
  120606. */
  120607. dispose(): void;
  120608. /**
  120609. * Gets if the scene is already disposed
  120610. */
  120611. get isDisposed(): boolean;
  120612. /**
  120613. * Call this function to reduce memory footprint of the scene.
  120614. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  120615. */
  120616. clearCachedVertexData(): void;
  120617. /**
  120618. * This function will remove the local cached buffer data from texture.
  120619. * It will save memory but will prevent the texture from being rebuilt
  120620. */
  120621. cleanCachedTextureBuffer(): void;
  120622. /**
  120623. * Get the world extend vectors with an optional filter
  120624. *
  120625. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  120626. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  120627. */
  120628. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  120629. min: Vector3;
  120630. max: Vector3;
  120631. };
  120632. /**
  120633. * Creates a ray that can be used to pick in the scene
  120634. * @param x defines the x coordinate of the origin (on-screen)
  120635. * @param y defines the y coordinate of the origin (on-screen)
  120636. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  120637. * @param camera defines the camera to use for the picking
  120638. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  120639. * @returns a Ray
  120640. */
  120641. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  120642. /**
  120643. * Creates a ray that can be used to pick in the scene
  120644. * @param x defines the x coordinate of the origin (on-screen)
  120645. * @param y defines the y coordinate of the origin (on-screen)
  120646. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  120647. * @param result defines the ray where to store the picking ray
  120648. * @param camera defines the camera to use for the picking
  120649. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  120650. * @returns the current scene
  120651. */
  120652. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  120653. /**
  120654. * Creates a ray that can be used to pick in the scene
  120655. * @param x defines the x coordinate of the origin (on-screen)
  120656. * @param y defines the y coordinate of the origin (on-screen)
  120657. * @param camera defines the camera to use for the picking
  120658. * @returns a Ray
  120659. */
  120660. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  120661. /**
  120662. * Creates a ray that can be used to pick in the scene
  120663. * @param x defines the x coordinate of the origin (on-screen)
  120664. * @param y defines the y coordinate of the origin (on-screen)
  120665. * @param result defines the ray where to store the picking ray
  120666. * @param camera defines the camera to use for the picking
  120667. * @returns the current scene
  120668. */
  120669. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  120670. /** Launch a ray to try to pick a mesh in the scene
  120671. * @param x position on screen
  120672. * @param y position on screen
  120673. * @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
  120674. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120675. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120676. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120677. * @returns a PickingInfo
  120678. */
  120679. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  120680. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  120681. * @param x position on screen
  120682. * @param y position on screen
  120683. * @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
  120684. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120685. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120686. * @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)
  120687. */
  120688. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  120689. /** Use the given ray to pick a mesh in the scene
  120690. * @param ray The ray to use to pick meshes
  120691. * @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
  120692. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120693. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120694. * @returns a PickingInfo
  120695. */
  120696. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  120697. /**
  120698. * Launch a ray to try to pick a mesh in the scene
  120699. * @param x X position on screen
  120700. * @param y Y position on screen
  120701. * @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
  120702. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120703. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120704. * @returns an array of PickingInfo
  120705. */
  120706. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  120707. /**
  120708. * Launch a ray to try to pick a mesh in the scene
  120709. * @param ray Ray to use
  120710. * @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
  120711. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120712. * @returns an array of PickingInfo
  120713. */
  120714. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  120715. /**
  120716. * Force the value of meshUnderPointer
  120717. * @param mesh defines the mesh to use
  120718. */
  120719. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  120720. /**
  120721. * Gets the mesh under the pointer
  120722. * @returns a Mesh or null if no mesh is under the pointer
  120723. */
  120724. getPointerOverMesh(): Nullable<AbstractMesh>;
  120725. /** @hidden */
  120726. _rebuildGeometries(): void;
  120727. /** @hidden */
  120728. _rebuildTextures(): void;
  120729. private _getByTags;
  120730. /**
  120731. * Get a list of meshes by tags
  120732. * @param tagsQuery defines the tags query to use
  120733. * @param forEach defines a predicate used to filter results
  120734. * @returns an array of Mesh
  120735. */
  120736. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  120737. /**
  120738. * Get a list of cameras by tags
  120739. * @param tagsQuery defines the tags query to use
  120740. * @param forEach defines a predicate used to filter results
  120741. * @returns an array of Camera
  120742. */
  120743. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  120744. /**
  120745. * Get a list of lights by tags
  120746. * @param tagsQuery defines the tags query to use
  120747. * @param forEach defines a predicate used to filter results
  120748. * @returns an array of Light
  120749. */
  120750. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  120751. /**
  120752. * Get a list of materials by tags
  120753. * @param tagsQuery defines the tags query to use
  120754. * @param forEach defines a predicate used to filter results
  120755. * @returns an array of Material
  120756. */
  120757. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  120758. /**
  120759. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  120760. * This allowed control for front to back rendering or reversly depending of the special needs.
  120761. *
  120762. * @param renderingGroupId The rendering group id corresponding to its index
  120763. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  120764. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  120765. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  120766. */
  120767. 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;
  120768. /**
  120769. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  120770. *
  120771. * @param renderingGroupId The rendering group id corresponding to its index
  120772. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  120773. * @param depth Automatically clears depth between groups if true and autoClear is true.
  120774. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  120775. */
  120776. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  120777. /**
  120778. * Gets the current auto clear configuration for one rendering group of the rendering
  120779. * manager.
  120780. * @param index the rendering group index to get the information for
  120781. * @returns The auto clear setup for the requested rendering group
  120782. */
  120783. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  120784. private _blockMaterialDirtyMechanism;
  120785. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  120786. get blockMaterialDirtyMechanism(): boolean;
  120787. set blockMaterialDirtyMechanism(value: boolean);
  120788. /**
  120789. * Will flag all materials as dirty to trigger new shader compilation
  120790. * @param flag defines the flag used to specify which material part must be marked as dirty
  120791. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  120792. */
  120793. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  120794. /** @hidden */
  120795. _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;
  120796. /** @hidden */
  120797. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  120798. /** @hidden */
  120799. _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;
  120800. /** @hidden */
  120801. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  120802. /** @hidden */
  120803. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  120804. /** @hidden */
  120805. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  120806. }
  120807. }
  120808. declare module BABYLON {
  120809. /**
  120810. * Set of assets to keep when moving a scene into an asset container.
  120811. */
  120812. export class KeepAssets extends AbstractScene {
  120813. }
  120814. /**
  120815. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  120816. */
  120817. export class InstantiatedEntries {
  120818. /**
  120819. * List of new root nodes (eg. nodes with no parent)
  120820. */
  120821. rootNodes: TransformNode[];
  120822. /**
  120823. * List of new skeletons
  120824. */
  120825. skeletons: Skeleton[];
  120826. /**
  120827. * List of new animation groups
  120828. */
  120829. animationGroups: AnimationGroup[];
  120830. }
  120831. /**
  120832. * Container with a set of assets that can be added or removed from a scene.
  120833. */
  120834. export class AssetContainer extends AbstractScene {
  120835. private _wasAddedToScene;
  120836. /**
  120837. * The scene the AssetContainer belongs to.
  120838. */
  120839. scene: Scene;
  120840. /**
  120841. * Instantiates an AssetContainer.
  120842. * @param scene The scene the AssetContainer belongs to.
  120843. */
  120844. constructor(scene: Scene);
  120845. /**
  120846. * Instantiate or clone all meshes and add the new ones to the scene.
  120847. * Skeletons and animation groups will all be cloned
  120848. * @param nameFunction defines an optional function used to get new names for clones
  120849. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  120850. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  120851. */
  120852. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  120853. /**
  120854. * Adds all the assets from the container to the scene.
  120855. */
  120856. addAllToScene(): void;
  120857. /**
  120858. * Removes all the assets in the container from the scene
  120859. */
  120860. removeAllFromScene(): void;
  120861. /**
  120862. * Disposes all the assets in the container
  120863. */
  120864. dispose(): void;
  120865. private _moveAssets;
  120866. /**
  120867. * Removes all the assets contained in the scene and adds them to the container.
  120868. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  120869. */
  120870. moveAllFromScene(keepAssets?: KeepAssets): void;
  120871. /**
  120872. * 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.
  120873. * @returns the root mesh
  120874. */
  120875. createRootMesh(): Mesh;
  120876. /**
  120877. * Merge animations (direct and animation groups) from this asset container into a scene
  120878. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  120879. * @param animatables set of animatables to retarget to a node from the scene
  120880. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  120881. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  120882. */
  120883. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  120884. }
  120885. }
  120886. declare module BABYLON {
  120887. /**
  120888. * Defines how the parser contract is defined.
  120889. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  120890. */
  120891. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  120892. /**
  120893. * Defines how the individual parser contract is defined.
  120894. * These parser can parse an individual asset
  120895. */
  120896. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  120897. /**
  120898. * Base class of the scene acting as a container for the different elements composing a scene.
  120899. * This class is dynamically extended by the different components of the scene increasing
  120900. * flexibility and reducing coupling
  120901. */
  120902. export abstract class AbstractScene {
  120903. /**
  120904. * Stores the list of available parsers in the application.
  120905. */
  120906. private static _BabylonFileParsers;
  120907. /**
  120908. * Stores the list of available individual parsers in the application.
  120909. */
  120910. private static _IndividualBabylonFileParsers;
  120911. /**
  120912. * Adds a parser in the list of available ones
  120913. * @param name Defines the name of the parser
  120914. * @param parser Defines the parser to add
  120915. */
  120916. static AddParser(name: string, parser: BabylonFileParser): void;
  120917. /**
  120918. * Gets a general parser from the list of avaialble ones
  120919. * @param name Defines the name of the parser
  120920. * @returns the requested parser or null
  120921. */
  120922. static GetParser(name: string): Nullable<BabylonFileParser>;
  120923. /**
  120924. * Adds n individual parser in the list of available ones
  120925. * @param name Defines the name of the parser
  120926. * @param parser Defines the parser to add
  120927. */
  120928. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  120929. /**
  120930. * Gets an individual parser from the list of avaialble ones
  120931. * @param name Defines the name of the parser
  120932. * @returns the requested parser or null
  120933. */
  120934. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  120935. /**
  120936. * Parser json data and populate both a scene and its associated container object
  120937. * @param jsonData Defines the data to parse
  120938. * @param scene Defines the scene to parse the data for
  120939. * @param container Defines the container attached to the parsing sequence
  120940. * @param rootUrl Defines the root url of the data
  120941. */
  120942. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  120943. /**
  120944. * Gets the list of root nodes (ie. nodes with no parent)
  120945. */
  120946. rootNodes: Node[];
  120947. /** All of the cameras added to this scene
  120948. * @see https://doc.babylonjs.com/babylon101/cameras
  120949. */
  120950. cameras: Camera[];
  120951. /**
  120952. * All of the lights added to this scene
  120953. * @see https://doc.babylonjs.com/babylon101/lights
  120954. */
  120955. lights: Light[];
  120956. /**
  120957. * All of the (abstract) meshes added to this scene
  120958. */
  120959. meshes: AbstractMesh[];
  120960. /**
  120961. * The list of skeletons added to the scene
  120962. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  120963. */
  120964. skeletons: Skeleton[];
  120965. /**
  120966. * All of the particle systems added to this scene
  120967. * @see https://doc.babylonjs.com/babylon101/particles
  120968. */
  120969. particleSystems: IParticleSystem[];
  120970. /**
  120971. * Gets a list of Animations associated with the scene
  120972. */
  120973. animations: Animation[];
  120974. /**
  120975. * All of the animation groups added to this scene
  120976. * @see https://doc.babylonjs.com/how_to/group
  120977. */
  120978. animationGroups: AnimationGroup[];
  120979. /**
  120980. * All of the multi-materials added to this scene
  120981. * @see https://doc.babylonjs.com/how_to/multi_materials
  120982. */
  120983. multiMaterials: MultiMaterial[];
  120984. /**
  120985. * All of the materials added to this scene
  120986. * In the context of a Scene, it is not supposed to be modified manually.
  120987. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  120988. * Note also that the order of the Material within the array is not significant and might change.
  120989. * @see https://doc.babylonjs.com/babylon101/materials
  120990. */
  120991. materials: Material[];
  120992. /**
  120993. * The list of morph target managers added to the scene
  120994. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  120995. */
  120996. morphTargetManagers: MorphTargetManager[];
  120997. /**
  120998. * The list of geometries used in the scene.
  120999. */
  121000. geometries: Geometry[];
  121001. /**
  121002. * All of the tranform nodes added to this scene
  121003. * In the context of a Scene, it is not supposed to be modified manually.
  121004. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  121005. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  121006. * @see https://doc.babylonjs.com/how_to/transformnode
  121007. */
  121008. transformNodes: TransformNode[];
  121009. /**
  121010. * ActionManagers available on the scene.
  121011. */
  121012. actionManagers: AbstractActionManager[];
  121013. /**
  121014. * Textures to keep.
  121015. */
  121016. textures: BaseTexture[];
  121017. /** @hidden */
  121018. protected _environmentTexture: Nullable<BaseTexture>;
  121019. /**
  121020. * Texture used in all pbr material as the reflection texture.
  121021. * As in the majority of the scene they are the same (exception for multi room and so on),
  121022. * this is easier to reference from here than from all the materials.
  121023. */
  121024. get environmentTexture(): Nullable<BaseTexture>;
  121025. set environmentTexture(value: Nullable<BaseTexture>);
  121026. /**
  121027. * The list of postprocesses added to the scene
  121028. */
  121029. postProcesses: PostProcess[];
  121030. /**
  121031. * @returns all meshes, lights, cameras, transformNodes and bones
  121032. */
  121033. getNodes(): Array<Node>;
  121034. }
  121035. }
  121036. declare module BABYLON {
  121037. /**
  121038. * Interface used to define options for Sound class
  121039. */
  121040. export interface ISoundOptions {
  121041. /**
  121042. * Does the sound autoplay once loaded.
  121043. */
  121044. autoplay?: boolean;
  121045. /**
  121046. * Does the sound loop after it finishes playing once.
  121047. */
  121048. loop?: boolean;
  121049. /**
  121050. * Sound's volume
  121051. */
  121052. volume?: number;
  121053. /**
  121054. * Is it a spatial sound?
  121055. */
  121056. spatialSound?: boolean;
  121057. /**
  121058. * Maximum distance to hear that sound
  121059. */
  121060. maxDistance?: number;
  121061. /**
  121062. * Uses user defined attenuation function
  121063. */
  121064. useCustomAttenuation?: boolean;
  121065. /**
  121066. * Define the roll off factor of spatial sounds.
  121067. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121068. */
  121069. rolloffFactor?: number;
  121070. /**
  121071. * Define the reference distance the sound should be heard perfectly.
  121072. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121073. */
  121074. refDistance?: number;
  121075. /**
  121076. * Define the distance attenuation model the sound will follow.
  121077. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121078. */
  121079. distanceModel?: string;
  121080. /**
  121081. * Defines the playback speed (1 by default)
  121082. */
  121083. playbackRate?: number;
  121084. /**
  121085. * Defines if the sound is from a streaming source
  121086. */
  121087. streaming?: boolean;
  121088. /**
  121089. * Defines an optional length (in seconds) inside the sound file
  121090. */
  121091. length?: number;
  121092. /**
  121093. * Defines an optional offset (in seconds) inside the sound file
  121094. */
  121095. offset?: number;
  121096. /**
  121097. * If true, URLs will not be required to state the audio file codec to use.
  121098. */
  121099. skipCodecCheck?: boolean;
  121100. }
  121101. /**
  121102. * Defines a sound that can be played in the application.
  121103. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  121104. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121105. */
  121106. export class Sound {
  121107. /**
  121108. * The name of the sound in the scene.
  121109. */
  121110. name: string;
  121111. /**
  121112. * Does the sound autoplay once loaded.
  121113. */
  121114. autoplay: boolean;
  121115. /**
  121116. * Does the sound loop after it finishes playing once.
  121117. */
  121118. loop: boolean;
  121119. /**
  121120. * Does the sound use a custom attenuation curve to simulate the falloff
  121121. * happening when the source gets further away from the camera.
  121122. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  121123. */
  121124. useCustomAttenuation: boolean;
  121125. /**
  121126. * The sound track id this sound belongs to.
  121127. */
  121128. soundTrackId: number;
  121129. /**
  121130. * Is this sound currently played.
  121131. */
  121132. isPlaying: boolean;
  121133. /**
  121134. * Is this sound currently paused.
  121135. */
  121136. isPaused: boolean;
  121137. /**
  121138. * Does this sound enables spatial sound.
  121139. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121140. */
  121141. spatialSound: boolean;
  121142. /**
  121143. * Define the reference distance the sound should be heard perfectly.
  121144. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121145. */
  121146. refDistance: number;
  121147. /**
  121148. * Define the roll off factor of spatial sounds.
  121149. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121150. */
  121151. rolloffFactor: number;
  121152. /**
  121153. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  121154. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121155. */
  121156. maxDistance: number;
  121157. /**
  121158. * Define the distance attenuation model the sound will follow.
  121159. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121160. */
  121161. distanceModel: string;
  121162. /**
  121163. * @hidden
  121164. * Back Compat
  121165. **/
  121166. onended: () => any;
  121167. /**
  121168. * Gets or sets an object used to store user defined information for the sound.
  121169. */
  121170. metadata: any;
  121171. /**
  121172. * Observable event when the current playing sound finishes.
  121173. */
  121174. onEndedObservable: Observable<Sound>;
  121175. private _panningModel;
  121176. private _playbackRate;
  121177. private _streaming;
  121178. private _startTime;
  121179. private _startOffset;
  121180. private _position;
  121181. /** @hidden */
  121182. _positionInEmitterSpace: boolean;
  121183. private _localDirection;
  121184. private _volume;
  121185. private _isReadyToPlay;
  121186. private _isDirectional;
  121187. private _readyToPlayCallback;
  121188. private _audioBuffer;
  121189. private _soundSource;
  121190. private _streamingSource;
  121191. private _soundPanner;
  121192. private _soundGain;
  121193. private _inputAudioNode;
  121194. private _outputAudioNode;
  121195. private _coneInnerAngle;
  121196. private _coneOuterAngle;
  121197. private _coneOuterGain;
  121198. private _scene;
  121199. private _connectedTransformNode;
  121200. private _customAttenuationFunction;
  121201. private _registerFunc;
  121202. private _isOutputConnected;
  121203. private _htmlAudioElement;
  121204. private _urlType;
  121205. private _length?;
  121206. private _offset?;
  121207. /** @hidden */
  121208. static _SceneComponentInitialization: (scene: Scene) => void;
  121209. /**
  121210. * Create a sound and attach it to a scene
  121211. * @param name Name of your sound
  121212. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  121213. * @param scene defines the scene the sound belongs to
  121214. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  121215. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  121216. */
  121217. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  121218. /**
  121219. * Release the sound and its associated resources
  121220. */
  121221. dispose(): void;
  121222. /**
  121223. * Gets if the sounds is ready to be played or not.
  121224. * @returns true if ready, otherwise false
  121225. */
  121226. isReady(): boolean;
  121227. private _soundLoaded;
  121228. /**
  121229. * Sets the data of the sound from an audiobuffer
  121230. * @param audioBuffer The audioBuffer containing the data
  121231. */
  121232. setAudioBuffer(audioBuffer: AudioBuffer): void;
  121233. /**
  121234. * Updates the current sounds options such as maxdistance, loop...
  121235. * @param options A JSON object containing values named as the object properties
  121236. */
  121237. updateOptions(options: ISoundOptions): void;
  121238. private _createSpatialParameters;
  121239. private _updateSpatialParameters;
  121240. /**
  121241. * Switch the panning model to HRTF:
  121242. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  121243. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121244. */
  121245. switchPanningModelToHRTF(): void;
  121246. /**
  121247. * Switch the panning model to Equal Power:
  121248. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  121249. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121250. */
  121251. switchPanningModelToEqualPower(): void;
  121252. private _switchPanningModel;
  121253. /**
  121254. * Connect this sound to a sound track audio node like gain...
  121255. * @param soundTrackAudioNode the sound track audio node to connect to
  121256. */
  121257. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  121258. /**
  121259. * Transform this sound into a directional source
  121260. * @param coneInnerAngle Size of the inner cone in degree
  121261. * @param coneOuterAngle Size of the outer cone in degree
  121262. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  121263. */
  121264. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  121265. /**
  121266. * Gets or sets the inner angle for the directional cone.
  121267. */
  121268. get directionalConeInnerAngle(): number;
  121269. /**
  121270. * Gets or sets the inner angle for the directional cone.
  121271. */
  121272. set directionalConeInnerAngle(value: number);
  121273. /**
  121274. * Gets or sets the outer angle for the directional cone.
  121275. */
  121276. get directionalConeOuterAngle(): number;
  121277. /**
  121278. * Gets or sets the outer angle for the directional cone.
  121279. */
  121280. set directionalConeOuterAngle(value: number);
  121281. /**
  121282. * Sets the position of the emitter if spatial sound is enabled
  121283. * @param newPosition Defines the new posisiton
  121284. */
  121285. setPosition(newPosition: Vector3): void;
  121286. /**
  121287. * Sets the local direction of the emitter if spatial sound is enabled
  121288. * @param newLocalDirection Defines the new local direction
  121289. */
  121290. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  121291. private _updateDirection;
  121292. /** @hidden */
  121293. updateDistanceFromListener(): void;
  121294. /**
  121295. * Sets a new custom attenuation function for the sound.
  121296. * @param callback Defines the function used for the attenuation
  121297. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  121298. */
  121299. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  121300. /**
  121301. * Play the sound
  121302. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  121303. * @param offset (optional) Start the sound at a specific time in seconds
  121304. * @param length (optional) Sound duration (in seconds)
  121305. */
  121306. play(time?: number, offset?: number, length?: number): void;
  121307. private _onended;
  121308. /**
  121309. * Stop the sound
  121310. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  121311. */
  121312. stop(time?: number): void;
  121313. /**
  121314. * Put the sound in pause
  121315. */
  121316. pause(): void;
  121317. /**
  121318. * Sets a dedicated volume for this sounds
  121319. * @param newVolume Define the new volume of the sound
  121320. * @param time Define time for gradual change to new volume
  121321. */
  121322. setVolume(newVolume: number, time?: number): void;
  121323. /**
  121324. * Set the sound play back rate
  121325. * @param newPlaybackRate Define the playback rate the sound should be played at
  121326. */
  121327. setPlaybackRate(newPlaybackRate: number): void;
  121328. /**
  121329. * Gets the volume of the sound.
  121330. * @returns the volume of the sound
  121331. */
  121332. getVolume(): number;
  121333. /**
  121334. * Attach the sound to a dedicated mesh
  121335. * @param transformNode The transform node to connect the sound with
  121336. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  121337. */
  121338. attachToMesh(transformNode: TransformNode): void;
  121339. /**
  121340. * Detach the sound from the previously attached mesh
  121341. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  121342. */
  121343. detachFromMesh(): void;
  121344. private _onRegisterAfterWorldMatrixUpdate;
  121345. /**
  121346. * Clone the current sound in the scene.
  121347. * @returns the new sound clone
  121348. */
  121349. clone(): Nullable<Sound>;
  121350. /**
  121351. * Gets the current underlying audio buffer containing the data
  121352. * @returns the audio buffer
  121353. */
  121354. getAudioBuffer(): Nullable<AudioBuffer>;
  121355. /**
  121356. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  121357. * @returns the source node
  121358. */
  121359. getSoundSource(): Nullable<AudioBufferSourceNode>;
  121360. /**
  121361. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  121362. * @returns the gain node
  121363. */
  121364. getSoundGain(): Nullable<GainNode>;
  121365. /**
  121366. * Serializes the Sound in a JSON representation
  121367. * @returns the JSON representation of the sound
  121368. */
  121369. serialize(): any;
  121370. /**
  121371. * Parse a JSON representation of a sound to innstantiate in a given scene
  121372. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  121373. * @param scene Define the scene the new parsed sound should be created in
  121374. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  121375. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  121376. * @returns the newly parsed sound
  121377. */
  121378. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  121379. }
  121380. }
  121381. declare module BABYLON {
  121382. /**
  121383. * This defines an action helpful to play a defined sound on a triggered action.
  121384. */
  121385. export class PlaySoundAction extends Action {
  121386. private _sound;
  121387. /**
  121388. * Instantiate the action
  121389. * @param triggerOptions defines the trigger options
  121390. * @param sound defines the sound to play
  121391. * @param condition defines the trigger related conditions
  121392. */
  121393. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  121394. /** @hidden */
  121395. _prepare(): void;
  121396. /**
  121397. * Execute the action and play the sound.
  121398. */
  121399. execute(): void;
  121400. /**
  121401. * Serializes the actions and its related information.
  121402. * @param parent defines the object to serialize in
  121403. * @returns the serialized object
  121404. */
  121405. serialize(parent: any): any;
  121406. }
  121407. /**
  121408. * This defines an action helpful to stop a defined sound on a triggered action.
  121409. */
  121410. export class StopSoundAction extends Action {
  121411. private _sound;
  121412. /**
  121413. * Instantiate the action
  121414. * @param triggerOptions defines the trigger options
  121415. * @param sound defines the sound to stop
  121416. * @param condition defines the trigger related conditions
  121417. */
  121418. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  121419. /** @hidden */
  121420. _prepare(): void;
  121421. /**
  121422. * Execute the action and stop the sound.
  121423. */
  121424. execute(): void;
  121425. /**
  121426. * Serializes the actions and its related information.
  121427. * @param parent defines the object to serialize in
  121428. * @returns the serialized object
  121429. */
  121430. serialize(parent: any): any;
  121431. }
  121432. }
  121433. declare module BABYLON {
  121434. /**
  121435. * This defines an action responsible to change the value of a property
  121436. * by interpolating between its current value and the newly set one once triggered.
  121437. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  121438. */
  121439. export class InterpolateValueAction extends Action {
  121440. /**
  121441. * Defines the path of the property where the value should be interpolated
  121442. */
  121443. propertyPath: string;
  121444. /**
  121445. * Defines the target value at the end of the interpolation.
  121446. */
  121447. value: any;
  121448. /**
  121449. * Defines the time it will take for the property to interpolate to the value.
  121450. */
  121451. duration: number;
  121452. /**
  121453. * Defines if the other scene animations should be stopped when the action has been triggered
  121454. */
  121455. stopOtherAnimations?: boolean;
  121456. /**
  121457. * Defines a callback raised once the interpolation animation has been done.
  121458. */
  121459. onInterpolationDone?: () => void;
  121460. /**
  121461. * Observable triggered once the interpolation animation has been done.
  121462. */
  121463. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  121464. private _target;
  121465. private _effectiveTarget;
  121466. private _property;
  121467. /**
  121468. * Instantiate the action
  121469. * @param triggerOptions defines the trigger options
  121470. * @param target defines the object containing the value to interpolate
  121471. * @param propertyPath defines the path to the property in the target object
  121472. * @param value defines the target value at the end of the interpolation
  121473. * @param duration deines the time it will take for the property to interpolate to the value.
  121474. * @param condition defines the trigger related conditions
  121475. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  121476. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  121477. */
  121478. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  121479. /** @hidden */
  121480. _prepare(): void;
  121481. /**
  121482. * Execute the action starts the value interpolation.
  121483. */
  121484. execute(): void;
  121485. /**
  121486. * Serializes the actions and its related information.
  121487. * @param parent defines the object to serialize in
  121488. * @returns the serialized object
  121489. */
  121490. serialize(parent: any): any;
  121491. }
  121492. }
  121493. declare module BABYLON {
  121494. /**
  121495. * Options allowed during the creation of a sound track.
  121496. */
  121497. export interface ISoundTrackOptions {
  121498. /**
  121499. * The volume the sound track should take during creation
  121500. */
  121501. volume?: number;
  121502. /**
  121503. * Define if the sound track is the main sound track of the scene
  121504. */
  121505. mainTrack?: boolean;
  121506. }
  121507. /**
  121508. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  121509. * It will be also used in a future release to apply effects on a specific track.
  121510. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  121511. */
  121512. export class SoundTrack {
  121513. /**
  121514. * The unique identifier of the sound track in the scene.
  121515. */
  121516. id: number;
  121517. /**
  121518. * The list of sounds included in the sound track.
  121519. */
  121520. soundCollection: Array<Sound>;
  121521. private _outputAudioNode;
  121522. private _scene;
  121523. private _connectedAnalyser;
  121524. private _options;
  121525. private _isInitialized;
  121526. /**
  121527. * Creates a new sound track.
  121528. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  121529. * @param scene Define the scene the sound track belongs to
  121530. * @param options
  121531. */
  121532. constructor(scene: Scene, options?: ISoundTrackOptions);
  121533. private _initializeSoundTrackAudioGraph;
  121534. /**
  121535. * Release the sound track and its associated resources
  121536. */
  121537. dispose(): void;
  121538. /**
  121539. * Adds a sound to this sound track
  121540. * @param sound define the cound to add
  121541. * @ignoreNaming
  121542. */
  121543. AddSound(sound: Sound): void;
  121544. /**
  121545. * Removes a sound to this sound track
  121546. * @param sound define the cound to remove
  121547. * @ignoreNaming
  121548. */
  121549. RemoveSound(sound: Sound): void;
  121550. /**
  121551. * Set a global volume for the full sound track.
  121552. * @param newVolume Define the new volume of the sound track
  121553. */
  121554. setVolume(newVolume: number): void;
  121555. /**
  121556. * Switch the panning model to HRTF:
  121557. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  121558. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121559. */
  121560. switchPanningModelToHRTF(): void;
  121561. /**
  121562. * Switch the panning model to Equal Power:
  121563. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  121564. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121565. */
  121566. switchPanningModelToEqualPower(): void;
  121567. /**
  121568. * Connect the sound track to an audio analyser allowing some amazing
  121569. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  121570. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  121571. * @param analyser The analyser to connect to the engine
  121572. */
  121573. connectToAnalyser(analyser: Analyser): void;
  121574. }
  121575. }
  121576. declare module BABYLON {
  121577. interface AbstractScene {
  121578. /**
  121579. * The list of sounds used in the scene.
  121580. */
  121581. sounds: Nullable<Array<Sound>>;
  121582. }
  121583. interface Scene {
  121584. /**
  121585. * @hidden
  121586. * Backing field
  121587. */
  121588. _mainSoundTrack: SoundTrack;
  121589. /**
  121590. * The main sound track played by the scene.
  121591. * It cotains your primary collection of sounds.
  121592. */
  121593. mainSoundTrack: SoundTrack;
  121594. /**
  121595. * The list of sound tracks added to the scene
  121596. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121597. */
  121598. soundTracks: Nullable<Array<SoundTrack>>;
  121599. /**
  121600. * Gets a sound using a given name
  121601. * @param name defines the name to search for
  121602. * @return the found sound or null if not found at all.
  121603. */
  121604. getSoundByName(name: string): Nullable<Sound>;
  121605. /**
  121606. * Gets or sets if audio support is enabled
  121607. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121608. */
  121609. audioEnabled: boolean;
  121610. /**
  121611. * Gets or sets if audio will be output to headphones
  121612. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121613. */
  121614. headphone: boolean;
  121615. /**
  121616. * Gets or sets custom audio listener position provider
  121617. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121618. */
  121619. audioListenerPositionProvider: Nullable<() => Vector3>;
  121620. /**
  121621. * Gets or sets a refresh rate when using 3D audio positioning
  121622. */
  121623. audioPositioningRefreshRate: number;
  121624. }
  121625. /**
  121626. * Defines the sound scene component responsible to manage any sounds
  121627. * in a given scene.
  121628. */
  121629. export class AudioSceneComponent implements ISceneSerializableComponent {
  121630. /**
  121631. * The component name helpfull to identify the component in the list of scene components.
  121632. */
  121633. readonly name: string;
  121634. /**
  121635. * The scene the component belongs to.
  121636. */
  121637. scene: Scene;
  121638. private _audioEnabled;
  121639. /**
  121640. * Gets whether audio is enabled or not.
  121641. * Please use related enable/disable method to switch state.
  121642. */
  121643. get audioEnabled(): boolean;
  121644. private _headphone;
  121645. /**
  121646. * Gets whether audio is outputing to headphone or not.
  121647. * Please use the according Switch methods to change output.
  121648. */
  121649. get headphone(): boolean;
  121650. /**
  121651. * Gets or sets a refresh rate when using 3D audio positioning
  121652. */
  121653. audioPositioningRefreshRate: number;
  121654. private _audioListenerPositionProvider;
  121655. /**
  121656. * Gets the current audio listener position provider
  121657. */
  121658. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  121659. /**
  121660. * Sets a custom listener position for all sounds in the scene
  121661. * By default, this is the position of the first active camera
  121662. */
  121663. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  121664. /**
  121665. * Creates a new instance of the component for the given scene
  121666. * @param scene Defines the scene to register the component in
  121667. */
  121668. constructor(scene: Scene);
  121669. /**
  121670. * Registers the component in a given scene
  121671. */
  121672. register(): void;
  121673. /**
  121674. * Rebuilds the elements related to this component in case of
  121675. * context lost for instance.
  121676. */
  121677. rebuild(): void;
  121678. /**
  121679. * Serializes the component data to the specified json object
  121680. * @param serializationObject The object to serialize to
  121681. */
  121682. serialize(serializationObject: any): void;
  121683. /**
  121684. * Adds all the elements from the container to the scene
  121685. * @param container the container holding the elements
  121686. */
  121687. addFromContainer(container: AbstractScene): void;
  121688. /**
  121689. * Removes all the elements in the container from the scene
  121690. * @param container contains the elements to remove
  121691. * @param dispose if the removed element should be disposed (default: false)
  121692. */
  121693. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  121694. /**
  121695. * Disposes the component and the associated ressources.
  121696. */
  121697. dispose(): void;
  121698. /**
  121699. * Disables audio in the associated scene.
  121700. */
  121701. disableAudio(): void;
  121702. /**
  121703. * Enables audio in the associated scene.
  121704. */
  121705. enableAudio(): void;
  121706. /**
  121707. * Switch audio to headphone output.
  121708. */
  121709. switchAudioModeForHeadphones(): void;
  121710. /**
  121711. * Switch audio to normal speakers.
  121712. */
  121713. switchAudioModeForNormalSpeakers(): void;
  121714. private _cachedCameraDirection;
  121715. private _cachedCameraPosition;
  121716. private _lastCheck;
  121717. private _afterRender;
  121718. }
  121719. }
  121720. declare module BABYLON {
  121721. /**
  121722. * Wraps one or more Sound objects and selects one with random weight for playback.
  121723. */
  121724. export class WeightedSound {
  121725. /** When true a Sound will be selected and played when the current playing Sound completes. */
  121726. loop: boolean;
  121727. private _coneInnerAngle;
  121728. private _coneOuterAngle;
  121729. private _volume;
  121730. /** A Sound is currently playing. */
  121731. isPlaying: boolean;
  121732. /** A Sound is currently paused. */
  121733. isPaused: boolean;
  121734. private _sounds;
  121735. private _weights;
  121736. private _currentIndex?;
  121737. /**
  121738. * Creates a new WeightedSound from the list of sounds given.
  121739. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  121740. * @param sounds Array of Sounds that will be selected from.
  121741. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  121742. */
  121743. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  121744. /**
  121745. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  121746. */
  121747. get directionalConeInnerAngle(): number;
  121748. /**
  121749. * The size of cone in degress for a directional sound in which there will be no attenuation.
  121750. */
  121751. set directionalConeInnerAngle(value: number);
  121752. /**
  121753. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  121754. * Listener angles between innerAngle and outerAngle will falloff linearly.
  121755. */
  121756. get directionalConeOuterAngle(): number;
  121757. /**
  121758. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  121759. * Listener angles between innerAngle and outerAngle will falloff linearly.
  121760. */
  121761. set directionalConeOuterAngle(value: number);
  121762. /**
  121763. * Playback volume.
  121764. */
  121765. get volume(): number;
  121766. /**
  121767. * Playback volume.
  121768. */
  121769. set volume(value: number);
  121770. private _onended;
  121771. /**
  121772. * Suspend playback
  121773. */
  121774. pause(): void;
  121775. /**
  121776. * Stop playback
  121777. */
  121778. stop(): void;
  121779. /**
  121780. * Start playback.
  121781. * @param startOffset Position the clip head at a specific time in seconds.
  121782. */
  121783. play(startOffset?: number): void;
  121784. }
  121785. }
  121786. declare module BABYLON {
  121787. /**
  121788. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  121789. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  121790. */
  121791. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  121792. /**
  121793. * Gets the name of the behavior.
  121794. */
  121795. get name(): string;
  121796. /**
  121797. * The easing function used by animations
  121798. */
  121799. static EasingFunction: BackEase;
  121800. /**
  121801. * The easing mode used by animations
  121802. */
  121803. static EasingMode: number;
  121804. /**
  121805. * The duration of the animation, in milliseconds
  121806. */
  121807. transitionDuration: number;
  121808. /**
  121809. * Length of the distance animated by the transition when lower radius is reached
  121810. */
  121811. lowerRadiusTransitionRange: number;
  121812. /**
  121813. * Length of the distance animated by the transition when upper radius is reached
  121814. */
  121815. upperRadiusTransitionRange: number;
  121816. private _autoTransitionRange;
  121817. /**
  121818. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  121819. */
  121820. get autoTransitionRange(): boolean;
  121821. /**
  121822. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  121823. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  121824. */
  121825. set autoTransitionRange(value: boolean);
  121826. private _attachedCamera;
  121827. private _onAfterCheckInputsObserver;
  121828. private _onMeshTargetChangedObserver;
  121829. /**
  121830. * Initializes the behavior.
  121831. */
  121832. init(): void;
  121833. /**
  121834. * Attaches the behavior to its arc rotate camera.
  121835. * @param camera Defines the camera to attach the behavior to
  121836. */
  121837. attach(camera: ArcRotateCamera): void;
  121838. /**
  121839. * Detaches the behavior from its current arc rotate camera.
  121840. */
  121841. detach(): void;
  121842. private _radiusIsAnimating;
  121843. private _radiusBounceTransition;
  121844. private _animatables;
  121845. private _cachedWheelPrecision;
  121846. /**
  121847. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  121848. * @param radiusLimit The limit to check against.
  121849. * @return Bool to indicate if at limit.
  121850. */
  121851. private _isRadiusAtLimit;
  121852. /**
  121853. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  121854. * @param radiusDelta The delta by which to animate to. Can be negative.
  121855. */
  121856. private _applyBoundRadiusAnimation;
  121857. /**
  121858. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  121859. */
  121860. protected _clearAnimationLocks(): void;
  121861. /**
  121862. * Stops and removes all animations that have been applied to the camera
  121863. */
  121864. stopAllAnimations(): void;
  121865. }
  121866. }
  121867. declare module BABYLON {
  121868. /**
  121869. * 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.
  121870. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  121871. */
  121872. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  121873. /**
  121874. * Gets the name of the behavior.
  121875. */
  121876. get name(): string;
  121877. private _mode;
  121878. private _radiusScale;
  121879. private _positionScale;
  121880. private _defaultElevation;
  121881. private _elevationReturnTime;
  121882. private _elevationReturnWaitTime;
  121883. private _zoomStopsAnimation;
  121884. private _framingTime;
  121885. /**
  121886. * The easing function used by animations
  121887. */
  121888. static EasingFunction: ExponentialEase;
  121889. /**
  121890. * The easing mode used by animations
  121891. */
  121892. static EasingMode: number;
  121893. /**
  121894. * Sets the current mode used by the behavior
  121895. */
  121896. set mode(mode: number);
  121897. /**
  121898. * Gets current mode used by the behavior.
  121899. */
  121900. get mode(): number;
  121901. /**
  121902. * Sets the scale applied to the radius (1 by default)
  121903. */
  121904. set radiusScale(radius: number);
  121905. /**
  121906. * Gets the scale applied to the radius
  121907. */
  121908. get radiusScale(): number;
  121909. /**
  121910. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  121911. */
  121912. set positionScale(scale: number);
  121913. /**
  121914. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  121915. */
  121916. get positionScale(): number;
  121917. /**
  121918. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  121919. * behaviour is triggered, in radians.
  121920. */
  121921. set defaultElevation(elevation: number);
  121922. /**
  121923. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  121924. * behaviour is triggered, in radians.
  121925. */
  121926. get defaultElevation(): number;
  121927. /**
  121928. * Sets the time (in milliseconds) taken to return to the default beta position.
  121929. * Negative value indicates camera should not return to default.
  121930. */
  121931. set elevationReturnTime(speed: number);
  121932. /**
  121933. * Gets the time (in milliseconds) taken to return to the default beta position.
  121934. * Negative value indicates camera should not return to default.
  121935. */
  121936. get elevationReturnTime(): number;
  121937. /**
  121938. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  121939. */
  121940. set elevationReturnWaitTime(time: number);
  121941. /**
  121942. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  121943. */
  121944. get elevationReturnWaitTime(): number;
  121945. /**
  121946. * Sets the flag that indicates if user zooming should stop animation.
  121947. */
  121948. set zoomStopsAnimation(flag: boolean);
  121949. /**
  121950. * Gets the flag that indicates if user zooming should stop animation.
  121951. */
  121952. get zoomStopsAnimation(): boolean;
  121953. /**
  121954. * Sets the transition time when framing the mesh, in milliseconds
  121955. */
  121956. set framingTime(time: number);
  121957. /**
  121958. * Gets the transition time when framing the mesh, in milliseconds
  121959. */
  121960. get framingTime(): number;
  121961. /**
  121962. * Define if the behavior should automatically change the configured
  121963. * camera limits and sensibilities.
  121964. */
  121965. autoCorrectCameraLimitsAndSensibility: boolean;
  121966. private _onPrePointerObservableObserver;
  121967. private _onAfterCheckInputsObserver;
  121968. private _onMeshTargetChangedObserver;
  121969. private _attachedCamera;
  121970. private _isPointerDown;
  121971. private _lastInteractionTime;
  121972. /**
  121973. * Initializes the behavior.
  121974. */
  121975. init(): void;
  121976. /**
  121977. * Attaches the behavior to its arc rotate camera.
  121978. * @param camera Defines the camera to attach the behavior to
  121979. */
  121980. attach(camera: ArcRotateCamera): void;
  121981. /**
  121982. * Detaches the behavior from its current arc rotate camera.
  121983. */
  121984. detach(): void;
  121985. private _animatables;
  121986. private _betaIsAnimating;
  121987. private _betaTransition;
  121988. private _radiusTransition;
  121989. private _vectorTransition;
  121990. /**
  121991. * Targets the given mesh and updates zoom level accordingly.
  121992. * @param mesh The mesh to target.
  121993. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  121994. * @param onAnimationEnd Callback triggered at the end of the framing animation
  121995. */
  121996. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  121997. /**
  121998. * Targets the given mesh with its children and updates zoom level accordingly.
  121999. * @param mesh The mesh to target.
  122000. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122001. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122002. */
  122003. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122004. /**
  122005. * Targets the given meshes with their children and updates zoom level accordingly.
  122006. * @param meshes The mesh to target.
  122007. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122008. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122009. */
  122010. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122011. /**
  122012. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  122013. * @param minimumWorld Determines the smaller position of the bounding box extend
  122014. * @param maximumWorld Determines the bigger position of the bounding box extend
  122015. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122016. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122017. */
  122018. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122019. /**
  122020. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  122021. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  122022. * frustum width.
  122023. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  122024. * to fully enclose the mesh in the viewing frustum.
  122025. */
  122026. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  122027. /**
  122028. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  122029. * is automatically returned to its default position (expected to be above ground plane).
  122030. */
  122031. private _maintainCameraAboveGround;
  122032. /**
  122033. * Returns the frustum slope based on the canvas ratio and camera FOV
  122034. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  122035. */
  122036. private _getFrustumSlope;
  122037. /**
  122038. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  122039. */
  122040. private _clearAnimationLocks;
  122041. /**
  122042. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  122043. */
  122044. private _applyUserInteraction;
  122045. /**
  122046. * Stops and removes all animations that have been applied to the camera
  122047. */
  122048. stopAllAnimations(): void;
  122049. /**
  122050. * Gets a value indicating if the user is moving the camera
  122051. */
  122052. get isUserIsMoving(): boolean;
  122053. /**
  122054. * The camera can move all the way towards the mesh.
  122055. */
  122056. static IgnoreBoundsSizeMode: number;
  122057. /**
  122058. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  122059. */
  122060. static FitFrustumSidesMode: number;
  122061. }
  122062. }
  122063. declare module BABYLON {
  122064. /**
  122065. * Base class for Camera Pointer Inputs.
  122066. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  122067. * for example usage.
  122068. */
  122069. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  122070. /**
  122071. * Defines the camera the input is attached to.
  122072. */
  122073. abstract camera: Camera;
  122074. /**
  122075. * Whether keyboard modifier keys are pressed at time of last mouse event.
  122076. */
  122077. protected _altKey: boolean;
  122078. protected _ctrlKey: boolean;
  122079. protected _metaKey: boolean;
  122080. protected _shiftKey: boolean;
  122081. /**
  122082. * Which mouse buttons were pressed at time of last mouse event.
  122083. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  122084. */
  122085. protected _buttonsPressed: number;
  122086. /**
  122087. * Defines the buttons associated with the input to handle camera move.
  122088. */
  122089. buttons: number[];
  122090. /**
  122091. * Attach the input controls to a specific dom element to get the input from.
  122092. * @param element Defines the element the controls should be listened from
  122093. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122094. */
  122095. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122096. /**
  122097. * Detach the current controls from the specified dom element.
  122098. * @param element Defines the element to stop listening the inputs from
  122099. */
  122100. detachControl(element: Nullable<HTMLElement>): void;
  122101. /**
  122102. * Gets the class name of the current input.
  122103. * @returns the class name
  122104. */
  122105. getClassName(): string;
  122106. /**
  122107. * Get the friendly name associated with the input class.
  122108. * @returns the input friendly name
  122109. */
  122110. getSimpleName(): string;
  122111. /**
  122112. * Called on pointer POINTERDOUBLETAP event.
  122113. * Override this method to provide functionality on POINTERDOUBLETAP event.
  122114. */
  122115. protected onDoubleTap(type: string): void;
  122116. /**
  122117. * Called on pointer POINTERMOVE event if only a single touch is active.
  122118. * Override this method to provide functionality.
  122119. */
  122120. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  122121. /**
  122122. * Called on pointer POINTERMOVE event if multiple touches are active.
  122123. * Override this method to provide functionality.
  122124. */
  122125. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  122126. /**
  122127. * Called on JS contextmenu event.
  122128. * Override this method to provide functionality.
  122129. */
  122130. protected onContextMenu(evt: PointerEvent): void;
  122131. /**
  122132. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  122133. * press.
  122134. * Override this method to provide functionality.
  122135. */
  122136. protected onButtonDown(evt: PointerEvent): void;
  122137. /**
  122138. * Called each time a new POINTERUP event occurs. Ie, for each button
  122139. * release.
  122140. * Override this method to provide functionality.
  122141. */
  122142. protected onButtonUp(evt: PointerEvent): void;
  122143. /**
  122144. * Called when window becomes inactive.
  122145. * Override this method to provide functionality.
  122146. */
  122147. protected onLostFocus(): void;
  122148. private _pointerInput;
  122149. private _observer;
  122150. private _onLostFocus;
  122151. private pointA;
  122152. private pointB;
  122153. }
  122154. }
  122155. declare module BABYLON {
  122156. /**
  122157. * Manage the pointers inputs to control an arc rotate camera.
  122158. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122159. */
  122160. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  122161. /**
  122162. * Defines the camera the input is attached to.
  122163. */
  122164. camera: ArcRotateCamera;
  122165. /**
  122166. * Gets the class name of the current input.
  122167. * @returns the class name
  122168. */
  122169. getClassName(): string;
  122170. /**
  122171. * Defines the buttons associated with the input to handle camera move.
  122172. */
  122173. buttons: number[];
  122174. /**
  122175. * Defines the pointer angular sensibility along the X axis or how fast is
  122176. * the camera rotating.
  122177. */
  122178. angularSensibilityX: number;
  122179. /**
  122180. * Defines the pointer angular sensibility along the Y axis or how fast is
  122181. * the camera rotating.
  122182. */
  122183. angularSensibilityY: number;
  122184. /**
  122185. * Defines the pointer pinch precision or how fast is the camera zooming.
  122186. */
  122187. pinchPrecision: number;
  122188. /**
  122189. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  122190. * from 0.
  122191. * It defines the percentage of current camera.radius to use as delta when
  122192. * pinch zoom is used.
  122193. */
  122194. pinchDeltaPercentage: number;
  122195. /**
  122196. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  122197. * that any object in the plane at the camera's target point will scale
  122198. * perfectly with finger motion.
  122199. * Overrides pinchDeltaPercentage and pinchPrecision.
  122200. */
  122201. useNaturalPinchZoom: boolean;
  122202. /**
  122203. * Defines the pointer panning sensibility or how fast is the camera moving.
  122204. */
  122205. panningSensibility: number;
  122206. /**
  122207. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  122208. */
  122209. multiTouchPanning: boolean;
  122210. /**
  122211. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  122212. * zoom (pinch) through multitouch.
  122213. */
  122214. multiTouchPanAndZoom: boolean;
  122215. /**
  122216. * Revers pinch action direction.
  122217. */
  122218. pinchInwards: boolean;
  122219. private _isPanClick;
  122220. private _twoFingerActivityCount;
  122221. private _isPinching;
  122222. /**
  122223. * Called on pointer POINTERMOVE event if only a single touch is active.
  122224. */
  122225. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  122226. /**
  122227. * Called on pointer POINTERDOUBLETAP event.
  122228. */
  122229. protected onDoubleTap(type: string): void;
  122230. /**
  122231. * Called on pointer POINTERMOVE event if multiple touches are active.
  122232. */
  122233. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  122234. /**
  122235. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  122236. * press.
  122237. */
  122238. protected onButtonDown(evt: PointerEvent): void;
  122239. /**
  122240. * Called each time a new POINTERUP event occurs. Ie, for each button
  122241. * release.
  122242. */
  122243. protected onButtonUp(evt: PointerEvent): void;
  122244. /**
  122245. * Called when window becomes inactive.
  122246. */
  122247. protected onLostFocus(): void;
  122248. }
  122249. }
  122250. declare module BABYLON {
  122251. /**
  122252. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  122253. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122254. */
  122255. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  122256. /**
  122257. * Defines the camera the input is attached to.
  122258. */
  122259. camera: ArcRotateCamera;
  122260. /**
  122261. * Defines the list of key codes associated with the up action (increase alpha)
  122262. */
  122263. keysUp: number[];
  122264. /**
  122265. * Defines the list of key codes associated with the down action (decrease alpha)
  122266. */
  122267. keysDown: number[];
  122268. /**
  122269. * Defines the list of key codes associated with the left action (increase beta)
  122270. */
  122271. keysLeft: number[];
  122272. /**
  122273. * Defines the list of key codes associated with the right action (decrease beta)
  122274. */
  122275. keysRight: number[];
  122276. /**
  122277. * Defines the list of key codes associated with the reset action.
  122278. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  122279. */
  122280. keysReset: number[];
  122281. /**
  122282. * Defines the panning sensibility of the inputs.
  122283. * (How fast is the camera panning)
  122284. */
  122285. panningSensibility: number;
  122286. /**
  122287. * Defines the zooming sensibility of the inputs.
  122288. * (How fast is the camera zooming)
  122289. */
  122290. zoomingSensibility: number;
  122291. /**
  122292. * Defines whether maintaining the alt key down switch the movement mode from
  122293. * orientation to zoom.
  122294. */
  122295. useAltToZoom: boolean;
  122296. /**
  122297. * Rotation speed of the camera
  122298. */
  122299. angularSpeed: number;
  122300. private _keys;
  122301. private _ctrlPressed;
  122302. private _altPressed;
  122303. private _onCanvasBlurObserver;
  122304. private _onKeyboardObserver;
  122305. private _engine;
  122306. private _scene;
  122307. /**
  122308. * Attach the input controls to a specific dom element to get the input from.
  122309. * @param element Defines the element the controls should be listened from
  122310. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122311. */
  122312. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122313. /**
  122314. * Detach the current controls from the specified dom element.
  122315. * @param element Defines the element to stop listening the inputs from
  122316. */
  122317. detachControl(element: Nullable<HTMLElement>): void;
  122318. /**
  122319. * Update the current camera state depending on the inputs that have been used this frame.
  122320. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  122321. */
  122322. checkInputs(): void;
  122323. /**
  122324. * Gets the class name of the current intput.
  122325. * @returns the class name
  122326. */
  122327. getClassName(): string;
  122328. /**
  122329. * Get the friendly name associated with the input class.
  122330. * @returns the input friendly name
  122331. */
  122332. getSimpleName(): string;
  122333. }
  122334. }
  122335. declare module BABYLON {
  122336. /**
  122337. * Manage the mouse wheel inputs to control an arc rotate camera.
  122338. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122339. */
  122340. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  122341. /**
  122342. * Defines the camera the input is attached to.
  122343. */
  122344. camera: ArcRotateCamera;
  122345. /**
  122346. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  122347. */
  122348. wheelPrecision: number;
  122349. /**
  122350. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  122351. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  122352. */
  122353. wheelDeltaPercentage: number;
  122354. private _wheel;
  122355. private _observer;
  122356. private computeDeltaFromMouseWheelLegacyEvent;
  122357. /**
  122358. * Attach the input controls to a specific dom element to get the input from.
  122359. * @param element Defines the element the controls should be listened from
  122360. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122361. */
  122362. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122363. /**
  122364. * Detach the current controls from the specified dom element.
  122365. * @param element Defines the element to stop listening the inputs from
  122366. */
  122367. detachControl(element: Nullable<HTMLElement>): void;
  122368. /**
  122369. * Gets the class name of the current intput.
  122370. * @returns the class name
  122371. */
  122372. getClassName(): string;
  122373. /**
  122374. * Get the friendly name associated with the input class.
  122375. * @returns the input friendly name
  122376. */
  122377. getSimpleName(): string;
  122378. }
  122379. }
  122380. declare module BABYLON {
  122381. /**
  122382. * Default Inputs manager for the ArcRotateCamera.
  122383. * It groups all the default supported inputs for ease of use.
  122384. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122385. */
  122386. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  122387. /**
  122388. * Instantiates a new ArcRotateCameraInputsManager.
  122389. * @param camera Defines the camera the inputs belong to
  122390. */
  122391. constructor(camera: ArcRotateCamera);
  122392. /**
  122393. * Add mouse wheel input support to the input manager.
  122394. * @returns the current input manager
  122395. */
  122396. addMouseWheel(): ArcRotateCameraInputsManager;
  122397. /**
  122398. * Add pointers input support to the input manager.
  122399. * @returns the current input manager
  122400. */
  122401. addPointers(): ArcRotateCameraInputsManager;
  122402. /**
  122403. * Add keyboard input support to the input manager.
  122404. * @returns the current input manager
  122405. */
  122406. addKeyboard(): ArcRotateCameraInputsManager;
  122407. }
  122408. }
  122409. declare module BABYLON {
  122410. /**
  122411. * This represents an orbital type of camera.
  122412. *
  122413. * 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.
  122414. * 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.
  122415. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  122416. */
  122417. export class ArcRotateCamera extends TargetCamera {
  122418. /**
  122419. * Defines the rotation angle of the camera along the longitudinal axis.
  122420. */
  122421. alpha: number;
  122422. /**
  122423. * Defines the rotation angle of the camera along the latitudinal axis.
  122424. */
  122425. beta: number;
  122426. /**
  122427. * Defines the radius of the camera from it s target point.
  122428. */
  122429. radius: number;
  122430. protected _target: Vector3;
  122431. protected _targetHost: Nullable<AbstractMesh>;
  122432. /**
  122433. * Defines the target point of the camera.
  122434. * The camera looks towards it form the radius distance.
  122435. * Please note that you can set the target to a mesh and thus the target will be copied from mesh.position
  122436. */
  122437. get target(): Vector3;
  122438. set target(value: Vector3);
  122439. /**
  122440. * Define the current local position of the camera in the scene
  122441. */
  122442. get position(): Vector3;
  122443. set position(newPosition: Vector3);
  122444. protected _upToYMatrix: Matrix;
  122445. protected _YToUpMatrix: Matrix;
  122446. /**
  122447. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  122448. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  122449. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  122450. */
  122451. set upVector(vec: Vector3);
  122452. get upVector(): Vector3;
  122453. /**
  122454. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  122455. */
  122456. setMatUp(): void;
  122457. /**
  122458. * Current inertia value on the longitudinal axis.
  122459. * The bigger this number the longer it will take for the camera to stop.
  122460. */
  122461. inertialAlphaOffset: number;
  122462. /**
  122463. * Current inertia value on the latitudinal axis.
  122464. * The bigger this number the longer it will take for the camera to stop.
  122465. */
  122466. inertialBetaOffset: number;
  122467. /**
  122468. * Current inertia value on the radius axis.
  122469. * The bigger this number the longer it will take for the camera to stop.
  122470. */
  122471. inertialRadiusOffset: number;
  122472. /**
  122473. * Minimum allowed angle on the longitudinal axis.
  122474. * This can help limiting how the Camera is able to move in the scene.
  122475. */
  122476. lowerAlphaLimit: Nullable<number>;
  122477. /**
  122478. * Maximum allowed angle on the longitudinal axis.
  122479. * This can help limiting how the Camera is able to move in the scene.
  122480. */
  122481. upperAlphaLimit: Nullable<number>;
  122482. /**
  122483. * Minimum allowed angle on the latitudinal axis.
  122484. * This can help limiting how the Camera is able to move in the scene.
  122485. */
  122486. lowerBetaLimit: number;
  122487. /**
  122488. * Maximum allowed angle on the latitudinal axis.
  122489. * This can help limiting how the Camera is able to move in the scene.
  122490. */
  122491. upperBetaLimit: number;
  122492. /**
  122493. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  122494. * This can help limiting how the Camera is able to move in the scene.
  122495. */
  122496. lowerRadiusLimit: Nullable<number>;
  122497. /**
  122498. * Maximum allowed distance of the camera to the target (The camera can not get further).
  122499. * This can help limiting how the Camera is able to move in the scene.
  122500. */
  122501. upperRadiusLimit: Nullable<number>;
  122502. /**
  122503. * Defines the current inertia value used during panning of the camera along the X axis.
  122504. */
  122505. inertialPanningX: number;
  122506. /**
  122507. * Defines the current inertia value used during panning of the camera along the Y axis.
  122508. */
  122509. inertialPanningY: number;
  122510. /**
  122511. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  122512. * Basically if your fingers moves away from more than this distance you will be considered
  122513. * in pinch mode.
  122514. */
  122515. pinchToPanMaxDistance: number;
  122516. /**
  122517. * Defines the maximum distance the camera can pan.
  122518. * This could help keeping the cammera always in your scene.
  122519. */
  122520. panningDistanceLimit: Nullable<number>;
  122521. /**
  122522. * Defines the target of the camera before paning.
  122523. */
  122524. panningOriginTarget: Vector3;
  122525. /**
  122526. * Defines the value of the inertia used during panning.
  122527. * 0 would mean stop inertia and one would mean no decelleration at all.
  122528. */
  122529. panningInertia: number;
  122530. /**
  122531. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  122532. */
  122533. get angularSensibilityX(): number;
  122534. set angularSensibilityX(value: number);
  122535. /**
  122536. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  122537. */
  122538. get angularSensibilityY(): number;
  122539. set angularSensibilityY(value: number);
  122540. /**
  122541. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  122542. */
  122543. get pinchPrecision(): number;
  122544. set pinchPrecision(value: number);
  122545. /**
  122546. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  122547. * It will be used instead of pinchDeltaPrecision if different from 0.
  122548. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  122549. */
  122550. get pinchDeltaPercentage(): number;
  122551. set pinchDeltaPercentage(value: number);
  122552. /**
  122553. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  122554. * and pinch delta percentage.
  122555. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  122556. * that any object in the plane at the camera's target point will scale
  122557. * perfectly with finger motion.
  122558. */
  122559. get useNaturalPinchZoom(): boolean;
  122560. set useNaturalPinchZoom(value: boolean);
  122561. /**
  122562. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  122563. */
  122564. get panningSensibility(): number;
  122565. set panningSensibility(value: number);
  122566. /**
  122567. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  122568. */
  122569. get keysUp(): number[];
  122570. set keysUp(value: number[]);
  122571. /**
  122572. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  122573. */
  122574. get keysDown(): number[];
  122575. set keysDown(value: number[]);
  122576. /**
  122577. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  122578. */
  122579. get keysLeft(): number[];
  122580. set keysLeft(value: number[]);
  122581. /**
  122582. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  122583. */
  122584. get keysRight(): number[];
  122585. set keysRight(value: number[]);
  122586. /**
  122587. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  122588. */
  122589. get wheelPrecision(): number;
  122590. set wheelPrecision(value: number);
  122591. /**
  122592. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  122593. * It will be used instead of pinchDeltaPrecision if different from 0.
  122594. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  122595. */
  122596. get wheelDeltaPercentage(): number;
  122597. set wheelDeltaPercentage(value: number);
  122598. /**
  122599. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  122600. */
  122601. zoomOnFactor: number;
  122602. /**
  122603. * Defines a screen offset for the camera position.
  122604. */
  122605. targetScreenOffset: Vector2;
  122606. /**
  122607. * Allows the camera to be completely reversed.
  122608. * If false the camera can not arrive upside down.
  122609. */
  122610. allowUpsideDown: boolean;
  122611. /**
  122612. * Define if double tap/click is used to restore the previously saved state of the camera.
  122613. */
  122614. useInputToRestoreState: boolean;
  122615. /** @hidden */
  122616. _viewMatrix: Matrix;
  122617. /** @hidden */
  122618. _useCtrlForPanning: boolean;
  122619. /** @hidden */
  122620. _panningMouseButton: number;
  122621. /**
  122622. * Defines the input associated to the camera.
  122623. */
  122624. inputs: ArcRotateCameraInputsManager;
  122625. /** @hidden */
  122626. _reset: () => void;
  122627. /**
  122628. * Defines the allowed panning axis.
  122629. */
  122630. panningAxis: Vector3;
  122631. protected _localDirection: Vector3;
  122632. protected _transformedDirection: Vector3;
  122633. private _bouncingBehavior;
  122634. /**
  122635. * Gets the bouncing behavior of the camera if it has been enabled.
  122636. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  122637. */
  122638. get bouncingBehavior(): Nullable<BouncingBehavior>;
  122639. /**
  122640. * Defines if the bouncing behavior of the camera is enabled on the camera.
  122641. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  122642. */
  122643. get useBouncingBehavior(): boolean;
  122644. set useBouncingBehavior(value: boolean);
  122645. private _framingBehavior;
  122646. /**
  122647. * Gets the framing behavior of the camera if it has been enabled.
  122648. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  122649. */
  122650. get framingBehavior(): Nullable<FramingBehavior>;
  122651. /**
  122652. * Defines if the framing behavior of the camera is enabled on the camera.
  122653. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  122654. */
  122655. get useFramingBehavior(): boolean;
  122656. set useFramingBehavior(value: boolean);
  122657. private _autoRotationBehavior;
  122658. /**
  122659. * Gets the auto rotation behavior of the camera if it has been enabled.
  122660. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122661. */
  122662. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  122663. /**
  122664. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  122665. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122666. */
  122667. get useAutoRotationBehavior(): boolean;
  122668. set useAutoRotationBehavior(value: boolean);
  122669. /**
  122670. * Observable triggered when the mesh target has been changed on the camera.
  122671. */
  122672. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  122673. /**
  122674. * Event raised when the camera is colliding with a mesh.
  122675. */
  122676. onCollide: (collidedMesh: AbstractMesh) => void;
  122677. /**
  122678. * Defines whether the camera should check collision with the objects oh the scene.
  122679. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  122680. */
  122681. checkCollisions: boolean;
  122682. /**
  122683. * Defines the collision radius of the camera.
  122684. * This simulates a sphere around the camera.
  122685. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  122686. */
  122687. collisionRadius: Vector3;
  122688. protected _collider: Collider;
  122689. protected _previousPosition: Vector3;
  122690. protected _collisionVelocity: Vector3;
  122691. protected _newPosition: Vector3;
  122692. protected _previousAlpha: number;
  122693. protected _previousBeta: number;
  122694. protected _previousRadius: number;
  122695. protected _collisionTriggered: boolean;
  122696. protected _targetBoundingCenter: Nullable<Vector3>;
  122697. private _computationVector;
  122698. /**
  122699. * Instantiates a new ArcRotateCamera in a given scene
  122700. * @param name Defines the name of the camera
  122701. * @param alpha Defines the camera rotation along the logitudinal axis
  122702. * @param beta Defines the camera rotation along the latitudinal axis
  122703. * @param radius Defines the camera distance from its target
  122704. * @param target Defines the camera target
  122705. * @param scene Defines the scene the camera belongs to
  122706. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  122707. */
  122708. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  122709. /** @hidden */
  122710. _initCache(): void;
  122711. /** @hidden */
  122712. _updateCache(ignoreParentClass?: boolean): void;
  122713. protected _getTargetPosition(): Vector3;
  122714. private _storedAlpha;
  122715. private _storedBeta;
  122716. private _storedRadius;
  122717. private _storedTarget;
  122718. private _storedTargetScreenOffset;
  122719. /**
  122720. * Stores the current state of the camera (alpha, beta, radius and target)
  122721. * @returns the camera itself
  122722. */
  122723. storeState(): Camera;
  122724. /**
  122725. * @hidden
  122726. * Restored camera state. You must call storeState() first
  122727. */
  122728. _restoreStateValues(): boolean;
  122729. /** @hidden */
  122730. _isSynchronizedViewMatrix(): boolean;
  122731. /**
  122732. * Attached controls to the current camera.
  122733. * @param element Defines the element the controls should be listened from
  122734. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122735. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  122736. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  122737. */
  122738. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  122739. /**
  122740. * Detach the current controls from the camera.
  122741. * The camera will stop reacting to inputs.
  122742. * @param element Defines the element to stop listening the inputs from
  122743. */
  122744. detachControl(element: HTMLElement): void;
  122745. /** @hidden */
  122746. _checkInputs(): void;
  122747. protected _checkLimits(): void;
  122748. /**
  122749. * Rebuilds angles (alpha, beta) and radius from the give position and target
  122750. */
  122751. rebuildAnglesAndRadius(): void;
  122752. /**
  122753. * Use a position to define the current camera related information like alpha, beta and radius
  122754. * @param position Defines the position to set the camera at
  122755. */
  122756. setPosition(position: Vector3): void;
  122757. /**
  122758. * Defines the target the camera should look at.
  122759. * This will automatically adapt alpha beta and radius to fit within the new target.
  122760. * @param target Defines the new target as a Vector or a mesh
  122761. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  122762. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  122763. */
  122764. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  122765. /** @hidden */
  122766. _getViewMatrix(): Matrix;
  122767. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  122768. /**
  122769. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  122770. * @param meshes Defines the mesh to zoom on
  122771. * @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)
  122772. */
  122773. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  122774. /**
  122775. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  122776. * The target will be changed but the radius
  122777. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  122778. * @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)
  122779. */
  122780. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  122781. min: Vector3;
  122782. max: Vector3;
  122783. distance: number;
  122784. }, doNotUpdateMaxZ?: boolean): void;
  122785. /**
  122786. * @override
  122787. * Override Camera.createRigCamera
  122788. */
  122789. createRigCamera(name: string, cameraIndex: number): Camera;
  122790. /**
  122791. * @hidden
  122792. * @override
  122793. * Override Camera._updateRigCameras
  122794. */
  122795. _updateRigCameras(): void;
  122796. /**
  122797. * Destroy the camera and release the current resources hold by it.
  122798. */
  122799. dispose(): void;
  122800. /**
  122801. * Gets the current object class name.
  122802. * @return the class name
  122803. */
  122804. getClassName(): string;
  122805. }
  122806. }
  122807. declare module BABYLON {
  122808. /**
  122809. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  122810. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122811. */
  122812. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  122813. /**
  122814. * Gets the name of the behavior.
  122815. */
  122816. get name(): string;
  122817. private _zoomStopsAnimation;
  122818. private _idleRotationSpeed;
  122819. private _idleRotationWaitTime;
  122820. private _idleRotationSpinupTime;
  122821. /**
  122822. * Sets the flag that indicates if user zooming should stop animation.
  122823. */
  122824. set zoomStopsAnimation(flag: boolean);
  122825. /**
  122826. * Gets the flag that indicates if user zooming should stop animation.
  122827. */
  122828. get zoomStopsAnimation(): boolean;
  122829. /**
  122830. * Sets the default speed at which the camera rotates around the model.
  122831. */
  122832. set idleRotationSpeed(speed: number);
  122833. /**
  122834. * Gets the default speed at which the camera rotates around the model.
  122835. */
  122836. get idleRotationSpeed(): number;
  122837. /**
  122838. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  122839. */
  122840. set idleRotationWaitTime(time: number);
  122841. /**
  122842. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  122843. */
  122844. get idleRotationWaitTime(): number;
  122845. /**
  122846. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  122847. */
  122848. set idleRotationSpinupTime(time: number);
  122849. /**
  122850. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  122851. */
  122852. get idleRotationSpinupTime(): number;
  122853. /**
  122854. * Gets a value indicating if the camera is currently rotating because of this behavior
  122855. */
  122856. get rotationInProgress(): boolean;
  122857. private _onPrePointerObservableObserver;
  122858. private _onAfterCheckInputsObserver;
  122859. private _attachedCamera;
  122860. private _isPointerDown;
  122861. private _lastFrameTime;
  122862. private _lastInteractionTime;
  122863. private _cameraRotationSpeed;
  122864. /**
  122865. * Initializes the behavior.
  122866. */
  122867. init(): void;
  122868. /**
  122869. * Attaches the behavior to its arc rotate camera.
  122870. * @param camera Defines the camera to attach the behavior to
  122871. */
  122872. attach(camera: ArcRotateCamera): void;
  122873. /**
  122874. * Detaches the behavior from its current arc rotate camera.
  122875. */
  122876. detach(): void;
  122877. /**
  122878. * Returns true if user is scrolling.
  122879. * @return true if user is scrolling.
  122880. */
  122881. private _userIsZooming;
  122882. private _lastFrameRadius;
  122883. private _shouldAnimationStopForInteraction;
  122884. /**
  122885. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  122886. */
  122887. private _applyUserInteraction;
  122888. private _userIsMoving;
  122889. }
  122890. }
  122891. declare module BABYLON {
  122892. /**
  122893. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  122894. */
  122895. export class AttachToBoxBehavior implements Behavior<Mesh> {
  122896. private ui;
  122897. /**
  122898. * The name of the behavior
  122899. */
  122900. name: string;
  122901. /**
  122902. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  122903. */
  122904. distanceAwayFromFace: number;
  122905. /**
  122906. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  122907. */
  122908. distanceAwayFromBottomOfFace: number;
  122909. private _faceVectors;
  122910. private _target;
  122911. private _scene;
  122912. private _onRenderObserver;
  122913. private _tmpMatrix;
  122914. private _tmpVector;
  122915. /**
  122916. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  122917. * @param ui The transform node that should be attched to the mesh
  122918. */
  122919. constructor(ui: TransformNode);
  122920. /**
  122921. * Initializes the behavior
  122922. */
  122923. init(): void;
  122924. private _closestFace;
  122925. private _zeroVector;
  122926. private _lookAtTmpMatrix;
  122927. private _lookAtToRef;
  122928. /**
  122929. * Attaches the AttachToBoxBehavior to the passed in mesh
  122930. * @param target The mesh that the specified node will be attached to
  122931. */
  122932. attach(target: Mesh): void;
  122933. /**
  122934. * Detaches the behavior from the mesh
  122935. */
  122936. detach(): void;
  122937. }
  122938. }
  122939. declare module BABYLON {
  122940. /**
  122941. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  122942. */
  122943. export class FadeInOutBehavior implements Behavior<Mesh> {
  122944. /**
  122945. * Time in milliseconds to delay before fading in (Default: 0)
  122946. */
  122947. delay: number;
  122948. /**
  122949. * Time in milliseconds for the mesh to fade in (Default: 300)
  122950. */
  122951. fadeInTime: number;
  122952. private _millisecondsPerFrame;
  122953. private _hovered;
  122954. private _hoverValue;
  122955. private _ownerNode;
  122956. /**
  122957. * Instatiates the FadeInOutBehavior
  122958. */
  122959. constructor();
  122960. /**
  122961. * The name of the behavior
  122962. */
  122963. get name(): string;
  122964. /**
  122965. * Initializes the behavior
  122966. */
  122967. init(): void;
  122968. /**
  122969. * Attaches the fade behavior on the passed in mesh
  122970. * @param ownerNode The mesh that will be faded in/out once attached
  122971. */
  122972. attach(ownerNode: Mesh): void;
  122973. /**
  122974. * Detaches the behavior from the mesh
  122975. */
  122976. detach(): void;
  122977. /**
  122978. * Triggers the mesh to begin fading in or out
  122979. * @param value if the object should fade in or out (true to fade in)
  122980. */
  122981. fadeIn(value: boolean): void;
  122982. private _update;
  122983. private _setAllVisibility;
  122984. }
  122985. }
  122986. declare module BABYLON {
  122987. /**
  122988. * Class containing a set of static utilities functions for managing Pivots
  122989. * @hidden
  122990. */
  122991. export class PivotTools {
  122992. private static _PivotCached;
  122993. private static _OldPivotPoint;
  122994. private static _PivotTranslation;
  122995. private static _PivotTmpVector;
  122996. /** @hidden */
  122997. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  122998. /** @hidden */
  122999. static _RestorePivotPoint(mesh: AbstractMesh): void;
  123000. }
  123001. }
  123002. declare module BABYLON {
  123003. /**
  123004. * Class containing static functions to help procedurally build meshes
  123005. */
  123006. export class PlaneBuilder {
  123007. /**
  123008. * Creates a plane mesh
  123009. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  123010. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  123011. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  123012. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  123013. * * 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
  123014. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  123015. * @param name defines the name of the mesh
  123016. * @param options defines the options used to create the mesh
  123017. * @param scene defines the hosting scene
  123018. * @returns the plane mesh
  123019. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  123020. */
  123021. static CreatePlane(name: string, options: {
  123022. size?: number;
  123023. width?: number;
  123024. height?: number;
  123025. sideOrientation?: number;
  123026. frontUVs?: Vector4;
  123027. backUVs?: Vector4;
  123028. updatable?: boolean;
  123029. sourcePlane?: Plane;
  123030. }, scene?: Nullable<Scene>): Mesh;
  123031. }
  123032. }
  123033. declare module BABYLON {
  123034. /**
  123035. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  123036. */
  123037. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  123038. private static _AnyMouseID;
  123039. /**
  123040. * Abstract mesh the behavior is set on
  123041. */
  123042. attachedNode: AbstractMesh;
  123043. private _dragPlane;
  123044. private _scene;
  123045. private _pointerObserver;
  123046. private _beforeRenderObserver;
  123047. private static _planeScene;
  123048. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  123049. /**
  123050. * 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)
  123051. */
  123052. maxDragAngle: number;
  123053. /**
  123054. * @hidden
  123055. */
  123056. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  123057. /**
  123058. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  123059. */
  123060. currentDraggingPointerID: number;
  123061. /**
  123062. * The last position where the pointer hit the drag plane in world space
  123063. */
  123064. lastDragPosition: Vector3;
  123065. /**
  123066. * If the behavior is currently in a dragging state
  123067. */
  123068. dragging: boolean;
  123069. /**
  123070. * 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)
  123071. */
  123072. dragDeltaRatio: number;
  123073. /**
  123074. * If the drag plane orientation should be updated during the dragging (Default: true)
  123075. */
  123076. updateDragPlane: boolean;
  123077. private _debugMode;
  123078. private _moving;
  123079. /**
  123080. * Fires each time the attached mesh is dragged with the pointer
  123081. * * delta between last drag position and current drag position in world space
  123082. * * dragDistance along the drag axis
  123083. * * dragPlaneNormal normal of the current drag plane used during the drag
  123084. * * dragPlanePoint in world space where the drag intersects the drag plane
  123085. */
  123086. onDragObservable: Observable<{
  123087. delta: Vector3;
  123088. dragPlanePoint: Vector3;
  123089. dragPlaneNormal: Vector3;
  123090. dragDistance: number;
  123091. pointerId: number;
  123092. }>;
  123093. /**
  123094. * Fires each time a drag begins (eg. mouse down on mesh)
  123095. */
  123096. onDragStartObservable: Observable<{
  123097. dragPlanePoint: Vector3;
  123098. pointerId: number;
  123099. }>;
  123100. /**
  123101. * Fires each time a drag ends (eg. mouse release after drag)
  123102. */
  123103. onDragEndObservable: Observable<{
  123104. dragPlanePoint: Vector3;
  123105. pointerId: number;
  123106. }>;
  123107. /**
  123108. * If the attached mesh should be moved when dragged
  123109. */
  123110. moveAttached: boolean;
  123111. /**
  123112. * If the drag behavior will react to drag events (Default: true)
  123113. */
  123114. enabled: boolean;
  123115. /**
  123116. * If pointer events should start and release the drag (Default: true)
  123117. */
  123118. startAndReleaseDragOnPointerEvents: boolean;
  123119. /**
  123120. * If camera controls should be detached during the drag
  123121. */
  123122. detachCameraControls: boolean;
  123123. /**
  123124. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  123125. */
  123126. useObjectOrientationForDragging: boolean;
  123127. private _options;
  123128. /**
  123129. * Gets the options used by the behavior
  123130. */
  123131. get options(): {
  123132. dragAxis?: Vector3;
  123133. dragPlaneNormal?: Vector3;
  123134. };
  123135. /**
  123136. * Sets the options used by the behavior
  123137. */
  123138. set options(options: {
  123139. dragAxis?: Vector3;
  123140. dragPlaneNormal?: Vector3;
  123141. });
  123142. /**
  123143. * Creates a pointer drag behavior that can be attached to a mesh
  123144. * @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)
  123145. */
  123146. constructor(options?: {
  123147. dragAxis?: Vector3;
  123148. dragPlaneNormal?: Vector3;
  123149. });
  123150. /**
  123151. * Predicate to determine if it is valid to move the object to a new position when it is moved
  123152. */
  123153. validateDrag: (targetPosition: Vector3) => boolean;
  123154. /**
  123155. * The name of the behavior
  123156. */
  123157. get name(): string;
  123158. /**
  123159. * Initializes the behavior
  123160. */
  123161. init(): void;
  123162. private _tmpVector;
  123163. private _alternatePickedPoint;
  123164. private _worldDragAxis;
  123165. private _targetPosition;
  123166. private _attachedElement;
  123167. /**
  123168. * Attaches the drag behavior the passed in mesh
  123169. * @param ownerNode The mesh that will be dragged around once attached
  123170. * @param predicate Predicate to use for pick filtering
  123171. */
  123172. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  123173. /**
  123174. * Force relase the drag action by code.
  123175. */
  123176. releaseDrag(): void;
  123177. private _startDragRay;
  123178. private _lastPointerRay;
  123179. /**
  123180. * Simulates the start of a pointer drag event on the behavior
  123181. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  123182. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  123183. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  123184. */
  123185. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  123186. private _startDrag;
  123187. private _dragDelta;
  123188. private _moveDrag;
  123189. private _pickWithRayOnDragPlane;
  123190. private _pointA;
  123191. private _pointC;
  123192. private _localAxis;
  123193. private _lookAt;
  123194. private _updateDragPlanePosition;
  123195. /**
  123196. * Detaches the behavior from the mesh
  123197. */
  123198. detach(): void;
  123199. }
  123200. }
  123201. declare module BABYLON {
  123202. /**
  123203. * A behavior that when attached to a mesh will allow the mesh to be scaled
  123204. */
  123205. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  123206. private _dragBehaviorA;
  123207. private _dragBehaviorB;
  123208. private _startDistance;
  123209. private _initialScale;
  123210. private _targetScale;
  123211. private _ownerNode;
  123212. private _sceneRenderObserver;
  123213. /**
  123214. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  123215. */
  123216. constructor();
  123217. /**
  123218. * The name of the behavior
  123219. */
  123220. get name(): string;
  123221. /**
  123222. * Initializes the behavior
  123223. */
  123224. init(): void;
  123225. private _getCurrentDistance;
  123226. /**
  123227. * Attaches the scale behavior the passed in mesh
  123228. * @param ownerNode The mesh that will be scaled around once attached
  123229. */
  123230. attach(ownerNode: Mesh): void;
  123231. /**
  123232. * Detaches the behavior from the mesh
  123233. */
  123234. detach(): void;
  123235. }
  123236. }
  123237. declare module BABYLON {
  123238. /**
  123239. * 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
  123240. */
  123241. export class SixDofDragBehavior implements Behavior<Mesh> {
  123242. private static _virtualScene;
  123243. private _ownerNode;
  123244. private _sceneRenderObserver;
  123245. private _scene;
  123246. private _targetPosition;
  123247. private _virtualOriginMesh;
  123248. private _virtualDragMesh;
  123249. private _pointerObserver;
  123250. private _moving;
  123251. private _startingOrientation;
  123252. private _attachedElement;
  123253. /**
  123254. * 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)
  123255. */
  123256. private zDragFactor;
  123257. /**
  123258. * If the object should rotate to face the drag origin
  123259. */
  123260. rotateDraggedObject: boolean;
  123261. /**
  123262. * If the behavior is currently in a dragging state
  123263. */
  123264. dragging: boolean;
  123265. /**
  123266. * 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)
  123267. */
  123268. dragDeltaRatio: number;
  123269. /**
  123270. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  123271. */
  123272. currentDraggingPointerID: number;
  123273. /**
  123274. * If camera controls should be detached during the drag
  123275. */
  123276. detachCameraControls: boolean;
  123277. /**
  123278. * Fires each time a drag starts
  123279. */
  123280. onDragStartObservable: Observable<{}>;
  123281. /**
  123282. * Fires each time a drag ends (eg. mouse release after drag)
  123283. */
  123284. onDragEndObservable: Observable<{}>;
  123285. /**
  123286. * 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
  123287. */
  123288. constructor();
  123289. /**
  123290. * The name of the behavior
  123291. */
  123292. get name(): string;
  123293. /**
  123294. * Initializes the behavior
  123295. */
  123296. init(): void;
  123297. /**
  123298. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  123299. */
  123300. private get _pointerCamera();
  123301. /**
  123302. * Attaches the scale behavior the passed in mesh
  123303. * @param ownerNode The mesh that will be scaled around once attached
  123304. */
  123305. attach(ownerNode: Mesh): void;
  123306. /**
  123307. * Detaches the behavior from the mesh
  123308. */
  123309. detach(): void;
  123310. }
  123311. }
  123312. declare module BABYLON {
  123313. /**
  123314. * Class used to apply inverse kinematics to bones
  123315. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  123316. */
  123317. export class BoneIKController {
  123318. private static _tmpVecs;
  123319. private static _tmpQuat;
  123320. private static _tmpMats;
  123321. /**
  123322. * Gets or sets the target mesh
  123323. */
  123324. targetMesh: AbstractMesh;
  123325. /** Gets or sets the mesh used as pole */
  123326. poleTargetMesh: AbstractMesh;
  123327. /**
  123328. * Gets or sets the bone used as pole
  123329. */
  123330. poleTargetBone: Nullable<Bone>;
  123331. /**
  123332. * Gets or sets the target position
  123333. */
  123334. targetPosition: Vector3;
  123335. /**
  123336. * Gets or sets the pole target position
  123337. */
  123338. poleTargetPosition: Vector3;
  123339. /**
  123340. * Gets or sets the pole target local offset
  123341. */
  123342. poleTargetLocalOffset: Vector3;
  123343. /**
  123344. * Gets or sets the pole angle
  123345. */
  123346. poleAngle: number;
  123347. /**
  123348. * Gets or sets the mesh associated with the controller
  123349. */
  123350. mesh: AbstractMesh;
  123351. /**
  123352. * 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)
  123353. */
  123354. slerpAmount: number;
  123355. private _bone1Quat;
  123356. private _bone1Mat;
  123357. private _bone2Ang;
  123358. private _bone1;
  123359. private _bone2;
  123360. private _bone1Length;
  123361. private _bone2Length;
  123362. private _maxAngle;
  123363. private _maxReach;
  123364. private _rightHandedSystem;
  123365. private _bendAxis;
  123366. private _slerping;
  123367. private _adjustRoll;
  123368. /**
  123369. * Gets or sets maximum allowed angle
  123370. */
  123371. get maxAngle(): number;
  123372. set maxAngle(value: number);
  123373. /**
  123374. * Creates a new BoneIKController
  123375. * @param mesh defines the mesh to control
  123376. * @param bone defines the bone to control
  123377. * @param options defines options to set up the controller
  123378. */
  123379. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  123380. targetMesh?: AbstractMesh;
  123381. poleTargetMesh?: AbstractMesh;
  123382. poleTargetBone?: Bone;
  123383. poleTargetLocalOffset?: Vector3;
  123384. poleAngle?: number;
  123385. bendAxis?: Vector3;
  123386. maxAngle?: number;
  123387. slerpAmount?: number;
  123388. });
  123389. private _setMaxAngle;
  123390. /**
  123391. * Force the controller to update the bones
  123392. */
  123393. update(): void;
  123394. }
  123395. }
  123396. declare module BABYLON {
  123397. /**
  123398. * Class used to make a bone look toward a point in space
  123399. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  123400. */
  123401. export class BoneLookController {
  123402. private static _tmpVecs;
  123403. private static _tmpQuat;
  123404. private static _tmpMats;
  123405. /**
  123406. * The target Vector3 that the bone will look at
  123407. */
  123408. target: Vector3;
  123409. /**
  123410. * The mesh that the bone is attached to
  123411. */
  123412. mesh: AbstractMesh;
  123413. /**
  123414. * The bone that will be looking to the target
  123415. */
  123416. bone: Bone;
  123417. /**
  123418. * The up axis of the coordinate system that is used when the bone is rotated
  123419. */
  123420. upAxis: Vector3;
  123421. /**
  123422. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  123423. */
  123424. upAxisSpace: Space;
  123425. /**
  123426. * Used to make an adjustment to the yaw of the bone
  123427. */
  123428. adjustYaw: number;
  123429. /**
  123430. * Used to make an adjustment to the pitch of the bone
  123431. */
  123432. adjustPitch: number;
  123433. /**
  123434. * Used to make an adjustment to the roll of the bone
  123435. */
  123436. adjustRoll: number;
  123437. /**
  123438. * 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)
  123439. */
  123440. slerpAmount: number;
  123441. private _minYaw;
  123442. private _maxYaw;
  123443. private _minPitch;
  123444. private _maxPitch;
  123445. private _minYawSin;
  123446. private _minYawCos;
  123447. private _maxYawSin;
  123448. private _maxYawCos;
  123449. private _midYawConstraint;
  123450. private _minPitchTan;
  123451. private _maxPitchTan;
  123452. private _boneQuat;
  123453. private _slerping;
  123454. private _transformYawPitch;
  123455. private _transformYawPitchInv;
  123456. private _firstFrameSkipped;
  123457. private _yawRange;
  123458. private _fowardAxis;
  123459. /**
  123460. * Gets or sets the minimum yaw angle that the bone can look to
  123461. */
  123462. get minYaw(): number;
  123463. set minYaw(value: number);
  123464. /**
  123465. * Gets or sets the maximum yaw angle that the bone can look to
  123466. */
  123467. get maxYaw(): number;
  123468. set maxYaw(value: number);
  123469. /**
  123470. * Gets or sets the minimum pitch angle that the bone can look to
  123471. */
  123472. get minPitch(): number;
  123473. set minPitch(value: number);
  123474. /**
  123475. * Gets or sets the maximum pitch angle that the bone can look to
  123476. */
  123477. get maxPitch(): number;
  123478. set maxPitch(value: number);
  123479. /**
  123480. * Create a BoneLookController
  123481. * @param mesh the mesh that the bone belongs to
  123482. * @param bone the bone that will be looking to the target
  123483. * @param target the target Vector3 to look at
  123484. * @param options optional settings:
  123485. * * maxYaw: the maximum angle the bone will yaw to
  123486. * * minYaw: the minimum angle the bone will yaw to
  123487. * * maxPitch: the maximum angle the bone will pitch to
  123488. * * minPitch: the minimum angle the bone will yaw to
  123489. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  123490. * * upAxis: the up axis of the coordinate system
  123491. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  123492. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  123493. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  123494. * * adjustYaw: used to make an adjustment to the yaw of the bone
  123495. * * adjustPitch: used to make an adjustment to the pitch of the bone
  123496. * * adjustRoll: used to make an adjustment to the roll of the bone
  123497. **/
  123498. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  123499. maxYaw?: number;
  123500. minYaw?: number;
  123501. maxPitch?: number;
  123502. minPitch?: number;
  123503. slerpAmount?: number;
  123504. upAxis?: Vector3;
  123505. upAxisSpace?: Space;
  123506. yawAxis?: Vector3;
  123507. pitchAxis?: Vector3;
  123508. adjustYaw?: number;
  123509. adjustPitch?: number;
  123510. adjustRoll?: number;
  123511. });
  123512. /**
  123513. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  123514. */
  123515. update(): void;
  123516. private _getAngleDiff;
  123517. private _getAngleBetween;
  123518. private _isAngleBetween;
  123519. }
  123520. }
  123521. declare module BABYLON {
  123522. /**
  123523. * Manage the gamepad inputs to control an arc rotate camera.
  123524. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123525. */
  123526. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  123527. /**
  123528. * Defines the camera the input is attached to.
  123529. */
  123530. camera: ArcRotateCamera;
  123531. /**
  123532. * Defines the gamepad the input is gathering event from.
  123533. */
  123534. gamepad: Nullable<Gamepad>;
  123535. /**
  123536. * Defines the gamepad rotation sensiblity.
  123537. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  123538. */
  123539. gamepadRotationSensibility: number;
  123540. /**
  123541. * Defines the gamepad move sensiblity.
  123542. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  123543. */
  123544. gamepadMoveSensibility: number;
  123545. private _yAxisScale;
  123546. /**
  123547. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  123548. */
  123549. get invertYAxis(): boolean;
  123550. set invertYAxis(value: boolean);
  123551. private _onGamepadConnectedObserver;
  123552. private _onGamepadDisconnectedObserver;
  123553. /**
  123554. * Attach the input controls to a specific dom element to get the input from.
  123555. * @param element Defines the element the controls should be listened from
  123556. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123557. */
  123558. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123559. /**
  123560. * Detach the current controls from the specified dom element.
  123561. * @param element Defines the element to stop listening the inputs from
  123562. */
  123563. detachControl(element: Nullable<HTMLElement>): void;
  123564. /**
  123565. * Update the current camera state depending on the inputs that have been used this frame.
  123566. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123567. */
  123568. checkInputs(): void;
  123569. /**
  123570. * Gets the class name of the current intput.
  123571. * @returns the class name
  123572. */
  123573. getClassName(): string;
  123574. /**
  123575. * Get the friendly name associated with the input class.
  123576. * @returns the input friendly name
  123577. */
  123578. getSimpleName(): string;
  123579. }
  123580. }
  123581. declare module BABYLON {
  123582. interface ArcRotateCameraInputsManager {
  123583. /**
  123584. * Add orientation input support to the input manager.
  123585. * @returns the current input manager
  123586. */
  123587. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  123588. }
  123589. /**
  123590. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  123591. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123592. */
  123593. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  123594. /**
  123595. * Defines the camera the input is attached to.
  123596. */
  123597. camera: ArcRotateCamera;
  123598. /**
  123599. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  123600. */
  123601. alphaCorrection: number;
  123602. /**
  123603. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  123604. */
  123605. gammaCorrection: number;
  123606. private _alpha;
  123607. private _gamma;
  123608. private _dirty;
  123609. private _deviceOrientationHandler;
  123610. /**
  123611. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  123612. */
  123613. constructor();
  123614. /**
  123615. * Attach the input controls to a specific dom element to get the input from.
  123616. * @param element Defines the element the controls should be listened from
  123617. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123618. */
  123619. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123620. /** @hidden */
  123621. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  123622. /**
  123623. * Update the current camera state depending on the inputs that have been used this frame.
  123624. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123625. */
  123626. checkInputs(): void;
  123627. /**
  123628. * Detach the current controls from the specified dom element.
  123629. * @param element Defines the element to stop listening the inputs from
  123630. */
  123631. detachControl(element: Nullable<HTMLElement>): void;
  123632. /**
  123633. * Gets the class name of the current intput.
  123634. * @returns the class name
  123635. */
  123636. getClassName(): string;
  123637. /**
  123638. * Get the friendly name associated with the input class.
  123639. * @returns the input friendly name
  123640. */
  123641. getSimpleName(): string;
  123642. }
  123643. }
  123644. declare module BABYLON {
  123645. /**
  123646. * Listen to mouse events to control the camera.
  123647. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123648. */
  123649. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  123650. /**
  123651. * Defines the camera the input is attached to.
  123652. */
  123653. camera: FlyCamera;
  123654. /**
  123655. * Defines if touch is enabled. (Default is true.)
  123656. */
  123657. touchEnabled: boolean;
  123658. /**
  123659. * Defines the buttons associated with the input to handle camera rotation.
  123660. */
  123661. buttons: number[];
  123662. /**
  123663. * Assign buttons for Yaw control.
  123664. */
  123665. buttonsYaw: number[];
  123666. /**
  123667. * Assign buttons for Pitch control.
  123668. */
  123669. buttonsPitch: number[];
  123670. /**
  123671. * Assign buttons for Roll control.
  123672. */
  123673. buttonsRoll: number[];
  123674. /**
  123675. * Detect if any button is being pressed while mouse is moved.
  123676. * -1 = Mouse locked.
  123677. * 0 = Left button.
  123678. * 1 = Middle Button.
  123679. * 2 = Right Button.
  123680. */
  123681. activeButton: number;
  123682. /**
  123683. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  123684. * Higher values reduce its sensitivity.
  123685. */
  123686. angularSensibility: number;
  123687. private _mousemoveCallback;
  123688. private _observer;
  123689. private _rollObserver;
  123690. private previousPosition;
  123691. private noPreventDefault;
  123692. private element;
  123693. /**
  123694. * Listen to mouse events to control the camera.
  123695. * @param touchEnabled Define if touch is enabled. (Default is true.)
  123696. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123697. */
  123698. constructor(touchEnabled?: boolean);
  123699. /**
  123700. * Attach the mouse control to the HTML DOM element.
  123701. * @param element Defines the element that listens to the input events.
  123702. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  123703. */
  123704. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123705. /**
  123706. * Detach the current controls from the specified dom element.
  123707. * @param element Defines the element to stop listening the inputs from
  123708. */
  123709. detachControl(element: Nullable<HTMLElement>): void;
  123710. /**
  123711. * Gets the class name of the current input.
  123712. * @returns the class name.
  123713. */
  123714. getClassName(): string;
  123715. /**
  123716. * Get the friendly name associated with the input class.
  123717. * @returns the input's friendly name.
  123718. */
  123719. getSimpleName(): string;
  123720. private _pointerInput;
  123721. private _onMouseMove;
  123722. /**
  123723. * Rotate camera by mouse offset.
  123724. */
  123725. private rotateCamera;
  123726. }
  123727. }
  123728. declare module BABYLON {
  123729. /**
  123730. * Default Inputs manager for the FlyCamera.
  123731. * It groups all the default supported inputs for ease of use.
  123732. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123733. */
  123734. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  123735. /**
  123736. * Instantiates a new FlyCameraInputsManager.
  123737. * @param camera Defines the camera the inputs belong to.
  123738. */
  123739. constructor(camera: FlyCamera);
  123740. /**
  123741. * Add keyboard input support to the input manager.
  123742. * @returns the new FlyCameraKeyboardMoveInput().
  123743. */
  123744. addKeyboard(): FlyCameraInputsManager;
  123745. /**
  123746. * Add mouse input support to the input manager.
  123747. * @param touchEnabled Enable touch screen support.
  123748. * @returns the new FlyCameraMouseInput().
  123749. */
  123750. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  123751. }
  123752. }
  123753. declare module BABYLON {
  123754. /**
  123755. * This is a flying camera, designed for 3D movement and rotation in all directions,
  123756. * such as in a 3D Space Shooter or a Flight Simulator.
  123757. */
  123758. export class FlyCamera extends TargetCamera {
  123759. /**
  123760. * Define the collision ellipsoid of the camera.
  123761. * This is helpful for simulating a camera body, like a player's body.
  123762. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  123763. */
  123764. ellipsoid: Vector3;
  123765. /**
  123766. * Define an offset for the position of the ellipsoid around the camera.
  123767. * This can be helpful if the camera is attached away from the player's body center,
  123768. * such as at its head.
  123769. */
  123770. ellipsoidOffset: Vector3;
  123771. /**
  123772. * Enable or disable collisions of the camera with the rest of the scene objects.
  123773. */
  123774. checkCollisions: boolean;
  123775. /**
  123776. * Enable or disable gravity on the camera.
  123777. */
  123778. applyGravity: boolean;
  123779. /**
  123780. * Define the current direction the camera is moving to.
  123781. */
  123782. cameraDirection: Vector3;
  123783. /**
  123784. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  123785. * This overrides and empties cameraRotation.
  123786. */
  123787. rotationQuaternion: Quaternion;
  123788. /**
  123789. * Track Roll to maintain the wanted Rolling when looking around.
  123790. */
  123791. _trackRoll: number;
  123792. /**
  123793. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  123794. */
  123795. rollCorrect: number;
  123796. /**
  123797. * Mimic a banked turn, Rolling the camera when Yawing.
  123798. * It's recommended to use rollCorrect = 10 for faster banking correction.
  123799. */
  123800. bankedTurn: boolean;
  123801. /**
  123802. * Limit in radians for how much Roll banking will add. (Default: 90°)
  123803. */
  123804. bankedTurnLimit: number;
  123805. /**
  123806. * Value of 0 disables the banked Roll.
  123807. * Value of 1 is equal to the Yaw angle in radians.
  123808. */
  123809. bankedTurnMultiplier: number;
  123810. /**
  123811. * The inputs manager loads all the input sources, such as keyboard and mouse.
  123812. */
  123813. inputs: FlyCameraInputsManager;
  123814. /**
  123815. * Gets the input sensibility for mouse input.
  123816. * Higher values reduce sensitivity.
  123817. */
  123818. get angularSensibility(): number;
  123819. /**
  123820. * Sets the input sensibility for a mouse input.
  123821. * Higher values reduce sensitivity.
  123822. */
  123823. set angularSensibility(value: number);
  123824. /**
  123825. * Get the keys for camera movement forward.
  123826. */
  123827. get keysForward(): number[];
  123828. /**
  123829. * Set the keys for camera movement forward.
  123830. */
  123831. set keysForward(value: number[]);
  123832. /**
  123833. * Get the keys for camera movement backward.
  123834. */
  123835. get keysBackward(): number[];
  123836. set keysBackward(value: number[]);
  123837. /**
  123838. * Get the keys for camera movement up.
  123839. */
  123840. get keysUp(): number[];
  123841. /**
  123842. * Set the keys for camera movement up.
  123843. */
  123844. set keysUp(value: number[]);
  123845. /**
  123846. * Get the keys for camera movement down.
  123847. */
  123848. get keysDown(): number[];
  123849. /**
  123850. * Set the keys for camera movement down.
  123851. */
  123852. set keysDown(value: number[]);
  123853. /**
  123854. * Get the keys for camera movement left.
  123855. */
  123856. get keysLeft(): number[];
  123857. /**
  123858. * Set the keys for camera movement left.
  123859. */
  123860. set keysLeft(value: number[]);
  123861. /**
  123862. * Set the keys for camera movement right.
  123863. */
  123864. get keysRight(): number[];
  123865. /**
  123866. * Set the keys for camera movement right.
  123867. */
  123868. set keysRight(value: number[]);
  123869. /**
  123870. * Event raised when the camera collides with a mesh in the scene.
  123871. */
  123872. onCollide: (collidedMesh: AbstractMesh) => void;
  123873. private _collider;
  123874. private _needMoveForGravity;
  123875. private _oldPosition;
  123876. private _diffPosition;
  123877. private _newPosition;
  123878. /** @hidden */
  123879. _localDirection: Vector3;
  123880. /** @hidden */
  123881. _transformedDirection: Vector3;
  123882. /**
  123883. * Instantiates a FlyCamera.
  123884. * This is a flying camera, designed for 3D movement and rotation in all directions,
  123885. * such as in a 3D Space Shooter or a Flight Simulator.
  123886. * @param name Define the name of the camera in the scene.
  123887. * @param position Define the starting position of the camera in the scene.
  123888. * @param scene Define the scene the camera belongs to.
  123889. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  123890. */
  123891. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  123892. /**
  123893. * Attach a control to the HTML DOM element.
  123894. * @param element Defines the element that listens to the input events.
  123895. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  123896. */
  123897. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123898. /**
  123899. * Detach a control from the HTML DOM element.
  123900. * The camera will stop reacting to that input.
  123901. * @param element Defines the element that listens to the input events.
  123902. */
  123903. detachControl(element: HTMLElement): void;
  123904. private _collisionMask;
  123905. /**
  123906. * Get the mask that the camera ignores in collision events.
  123907. */
  123908. get collisionMask(): number;
  123909. /**
  123910. * Set the mask that the camera ignores in collision events.
  123911. */
  123912. set collisionMask(mask: number);
  123913. /** @hidden */
  123914. _collideWithWorld(displacement: Vector3): void;
  123915. /** @hidden */
  123916. private _onCollisionPositionChange;
  123917. /** @hidden */
  123918. _checkInputs(): void;
  123919. /** @hidden */
  123920. _decideIfNeedsToMove(): boolean;
  123921. /** @hidden */
  123922. _updatePosition(): void;
  123923. /**
  123924. * Restore the Roll to its target value at the rate specified.
  123925. * @param rate - Higher means slower restoring.
  123926. * @hidden
  123927. */
  123928. restoreRoll(rate: number): void;
  123929. /**
  123930. * Destroy the camera and release the current resources held by it.
  123931. */
  123932. dispose(): void;
  123933. /**
  123934. * Get the current object class name.
  123935. * @returns the class name.
  123936. */
  123937. getClassName(): string;
  123938. }
  123939. }
  123940. declare module BABYLON {
  123941. /**
  123942. * Listen to keyboard events to control the camera.
  123943. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123944. */
  123945. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  123946. /**
  123947. * Defines the camera the input is attached to.
  123948. */
  123949. camera: FlyCamera;
  123950. /**
  123951. * The list of keyboard keys used to control the forward move of the camera.
  123952. */
  123953. keysForward: number[];
  123954. /**
  123955. * The list of keyboard keys used to control the backward move of the camera.
  123956. */
  123957. keysBackward: number[];
  123958. /**
  123959. * The list of keyboard keys used to control the forward move of the camera.
  123960. */
  123961. keysUp: number[];
  123962. /**
  123963. * The list of keyboard keys used to control the backward move of the camera.
  123964. */
  123965. keysDown: number[];
  123966. /**
  123967. * The list of keyboard keys used to control the right strafe move of the camera.
  123968. */
  123969. keysRight: number[];
  123970. /**
  123971. * The list of keyboard keys used to control the left strafe move of the camera.
  123972. */
  123973. keysLeft: number[];
  123974. private _keys;
  123975. private _onCanvasBlurObserver;
  123976. private _onKeyboardObserver;
  123977. private _engine;
  123978. private _scene;
  123979. /**
  123980. * Attach the input controls to a specific dom element to get the input from.
  123981. * @param element Defines the element the controls should be listened from
  123982. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123983. */
  123984. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123985. /**
  123986. * Detach the current controls from the specified dom element.
  123987. * @param element Defines the element to stop listening the inputs from
  123988. */
  123989. detachControl(element: Nullable<HTMLElement>): void;
  123990. /**
  123991. * Gets the class name of the current intput.
  123992. * @returns the class name
  123993. */
  123994. getClassName(): string;
  123995. /** @hidden */
  123996. _onLostFocus(e: FocusEvent): void;
  123997. /**
  123998. * Get the friendly name associated with the input class.
  123999. * @returns the input friendly name
  124000. */
  124001. getSimpleName(): string;
  124002. /**
  124003. * Update the current camera state depending on the inputs that have been used this frame.
  124004. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124005. */
  124006. checkInputs(): void;
  124007. }
  124008. }
  124009. declare module BABYLON {
  124010. /**
  124011. * Manage the mouse wheel inputs to control a follow camera.
  124012. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124013. */
  124014. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  124015. /**
  124016. * Defines the camera the input is attached to.
  124017. */
  124018. camera: FollowCamera;
  124019. /**
  124020. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  124021. */
  124022. axisControlRadius: boolean;
  124023. /**
  124024. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  124025. */
  124026. axisControlHeight: boolean;
  124027. /**
  124028. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  124029. */
  124030. axisControlRotation: boolean;
  124031. /**
  124032. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  124033. * relation to mouseWheel events.
  124034. */
  124035. wheelPrecision: number;
  124036. /**
  124037. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  124038. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  124039. */
  124040. wheelDeltaPercentage: number;
  124041. private _wheel;
  124042. private _observer;
  124043. /**
  124044. * Attach the input controls to a specific dom element to get the input from.
  124045. * @param element Defines the element the controls should be listened from
  124046. * @param noPreventDefault Defines whether event 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 the current controls from the specified dom element.
  124051. * @param element Defines the element to stop listening the inputs from
  124052. */
  124053. detachControl(element: Nullable<HTMLElement>): void;
  124054. /**
  124055. * Gets the class name of the current intput.
  124056. * @returns the class name
  124057. */
  124058. getClassName(): string;
  124059. /**
  124060. * Get the friendly name associated with the input class.
  124061. * @returns the input friendly name
  124062. */
  124063. getSimpleName(): string;
  124064. }
  124065. }
  124066. declare module BABYLON {
  124067. /**
  124068. * Manage the pointers inputs to control an follow camera.
  124069. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124070. */
  124071. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  124072. /**
  124073. * Defines the camera the input is attached to.
  124074. */
  124075. camera: FollowCamera;
  124076. /**
  124077. * Gets the class name of the current input.
  124078. * @returns the class name
  124079. */
  124080. getClassName(): string;
  124081. /**
  124082. * Defines the pointer angular sensibility along the X axis or how fast is
  124083. * the camera rotating.
  124084. * A negative number will reverse the axis direction.
  124085. */
  124086. angularSensibilityX: number;
  124087. /**
  124088. * Defines the pointer angular sensibility along the Y axis or how fast is
  124089. * the camera rotating.
  124090. * A negative number will reverse the axis direction.
  124091. */
  124092. angularSensibilityY: number;
  124093. /**
  124094. * Defines the pointer pinch precision or how fast is the camera zooming.
  124095. * A negative number will reverse the axis direction.
  124096. */
  124097. pinchPrecision: number;
  124098. /**
  124099. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  124100. * from 0.
  124101. * It defines the percentage of current camera.radius to use as delta when
  124102. * pinch zoom is used.
  124103. */
  124104. pinchDeltaPercentage: number;
  124105. /**
  124106. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  124107. */
  124108. axisXControlRadius: boolean;
  124109. /**
  124110. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  124111. */
  124112. axisXControlHeight: boolean;
  124113. /**
  124114. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  124115. */
  124116. axisXControlRotation: boolean;
  124117. /**
  124118. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  124119. */
  124120. axisYControlRadius: boolean;
  124121. /**
  124122. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  124123. */
  124124. axisYControlHeight: boolean;
  124125. /**
  124126. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  124127. */
  124128. axisYControlRotation: boolean;
  124129. /**
  124130. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  124131. */
  124132. axisPinchControlRadius: boolean;
  124133. /**
  124134. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  124135. */
  124136. axisPinchControlHeight: boolean;
  124137. /**
  124138. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  124139. */
  124140. axisPinchControlRotation: boolean;
  124141. /**
  124142. * Log error messages if basic misconfiguration has occurred.
  124143. */
  124144. warningEnable: boolean;
  124145. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  124146. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  124147. private _warningCounter;
  124148. private _warning;
  124149. }
  124150. }
  124151. declare module BABYLON {
  124152. /**
  124153. * Default Inputs manager for the FollowCamera.
  124154. * It groups all the default supported inputs for ease of use.
  124155. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124156. */
  124157. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  124158. /**
  124159. * Instantiates a new FollowCameraInputsManager.
  124160. * @param camera Defines the camera the inputs belong to
  124161. */
  124162. constructor(camera: FollowCamera);
  124163. /**
  124164. * Add keyboard input support to the input manager.
  124165. * @returns the current input manager
  124166. */
  124167. addKeyboard(): FollowCameraInputsManager;
  124168. /**
  124169. * Add mouse wheel input support to the input manager.
  124170. * @returns the current input manager
  124171. */
  124172. addMouseWheel(): FollowCameraInputsManager;
  124173. /**
  124174. * Add pointers input support to the input manager.
  124175. * @returns the current input manager
  124176. */
  124177. addPointers(): FollowCameraInputsManager;
  124178. /**
  124179. * Add orientation input support to the input manager.
  124180. * @returns the current input manager
  124181. */
  124182. addVRDeviceOrientation(): FollowCameraInputsManager;
  124183. }
  124184. }
  124185. declare module BABYLON {
  124186. /**
  124187. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  124188. * an arc rotate version arcFollowCamera are available.
  124189. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124190. */
  124191. export class FollowCamera extends TargetCamera {
  124192. /**
  124193. * Distance the follow camera should follow an object at
  124194. */
  124195. radius: number;
  124196. /**
  124197. * Minimum allowed distance of the camera to the axis of rotation
  124198. * (The camera can not get closer).
  124199. * This can help limiting how the Camera is able to move in the scene.
  124200. */
  124201. lowerRadiusLimit: Nullable<number>;
  124202. /**
  124203. * Maximum allowed distance of the camera to the axis of rotation
  124204. * (The camera can not get further).
  124205. * This can help limiting how the Camera is able to move in the scene.
  124206. */
  124207. upperRadiusLimit: Nullable<number>;
  124208. /**
  124209. * Define a rotation offset between the camera and the object it follows
  124210. */
  124211. rotationOffset: number;
  124212. /**
  124213. * Minimum allowed angle to camera position relative to target object.
  124214. * This can help limiting how the Camera is able to move in the scene.
  124215. */
  124216. lowerRotationOffsetLimit: Nullable<number>;
  124217. /**
  124218. * Maximum allowed angle to camera position relative to target object.
  124219. * This can help limiting how the Camera is able to move in the scene.
  124220. */
  124221. upperRotationOffsetLimit: Nullable<number>;
  124222. /**
  124223. * Define a height offset between the camera and the object it follows.
  124224. * It can help following an object from the top (like a car chaing a plane)
  124225. */
  124226. heightOffset: number;
  124227. /**
  124228. * Minimum allowed height of camera position relative to target object.
  124229. * This can help limiting how the Camera is able to move in the scene.
  124230. */
  124231. lowerHeightOffsetLimit: Nullable<number>;
  124232. /**
  124233. * Maximum allowed height of camera position relative to target object.
  124234. * This can help limiting how the Camera is able to move in the scene.
  124235. */
  124236. upperHeightOffsetLimit: Nullable<number>;
  124237. /**
  124238. * Define how fast the camera can accelerate to follow it s target.
  124239. */
  124240. cameraAcceleration: number;
  124241. /**
  124242. * Define the speed limit of the camera following an object.
  124243. */
  124244. maxCameraSpeed: number;
  124245. /**
  124246. * Define the target of the camera.
  124247. */
  124248. lockedTarget: Nullable<AbstractMesh>;
  124249. /**
  124250. * Defines the input associated with the camera.
  124251. */
  124252. inputs: FollowCameraInputsManager;
  124253. /**
  124254. * Instantiates the follow camera.
  124255. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124256. * @param name Define the name of the camera in the scene
  124257. * @param position Define the position of the camera
  124258. * @param scene Define the scene the camera belong to
  124259. * @param lockedTarget Define the target of the camera
  124260. */
  124261. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  124262. private _follow;
  124263. /**
  124264. * Attached controls to the current camera.
  124265. * @param element Defines the element the controls should be listened from
  124266. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124267. */
  124268. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124269. /**
  124270. * Detach the current controls from the camera.
  124271. * The camera will stop reacting to inputs.
  124272. * @param element Defines the element to stop listening the inputs from
  124273. */
  124274. detachControl(element: HTMLElement): void;
  124275. /** @hidden */
  124276. _checkInputs(): void;
  124277. private _checkLimits;
  124278. /**
  124279. * Gets the camera class name.
  124280. * @returns the class name
  124281. */
  124282. getClassName(): string;
  124283. }
  124284. /**
  124285. * Arc Rotate version of the follow camera.
  124286. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  124287. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124288. */
  124289. export class ArcFollowCamera extends TargetCamera {
  124290. /** The longitudinal angle of the camera */
  124291. alpha: number;
  124292. /** The latitudinal angle of the camera */
  124293. beta: number;
  124294. /** The radius of the camera from its target */
  124295. radius: number;
  124296. private _cartesianCoordinates;
  124297. /** Define the camera target (the mesh it should follow) */
  124298. private _meshTarget;
  124299. /**
  124300. * Instantiates a new ArcFollowCamera
  124301. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124302. * @param name Define the name of the camera
  124303. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  124304. * @param beta Define the rotation angle of the camera around the elevation axis
  124305. * @param radius Define the radius of the camera from its target point
  124306. * @param target Define the target of the camera
  124307. * @param scene Define the scene the camera belongs to
  124308. */
  124309. constructor(name: string,
  124310. /** The longitudinal angle of the camera */
  124311. alpha: number,
  124312. /** The latitudinal angle of the camera */
  124313. beta: number,
  124314. /** The radius of the camera from its target */
  124315. radius: number,
  124316. /** Define the camera target (the mesh it should follow) */
  124317. target: Nullable<AbstractMesh>, scene: Scene);
  124318. private _follow;
  124319. /** @hidden */
  124320. _checkInputs(): void;
  124321. /**
  124322. * Returns the class name of the object.
  124323. * It is mostly used internally for serialization purposes.
  124324. */
  124325. getClassName(): string;
  124326. }
  124327. }
  124328. declare module BABYLON {
  124329. /**
  124330. * Manage the keyboard inputs to control the movement of a follow camera.
  124331. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124332. */
  124333. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  124334. /**
  124335. * Defines the camera the input is attached to.
  124336. */
  124337. camera: FollowCamera;
  124338. /**
  124339. * Defines the list of key codes associated with the up action (increase heightOffset)
  124340. */
  124341. keysHeightOffsetIncr: number[];
  124342. /**
  124343. * Defines the list of key codes associated with the down action (decrease heightOffset)
  124344. */
  124345. keysHeightOffsetDecr: number[];
  124346. /**
  124347. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  124348. */
  124349. keysHeightOffsetModifierAlt: boolean;
  124350. /**
  124351. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  124352. */
  124353. keysHeightOffsetModifierCtrl: boolean;
  124354. /**
  124355. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  124356. */
  124357. keysHeightOffsetModifierShift: boolean;
  124358. /**
  124359. * Defines the list of key codes associated with the left action (increase rotationOffset)
  124360. */
  124361. keysRotationOffsetIncr: number[];
  124362. /**
  124363. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  124364. */
  124365. keysRotationOffsetDecr: number[];
  124366. /**
  124367. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  124368. */
  124369. keysRotationOffsetModifierAlt: boolean;
  124370. /**
  124371. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  124372. */
  124373. keysRotationOffsetModifierCtrl: boolean;
  124374. /**
  124375. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  124376. */
  124377. keysRotationOffsetModifierShift: boolean;
  124378. /**
  124379. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  124380. */
  124381. keysRadiusIncr: number[];
  124382. /**
  124383. * Defines the list of key codes associated with the zoom-out action (increase radius)
  124384. */
  124385. keysRadiusDecr: number[];
  124386. /**
  124387. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  124388. */
  124389. keysRadiusModifierAlt: boolean;
  124390. /**
  124391. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  124392. */
  124393. keysRadiusModifierCtrl: boolean;
  124394. /**
  124395. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  124396. */
  124397. keysRadiusModifierShift: boolean;
  124398. /**
  124399. * Defines the rate of change of heightOffset.
  124400. */
  124401. heightSensibility: number;
  124402. /**
  124403. * Defines the rate of change of rotationOffset.
  124404. */
  124405. rotationSensibility: number;
  124406. /**
  124407. * Defines the rate of change of radius.
  124408. */
  124409. radiusSensibility: number;
  124410. private _keys;
  124411. private _ctrlPressed;
  124412. private _altPressed;
  124413. private _shiftPressed;
  124414. private _onCanvasBlurObserver;
  124415. private _onKeyboardObserver;
  124416. private _engine;
  124417. private _scene;
  124418. /**
  124419. * Attach the input controls to a specific dom element to get the input from.
  124420. * @param element Defines the element the controls should be listened from
  124421. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124422. */
  124423. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124424. /**
  124425. * Detach the current controls from the specified dom element.
  124426. * @param element Defines the element to stop listening the inputs from
  124427. */
  124428. detachControl(element: Nullable<HTMLElement>): void;
  124429. /**
  124430. * Update the current camera state depending on the inputs that have been used this frame.
  124431. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124432. */
  124433. checkInputs(): void;
  124434. /**
  124435. * Gets the class name of the current input.
  124436. * @returns the class name
  124437. */
  124438. getClassName(): string;
  124439. /**
  124440. * Get the friendly name associated with the input class.
  124441. * @returns the input friendly name
  124442. */
  124443. getSimpleName(): string;
  124444. /**
  124445. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124446. * allow modification of the heightOffset value.
  124447. */
  124448. private _modifierHeightOffset;
  124449. /**
  124450. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124451. * allow modification of the rotationOffset value.
  124452. */
  124453. private _modifierRotationOffset;
  124454. /**
  124455. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124456. * allow modification of the radius value.
  124457. */
  124458. private _modifierRadius;
  124459. }
  124460. }
  124461. declare module BABYLON {
  124462. interface FreeCameraInputsManager {
  124463. /**
  124464. * @hidden
  124465. */
  124466. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  124467. /**
  124468. * Add orientation input support to the input manager.
  124469. * @returns the current input manager
  124470. */
  124471. addDeviceOrientation(): FreeCameraInputsManager;
  124472. }
  124473. /**
  124474. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  124475. * Screen rotation is taken into account.
  124476. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124477. */
  124478. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  124479. private _camera;
  124480. private _screenOrientationAngle;
  124481. private _constantTranform;
  124482. private _screenQuaternion;
  124483. private _alpha;
  124484. private _beta;
  124485. private _gamma;
  124486. /**
  124487. * Can be used to detect if a device orientation sensor is available on a device
  124488. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  124489. * @returns a promise that will resolve on orientation change
  124490. */
  124491. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  124492. /**
  124493. * @hidden
  124494. */
  124495. _onDeviceOrientationChangedObservable: Observable<void>;
  124496. /**
  124497. * Instantiates a new input
  124498. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124499. */
  124500. constructor();
  124501. /**
  124502. * Define the camera controlled by the input.
  124503. */
  124504. get camera(): FreeCamera;
  124505. set camera(camera: FreeCamera);
  124506. /**
  124507. * Attach the input controls to a specific dom element to get the input from.
  124508. * @param element Defines the element the controls should be listened from
  124509. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124510. */
  124511. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124512. private _orientationChanged;
  124513. private _deviceOrientation;
  124514. /**
  124515. * Detach the current controls from the specified dom element.
  124516. * @param element Defines the element to stop listening the inputs from
  124517. */
  124518. detachControl(element: Nullable<HTMLElement>): void;
  124519. /**
  124520. * Update the current camera state depending on the inputs that have been used this frame.
  124521. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124522. */
  124523. checkInputs(): void;
  124524. /**
  124525. * Gets the class name of the current intput.
  124526. * @returns the class name
  124527. */
  124528. getClassName(): string;
  124529. /**
  124530. * Get the friendly name associated with the input class.
  124531. * @returns the input friendly name
  124532. */
  124533. getSimpleName(): string;
  124534. }
  124535. }
  124536. declare module BABYLON {
  124537. /**
  124538. * Manage the gamepad inputs to control a free camera.
  124539. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124540. */
  124541. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  124542. /**
  124543. * Define the camera the input is attached to.
  124544. */
  124545. camera: FreeCamera;
  124546. /**
  124547. * Define the Gamepad controlling the input
  124548. */
  124549. gamepad: Nullable<Gamepad>;
  124550. /**
  124551. * Defines the gamepad rotation sensiblity.
  124552. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  124553. */
  124554. gamepadAngularSensibility: number;
  124555. /**
  124556. * Defines the gamepad move sensiblity.
  124557. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  124558. */
  124559. gamepadMoveSensibility: number;
  124560. private _yAxisScale;
  124561. /**
  124562. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  124563. */
  124564. get invertYAxis(): boolean;
  124565. set invertYAxis(value: boolean);
  124566. private _onGamepadConnectedObserver;
  124567. private _onGamepadDisconnectedObserver;
  124568. private _cameraTransform;
  124569. private _deltaTransform;
  124570. private _vector3;
  124571. private _vector2;
  124572. /**
  124573. * Attach the input controls to a specific dom element to get the input from.
  124574. * @param element Defines the element the controls should be listened from
  124575. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124576. */
  124577. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124578. /**
  124579. * Detach the current controls from the specified dom element.
  124580. * @param element Defines the element to stop listening the inputs from
  124581. */
  124582. detachControl(element: Nullable<HTMLElement>): void;
  124583. /**
  124584. * Update the current camera state depending on the inputs that have been used this frame.
  124585. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124586. */
  124587. checkInputs(): void;
  124588. /**
  124589. * Gets the class name of the current intput.
  124590. * @returns the class name
  124591. */
  124592. getClassName(): string;
  124593. /**
  124594. * Get the friendly name associated with the input class.
  124595. * @returns the input friendly name
  124596. */
  124597. getSimpleName(): string;
  124598. }
  124599. }
  124600. declare module BABYLON {
  124601. /**
  124602. * Defines the potential axis of a Joystick
  124603. */
  124604. export enum JoystickAxis {
  124605. /** X axis */
  124606. X = 0,
  124607. /** Y axis */
  124608. Y = 1,
  124609. /** Z axis */
  124610. Z = 2
  124611. }
  124612. /**
  124613. * Represents the different customization options available
  124614. * for VirtualJoystick
  124615. */
  124616. interface VirtualJoystickCustomizations {
  124617. /**
  124618. * Size of the joystick's puck
  124619. */
  124620. puckSize: number;
  124621. /**
  124622. * Size of the joystick's container
  124623. */
  124624. containerSize: number;
  124625. /**
  124626. * Color of the joystick && puck
  124627. */
  124628. color: string;
  124629. /**
  124630. * Image URL for the joystick's puck
  124631. */
  124632. puckImage?: string;
  124633. /**
  124634. * Image URL for the joystick's container
  124635. */
  124636. containerImage?: string;
  124637. /**
  124638. * Defines the unmoving position of the joystick container
  124639. */
  124640. position?: {
  124641. x: number;
  124642. y: number;
  124643. };
  124644. /**
  124645. * Defines whether or not the joystick container is always visible
  124646. */
  124647. alwaysVisible: boolean;
  124648. /**
  124649. * Defines whether or not to limit the movement of the puck to the joystick's container
  124650. */
  124651. limitToContainer: boolean;
  124652. }
  124653. /**
  124654. * Class used to define virtual joystick (used in touch mode)
  124655. */
  124656. export class VirtualJoystick {
  124657. /**
  124658. * Gets or sets a boolean indicating that left and right values must be inverted
  124659. */
  124660. reverseLeftRight: boolean;
  124661. /**
  124662. * Gets or sets a boolean indicating that up and down values must be inverted
  124663. */
  124664. reverseUpDown: boolean;
  124665. /**
  124666. * Gets the offset value for the position (ie. the change of the position value)
  124667. */
  124668. deltaPosition: Vector3;
  124669. /**
  124670. * Gets a boolean indicating if the virtual joystick was pressed
  124671. */
  124672. pressed: boolean;
  124673. /**
  124674. * Canvas the virtual joystick will render onto, default z-index of this is 5
  124675. */
  124676. static Canvas: Nullable<HTMLCanvasElement>;
  124677. /**
  124678. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  124679. */
  124680. limitToContainer: boolean;
  124681. private static _globalJoystickIndex;
  124682. private static _alwaysVisibleSticks;
  124683. private static vjCanvasContext;
  124684. private static vjCanvasWidth;
  124685. private static vjCanvasHeight;
  124686. private static halfWidth;
  124687. private static _GetDefaultOptions;
  124688. private _action;
  124689. private _axisTargetedByLeftAndRight;
  124690. private _axisTargetedByUpAndDown;
  124691. private _joystickSensibility;
  124692. private _inversedSensibility;
  124693. private _joystickPointerID;
  124694. private _joystickColor;
  124695. private _joystickPointerPos;
  124696. private _joystickPreviousPointerPos;
  124697. private _joystickPointerStartPos;
  124698. private _deltaJoystickVector;
  124699. private _leftJoystick;
  124700. private _touches;
  124701. private _joystickPosition;
  124702. private _alwaysVisible;
  124703. private _puckImage;
  124704. private _containerImage;
  124705. private _joystickPuckSize;
  124706. private _joystickContainerSize;
  124707. private _clearPuckSize;
  124708. private _clearContainerSize;
  124709. private _clearPuckSizeOffset;
  124710. private _clearContainerSizeOffset;
  124711. private _onPointerDownHandlerRef;
  124712. private _onPointerMoveHandlerRef;
  124713. private _onPointerUpHandlerRef;
  124714. private _onResize;
  124715. /**
  124716. * Creates a new virtual joystick
  124717. * @param leftJoystick defines that the joystick is for left hand (false by default)
  124718. * @param customizations Defines the options we want to customize the VirtualJoystick
  124719. */
  124720. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  124721. /**
  124722. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  124723. * @param newJoystickSensibility defines the new sensibility
  124724. */
  124725. setJoystickSensibility(newJoystickSensibility: number): void;
  124726. private _onPointerDown;
  124727. private _onPointerMove;
  124728. private _onPointerUp;
  124729. /**
  124730. * Change the color of the virtual joystick
  124731. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  124732. */
  124733. setJoystickColor(newColor: string): void;
  124734. /**
  124735. * Size of the joystick's container
  124736. */
  124737. set containerSize(newSize: number);
  124738. get containerSize(): number;
  124739. /**
  124740. * Size of the joystick's puck
  124741. */
  124742. set puckSize(newSize: number);
  124743. get puckSize(): number;
  124744. /**
  124745. * Clears the set position of the joystick
  124746. */
  124747. clearPosition(): void;
  124748. /**
  124749. * Defines whether or not the joystick container is always visible
  124750. */
  124751. set alwaysVisible(value: boolean);
  124752. get alwaysVisible(): boolean;
  124753. /**
  124754. * Sets the constant position of the Joystick container
  124755. * @param x X axis coordinate
  124756. * @param y Y axis coordinate
  124757. */
  124758. setPosition(x: number, y: number): void;
  124759. /**
  124760. * Defines a callback to call when the joystick is touched
  124761. * @param action defines the callback
  124762. */
  124763. setActionOnTouch(action: () => any): void;
  124764. /**
  124765. * Defines which axis you'd like to control for left & right
  124766. * @param axis defines the axis to use
  124767. */
  124768. setAxisForLeftRight(axis: JoystickAxis): void;
  124769. /**
  124770. * Defines which axis you'd like to control for up & down
  124771. * @param axis defines the axis to use
  124772. */
  124773. setAxisForUpDown(axis: JoystickAxis): void;
  124774. /**
  124775. * Clears the canvas from the previous puck / container draw
  124776. */
  124777. private _clearPreviousDraw;
  124778. /**
  124779. * Loads `urlPath` to be used for the container's image
  124780. * @param urlPath defines the urlPath of an image to use
  124781. */
  124782. setContainerImage(urlPath: string): void;
  124783. /**
  124784. * Loads `urlPath` to be used for the puck's image
  124785. * @param urlPath defines the urlPath of an image to use
  124786. */
  124787. setPuckImage(urlPath: string): void;
  124788. /**
  124789. * Draws the Virtual Joystick's container
  124790. */
  124791. private _drawContainer;
  124792. /**
  124793. * Draws the Virtual Joystick's puck
  124794. */
  124795. private _drawPuck;
  124796. private _drawVirtualJoystick;
  124797. /**
  124798. * Release internal HTML canvas
  124799. */
  124800. releaseCanvas(): void;
  124801. }
  124802. }
  124803. declare module BABYLON {
  124804. interface FreeCameraInputsManager {
  124805. /**
  124806. * Add virtual joystick input support to the input manager.
  124807. * @returns the current input manager
  124808. */
  124809. addVirtualJoystick(): FreeCameraInputsManager;
  124810. }
  124811. /**
  124812. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  124813. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124814. */
  124815. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  124816. /**
  124817. * Defines the camera the input is attached to.
  124818. */
  124819. camera: FreeCamera;
  124820. private _leftjoystick;
  124821. private _rightjoystick;
  124822. /**
  124823. * Gets the left stick of the virtual joystick.
  124824. * @returns The virtual Joystick
  124825. */
  124826. getLeftJoystick(): VirtualJoystick;
  124827. /**
  124828. * Gets the right stick of the virtual joystick.
  124829. * @returns The virtual Joystick
  124830. */
  124831. getRightJoystick(): VirtualJoystick;
  124832. /**
  124833. * Update the current camera state depending on the inputs that have been used this frame.
  124834. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124835. */
  124836. checkInputs(): void;
  124837. /**
  124838. * Attach the input controls to a specific dom element to get the input from.
  124839. * @param element Defines the element the controls should be listened from
  124840. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124841. */
  124842. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124843. /**
  124844. * Detach the current controls from the specified dom element.
  124845. * @param element Defines the element to stop listening the inputs from
  124846. */
  124847. detachControl(element: Nullable<HTMLElement>): void;
  124848. /**
  124849. * Gets the class name of the current intput.
  124850. * @returns the class name
  124851. */
  124852. getClassName(): string;
  124853. /**
  124854. * Get the friendly name associated with the input class.
  124855. * @returns the input friendly name
  124856. */
  124857. getSimpleName(): string;
  124858. }
  124859. }
  124860. declare module BABYLON {
  124861. /**
  124862. * This represents a FPS type of camera controlled by touch.
  124863. * This is like a universal camera minus the Gamepad controls.
  124864. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  124865. */
  124866. export class TouchCamera extends FreeCamera {
  124867. /**
  124868. * Defines the touch sensibility for rotation.
  124869. * The higher the faster.
  124870. */
  124871. get touchAngularSensibility(): number;
  124872. set touchAngularSensibility(value: number);
  124873. /**
  124874. * Defines the touch sensibility for move.
  124875. * The higher the faster.
  124876. */
  124877. get touchMoveSensibility(): number;
  124878. set touchMoveSensibility(value: number);
  124879. /**
  124880. * Instantiates a new touch camera.
  124881. * This represents a FPS type of camera controlled by touch.
  124882. * This is like a universal camera minus the Gamepad controls.
  124883. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  124884. * @param name Define the name of the camera in the scene
  124885. * @param position Define the start position of the camera in the scene
  124886. * @param scene Define the scene the camera belongs to
  124887. */
  124888. constructor(name: string, position: Vector3, scene: Scene);
  124889. /**
  124890. * Gets the current object class name.
  124891. * @return the class name
  124892. */
  124893. getClassName(): string;
  124894. /** @hidden */
  124895. _setupInputs(): void;
  124896. }
  124897. }
  124898. declare module BABYLON {
  124899. /**
  124900. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  124901. * being tilted forward or back and left or right.
  124902. */
  124903. export class DeviceOrientationCamera extends FreeCamera {
  124904. private _initialQuaternion;
  124905. private _quaternionCache;
  124906. private _tmpDragQuaternion;
  124907. private _disablePointerInputWhenUsingDeviceOrientation;
  124908. /**
  124909. * Creates a new device orientation camera
  124910. * @param name The name of the camera
  124911. * @param position The start position camera
  124912. * @param scene The scene the camera belongs to
  124913. */
  124914. constructor(name: string, position: Vector3, scene: Scene);
  124915. /**
  124916. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  124917. */
  124918. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  124919. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  124920. private _dragFactor;
  124921. /**
  124922. * Enabled turning on the y axis when the orientation sensor is active
  124923. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  124924. */
  124925. enableHorizontalDragging(dragFactor?: number): void;
  124926. /**
  124927. * Gets the current instance class name ("DeviceOrientationCamera").
  124928. * This helps avoiding instanceof at run time.
  124929. * @returns the class name
  124930. */
  124931. getClassName(): string;
  124932. /**
  124933. * @hidden
  124934. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  124935. */
  124936. _checkInputs(): void;
  124937. /**
  124938. * Reset the camera to its default orientation on the specified axis only.
  124939. * @param axis The axis to reset
  124940. */
  124941. resetToCurrentRotation(axis?: Axis): void;
  124942. }
  124943. }
  124944. declare module BABYLON {
  124945. /**
  124946. * Defines supported buttons for XBox360 compatible gamepads
  124947. */
  124948. export enum Xbox360Button {
  124949. /** A */
  124950. A = 0,
  124951. /** B */
  124952. B = 1,
  124953. /** X */
  124954. X = 2,
  124955. /** Y */
  124956. Y = 3,
  124957. /** Left button */
  124958. LB = 4,
  124959. /** Right button */
  124960. RB = 5,
  124961. /** Back */
  124962. Back = 8,
  124963. /** Start */
  124964. Start = 9,
  124965. /** Left stick */
  124966. LeftStick = 10,
  124967. /** Right stick */
  124968. RightStick = 11
  124969. }
  124970. /** Defines values for XBox360 DPad */
  124971. export enum Xbox360Dpad {
  124972. /** Up */
  124973. Up = 12,
  124974. /** Down */
  124975. Down = 13,
  124976. /** Left */
  124977. Left = 14,
  124978. /** Right */
  124979. Right = 15
  124980. }
  124981. /**
  124982. * Defines a XBox360 gamepad
  124983. */
  124984. export class Xbox360Pad extends Gamepad {
  124985. private _leftTrigger;
  124986. private _rightTrigger;
  124987. private _onlefttriggerchanged;
  124988. private _onrighttriggerchanged;
  124989. private _onbuttondown;
  124990. private _onbuttonup;
  124991. private _ondpaddown;
  124992. private _ondpadup;
  124993. /** Observable raised when a button is pressed */
  124994. onButtonDownObservable: Observable<Xbox360Button>;
  124995. /** Observable raised when a button is released */
  124996. onButtonUpObservable: Observable<Xbox360Button>;
  124997. /** Observable raised when a pad is pressed */
  124998. onPadDownObservable: Observable<Xbox360Dpad>;
  124999. /** Observable raised when a pad is released */
  125000. onPadUpObservable: Observable<Xbox360Dpad>;
  125001. private _buttonA;
  125002. private _buttonB;
  125003. private _buttonX;
  125004. private _buttonY;
  125005. private _buttonBack;
  125006. private _buttonStart;
  125007. private _buttonLB;
  125008. private _buttonRB;
  125009. private _buttonLeftStick;
  125010. private _buttonRightStick;
  125011. private _dPadUp;
  125012. private _dPadDown;
  125013. private _dPadLeft;
  125014. private _dPadRight;
  125015. private _isXboxOnePad;
  125016. /**
  125017. * Creates a new XBox360 gamepad object
  125018. * @param id defines the id of this gamepad
  125019. * @param index defines its index
  125020. * @param gamepad defines the internal HTML gamepad object
  125021. * @param xboxOne defines if it is a XBox One gamepad
  125022. */
  125023. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  125024. /**
  125025. * Defines the callback to call when left trigger is pressed
  125026. * @param callback defines the callback to use
  125027. */
  125028. onlefttriggerchanged(callback: (value: number) => void): void;
  125029. /**
  125030. * Defines the callback to call when right trigger is pressed
  125031. * @param callback defines the callback to use
  125032. */
  125033. onrighttriggerchanged(callback: (value: number) => void): void;
  125034. /**
  125035. * Gets the left trigger value
  125036. */
  125037. get leftTrigger(): number;
  125038. /**
  125039. * Sets the left trigger value
  125040. */
  125041. set leftTrigger(newValue: number);
  125042. /**
  125043. * Gets the right trigger value
  125044. */
  125045. get rightTrigger(): number;
  125046. /**
  125047. * Sets the right trigger value
  125048. */
  125049. set rightTrigger(newValue: number);
  125050. /**
  125051. * Defines the callback to call when a button is pressed
  125052. * @param callback defines the callback to use
  125053. */
  125054. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  125055. /**
  125056. * Defines the callback to call when a button is released
  125057. * @param callback defines the callback to use
  125058. */
  125059. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  125060. /**
  125061. * Defines the callback to call when a pad is pressed
  125062. * @param callback defines the callback to use
  125063. */
  125064. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  125065. /**
  125066. * Defines the callback to call when a pad is released
  125067. * @param callback defines the callback to use
  125068. */
  125069. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  125070. private _setButtonValue;
  125071. private _setDPadValue;
  125072. /**
  125073. * Gets the value of the `A` button
  125074. */
  125075. get buttonA(): number;
  125076. /**
  125077. * Sets the value of the `A` button
  125078. */
  125079. set buttonA(value: number);
  125080. /**
  125081. * Gets the value of the `B` button
  125082. */
  125083. get buttonB(): number;
  125084. /**
  125085. * Sets the value of the `B` button
  125086. */
  125087. set buttonB(value: number);
  125088. /**
  125089. * Gets the value of the `X` button
  125090. */
  125091. get buttonX(): number;
  125092. /**
  125093. * Sets the value of the `X` button
  125094. */
  125095. set buttonX(value: number);
  125096. /**
  125097. * Gets the value of the `Y` button
  125098. */
  125099. get buttonY(): number;
  125100. /**
  125101. * Sets the value of the `Y` button
  125102. */
  125103. set buttonY(value: number);
  125104. /**
  125105. * Gets the value of the `Start` button
  125106. */
  125107. get buttonStart(): number;
  125108. /**
  125109. * Sets the value of the `Start` button
  125110. */
  125111. set buttonStart(value: number);
  125112. /**
  125113. * Gets the value of the `Back` button
  125114. */
  125115. get buttonBack(): number;
  125116. /**
  125117. * Sets the value of the `Back` button
  125118. */
  125119. set buttonBack(value: number);
  125120. /**
  125121. * Gets the value of the `Left` button
  125122. */
  125123. get buttonLB(): number;
  125124. /**
  125125. * Sets the value of the `Left` button
  125126. */
  125127. set buttonLB(value: number);
  125128. /**
  125129. * Gets the value of the `Right` button
  125130. */
  125131. get buttonRB(): number;
  125132. /**
  125133. * Sets the value of the `Right` button
  125134. */
  125135. set buttonRB(value: number);
  125136. /**
  125137. * Gets the value of the Left joystick
  125138. */
  125139. get buttonLeftStick(): number;
  125140. /**
  125141. * Sets the value of the Left joystick
  125142. */
  125143. set buttonLeftStick(value: number);
  125144. /**
  125145. * Gets the value of the Right joystick
  125146. */
  125147. get buttonRightStick(): number;
  125148. /**
  125149. * Sets the value of the Right joystick
  125150. */
  125151. set buttonRightStick(value: number);
  125152. /**
  125153. * Gets the value of D-pad up
  125154. */
  125155. get dPadUp(): number;
  125156. /**
  125157. * Sets the value of D-pad up
  125158. */
  125159. set dPadUp(value: number);
  125160. /**
  125161. * Gets the value of D-pad down
  125162. */
  125163. get dPadDown(): number;
  125164. /**
  125165. * Sets the value of D-pad down
  125166. */
  125167. set dPadDown(value: number);
  125168. /**
  125169. * Gets the value of D-pad left
  125170. */
  125171. get dPadLeft(): number;
  125172. /**
  125173. * Sets the value of D-pad left
  125174. */
  125175. set dPadLeft(value: number);
  125176. /**
  125177. * Gets the value of D-pad right
  125178. */
  125179. get dPadRight(): number;
  125180. /**
  125181. * Sets the value of D-pad right
  125182. */
  125183. set dPadRight(value: number);
  125184. /**
  125185. * Force the gamepad to synchronize with device values
  125186. */
  125187. update(): void;
  125188. /**
  125189. * Disposes the gamepad
  125190. */
  125191. dispose(): void;
  125192. }
  125193. }
  125194. declare module BABYLON {
  125195. /**
  125196. * Defines supported buttons for DualShock compatible gamepads
  125197. */
  125198. export enum DualShockButton {
  125199. /** Cross */
  125200. Cross = 0,
  125201. /** Circle */
  125202. Circle = 1,
  125203. /** Square */
  125204. Square = 2,
  125205. /** Triangle */
  125206. Triangle = 3,
  125207. /** L1 */
  125208. L1 = 4,
  125209. /** R1 */
  125210. R1 = 5,
  125211. /** Share */
  125212. Share = 8,
  125213. /** Options */
  125214. Options = 9,
  125215. /** Left stick */
  125216. LeftStick = 10,
  125217. /** Right stick */
  125218. RightStick = 11
  125219. }
  125220. /** Defines values for DualShock DPad */
  125221. export enum DualShockDpad {
  125222. /** Up */
  125223. Up = 12,
  125224. /** Down */
  125225. Down = 13,
  125226. /** Left */
  125227. Left = 14,
  125228. /** Right */
  125229. Right = 15
  125230. }
  125231. /**
  125232. * Defines a DualShock gamepad
  125233. */
  125234. export class DualShockPad extends Gamepad {
  125235. private _leftTrigger;
  125236. private _rightTrigger;
  125237. private _onlefttriggerchanged;
  125238. private _onrighttriggerchanged;
  125239. private _onbuttondown;
  125240. private _onbuttonup;
  125241. private _ondpaddown;
  125242. private _ondpadup;
  125243. /** Observable raised when a button is pressed */
  125244. onButtonDownObservable: Observable<DualShockButton>;
  125245. /** Observable raised when a button is released */
  125246. onButtonUpObservable: Observable<DualShockButton>;
  125247. /** Observable raised when a pad is pressed */
  125248. onPadDownObservable: Observable<DualShockDpad>;
  125249. /** Observable raised when a pad is released */
  125250. onPadUpObservable: Observable<DualShockDpad>;
  125251. private _buttonCross;
  125252. private _buttonCircle;
  125253. private _buttonSquare;
  125254. private _buttonTriangle;
  125255. private _buttonShare;
  125256. private _buttonOptions;
  125257. private _buttonL1;
  125258. private _buttonR1;
  125259. private _buttonLeftStick;
  125260. private _buttonRightStick;
  125261. private _dPadUp;
  125262. private _dPadDown;
  125263. private _dPadLeft;
  125264. private _dPadRight;
  125265. /**
  125266. * Creates a new DualShock gamepad object
  125267. * @param id defines the id of this gamepad
  125268. * @param index defines its index
  125269. * @param gamepad defines the internal HTML gamepad object
  125270. */
  125271. constructor(id: string, index: number, gamepad: any);
  125272. /**
  125273. * Defines the callback to call when left trigger is pressed
  125274. * @param callback defines the callback to use
  125275. */
  125276. onlefttriggerchanged(callback: (value: number) => void): void;
  125277. /**
  125278. * Defines the callback to call when right trigger is pressed
  125279. * @param callback defines the callback to use
  125280. */
  125281. onrighttriggerchanged(callback: (value: number) => void): void;
  125282. /**
  125283. * Gets the left trigger value
  125284. */
  125285. get leftTrigger(): number;
  125286. /**
  125287. * Sets the left trigger value
  125288. */
  125289. set leftTrigger(newValue: number);
  125290. /**
  125291. * Gets the right trigger value
  125292. */
  125293. get rightTrigger(): number;
  125294. /**
  125295. * Sets the right trigger value
  125296. */
  125297. set rightTrigger(newValue: number);
  125298. /**
  125299. * Defines the callback to call when a button is pressed
  125300. * @param callback defines the callback to use
  125301. */
  125302. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  125303. /**
  125304. * Defines the callback to call when a button is released
  125305. * @param callback defines the callback to use
  125306. */
  125307. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  125308. /**
  125309. * Defines the callback to call when a pad is pressed
  125310. * @param callback defines the callback to use
  125311. */
  125312. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  125313. /**
  125314. * Defines the callback to call when a pad is released
  125315. * @param callback defines the callback to use
  125316. */
  125317. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  125318. private _setButtonValue;
  125319. private _setDPadValue;
  125320. /**
  125321. * Gets the value of the `Cross` button
  125322. */
  125323. get buttonCross(): number;
  125324. /**
  125325. * Sets the value of the `Cross` button
  125326. */
  125327. set buttonCross(value: number);
  125328. /**
  125329. * Gets the value of the `Circle` button
  125330. */
  125331. get buttonCircle(): number;
  125332. /**
  125333. * Sets the value of the `Circle` button
  125334. */
  125335. set buttonCircle(value: number);
  125336. /**
  125337. * Gets the value of the `Square` button
  125338. */
  125339. get buttonSquare(): number;
  125340. /**
  125341. * Sets the value of the `Square` button
  125342. */
  125343. set buttonSquare(value: number);
  125344. /**
  125345. * Gets the value of the `Triangle` button
  125346. */
  125347. get buttonTriangle(): number;
  125348. /**
  125349. * Sets the value of the `Triangle` button
  125350. */
  125351. set buttonTriangle(value: number);
  125352. /**
  125353. * Gets the value of the `Options` button
  125354. */
  125355. get buttonOptions(): number;
  125356. /**
  125357. * Sets the value of the `Options` button
  125358. */
  125359. set buttonOptions(value: number);
  125360. /**
  125361. * Gets the value of the `Share` button
  125362. */
  125363. get buttonShare(): number;
  125364. /**
  125365. * Sets the value of the `Share` button
  125366. */
  125367. set buttonShare(value: number);
  125368. /**
  125369. * Gets the value of the `L1` button
  125370. */
  125371. get buttonL1(): number;
  125372. /**
  125373. * Sets the value of the `L1` button
  125374. */
  125375. set buttonL1(value: number);
  125376. /**
  125377. * Gets the value of the `R1` button
  125378. */
  125379. get buttonR1(): number;
  125380. /**
  125381. * Sets the value of the `R1` button
  125382. */
  125383. set buttonR1(value: number);
  125384. /**
  125385. * Gets the value of the Left joystick
  125386. */
  125387. get buttonLeftStick(): number;
  125388. /**
  125389. * Sets the value of the Left joystick
  125390. */
  125391. set buttonLeftStick(value: number);
  125392. /**
  125393. * Gets the value of the Right joystick
  125394. */
  125395. get buttonRightStick(): number;
  125396. /**
  125397. * Sets the value of the Right joystick
  125398. */
  125399. set buttonRightStick(value: number);
  125400. /**
  125401. * Gets the value of D-pad up
  125402. */
  125403. get dPadUp(): number;
  125404. /**
  125405. * Sets the value of D-pad up
  125406. */
  125407. set dPadUp(value: number);
  125408. /**
  125409. * Gets the value of D-pad down
  125410. */
  125411. get dPadDown(): number;
  125412. /**
  125413. * Sets the value of D-pad down
  125414. */
  125415. set dPadDown(value: number);
  125416. /**
  125417. * Gets the value of D-pad left
  125418. */
  125419. get dPadLeft(): number;
  125420. /**
  125421. * Sets the value of D-pad left
  125422. */
  125423. set dPadLeft(value: number);
  125424. /**
  125425. * Gets the value of D-pad right
  125426. */
  125427. get dPadRight(): number;
  125428. /**
  125429. * Sets the value of D-pad right
  125430. */
  125431. set dPadRight(value: number);
  125432. /**
  125433. * Force the gamepad to synchronize with device values
  125434. */
  125435. update(): void;
  125436. /**
  125437. * Disposes the gamepad
  125438. */
  125439. dispose(): void;
  125440. }
  125441. }
  125442. declare module BABYLON {
  125443. /**
  125444. * Manager for handling gamepads
  125445. */
  125446. export class GamepadManager {
  125447. private _scene?;
  125448. private _babylonGamepads;
  125449. private _oneGamepadConnected;
  125450. /** @hidden */
  125451. _isMonitoring: boolean;
  125452. private _gamepadEventSupported;
  125453. private _gamepadSupport?;
  125454. /**
  125455. * observable to be triggered when the gamepad controller has been connected
  125456. */
  125457. onGamepadConnectedObservable: Observable<Gamepad>;
  125458. /**
  125459. * observable to be triggered when the gamepad controller has been disconnected
  125460. */
  125461. onGamepadDisconnectedObservable: Observable<Gamepad>;
  125462. private _onGamepadConnectedEvent;
  125463. private _onGamepadDisconnectedEvent;
  125464. /**
  125465. * Initializes the gamepad manager
  125466. * @param _scene BabylonJS scene
  125467. */
  125468. constructor(_scene?: Scene | undefined);
  125469. /**
  125470. * The gamepads in the game pad manager
  125471. */
  125472. get gamepads(): Gamepad[];
  125473. /**
  125474. * Get the gamepad controllers based on type
  125475. * @param type The type of gamepad controller
  125476. * @returns Nullable gamepad
  125477. */
  125478. getGamepadByType(type?: number): Nullable<Gamepad>;
  125479. /**
  125480. * Disposes the gamepad manager
  125481. */
  125482. dispose(): void;
  125483. private _addNewGamepad;
  125484. private _startMonitoringGamepads;
  125485. private _stopMonitoringGamepads;
  125486. /** @hidden */
  125487. _checkGamepadsStatus(): void;
  125488. private _updateGamepadObjects;
  125489. }
  125490. }
  125491. declare module BABYLON {
  125492. interface Scene {
  125493. /** @hidden */
  125494. _gamepadManager: Nullable<GamepadManager>;
  125495. /**
  125496. * Gets the gamepad manager associated with the scene
  125497. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  125498. */
  125499. gamepadManager: GamepadManager;
  125500. }
  125501. /**
  125502. * Interface representing a free camera inputs manager
  125503. */
  125504. interface FreeCameraInputsManager {
  125505. /**
  125506. * Adds gamepad input support to the FreeCameraInputsManager.
  125507. * @returns the FreeCameraInputsManager
  125508. */
  125509. addGamepad(): FreeCameraInputsManager;
  125510. }
  125511. /**
  125512. * Interface representing an arc rotate camera inputs manager
  125513. */
  125514. interface ArcRotateCameraInputsManager {
  125515. /**
  125516. * Adds gamepad input support to the ArcRotateCamera InputManager.
  125517. * @returns the camera inputs manager
  125518. */
  125519. addGamepad(): ArcRotateCameraInputsManager;
  125520. }
  125521. /**
  125522. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  125523. */
  125524. export class GamepadSystemSceneComponent implements ISceneComponent {
  125525. /**
  125526. * The component name helpfull to identify the component in the list of scene components.
  125527. */
  125528. readonly name: string;
  125529. /**
  125530. * The scene the component belongs to.
  125531. */
  125532. scene: Scene;
  125533. /**
  125534. * Creates a new instance of the component for the given scene
  125535. * @param scene Defines the scene to register the component in
  125536. */
  125537. constructor(scene: Scene);
  125538. /**
  125539. * Registers the component in a given scene
  125540. */
  125541. register(): void;
  125542. /**
  125543. * Rebuilds the elements related to this component in case of
  125544. * context lost for instance.
  125545. */
  125546. rebuild(): void;
  125547. /**
  125548. * Disposes the component and the associated ressources
  125549. */
  125550. dispose(): void;
  125551. private _beforeCameraUpdate;
  125552. }
  125553. }
  125554. declare module BABYLON {
  125555. /**
  125556. * 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,
  125557. * which still works and will still be found in many Playgrounds.
  125558. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125559. */
  125560. export class UniversalCamera extends TouchCamera {
  125561. /**
  125562. * Defines the gamepad rotation sensiblity.
  125563. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  125564. */
  125565. get gamepadAngularSensibility(): number;
  125566. set gamepadAngularSensibility(value: number);
  125567. /**
  125568. * Defines the gamepad move sensiblity.
  125569. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  125570. */
  125571. get gamepadMoveSensibility(): number;
  125572. set gamepadMoveSensibility(value: number);
  125573. /**
  125574. * 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,
  125575. * which still works and will still be found in many Playgrounds.
  125576. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125577. * @param name Define the name of the camera in the scene
  125578. * @param position Define the start position of the camera in the scene
  125579. * @param scene Define the scene the camera belongs to
  125580. */
  125581. constructor(name: string, position: Vector3, scene: Scene);
  125582. /**
  125583. * Gets the current object class name.
  125584. * @return the class name
  125585. */
  125586. getClassName(): string;
  125587. }
  125588. }
  125589. declare module BABYLON {
  125590. /**
  125591. * This represents a FPS type of camera. This is only here for back compat purpose.
  125592. * Please use the UniversalCamera instead as both are identical.
  125593. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125594. */
  125595. export class GamepadCamera extends UniversalCamera {
  125596. /**
  125597. * Instantiates a new Gamepad Camera
  125598. * This represents a FPS type of camera. This is only here for back compat purpose.
  125599. * Please use the UniversalCamera instead as both are identical.
  125600. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125601. * @param name Define the name of the camera in the scene
  125602. * @param position Define the start position of the camera in the scene
  125603. * @param scene Define the scene the camera belongs to
  125604. */
  125605. constructor(name: string, position: Vector3, scene: Scene);
  125606. /**
  125607. * Gets the current object class name.
  125608. * @return the class name
  125609. */
  125610. getClassName(): string;
  125611. }
  125612. }
  125613. declare module BABYLON {
  125614. /** @hidden */
  125615. export var passPixelShader: {
  125616. name: string;
  125617. shader: string;
  125618. };
  125619. }
  125620. declare module BABYLON {
  125621. /** @hidden */
  125622. export var passCubePixelShader: {
  125623. name: string;
  125624. shader: string;
  125625. };
  125626. }
  125627. declare module BABYLON {
  125628. /**
  125629. * PassPostProcess which produces an output the same as it's input
  125630. */
  125631. export class PassPostProcess extends PostProcess {
  125632. /**
  125633. * Gets a string identifying the name of the class
  125634. * @returns "PassPostProcess" string
  125635. */
  125636. getClassName(): string;
  125637. /**
  125638. * Creates the PassPostProcess
  125639. * @param name The name of the effect.
  125640. * @param options The required width/height ratio to downsize to before computing the render pass.
  125641. * @param camera The camera to apply the render pass to.
  125642. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  125643. * @param engine The engine which the post process will be applied. (default: current engine)
  125644. * @param reusable If the post process can be reused on the same frame. (default: false)
  125645. * @param textureType The type of texture to be used when performing the post processing.
  125646. * @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)
  125647. */
  125648. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  125649. /** @hidden */
  125650. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassPostProcess;
  125651. }
  125652. /**
  125653. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  125654. */
  125655. export class PassCubePostProcess extends PostProcess {
  125656. private _face;
  125657. /**
  125658. * Gets or sets the cube face to display.
  125659. * * 0 is +X
  125660. * * 1 is -X
  125661. * * 2 is +Y
  125662. * * 3 is -Y
  125663. * * 4 is +Z
  125664. * * 5 is -Z
  125665. */
  125666. get face(): number;
  125667. set face(value: number);
  125668. /**
  125669. * Gets a string identifying the name of the class
  125670. * @returns "PassCubePostProcess" string
  125671. */
  125672. getClassName(): string;
  125673. /**
  125674. * Creates the PassCubePostProcess
  125675. * @param name The name of the effect.
  125676. * @param options The required width/height ratio to downsize to before computing the render pass.
  125677. * @param camera The camera to apply the render pass to.
  125678. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  125679. * @param engine The engine which the post process will be applied. (default: current engine)
  125680. * @param reusable If the post process can be reused on the same frame. (default: false)
  125681. * @param textureType The type of texture to be used when performing the post processing.
  125682. * @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)
  125683. */
  125684. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  125685. /** @hidden */
  125686. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassCubePostProcess;
  125687. }
  125688. }
  125689. declare module BABYLON {
  125690. /** @hidden */
  125691. export var anaglyphPixelShader: {
  125692. name: string;
  125693. shader: string;
  125694. };
  125695. }
  125696. declare module BABYLON {
  125697. /**
  125698. * Postprocess used to generate anaglyphic rendering
  125699. */
  125700. export class AnaglyphPostProcess extends PostProcess {
  125701. private _passedProcess;
  125702. /**
  125703. * Gets a string identifying the name of the class
  125704. * @returns "AnaglyphPostProcess" string
  125705. */
  125706. getClassName(): string;
  125707. /**
  125708. * Creates a new AnaglyphPostProcess
  125709. * @param name defines postprocess name
  125710. * @param options defines creation options or target ratio scale
  125711. * @param rigCameras defines cameras using this postprocess
  125712. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  125713. * @param engine defines hosting engine
  125714. * @param reusable defines if the postprocess will be reused multiple times per frame
  125715. */
  125716. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  125717. }
  125718. }
  125719. declare module BABYLON {
  125720. /**
  125721. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  125722. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125723. */
  125724. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  125725. /**
  125726. * Creates a new AnaglyphArcRotateCamera
  125727. * @param name defines camera name
  125728. * @param alpha defines alpha angle (in radians)
  125729. * @param beta defines beta angle (in radians)
  125730. * @param radius defines radius
  125731. * @param target defines camera target
  125732. * @param interaxialDistance defines distance between each color axis
  125733. * @param scene defines the hosting scene
  125734. */
  125735. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  125736. /**
  125737. * Gets camera class name
  125738. * @returns AnaglyphArcRotateCamera
  125739. */
  125740. getClassName(): string;
  125741. }
  125742. }
  125743. declare module BABYLON {
  125744. /**
  125745. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  125746. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125747. */
  125748. export class AnaglyphFreeCamera extends FreeCamera {
  125749. /**
  125750. * Creates a new AnaglyphFreeCamera
  125751. * @param name defines camera name
  125752. * @param position defines initial position
  125753. * @param interaxialDistance defines distance between each color axis
  125754. * @param scene defines the hosting scene
  125755. */
  125756. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125757. /**
  125758. * Gets camera class name
  125759. * @returns AnaglyphFreeCamera
  125760. */
  125761. getClassName(): string;
  125762. }
  125763. }
  125764. declare module BABYLON {
  125765. /**
  125766. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  125767. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125768. */
  125769. export class AnaglyphGamepadCamera extends GamepadCamera {
  125770. /**
  125771. * Creates a new AnaglyphGamepadCamera
  125772. * @param name defines camera name
  125773. * @param position defines initial position
  125774. * @param interaxialDistance defines distance between each color axis
  125775. * @param scene defines the hosting scene
  125776. */
  125777. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125778. /**
  125779. * Gets camera class name
  125780. * @returns AnaglyphGamepadCamera
  125781. */
  125782. getClassName(): string;
  125783. }
  125784. }
  125785. declare module BABYLON {
  125786. /**
  125787. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  125788. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125789. */
  125790. export class AnaglyphUniversalCamera extends UniversalCamera {
  125791. /**
  125792. * Creates a new AnaglyphUniversalCamera
  125793. * @param name defines camera name
  125794. * @param position defines initial position
  125795. * @param interaxialDistance defines distance between each color axis
  125796. * @param scene defines the hosting scene
  125797. */
  125798. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125799. /**
  125800. * Gets camera class name
  125801. * @returns AnaglyphUniversalCamera
  125802. */
  125803. getClassName(): string;
  125804. }
  125805. }
  125806. declare module BABYLON {
  125807. /**
  125808. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  125809. * @see https://doc.babylonjs.com/features/cameras
  125810. */
  125811. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  125812. /**
  125813. * Creates a new StereoscopicArcRotateCamera
  125814. * @param name defines camera name
  125815. * @param alpha defines alpha angle (in radians)
  125816. * @param beta defines beta angle (in radians)
  125817. * @param radius defines radius
  125818. * @param target defines camera target
  125819. * @param interaxialDistance defines distance between each color axis
  125820. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125821. * @param scene defines the hosting scene
  125822. */
  125823. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125824. /**
  125825. * Gets camera class name
  125826. * @returns StereoscopicArcRotateCamera
  125827. */
  125828. getClassName(): string;
  125829. }
  125830. }
  125831. declare module BABYLON {
  125832. /**
  125833. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  125834. * @see https://doc.babylonjs.com/features/cameras
  125835. */
  125836. export class StereoscopicFreeCamera extends FreeCamera {
  125837. /**
  125838. * Creates a new StereoscopicFreeCamera
  125839. * @param name defines camera name
  125840. * @param position defines initial position
  125841. * @param interaxialDistance defines distance between each color axis
  125842. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125843. * @param scene defines the hosting scene
  125844. */
  125845. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125846. /**
  125847. * Gets camera class name
  125848. * @returns StereoscopicFreeCamera
  125849. */
  125850. getClassName(): string;
  125851. }
  125852. }
  125853. declare module BABYLON {
  125854. /**
  125855. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  125856. * @see https://doc.babylonjs.com/features/cameras
  125857. */
  125858. export class StereoscopicGamepadCamera extends GamepadCamera {
  125859. /**
  125860. * Creates a new StereoscopicGamepadCamera
  125861. * @param name defines camera name
  125862. * @param position defines initial position
  125863. * @param interaxialDistance defines distance between each color axis
  125864. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125865. * @param scene defines the hosting scene
  125866. */
  125867. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125868. /**
  125869. * Gets camera class name
  125870. * @returns StereoscopicGamepadCamera
  125871. */
  125872. getClassName(): string;
  125873. }
  125874. }
  125875. declare module BABYLON {
  125876. /**
  125877. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  125878. * @see https://doc.babylonjs.com/features/cameras
  125879. */
  125880. export class StereoscopicUniversalCamera extends UniversalCamera {
  125881. /**
  125882. * Creates a new StereoscopicUniversalCamera
  125883. * @param name defines camera name
  125884. * @param position defines initial position
  125885. * @param interaxialDistance defines distance between each color axis
  125886. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125887. * @param scene defines the hosting scene
  125888. */
  125889. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125890. /**
  125891. * Gets camera class name
  125892. * @returns StereoscopicUniversalCamera
  125893. */
  125894. getClassName(): string;
  125895. }
  125896. }
  125897. declare module BABYLON {
  125898. /**
  125899. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  125900. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  125901. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  125902. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  125903. */
  125904. export class VirtualJoysticksCamera extends FreeCamera {
  125905. /**
  125906. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  125907. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  125908. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  125909. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  125910. * @param name Define the name of the camera in the scene
  125911. * @param position Define the start position of the camera in the scene
  125912. * @param scene Define the scene the camera belongs to
  125913. */
  125914. constructor(name: string, position: Vector3, scene: Scene);
  125915. /**
  125916. * Gets the current object class name.
  125917. * @return the class name
  125918. */
  125919. getClassName(): string;
  125920. }
  125921. }
  125922. declare module BABYLON {
  125923. /**
  125924. * This represents all the required metrics to create a VR camera.
  125925. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  125926. */
  125927. export class VRCameraMetrics {
  125928. /**
  125929. * Define the horizontal resolution off the screen.
  125930. */
  125931. hResolution: number;
  125932. /**
  125933. * Define the vertical resolution off the screen.
  125934. */
  125935. vResolution: number;
  125936. /**
  125937. * Define the horizontal screen size.
  125938. */
  125939. hScreenSize: number;
  125940. /**
  125941. * Define the vertical screen size.
  125942. */
  125943. vScreenSize: number;
  125944. /**
  125945. * Define the vertical screen center position.
  125946. */
  125947. vScreenCenter: number;
  125948. /**
  125949. * Define the distance of the eyes to the screen.
  125950. */
  125951. eyeToScreenDistance: number;
  125952. /**
  125953. * Define the distance between both lenses
  125954. */
  125955. lensSeparationDistance: number;
  125956. /**
  125957. * Define the distance between both viewer's eyes.
  125958. */
  125959. interpupillaryDistance: number;
  125960. /**
  125961. * Define the distortion factor of the VR postprocess.
  125962. * Please, touch with care.
  125963. */
  125964. distortionK: number[];
  125965. /**
  125966. * Define the chromatic aberration correction factors for the VR post process.
  125967. */
  125968. chromaAbCorrection: number[];
  125969. /**
  125970. * Define the scale factor of the post process.
  125971. * The smaller the better but the slower.
  125972. */
  125973. postProcessScaleFactor: number;
  125974. /**
  125975. * Define an offset for the lens center.
  125976. */
  125977. lensCenterOffset: number;
  125978. /**
  125979. * Define if the current vr camera should compensate the distortion of the lense or not.
  125980. */
  125981. compensateDistortion: boolean;
  125982. /**
  125983. * Defines if multiview should be enabled when rendering (Default: false)
  125984. */
  125985. multiviewEnabled: boolean;
  125986. /**
  125987. * Gets the rendering aspect ratio based on the provided resolutions.
  125988. */
  125989. get aspectRatio(): number;
  125990. /**
  125991. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  125992. */
  125993. get aspectRatioFov(): number;
  125994. /**
  125995. * @hidden
  125996. */
  125997. get leftHMatrix(): Matrix;
  125998. /**
  125999. * @hidden
  126000. */
  126001. get rightHMatrix(): Matrix;
  126002. /**
  126003. * @hidden
  126004. */
  126005. get leftPreViewMatrix(): Matrix;
  126006. /**
  126007. * @hidden
  126008. */
  126009. get rightPreViewMatrix(): Matrix;
  126010. /**
  126011. * Get the default VRMetrics based on the most generic setup.
  126012. * @returns the default vr metrics
  126013. */
  126014. static GetDefault(): VRCameraMetrics;
  126015. }
  126016. }
  126017. declare module BABYLON {
  126018. /** @hidden */
  126019. export var vrDistortionCorrectionPixelShader: {
  126020. name: string;
  126021. shader: string;
  126022. };
  126023. }
  126024. declare module BABYLON {
  126025. /**
  126026. * VRDistortionCorrectionPostProcess used for mobile VR
  126027. */
  126028. export class VRDistortionCorrectionPostProcess extends PostProcess {
  126029. private _isRightEye;
  126030. private _distortionFactors;
  126031. private _postProcessScaleFactor;
  126032. private _lensCenterOffset;
  126033. private _scaleIn;
  126034. private _scaleFactor;
  126035. private _lensCenter;
  126036. /**
  126037. * Gets a string identifying the name of the class
  126038. * @returns "VRDistortionCorrectionPostProcess" string
  126039. */
  126040. getClassName(): string;
  126041. /**
  126042. * Initializes the VRDistortionCorrectionPostProcess
  126043. * @param name The name of the effect.
  126044. * @param camera The camera to apply the render pass to.
  126045. * @param isRightEye If this is for the right eye distortion
  126046. * @param vrMetrics All the required metrics for the VR camera
  126047. */
  126048. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  126049. }
  126050. }
  126051. declare module BABYLON {
  126052. /**
  126053. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  126054. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126055. */
  126056. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  126057. /**
  126058. * Creates a new VRDeviceOrientationArcRotateCamera
  126059. * @param name defines camera name
  126060. * @param alpha defines the camera rotation along the logitudinal axis
  126061. * @param beta defines the camera rotation along the latitudinal axis
  126062. * @param radius defines the camera distance from its target
  126063. * @param target defines the camera target
  126064. * @param scene defines the scene the camera belongs to
  126065. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126066. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126067. */
  126068. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126069. /**
  126070. * Gets camera class name
  126071. * @returns VRDeviceOrientationArcRotateCamera
  126072. */
  126073. getClassName(): string;
  126074. }
  126075. }
  126076. declare module BABYLON {
  126077. /**
  126078. * Camera used to simulate VR rendering (based on FreeCamera)
  126079. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126080. */
  126081. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  126082. /**
  126083. * Creates a new VRDeviceOrientationFreeCamera
  126084. * @param name defines camera name
  126085. * @param position defines the start position of the camera
  126086. * @param scene defines the scene the camera belongs to
  126087. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126088. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126089. */
  126090. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126091. /**
  126092. * Gets camera class name
  126093. * @returns VRDeviceOrientationFreeCamera
  126094. */
  126095. getClassName(): string;
  126096. }
  126097. }
  126098. declare module BABYLON {
  126099. /**
  126100. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  126101. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126102. */
  126103. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  126104. /**
  126105. * Creates a new VRDeviceOrientationGamepadCamera
  126106. * @param name defines camera name
  126107. * @param position defines the start position of the camera
  126108. * @param scene defines the scene the camera belongs to
  126109. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126110. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126111. */
  126112. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126113. /**
  126114. * Gets camera class name
  126115. * @returns VRDeviceOrientationGamepadCamera
  126116. */
  126117. getClassName(): string;
  126118. }
  126119. }
  126120. declare module BABYLON {
  126121. /**
  126122. * A class extending Texture allowing drawing on a texture
  126123. * @see https://doc.babylonjs.com/how_to/dynamictexture
  126124. */
  126125. export class DynamicTexture extends Texture {
  126126. private _generateMipMaps;
  126127. private _canvas;
  126128. private _context;
  126129. /**
  126130. * Creates a DynamicTexture
  126131. * @param name defines the name of the texture
  126132. * @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
  126133. * @param scene defines the scene where you want the texture
  126134. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  126135. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  126136. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  126137. */
  126138. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  126139. /**
  126140. * Get the current class name of the texture useful for serialization or dynamic coding.
  126141. * @returns "DynamicTexture"
  126142. */
  126143. getClassName(): string;
  126144. /**
  126145. * Gets the current state of canRescale
  126146. */
  126147. get canRescale(): boolean;
  126148. private _recreate;
  126149. /**
  126150. * Scales the texture
  126151. * @param ratio the scale factor to apply to both width and height
  126152. */
  126153. scale(ratio: number): void;
  126154. /**
  126155. * Resizes the texture
  126156. * @param width the new width
  126157. * @param height the new height
  126158. */
  126159. scaleTo(width: number, height: number): void;
  126160. /**
  126161. * Gets the context of the canvas used by the texture
  126162. * @returns the canvas context of the dynamic texture
  126163. */
  126164. getContext(): CanvasRenderingContext2D;
  126165. /**
  126166. * Clears the texture
  126167. */
  126168. clear(): void;
  126169. /**
  126170. * Updates the texture
  126171. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  126172. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  126173. */
  126174. update(invertY?: boolean, premulAlpha?: boolean): void;
  126175. /**
  126176. * Draws text onto the texture
  126177. * @param text defines the text to be drawn
  126178. * @param x defines the placement of the text from the left
  126179. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  126180. * @param font defines the font to be used with font-style, font-size, font-name
  126181. * @param color defines the color used for the text
  126182. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  126183. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  126184. * @param update defines whether texture is immediately update (default is true)
  126185. */
  126186. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  126187. /**
  126188. * Clones the texture
  126189. * @returns the clone of the texture.
  126190. */
  126191. clone(): DynamicTexture;
  126192. /**
  126193. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  126194. * @returns a serialized dynamic texture object
  126195. */
  126196. serialize(): any;
  126197. private _IsCanvasElement;
  126198. /** @hidden */
  126199. _rebuild(): void;
  126200. }
  126201. }
  126202. declare module BABYLON {
  126203. /**
  126204. * Class containing static functions to help procedurally build meshes
  126205. */
  126206. export class GroundBuilder {
  126207. /**
  126208. * Creates a ground mesh
  126209. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  126210. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  126211. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126212. * @param name defines the name of the mesh
  126213. * @param options defines the options used to create the mesh
  126214. * @param scene defines the hosting scene
  126215. * @returns the ground mesh
  126216. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  126217. */
  126218. static CreateGround(name: string, options: {
  126219. width?: number;
  126220. height?: number;
  126221. subdivisions?: number;
  126222. subdivisionsX?: number;
  126223. subdivisionsY?: number;
  126224. updatable?: boolean;
  126225. }, scene: any): Mesh;
  126226. /**
  126227. * Creates a tiled ground mesh
  126228. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  126229. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  126230. * * 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
  126231. * * 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
  126232. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126233. * @param name defines the name of the mesh
  126234. * @param options defines the options used to create the mesh
  126235. * @param scene defines the hosting scene
  126236. * @returns the tiled ground mesh
  126237. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  126238. */
  126239. static CreateTiledGround(name: string, options: {
  126240. xmin: number;
  126241. zmin: number;
  126242. xmax: number;
  126243. zmax: number;
  126244. subdivisions?: {
  126245. w: number;
  126246. h: number;
  126247. };
  126248. precision?: {
  126249. w: number;
  126250. h: number;
  126251. };
  126252. updatable?: boolean;
  126253. }, scene?: Nullable<Scene>): Mesh;
  126254. /**
  126255. * Creates a ground mesh from a height map
  126256. * * The parameter `url` sets the URL of the height map image resource.
  126257. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  126258. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  126259. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  126260. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  126261. * * 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.
  126262. * * 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).
  126263. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  126264. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126265. * @param name defines the name of the mesh
  126266. * @param url defines the url to the height map
  126267. * @param options defines the options used to create the mesh
  126268. * @param scene defines the hosting scene
  126269. * @returns the ground mesh
  126270. * @see https://doc.babylonjs.com/babylon101/height_map
  126271. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  126272. */
  126273. static CreateGroundFromHeightMap(name: string, url: string, options: {
  126274. width?: number;
  126275. height?: number;
  126276. subdivisions?: number;
  126277. minHeight?: number;
  126278. maxHeight?: number;
  126279. colorFilter?: Color3;
  126280. alphaFilter?: number;
  126281. updatable?: boolean;
  126282. onReady?: (mesh: GroundMesh) => void;
  126283. }, scene?: Nullable<Scene>): GroundMesh;
  126284. }
  126285. }
  126286. declare module BABYLON {
  126287. /**
  126288. * Class containing static functions to help procedurally build meshes
  126289. */
  126290. export class TorusBuilder {
  126291. /**
  126292. * Creates a torus mesh
  126293. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  126294. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  126295. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  126296. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126297. * * 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
  126298. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126299. * @param name defines the name of the mesh
  126300. * @param options defines the options used to create the mesh
  126301. * @param scene defines the hosting scene
  126302. * @returns the torus mesh
  126303. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  126304. */
  126305. static CreateTorus(name: string, options: {
  126306. diameter?: number;
  126307. thickness?: number;
  126308. tessellation?: number;
  126309. updatable?: boolean;
  126310. sideOrientation?: number;
  126311. frontUVs?: Vector4;
  126312. backUVs?: Vector4;
  126313. }, scene: any): Mesh;
  126314. }
  126315. }
  126316. declare module BABYLON {
  126317. /**
  126318. * Class containing static functions to help procedurally build meshes
  126319. */
  126320. export class CylinderBuilder {
  126321. /**
  126322. * Creates a cylinder or a cone mesh
  126323. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  126324. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  126325. * * 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.
  126326. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  126327. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  126328. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  126329. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  126330. * * 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).
  126331. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  126332. * * 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).
  126333. * * 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
  126334. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  126335. * * 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
  126336. * * 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.
  126337. * * If `enclose` is false, a ring surface is one element.
  126338. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  126339. * * 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
  126340. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126341. * * 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
  126342. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126343. * @param name defines the name of the mesh
  126344. * @param options defines the options used to create the mesh
  126345. * @param scene defines the hosting scene
  126346. * @returns the cylinder mesh
  126347. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  126348. */
  126349. static CreateCylinder(name: string, options: {
  126350. height?: number;
  126351. diameterTop?: number;
  126352. diameterBottom?: number;
  126353. diameter?: number;
  126354. tessellation?: number;
  126355. subdivisions?: number;
  126356. arc?: number;
  126357. faceColors?: Color4[];
  126358. faceUV?: Vector4[];
  126359. updatable?: boolean;
  126360. hasRings?: boolean;
  126361. enclose?: boolean;
  126362. cap?: number;
  126363. sideOrientation?: number;
  126364. frontUVs?: Vector4;
  126365. backUVs?: Vector4;
  126366. }, scene: any): Mesh;
  126367. }
  126368. }
  126369. declare module BABYLON {
  126370. /**
  126371. * States of the webXR experience
  126372. */
  126373. export enum WebXRState {
  126374. /**
  126375. * Transitioning to being in XR mode
  126376. */
  126377. ENTERING_XR = 0,
  126378. /**
  126379. * Transitioning to non XR mode
  126380. */
  126381. EXITING_XR = 1,
  126382. /**
  126383. * In XR mode and presenting
  126384. */
  126385. IN_XR = 2,
  126386. /**
  126387. * Not entered XR mode
  126388. */
  126389. NOT_IN_XR = 3
  126390. }
  126391. /**
  126392. * Abstraction of the XR render target
  126393. */
  126394. export interface WebXRRenderTarget extends IDisposable {
  126395. /**
  126396. * xrpresent context of the canvas which can be used to display/mirror xr content
  126397. */
  126398. canvasContext: WebGLRenderingContext;
  126399. /**
  126400. * xr layer for the canvas
  126401. */
  126402. xrLayer: Nullable<XRWebGLLayer>;
  126403. /**
  126404. * Initializes the xr layer for the session
  126405. * @param xrSession xr session
  126406. * @returns a promise that will resolve once the XR Layer has been created
  126407. */
  126408. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  126409. }
  126410. }
  126411. declare module BABYLON {
  126412. /**
  126413. * COnfiguration object for WebXR output canvas
  126414. */
  126415. export class WebXRManagedOutputCanvasOptions {
  126416. /**
  126417. * An optional canvas in case you wish to create it yourself and provide it here.
  126418. * If not provided, a new canvas will be created
  126419. */
  126420. canvasElement?: HTMLCanvasElement;
  126421. /**
  126422. * Options for this XR Layer output
  126423. */
  126424. canvasOptions?: XRWebGLLayerOptions;
  126425. /**
  126426. * CSS styling for a newly created canvas (if not provided)
  126427. */
  126428. newCanvasCssStyle?: string;
  126429. /**
  126430. * Get the default values of the configuration object
  126431. * @param engine defines the engine to use (can be null)
  126432. * @returns default values of this configuration object
  126433. */
  126434. static GetDefaults(engine?: ThinEngine): WebXRManagedOutputCanvasOptions;
  126435. }
  126436. /**
  126437. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  126438. */
  126439. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  126440. private _options;
  126441. private _canvas;
  126442. private _engine;
  126443. private _originalCanvasSize;
  126444. /**
  126445. * Rendering context of the canvas which can be used to display/mirror xr content
  126446. */
  126447. canvasContext: WebGLRenderingContext;
  126448. /**
  126449. * xr layer for the canvas
  126450. */
  126451. xrLayer: Nullable<XRWebGLLayer>;
  126452. /**
  126453. * Obseervers registered here will be triggered when the xr layer was initialized
  126454. */
  126455. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  126456. /**
  126457. * Initializes the canvas to be added/removed upon entering/exiting xr
  126458. * @param _xrSessionManager The XR Session manager
  126459. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  126460. */
  126461. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  126462. /**
  126463. * Disposes of the object
  126464. */
  126465. dispose(): void;
  126466. /**
  126467. * Initializes the xr layer for the session
  126468. * @param xrSession xr session
  126469. * @returns a promise that will resolve once the XR Layer has been created
  126470. */
  126471. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  126472. private _addCanvas;
  126473. private _removeCanvas;
  126474. private _setCanvasSize;
  126475. private _setManagedOutputCanvas;
  126476. }
  126477. }
  126478. declare module BABYLON {
  126479. /**
  126480. * Manages an XRSession to work with Babylon's engine
  126481. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  126482. */
  126483. export class WebXRSessionManager implements IDisposable {
  126484. /** The scene which the session should be created for */
  126485. scene: Scene;
  126486. private _referenceSpace;
  126487. private _rttProvider;
  126488. private _sessionEnded;
  126489. private _xrNavigator;
  126490. private baseLayer;
  126491. /**
  126492. * The base reference space from which the session started. good if you want to reset your
  126493. * reference space
  126494. */
  126495. baseReferenceSpace: XRReferenceSpace;
  126496. /**
  126497. * Current XR frame
  126498. */
  126499. currentFrame: Nullable<XRFrame>;
  126500. /** WebXR timestamp updated every frame */
  126501. currentTimestamp: number;
  126502. /**
  126503. * Used just in case of a failure to initialize an immersive session.
  126504. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  126505. */
  126506. defaultHeightCompensation: number;
  126507. /**
  126508. * Fires every time a new xrFrame arrives which can be used to update the camera
  126509. */
  126510. onXRFrameObservable: Observable<XRFrame>;
  126511. /**
  126512. * Fires when the reference space changed
  126513. */
  126514. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  126515. /**
  126516. * Fires when the xr session is ended either by the device or manually done
  126517. */
  126518. onXRSessionEnded: Observable<any>;
  126519. /**
  126520. * Fires when the xr session is ended either by the device or manually done
  126521. */
  126522. onXRSessionInit: Observable<XRSession>;
  126523. /**
  126524. * Underlying xr session
  126525. */
  126526. session: XRSession;
  126527. /**
  126528. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  126529. * or get the offset the player is currently at.
  126530. */
  126531. viewerReferenceSpace: XRReferenceSpace;
  126532. /**
  126533. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  126534. * @param scene The scene which the session should be created for
  126535. */
  126536. constructor(
  126537. /** The scene which the session should be created for */
  126538. scene: Scene);
  126539. /**
  126540. * The current reference space used in this session. This reference space can constantly change!
  126541. * It is mainly used to offset the camera's position.
  126542. */
  126543. get referenceSpace(): XRReferenceSpace;
  126544. /**
  126545. * Set a new reference space and triggers the observable
  126546. */
  126547. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  126548. /**
  126549. * Disposes of the session manager
  126550. */
  126551. dispose(): void;
  126552. /**
  126553. * Stops the xrSession and restores the render loop
  126554. * @returns Promise which resolves after it exits XR
  126555. */
  126556. exitXRAsync(): Promise<void>;
  126557. /**
  126558. * Gets the correct render target texture to be rendered this frame for this eye
  126559. * @param eye the eye for which to get the render target
  126560. * @returns the render target for the specified eye
  126561. */
  126562. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  126563. /**
  126564. * Creates a WebXRRenderTarget object for the XR session
  126565. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  126566. * @param options optional options to provide when creating a new render target
  126567. * @returns a WebXR render target to which the session can render
  126568. */
  126569. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  126570. /**
  126571. * Initializes the manager
  126572. * After initialization enterXR can be called to start an XR session
  126573. * @returns Promise which resolves after it is initialized
  126574. */
  126575. initializeAsync(): Promise<void>;
  126576. /**
  126577. * Initializes an xr session
  126578. * @param xrSessionMode mode to initialize
  126579. * @param xrSessionInit defines optional and required values to pass to the session builder
  126580. * @returns a promise which will resolve once the session has been initialized
  126581. */
  126582. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  126583. /**
  126584. * Checks if a session would be supported for the creation options specified
  126585. * @param sessionMode session mode to check if supported eg. immersive-vr
  126586. * @returns A Promise that resolves to true if supported and false if not
  126587. */
  126588. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  126589. /**
  126590. * Resets the reference space to the one started the session
  126591. */
  126592. resetReferenceSpace(): void;
  126593. /**
  126594. * Starts rendering to the xr layer
  126595. */
  126596. runXRRenderLoop(): void;
  126597. /**
  126598. * Sets the reference space on the xr session
  126599. * @param referenceSpaceType space to set
  126600. * @returns a promise that will resolve once the reference space has been set
  126601. */
  126602. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  126603. /**
  126604. * Updates the render state of the session
  126605. * @param state state to set
  126606. * @returns a promise that resolves once the render state has been updated
  126607. */
  126608. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  126609. /**
  126610. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  126611. * @param sessionMode defines the session to test
  126612. * @returns a promise with boolean as final value
  126613. */
  126614. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  126615. private _createRenderTargetTexture;
  126616. }
  126617. }
  126618. declare module BABYLON {
  126619. /**
  126620. * WebXR Camera which holds the views for the xrSession
  126621. * @see https://doc.babylonjs.com/how_to/webxr_camera
  126622. */
  126623. export class WebXRCamera extends FreeCamera {
  126624. private _xrSessionManager;
  126625. private _firstFrame;
  126626. private _referenceQuaternion;
  126627. private _referencedPosition;
  126628. private _xrInvPositionCache;
  126629. private _xrInvQuaternionCache;
  126630. /**
  126631. * Observable raised before camera teleportation
  126632. */
  126633. onBeforeCameraTeleport: Observable<Vector3>;
  126634. /**
  126635. * Observable raised after camera teleportation
  126636. */
  126637. onAfterCameraTeleport: Observable<Vector3>;
  126638. /**
  126639. * Should position compensation execute on first frame.
  126640. * This is used when copying the position from a native (non XR) camera
  126641. */
  126642. compensateOnFirstFrame: boolean;
  126643. /**
  126644. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  126645. * @param name the name of the camera
  126646. * @param scene the scene to add the camera to
  126647. * @param _xrSessionManager a constructed xr session manager
  126648. */
  126649. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  126650. /**
  126651. * Return the user's height, unrelated to the current ground.
  126652. * This will be the y position of this camera, when ground level is 0.
  126653. */
  126654. get realWorldHeight(): number;
  126655. /** @hidden */
  126656. _updateForDualEyeDebugging(): void;
  126657. /**
  126658. * Sets this camera's transformation based on a non-vr camera
  126659. * @param otherCamera the non-vr camera to copy the transformation from
  126660. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  126661. */
  126662. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  126663. /**
  126664. * Gets the current instance class name ("WebXRCamera").
  126665. * @returns the class name
  126666. */
  126667. getClassName(): string;
  126668. private _rotate180;
  126669. private _updateFromXRSession;
  126670. private _updateNumberOfRigCameras;
  126671. private _updateReferenceSpace;
  126672. private _updateReferenceSpaceOffset;
  126673. }
  126674. }
  126675. declare module BABYLON {
  126676. /**
  126677. * Defining the interface required for a (webxr) feature
  126678. */
  126679. export interface IWebXRFeature extends IDisposable {
  126680. /**
  126681. * Is this feature attached
  126682. */
  126683. attached: boolean;
  126684. /**
  126685. * Should auto-attach be disabled?
  126686. */
  126687. disableAutoAttach: boolean;
  126688. /**
  126689. * Attach the feature to the session
  126690. * Will usually be called by the features manager
  126691. *
  126692. * @param force should attachment be forced (even when already attached)
  126693. * @returns true if successful.
  126694. */
  126695. attach(force?: boolean): boolean;
  126696. /**
  126697. * Detach the feature from the session
  126698. * Will usually be called by the features manager
  126699. *
  126700. * @returns true if successful.
  126701. */
  126702. detach(): boolean;
  126703. /**
  126704. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  126705. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  126706. *
  126707. * @returns whether or not the feature is compatible in this environment
  126708. */
  126709. isCompatible(): boolean;
  126710. /**
  126711. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  126712. */
  126713. xrNativeFeatureName?: string;
  126714. /**
  126715. * A list of (Babylon WebXR) features this feature depends on
  126716. */
  126717. dependsOn?: string[];
  126718. }
  126719. /**
  126720. * A list of the currently available features without referencing them
  126721. */
  126722. export class WebXRFeatureName {
  126723. /**
  126724. * The name of the anchor system feature
  126725. */
  126726. static readonly ANCHOR_SYSTEM: string;
  126727. /**
  126728. * The name of the background remover feature
  126729. */
  126730. static readonly BACKGROUND_REMOVER: string;
  126731. /**
  126732. * The name of the hit test feature
  126733. */
  126734. static readonly HIT_TEST: string;
  126735. /**
  126736. * physics impostors for xr controllers feature
  126737. */
  126738. static readonly PHYSICS_CONTROLLERS: string;
  126739. /**
  126740. * The name of the plane detection feature
  126741. */
  126742. static readonly PLANE_DETECTION: string;
  126743. /**
  126744. * The name of the pointer selection feature
  126745. */
  126746. static readonly POINTER_SELECTION: string;
  126747. /**
  126748. * The name of the teleportation feature
  126749. */
  126750. static readonly TELEPORTATION: string;
  126751. /**
  126752. * The name of the feature points feature.
  126753. */
  126754. static readonly FEATURE_POINTS: string;
  126755. /**
  126756. * The name of the hand tracking feature.
  126757. */
  126758. static readonly HAND_TRACKING: string;
  126759. }
  126760. /**
  126761. * Defining the constructor of a feature. Used to register the modules.
  126762. */
  126763. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  126764. /**
  126765. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  126766. * It is mainly used in AR sessions.
  126767. *
  126768. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  126769. */
  126770. export class WebXRFeaturesManager implements IDisposable {
  126771. private _xrSessionManager;
  126772. private static readonly _AvailableFeatures;
  126773. private _features;
  126774. /**
  126775. * constructs a new features manages.
  126776. *
  126777. * @param _xrSessionManager an instance of WebXRSessionManager
  126778. */
  126779. constructor(_xrSessionManager: WebXRSessionManager);
  126780. /**
  126781. * Used to register a module. After calling this function a developer can use this feature in the scene.
  126782. * Mainly used internally.
  126783. *
  126784. * @param featureName the name of the feature to register
  126785. * @param constructorFunction the function used to construct the module
  126786. * @param version the (babylon) version of the module
  126787. * @param stable is that a stable version of this module
  126788. */
  126789. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  126790. /**
  126791. * Returns a constructor of a specific feature.
  126792. *
  126793. * @param featureName the name of the feature to construct
  126794. * @param version the version of the feature to load
  126795. * @param xrSessionManager the xrSessionManager. Used to construct the module
  126796. * @param options optional options provided to the module.
  126797. * @returns a function that, when called, will return a new instance of this feature
  126798. */
  126799. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  126800. /**
  126801. * Can be used to return the list of features currently registered
  126802. *
  126803. * @returns an Array of available features
  126804. */
  126805. static GetAvailableFeatures(): string[];
  126806. /**
  126807. * Gets the versions available for a specific feature
  126808. * @param featureName the name of the feature
  126809. * @returns an array with the available versions
  126810. */
  126811. static GetAvailableVersions(featureName: string): string[];
  126812. /**
  126813. * Return the latest unstable version of this feature
  126814. * @param featureName the name of the feature to search
  126815. * @returns the version number. if not found will return -1
  126816. */
  126817. static GetLatestVersionOfFeature(featureName: string): number;
  126818. /**
  126819. * Return the latest stable version of this feature
  126820. * @param featureName the name of the feature to search
  126821. * @returns the version number. if not found will return -1
  126822. */
  126823. static GetStableVersionOfFeature(featureName: string): number;
  126824. /**
  126825. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  126826. * Can be used during a session to start a feature
  126827. * @param featureName the name of feature to attach
  126828. */
  126829. attachFeature(featureName: string): void;
  126830. /**
  126831. * Can be used inside a session or when the session ends to detach a specific feature
  126832. * @param featureName the name of the feature to detach
  126833. */
  126834. detachFeature(featureName: string): void;
  126835. /**
  126836. * Used to disable an already-enabled feature
  126837. * The feature will be disposed and will be recreated once enabled.
  126838. * @param featureName the feature to disable
  126839. * @returns true if disable was successful
  126840. */
  126841. disableFeature(featureName: string | {
  126842. Name: string;
  126843. }): boolean;
  126844. /**
  126845. * dispose this features manager
  126846. */
  126847. dispose(): void;
  126848. /**
  126849. * 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.
  126850. * 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.
  126851. *
  126852. * @param featureName the name of the feature to load or the class of the feature
  126853. * @param version optional version to load. if not provided the latest version will be enabled
  126854. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  126855. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  126856. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  126857. * @returns a new constructed feature or throws an error if feature not found.
  126858. */
  126859. enableFeature(featureName: string | {
  126860. Name: string;
  126861. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  126862. /**
  126863. * get the implementation of an enabled feature.
  126864. * @param featureName the name of the feature to load
  126865. * @returns the feature class, if found
  126866. */
  126867. getEnabledFeature(featureName: string): IWebXRFeature;
  126868. /**
  126869. * Get the list of enabled features
  126870. * @returns an array of enabled features
  126871. */
  126872. getEnabledFeatures(): string[];
  126873. /**
  126874. * This function will exten the session creation configuration object with enabled features.
  126875. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  126876. * according to the defined "required" variable, provided during enableFeature call
  126877. * @param xrSessionInit the xr Session init object to extend
  126878. *
  126879. * @returns an extended XRSessionInit object
  126880. */
  126881. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  126882. }
  126883. }
  126884. declare module BABYLON {
  126885. /**
  126886. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  126887. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  126888. */
  126889. export class WebXRExperienceHelper implements IDisposable {
  126890. private scene;
  126891. private _nonVRCamera;
  126892. private _originalSceneAutoClear;
  126893. private _supported;
  126894. /**
  126895. * Camera used to render xr content
  126896. */
  126897. camera: WebXRCamera;
  126898. /** A features manager for this xr session */
  126899. featuresManager: WebXRFeaturesManager;
  126900. /**
  126901. * Observers registered here will be triggered after the camera's initial transformation is set
  126902. * This can be used to set a different ground level or an extra rotation.
  126903. *
  126904. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  126905. * to the position set after this observable is done executing.
  126906. */
  126907. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  126908. /**
  126909. * Fires when the state of the experience helper has changed
  126910. */
  126911. onStateChangedObservable: Observable<WebXRState>;
  126912. /** Session manager used to keep track of xr session */
  126913. sessionManager: WebXRSessionManager;
  126914. /**
  126915. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  126916. */
  126917. state: WebXRState;
  126918. /**
  126919. * Creates a WebXRExperienceHelper
  126920. * @param scene The scene the helper should be created in
  126921. */
  126922. private constructor();
  126923. /**
  126924. * Creates the experience helper
  126925. * @param scene the scene to attach the experience helper to
  126926. * @returns a promise for the experience helper
  126927. */
  126928. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  126929. /**
  126930. * Disposes of the experience helper
  126931. */
  126932. dispose(): void;
  126933. /**
  126934. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  126935. * @param sessionMode options for the XR session
  126936. * @param referenceSpaceType frame of reference of the XR session
  126937. * @param renderTarget the output canvas that will be used to enter XR mode
  126938. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  126939. * @returns promise that resolves after xr mode has entered
  126940. */
  126941. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  126942. /**
  126943. * Exits XR mode and returns the scene to its original state
  126944. * @returns promise that resolves after xr mode has exited
  126945. */
  126946. exitXRAsync(): Promise<void>;
  126947. private _nonXRToXRCamera;
  126948. private _setState;
  126949. }
  126950. }
  126951. declare module BABYLON {
  126952. /**
  126953. * X-Y values for axes in WebXR
  126954. */
  126955. export interface IWebXRMotionControllerAxesValue {
  126956. /**
  126957. * The value of the x axis
  126958. */
  126959. x: number;
  126960. /**
  126961. * The value of the y-axis
  126962. */
  126963. y: number;
  126964. }
  126965. /**
  126966. * changed / previous values for the values of this component
  126967. */
  126968. export interface IWebXRMotionControllerComponentChangesValues<T> {
  126969. /**
  126970. * current (this frame) value
  126971. */
  126972. current: T;
  126973. /**
  126974. * previous (last change) value
  126975. */
  126976. previous: T;
  126977. }
  126978. /**
  126979. * Represents changes in the component between current frame and last values recorded
  126980. */
  126981. export interface IWebXRMotionControllerComponentChanges {
  126982. /**
  126983. * will be populated with previous and current values if axes changed
  126984. */
  126985. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  126986. /**
  126987. * will be populated with previous and current values if pressed changed
  126988. */
  126989. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  126990. /**
  126991. * will be populated with previous and current values if touched changed
  126992. */
  126993. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  126994. /**
  126995. * will be populated with previous and current values if value changed
  126996. */
  126997. value?: IWebXRMotionControllerComponentChangesValues<number>;
  126998. }
  126999. /**
  127000. * This class represents a single component (for example button or thumbstick) of a motion controller
  127001. */
  127002. export class WebXRControllerComponent implements IDisposable {
  127003. /**
  127004. * the id of this component
  127005. */
  127006. id: string;
  127007. /**
  127008. * the type of the component
  127009. */
  127010. type: MotionControllerComponentType;
  127011. private _buttonIndex;
  127012. private _axesIndices;
  127013. private _axes;
  127014. private _changes;
  127015. private _currentValue;
  127016. private _hasChanges;
  127017. private _pressed;
  127018. private _touched;
  127019. /**
  127020. * button component type
  127021. */
  127022. static BUTTON_TYPE: MotionControllerComponentType;
  127023. /**
  127024. * squeeze component type
  127025. */
  127026. static SQUEEZE_TYPE: MotionControllerComponentType;
  127027. /**
  127028. * Thumbstick component type
  127029. */
  127030. static THUMBSTICK_TYPE: MotionControllerComponentType;
  127031. /**
  127032. * Touchpad component type
  127033. */
  127034. static TOUCHPAD_TYPE: MotionControllerComponentType;
  127035. /**
  127036. * trigger component type
  127037. */
  127038. static TRIGGER_TYPE: MotionControllerComponentType;
  127039. /**
  127040. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  127041. * the axes data changes
  127042. */
  127043. onAxisValueChangedObservable: Observable<{
  127044. x: number;
  127045. y: number;
  127046. }>;
  127047. /**
  127048. * Observers registered here will be triggered when the state of a button changes
  127049. * State change is either pressed / touched / value
  127050. */
  127051. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  127052. /**
  127053. * Creates a new component for a motion controller.
  127054. * It is created by the motion controller itself
  127055. *
  127056. * @param id the id of this component
  127057. * @param type the type of the component
  127058. * @param _buttonIndex index in the buttons array of the gamepad
  127059. * @param _axesIndices indices of the values in the axes array of the gamepad
  127060. */
  127061. constructor(
  127062. /**
  127063. * the id of this component
  127064. */
  127065. id: string,
  127066. /**
  127067. * the type of the component
  127068. */
  127069. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  127070. /**
  127071. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  127072. */
  127073. get axes(): IWebXRMotionControllerAxesValue;
  127074. /**
  127075. * Get the changes. Elements will be populated only if they changed with their previous and current value
  127076. */
  127077. get changes(): IWebXRMotionControllerComponentChanges;
  127078. /**
  127079. * Return whether or not the component changed the last frame
  127080. */
  127081. get hasChanges(): boolean;
  127082. /**
  127083. * is the button currently pressed
  127084. */
  127085. get pressed(): boolean;
  127086. /**
  127087. * is the button currently touched
  127088. */
  127089. get touched(): boolean;
  127090. /**
  127091. * Get the current value of this component
  127092. */
  127093. get value(): number;
  127094. /**
  127095. * Dispose this component
  127096. */
  127097. dispose(): void;
  127098. /**
  127099. * Are there axes correlating to this component
  127100. * @return true is axes data is available
  127101. */
  127102. isAxes(): boolean;
  127103. /**
  127104. * Is this component a button (hence - pressable)
  127105. * @returns true if can be pressed
  127106. */
  127107. isButton(): boolean;
  127108. /**
  127109. * update this component using the gamepad object it is in. Called on every frame
  127110. * @param nativeController the native gamepad controller object
  127111. */
  127112. update(nativeController: IMinimalMotionControllerObject): void;
  127113. }
  127114. }
  127115. declare module BABYLON {
  127116. /**
  127117. * Interface used to represent data loading progression
  127118. */
  127119. export interface ISceneLoaderProgressEvent {
  127120. /**
  127121. * Defines if data length to load can be evaluated
  127122. */
  127123. readonly lengthComputable: boolean;
  127124. /**
  127125. * Defines the loaded data length
  127126. */
  127127. readonly loaded: number;
  127128. /**
  127129. * Defines the data length to load
  127130. */
  127131. readonly total: number;
  127132. }
  127133. /**
  127134. * Interface used by SceneLoader plugins to define supported file extensions
  127135. */
  127136. export interface ISceneLoaderPluginExtensions {
  127137. /**
  127138. * Defines the list of supported extensions
  127139. */
  127140. [extension: string]: {
  127141. isBinary: boolean;
  127142. };
  127143. }
  127144. /**
  127145. * Interface used by SceneLoader plugin factory
  127146. */
  127147. export interface ISceneLoaderPluginFactory {
  127148. /**
  127149. * Defines the name of the factory
  127150. */
  127151. name: string;
  127152. /**
  127153. * Function called to create a new plugin
  127154. * @return the new plugin
  127155. */
  127156. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  127157. /**
  127158. * The callback that returns true if the data can be directly loaded.
  127159. * @param data string containing the file data
  127160. * @returns if the data can be loaded directly
  127161. */
  127162. canDirectLoad?(data: string): boolean;
  127163. }
  127164. /**
  127165. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  127166. */
  127167. export interface ISceneLoaderPluginBase {
  127168. /**
  127169. * The friendly name of this plugin.
  127170. */
  127171. name: string;
  127172. /**
  127173. * The file extensions supported by this plugin.
  127174. */
  127175. extensions: string | ISceneLoaderPluginExtensions;
  127176. /**
  127177. * The callback called when loading from a url.
  127178. * @param scene scene loading this url
  127179. * @param url url to load
  127180. * @param onSuccess callback called when the file successfully loads
  127181. * @param onProgress callback called while file is loading (if the server supports this mode)
  127182. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  127183. * @param onError callback called when the file fails to load
  127184. * @returns a file request object
  127185. */
  127186. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  127187. /**
  127188. * The callback called when loading from a file object.
  127189. * @param scene scene loading this file
  127190. * @param file defines the file to load
  127191. * @param onSuccess defines the callback to call when data is loaded
  127192. * @param onProgress defines the callback to call during loading process
  127193. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  127194. * @param onError defines the callback to call when an error occurs
  127195. * @returns a file request object
  127196. */
  127197. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  127198. /**
  127199. * The callback that returns true if the data can be directly loaded.
  127200. * @param data string containing the file data
  127201. * @returns if the data can be loaded directly
  127202. */
  127203. canDirectLoad?(data: string): boolean;
  127204. /**
  127205. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  127206. * @param scene scene loading this data
  127207. * @param data string containing the data
  127208. * @returns data to pass to the plugin
  127209. */
  127210. directLoad?(scene: Scene, data: string): any;
  127211. /**
  127212. * The callback that allows custom handling of the root url based on the response url.
  127213. * @param rootUrl the original root url
  127214. * @param responseURL the response url if available
  127215. * @returns the new root url
  127216. */
  127217. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  127218. }
  127219. /**
  127220. * Interface used to define a SceneLoader plugin
  127221. */
  127222. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  127223. /**
  127224. * Import meshes into a scene.
  127225. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127226. * @param scene The scene to import into
  127227. * @param data The data to import
  127228. * @param rootUrl The root url for scene and resources
  127229. * @param meshes The meshes array to import into
  127230. * @param particleSystems The particle systems array to import into
  127231. * @param skeletons The skeletons array to import into
  127232. * @param onError The callback when import fails
  127233. * @returns True if successful or false otherwise
  127234. */
  127235. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  127236. /**
  127237. * Load into a scene.
  127238. * @param scene The scene to load into
  127239. * @param data The data to import
  127240. * @param rootUrl The root url for scene and resources
  127241. * @param onError The callback when import fails
  127242. * @returns True if successful or false otherwise
  127243. */
  127244. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  127245. /**
  127246. * Load into an asset container.
  127247. * @param scene The scene to load into
  127248. * @param data The data to import
  127249. * @param rootUrl The root url for scene and resources
  127250. * @param onError The callback when import fails
  127251. * @returns The loaded asset container
  127252. */
  127253. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  127254. }
  127255. /**
  127256. * Interface used to define an async SceneLoader plugin
  127257. */
  127258. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  127259. /**
  127260. * Import meshes into a scene.
  127261. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127262. * @param scene The scene to import into
  127263. * @param data The data to import
  127264. * @param rootUrl The root url for scene and resources
  127265. * @param onProgress The callback when the load progresses
  127266. * @param fileName Defines the name of the file to load
  127267. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  127268. */
  127269. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  127270. meshes: AbstractMesh[];
  127271. particleSystems: IParticleSystem[];
  127272. skeletons: Skeleton[];
  127273. animationGroups: AnimationGroup[];
  127274. }>;
  127275. /**
  127276. * Load into a scene.
  127277. * @param scene The scene to load into
  127278. * @param data The data to import
  127279. * @param rootUrl The root url for scene and resources
  127280. * @param onProgress The callback when the load progresses
  127281. * @param fileName Defines the name of the file to load
  127282. * @returns Nothing
  127283. */
  127284. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  127285. /**
  127286. * Load into an asset container.
  127287. * @param scene The scene to load into
  127288. * @param data The data to import
  127289. * @param rootUrl The root url for scene and resources
  127290. * @param onProgress The callback when the load progresses
  127291. * @param fileName Defines the name of the file to load
  127292. * @returns The loaded asset container
  127293. */
  127294. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  127295. }
  127296. /**
  127297. * Mode that determines how to handle old animation groups before loading new ones.
  127298. */
  127299. export enum SceneLoaderAnimationGroupLoadingMode {
  127300. /**
  127301. * Reset all old animations to initial state then dispose them.
  127302. */
  127303. Clean = 0,
  127304. /**
  127305. * Stop all old animations.
  127306. */
  127307. Stop = 1,
  127308. /**
  127309. * Restart old animations from first frame.
  127310. */
  127311. Sync = 2,
  127312. /**
  127313. * Old animations remains untouched.
  127314. */
  127315. NoSync = 3
  127316. }
  127317. /**
  127318. * Defines a plugin registered by the SceneLoader
  127319. */
  127320. interface IRegisteredPlugin {
  127321. /**
  127322. * Defines the plugin to use
  127323. */
  127324. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  127325. /**
  127326. * Defines if the plugin supports binary data
  127327. */
  127328. isBinary: boolean;
  127329. }
  127330. /**
  127331. * Class used to load scene from various file formats using registered plugins
  127332. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  127333. */
  127334. export class SceneLoader {
  127335. /**
  127336. * No logging while loading
  127337. */
  127338. static readonly NO_LOGGING: number;
  127339. /**
  127340. * Minimal logging while loading
  127341. */
  127342. static readonly MINIMAL_LOGGING: number;
  127343. /**
  127344. * Summary logging while loading
  127345. */
  127346. static readonly SUMMARY_LOGGING: number;
  127347. /**
  127348. * Detailled logging while loading
  127349. */
  127350. static readonly DETAILED_LOGGING: number;
  127351. /**
  127352. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  127353. */
  127354. static get ForceFullSceneLoadingForIncremental(): boolean;
  127355. static set ForceFullSceneLoadingForIncremental(value: boolean);
  127356. /**
  127357. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  127358. */
  127359. static get ShowLoadingScreen(): boolean;
  127360. static set ShowLoadingScreen(value: boolean);
  127361. /**
  127362. * Defines the current logging level (while loading the scene)
  127363. * @ignorenaming
  127364. */
  127365. static get loggingLevel(): number;
  127366. static set loggingLevel(value: number);
  127367. /**
  127368. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  127369. */
  127370. static get CleanBoneMatrixWeights(): boolean;
  127371. static set CleanBoneMatrixWeights(value: boolean);
  127372. /**
  127373. * Event raised when a plugin is used to load a scene
  127374. */
  127375. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  127376. private static _registeredPlugins;
  127377. private static _showingLoadingScreen;
  127378. /**
  127379. * Gets the default plugin (used to load Babylon files)
  127380. * @returns the .babylon plugin
  127381. */
  127382. static GetDefaultPlugin(): IRegisteredPlugin;
  127383. private static _GetPluginForExtension;
  127384. private static _GetPluginForDirectLoad;
  127385. private static _GetPluginForFilename;
  127386. private static _GetDirectLoad;
  127387. private static _LoadData;
  127388. private static _GetFileInfo;
  127389. /**
  127390. * Gets a plugin that can load the given extension
  127391. * @param extension defines the extension to load
  127392. * @returns a plugin or null if none works
  127393. */
  127394. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  127395. /**
  127396. * Gets a boolean indicating that the given extension can be loaded
  127397. * @param extension defines the extension to load
  127398. * @returns true if the extension is supported
  127399. */
  127400. static IsPluginForExtensionAvailable(extension: string): boolean;
  127401. /**
  127402. * Adds a new plugin to the list of registered plugins
  127403. * @param plugin defines the plugin to add
  127404. */
  127405. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  127406. /**
  127407. * Import meshes into a scene
  127408. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127409. * @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)
  127410. * @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)
  127411. * @param scene the instance of BABYLON.Scene to append to
  127412. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  127413. * @param onProgress a callback with a progress event for each file being loaded
  127414. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127415. * @param pluginExtension the extension used to determine the plugin
  127416. * @returns The loaded plugin
  127417. */
  127418. 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>;
  127419. /**
  127420. * Import meshes into a scene
  127421. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127422. * @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)
  127423. * @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)
  127424. * @param scene the instance of BABYLON.Scene to append to
  127425. * @param onProgress a callback with a progress event for each file being loaded
  127426. * @param pluginExtension the extension used to determine the plugin
  127427. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  127428. */
  127429. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  127430. meshes: AbstractMesh[];
  127431. particleSystems: IParticleSystem[];
  127432. skeletons: Skeleton[];
  127433. animationGroups: AnimationGroup[];
  127434. }>;
  127435. /**
  127436. * Load a scene
  127437. * @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)
  127438. * @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)
  127439. * @param engine is the instance of BABYLON.Engine to use to create the scene
  127440. * @param onSuccess a callback with the scene when import succeeds
  127441. * @param onProgress a callback with a progress event for each file being loaded
  127442. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127443. * @param pluginExtension the extension used to determine the plugin
  127444. * @returns The loaded plugin
  127445. */
  127446. 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>;
  127447. /**
  127448. * Load a scene
  127449. * @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)
  127450. * @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)
  127451. * @param engine is the instance of BABYLON.Engine to use to create the scene
  127452. * @param onProgress a callback with a progress event for each file being loaded
  127453. * @param pluginExtension the extension used to determine the plugin
  127454. * @returns The loaded scene
  127455. */
  127456. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  127457. /**
  127458. * Append a scene
  127459. * @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)
  127460. * @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)
  127461. * @param scene is the instance of BABYLON.Scene to append to
  127462. * @param onSuccess a callback with the scene when import succeeds
  127463. * @param onProgress a callback with a progress event for each file being loaded
  127464. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127465. * @param pluginExtension the extension used to determine the plugin
  127466. * @returns The loaded plugin
  127467. */
  127468. 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>;
  127469. /**
  127470. * Append a scene
  127471. * @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)
  127472. * @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)
  127473. * @param scene is the instance of BABYLON.Scene to append to
  127474. * @param onProgress a callback with a progress event for each file being loaded
  127475. * @param pluginExtension the extension used to determine the plugin
  127476. * @returns The given scene
  127477. */
  127478. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  127479. /**
  127480. * Load a scene into an asset container
  127481. * @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)
  127482. * @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)
  127483. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127484. * @param onSuccess a callback with the scene when import succeeds
  127485. * @param onProgress a callback with a progress event for each file being loaded
  127486. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127487. * @param pluginExtension the extension used to determine the plugin
  127488. * @returns The loaded plugin
  127489. */
  127490. 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>;
  127491. /**
  127492. * Load a scene into an asset container
  127493. * @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)
  127494. * @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)
  127495. * @param scene is the instance of Scene to append to
  127496. * @param onProgress a callback with a progress event for each file being loaded
  127497. * @param pluginExtension the extension used to determine the plugin
  127498. * @returns The loaded asset container
  127499. */
  127500. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  127501. /**
  127502. * Import animations from a file into a scene
  127503. * @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)
  127504. * @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)
  127505. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127506. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  127507. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  127508. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  127509. * @param onSuccess a callback with the scene when import succeeds
  127510. * @param onProgress a callback with a progress event for each file being loaded
  127511. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127512. * @param pluginExtension the extension used to determine the plugin
  127513. */
  127514. 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;
  127515. /**
  127516. * Import animations from a file into a scene
  127517. * @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)
  127518. * @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)
  127519. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127520. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  127521. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  127522. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  127523. * @param onSuccess a callback with the scene when import succeeds
  127524. * @param onProgress a callback with a progress event for each file being loaded
  127525. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127526. * @param pluginExtension the extension used to determine the plugin
  127527. * @returns the updated scene with imported animations
  127528. */
  127529. 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>;
  127530. }
  127531. }
  127532. declare module BABYLON {
  127533. /**
  127534. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  127535. */
  127536. export type MotionControllerHandedness = "none" | "left" | "right";
  127537. /**
  127538. * The type of components available in motion controllers.
  127539. * This is not the name of the component.
  127540. */
  127541. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  127542. /**
  127543. * The state of a controller component
  127544. */
  127545. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  127546. /**
  127547. * The schema of motion controller layout.
  127548. * No object will be initialized using this interface
  127549. * This is used just to define the profile.
  127550. */
  127551. export interface IMotionControllerLayout {
  127552. /**
  127553. * Path to load the assets. Usually relative to the base path
  127554. */
  127555. assetPath: string;
  127556. /**
  127557. * Available components (unsorted)
  127558. */
  127559. components: {
  127560. /**
  127561. * A map of component Ids
  127562. */
  127563. [componentId: string]: {
  127564. /**
  127565. * The type of input the component outputs
  127566. */
  127567. type: MotionControllerComponentType;
  127568. /**
  127569. * The indices of this component in the gamepad object
  127570. */
  127571. gamepadIndices: {
  127572. /**
  127573. * Index of button
  127574. */
  127575. button?: number;
  127576. /**
  127577. * If available, index of x-axis
  127578. */
  127579. xAxis?: number;
  127580. /**
  127581. * If available, index of y-axis
  127582. */
  127583. yAxis?: number;
  127584. };
  127585. /**
  127586. * The mesh's root node name
  127587. */
  127588. rootNodeName: string;
  127589. /**
  127590. * Animation definitions for this model
  127591. */
  127592. visualResponses: {
  127593. [stateKey: string]: {
  127594. /**
  127595. * What property will be animated
  127596. */
  127597. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  127598. /**
  127599. * What states influence this visual response
  127600. */
  127601. states: MotionControllerComponentStateType[];
  127602. /**
  127603. * Type of animation - movement or visibility
  127604. */
  127605. valueNodeProperty: "transform" | "visibility";
  127606. /**
  127607. * Base node name to move. Its position will be calculated according to the min and max nodes
  127608. */
  127609. valueNodeName?: string;
  127610. /**
  127611. * Minimum movement node
  127612. */
  127613. minNodeName?: string;
  127614. /**
  127615. * Max movement node
  127616. */
  127617. maxNodeName?: string;
  127618. };
  127619. };
  127620. /**
  127621. * If touch enabled, what is the name of node to display user feedback
  127622. */
  127623. touchPointNodeName?: string;
  127624. };
  127625. };
  127626. /**
  127627. * Is it xr standard mapping or not
  127628. */
  127629. gamepadMapping: "" | "xr-standard";
  127630. /**
  127631. * Base root node of this entire model
  127632. */
  127633. rootNodeName: string;
  127634. /**
  127635. * Defines the main button component id
  127636. */
  127637. selectComponentId: string;
  127638. }
  127639. /**
  127640. * A definition for the layout map in the input profile
  127641. */
  127642. export interface IMotionControllerLayoutMap {
  127643. /**
  127644. * Layouts with handedness type as a key
  127645. */
  127646. [handedness: string]: IMotionControllerLayout;
  127647. }
  127648. /**
  127649. * The XR Input profile schema
  127650. * Profiles can be found here:
  127651. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  127652. */
  127653. export interface IMotionControllerProfile {
  127654. /**
  127655. * fallback profiles for this profileId
  127656. */
  127657. fallbackProfileIds: string[];
  127658. /**
  127659. * The layout map, with handedness as key
  127660. */
  127661. layouts: IMotionControllerLayoutMap;
  127662. /**
  127663. * The id of this profile
  127664. * correlates to the profile(s) in the xrInput.profiles array
  127665. */
  127666. profileId: string;
  127667. }
  127668. /**
  127669. * A helper-interface for the 3 meshes needed for controller button animation
  127670. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  127671. */
  127672. export interface IMotionControllerButtonMeshMap {
  127673. /**
  127674. * the mesh that defines the pressed value mesh position.
  127675. * This is used to find the max-position of this button
  127676. */
  127677. pressedMesh: AbstractMesh;
  127678. /**
  127679. * the mesh that defines the unpressed value mesh position.
  127680. * This is used to find the min (or initial) position of this button
  127681. */
  127682. unpressedMesh: AbstractMesh;
  127683. /**
  127684. * The mesh that will be changed when value changes
  127685. */
  127686. valueMesh: AbstractMesh;
  127687. }
  127688. /**
  127689. * A helper-interface for the 3 meshes needed for controller axis animation.
  127690. * This will be expanded when touchpad animations are fully supported
  127691. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  127692. */
  127693. export interface IMotionControllerMeshMap {
  127694. /**
  127695. * the mesh that defines the maximum value mesh position.
  127696. */
  127697. maxMesh?: AbstractMesh;
  127698. /**
  127699. * the mesh that defines the minimum value mesh position.
  127700. */
  127701. minMesh?: AbstractMesh;
  127702. /**
  127703. * The mesh that will be changed when axis value changes
  127704. */
  127705. valueMesh?: AbstractMesh;
  127706. }
  127707. /**
  127708. * The elements needed for change-detection of the gamepad objects in motion controllers
  127709. */
  127710. export interface IMinimalMotionControllerObject {
  127711. /**
  127712. * Available axes of this controller
  127713. */
  127714. axes: number[];
  127715. /**
  127716. * An array of available buttons
  127717. */
  127718. buttons: Array<{
  127719. /**
  127720. * Value of the button/trigger
  127721. */
  127722. value: number;
  127723. /**
  127724. * If the button/trigger is currently touched
  127725. */
  127726. touched: boolean;
  127727. /**
  127728. * If the button/trigger is currently pressed
  127729. */
  127730. pressed: boolean;
  127731. }>;
  127732. /**
  127733. * EXPERIMENTAL haptic support.
  127734. */
  127735. hapticActuators?: Array<{
  127736. pulse: (value: number, duration: number) => Promise<boolean>;
  127737. }>;
  127738. }
  127739. /**
  127740. * An Abstract Motion controller
  127741. * This class receives an xrInput and a profile layout and uses those to initialize the components
  127742. * Each component has an observable to check for changes in value and state
  127743. */
  127744. export abstract class WebXRAbstractMotionController implements IDisposable {
  127745. protected scene: Scene;
  127746. protected layout: IMotionControllerLayout;
  127747. /**
  127748. * The gamepad object correlating to this controller
  127749. */
  127750. gamepadObject: IMinimalMotionControllerObject;
  127751. /**
  127752. * handedness (left/right/none) of this controller
  127753. */
  127754. handedness: MotionControllerHandedness;
  127755. private _initComponent;
  127756. private _modelReady;
  127757. /**
  127758. * A map of components (WebXRControllerComponent) in this motion controller
  127759. * Components have a ComponentType and can also have both button and axis definitions
  127760. */
  127761. readonly components: {
  127762. [id: string]: WebXRControllerComponent;
  127763. };
  127764. /**
  127765. * Disable the model's animation. Can be set at any time.
  127766. */
  127767. disableAnimation: boolean;
  127768. /**
  127769. * Observers registered here will be triggered when the model of this controller is done loading
  127770. */
  127771. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  127772. /**
  127773. * The profile id of this motion controller
  127774. */
  127775. abstract profileId: string;
  127776. /**
  127777. * The root mesh of the model. It is null if the model was not yet initialized
  127778. */
  127779. rootMesh: Nullable<AbstractMesh>;
  127780. /**
  127781. * constructs a new abstract motion controller
  127782. * @param scene the scene to which the model of the controller will be added
  127783. * @param layout The profile layout to load
  127784. * @param gamepadObject The gamepad object correlating to this controller
  127785. * @param handedness handedness (left/right/none) of this controller
  127786. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  127787. */
  127788. constructor(scene: Scene, layout: IMotionControllerLayout,
  127789. /**
  127790. * The gamepad object correlating to this controller
  127791. */
  127792. gamepadObject: IMinimalMotionControllerObject,
  127793. /**
  127794. * handedness (left/right/none) of this controller
  127795. */
  127796. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  127797. /**
  127798. * Dispose this controller, the model mesh and all its components
  127799. */
  127800. dispose(): void;
  127801. /**
  127802. * Returns all components of specific type
  127803. * @param type the type to search for
  127804. * @return an array of components with this type
  127805. */
  127806. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  127807. /**
  127808. * get a component based an its component id as defined in layout.components
  127809. * @param id the id of the component
  127810. * @returns the component correlates to the id or undefined if not found
  127811. */
  127812. getComponent(id: string): WebXRControllerComponent;
  127813. /**
  127814. * Get the list of components available in this motion controller
  127815. * @returns an array of strings correlating to available components
  127816. */
  127817. getComponentIds(): string[];
  127818. /**
  127819. * Get the first component of specific type
  127820. * @param type type of component to find
  127821. * @return a controller component or null if not found
  127822. */
  127823. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  127824. /**
  127825. * Get the main (Select) component of this controller as defined in the layout
  127826. * @returns the main component of this controller
  127827. */
  127828. getMainComponent(): WebXRControllerComponent;
  127829. /**
  127830. * Loads the model correlating to this controller
  127831. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  127832. * @returns A promise fulfilled with the result of the model loading
  127833. */
  127834. loadModel(): Promise<boolean>;
  127835. /**
  127836. * Update this model using the current XRFrame
  127837. * @param xrFrame the current xr frame to use and update the model
  127838. */
  127839. updateFromXRFrame(xrFrame: XRFrame): void;
  127840. /**
  127841. * Backwards compatibility due to a deeply-integrated typo
  127842. */
  127843. get handness(): XREye;
  127844. /**
  127845. * Pulse (vibrate) this controller
  127846. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  127847. * Consecutive calls to this function will cancel the last pulse call
  127848. *
  127849. * @param value the strength of the pulse in 0.0...1.0 range
  127850. * @param duration Duration of the pulse in milliseconds
  127851. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  127852. * @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
  127853. */
  127854. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  127855. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  127856. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  127857. /**
  127858. * Moves the axis on the controller mesh based on its current state
  127859. * @param axis the index of the axis
  127860. * @param axisValue the value of the axis which determines the meshes new position
  127861. * @hidden
  127862. */
  127863. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  127864. /**
  127865. * Update the model itself with the current frame data
  127866. * @param xrFrame the frame to use for updating the model mesh
  127867. */
  127868. protected updateModel(xrFrame: XRFrame): void;
  127869. /**
  127870. * Get the filename and path for this controller's model
  127871. * @returns a map of filename and path
  127872. */
  127873. protected abstract _getFilenameAndPath(): {
  127874. filename: string;
  127875. path: string;
  127876. };
  127877. /**
  127878. * This function is called before the mesh is loaded. It checks for loading constraints.
  127879. * For example, this function can check if the GLB loader is available
  127880. * If this function returns false, the generic controller will be loaded instead
  127881. * @returns Is the client ready to load the mesh
  127882. */
  127883. protected abstract _getModelLoadingConstraints(): boolean;
  127884. /**
  127885. * This function will be called after the model was successfully loaded and can be used
  127886. * for mesh transformations before it is available for the user
  127887. * @param meshes the loaded meshes
  127888. */
  127889. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  127890. /**
  127891. * Set the root mesh for this controller. Important for the WebXR controller class
  127892. * @param meshes the loaded meshes
  127893. */
  127894. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  127895. /**
  127896. * A function executed each frame that updates the mesh (if needed)
  127897. * @param xrFrame the current xrFrame
  127898. */
  127899. protected abstract _updateModel(xrFrame: XRFrame): void;
  127900. private _getGenericFilenameAndPath;
  127901. private _getGenericParentMesh;
  127902. }
  127903. }
  127904. declare module BABYLON {
  127905. /**
  127906. * A generic trigger-only motion controller for WebXR
  127907. */
  127908. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  127909. /**
  127910. * Static version of the profile id of this controller
  127911. */
  127912. static ProfileId: string;
  127913. profileId: string;
  127914. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  127915. protected _getFilenameAndPath(): {
  127916. filename: string;
  127917. path: string;
  127918. };
  127919. protected _getModelLoadingConstraints(): boolean;
  127920. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  127921. protected _setRootMesh(meshes: AbstractMesh[]): void;
  127922. protected _updateModel(): void;
  127923. }
  127924. }
  127925. declare module BABYLON {
  127926. /**
  127927. * Class containing static functions to help procedurally build meshes
  127928. */
  127929. export class SphereBuilder {
  127930. /**
  127931. * Creates a sphere mesh
  127932. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  127933. * * 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`)
  127934. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  127935. * * 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
  127936. * * 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)
  127937. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  127938. * * 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
  127939. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  127940. * @param name defines the name of the mesh
  127941. * @param options defines the options used to create the mesh
  127942. * @param scene defines the hosting scene
  127943. * @returns the sphere mesh
  127944. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  127945. */
  127946. static CreateSphere(name: string, options: {
  127947. segments?: number;
  127948. diameter?: number;
  127949. diameterX?: number;
  127950. diameterY?: number;
  127951. diameterZ?: number;
  127952. arc?: number;
  127953. slice?: number;
  127954. sideOrientation?: number;
  127955. frontUVs?: Vector4;
  127956. backUVs?: Vector4;
  127957. updatable?: boolean;
  127958. }, scene?: Nullable<Scene>): Mesh;
  127959. }
  127960. }
  127961. declare module BABYLON {
  127962. /**
  127963. * A profiled motion controller has its profile loaded from an online repository.
  127964. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  127965. */
  127966. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  127967. private _repositoryUrl;
  127968. private _buttonMeshMapping;
  127969. private _touchDots;
  127970. /**
  127971. * The profile ID of this controller. Will be populated when the controller initializes.
  127972. */
  127973. profileId: string;
  127974. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  127975. dispose(): void;
  127976. protected _getFilenameAndPath(): {
  127977. filename: string;
  127978. path: string;
  127979. };
  127980. protected _getModelLoadingConstraints(): boolean;
  127981. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  127982. protected _setRootMesh(meshes: AbstractMesh[]): void;
  127983. protected _updateModel(_xrFrame: XRFrame): void;
  127984. }
  127985. }
  127986. declare module BABYLON {
  127987. /**
  127988. * A construction function type to create a new controller based on an xrInput object
  127989. */
  127990. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  127991. /**
  127992. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  127993. *
  127994. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  127995. * it should be replaced with auto-loaded controllers.
  127996. *
  127997. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  127998. */
  127999. export class WebXRMotionControllerManager {
  128000. private static _AvailableControllers;
  128001. private static _Fallbacks;
  128002. private static _ProfileLoadingPromises;
  128003. private static _ProfilesList;
  128004. /**
  128005. * The base URL of the online controller repository. Can be changed at any time.
  128006. */
  128007. static BaseRepositoryUrl: string;
  128008. /**
  128009. * Which repository gets priority - local or online
  128010. */
  128011. static PrioritizeOnlineRepository: boolean;
  128012. /**
  128013. * Use the online repository, or use only locally-defined controllers
  128014. */
  128015. static UseOnlineRepository: boolean;
  128016. /**
  128017. * Clear the cache used for profile loading and reload when requested again
  128018. */
  128019. static ClearProfilesCache(): void;
  128020. /**
  128021. * Register the default fallbacks.
  128022. * This function is called automatically when this file is imported.
  128023. */
  128024. static DefaultFallbacks(): void;
  128025. /**
  128026. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  128027. * @param profileId the profile to which a fallback needs to be found
  128028. * @return an array with corresponding fallback profiles
  128029. */
  128030. static FindFallbackWithProfileId(profileId: string): string[];
  128031. /**
  128032. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  128033. * The order of search:
  128034. *
  128035. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  128036. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  128037. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  128038. * 4) return the generic trigger controller if none were found
  128039. *
  128040. * @param xrInput the xrInput to which a new controller is initialized
  128041. * @param scene the scene to which the model will be added
  128042. * @param forceProfile force a certain profile for this controller
  128043. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  128044. */
  128045. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  128046. /**
  128047. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  128048. *
  128049. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  128050. *
  128051. * @param type the profile type to register
  128052. * @param constructFunction the function to be called when loading this profile
  128053. */
  128054. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  128055. /**
  128056. * Register a fallback to a specific profile.
  128057. * @param profileId the profileId that will receive the fallbacks
  128058. * @param fallbacks A list of fallback profiles
  128059. */
  128060. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  128061. /**
  128062. * Will update the list of profiles available in the repository
  128063. * @return a promise that resolves to a map of profiles available online
  128064. */
  128065. static UpdateProfilesList(): Promise<{
  128066. [profile: string]: string;
  128067. }>;
  128068. private static _LoadProfileFromRepository;
  128069. private static _LoadProfilesFromAvailableControllers;
  128070. }
  128071. }
  128072. declare module BABYLON {
  128073. /**
  128074. * Configuration options for the WebXR controller creation
  128075. */
  128076. export interface IWebXRControllerOptions {
  128077. /**
  128078. * Should the controller mesh be animated when a user interacts with it
  128079. * The pressed buttons / thumbstick and touchpad animations will be disabled
  128080. */
  128081. disableMotionControllerAnimation?: boolean;
  128082. /**
  128083. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  128084. */
  128085. doNotLoadControllerMesh?: boolean;
  128086. /**
  128087. * Force a specific controller type for this controller.
  128088. * This can be used when creating your own profile or when testing different controllers
  128089. */
  128090. forceControllerProfile?: string;
  128091. /**
  128092. * Defines a rendering group ID for meshes that will be loaded.
  128093. * This is for the default controllers only.
  128094. */
  128095. renderingGroupId?: number;
  128096. }
  128097. /**
  128098. * Represents an XR controller
  128099. */
  128100. export class WebXRInputSource {
  128101. private _scene;
  128102. /** The underlying input source for the controller */
  128103. inputSource: XRInputSource;
  128104. private _options;
  128105. private _tmpVector;
  128106. private _uniqueId;
  128107. private _disposed;
  128108. /**
  128109. * 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
  128110. */
  128111. grip?: AbstractMesh;
  128112. /**
  128113. * If available, this is the gamepad object related to this controller.
  128114. * Using this object it is possible to get click events and trackpad changes of the
  128115. * webxr controller that is currently being used.
  128116. */
  128117. motionController?: WebXRAbstractMotionController;
  128118. /**
  128119. * Event that fires when the controller is removed/disposed.
  128120. * The object provided as event data is this controller, after associated assets were disposed.
  128121. * uniqueId is still available.
  128122. */
  128123. onDisposeObservable: Observable<WebXRInputSource>;
  128124. /**
  128125. * Will be triggered when the mesh associated with the motion controller is done loading.
  128126. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  128127. * A shortened version of controller -> motion controller -> on mesh loaded.
  128128. */
  128129. onMeshLoadedObservable: Observable<AbstractMesh>;
  128130. /**
  128131. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  128132. */
  128133. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  128134. /**
  128135. * Pointer which can be used to select objects or attach a visible laser to
  128136. */
  128137. pointer: AbstractMesh;
  128138. /**
  128139. * Creates the input source object
  128140. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  128141. * @param _scene the scene which the controller should be associated to
  128142. * @param inputSource the underlying input source for the controller
  128143. * @param _options options for this controller creation
  128144. */
  128145. constructor(_scene: Scene,
  128146. /** The underlying input source for the controller */
  128147. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  128148. /**
  128149. * Get this controllers unique id
  128150. */
  128151. get uniqueId(): string;
  128152. /**
  128153. * Disposes of the object
  128154. */
  128155. dispose(): void;
  128156. /**
  128157. * Gets a world space ray coming from the pointer or grip
  128158. * @param result the resulting ray
  128159. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  128160. */
  128161. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  128162. /**
  128163. * Updates the controller pose based on the given XRFrame
  128164. * @param xrFrame xr frame to update the pose with
  128165. * @param referenceSpace reference space to use
  128166. */
  128167. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  128168. }
  128169. }
  128170. declare module BABYLON {
  128171. /**
  128172. * The schema for initialization options of the XR Input class
  128173. */
  128174. export interface IWebXRInputOptions {
  128175. /**
  128176. * If set to true no model will be automatically loaded
  128177. */
  128178. doNotLoadControllerMeshes?: boolean;
  128179. /**
  128180. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  128181. * If not found, the xr input profile data will be used.
  128182. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  128183. */
  128184. forceInputProfile?: string;
  128185. /**
  128186. * Do not send a request to the controller repository to load the profile.
  128187. *
  128188. * Instead, use the controllers available in babylon itself.
  128189. */
  128190. disableOnlineControllerRepository?: boolean;
  128191. /**
  128192. * A custom URL for the controllers repository
  128193. */
  128194. customControllersRepositoryURL?: string;
  128195. /**
  128196. * Should the controller model's components not move according to the user input
  128197. */
  128198. disableControllerAnimation?: boolean;
  128199. /**
  128200. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  128201. */
  128202. controllerOptions?: IWebXRControllerOptions;
  128203. }
  128204. /**
  128205. * XR input used to track XR inputs such as controllers/rays
  128206. */
  128207. export class WebXRInput implements IDisposable {
  128208. /**
  128209. * the xr session manager for this session
  128210. */
  128211. xrSessionManager: WebXRSessionManager;
  128212. /**
  128213. * the WebXR camera for this session. Mainly used for teleportation
  128214. */
  128215. xrCamera: WebXRCamera;
  128216. private readonly options;
  128217. /**
  128218. * XR controllers being tracked
  128219. */
  128220. controllers: Array<WebXRInputSource>;
  128221. private _frameObserver;
  128222. private _sessionEndedObserver;
  128223. private _sessionInitObserver;
  128224. /**
  128225. * Event when a controller has been connected/added
  128226. */
  128227. onControllerAddedObservable: Observable<WebXRInputSource>;
  128228. /**
  128229. * Event when a controller has been removed/disconnected
  128230. */
  128231. onControllerRemovedObservable: Observable<WebXRInputSource>;
  128232. /**
  128233. * Initializes the WebXRInput
  128234. * @param xrSessionManager the xr session manager for this session
  128235. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  128236. * @param options = initialization options for this xr input
  128237. */
  128238. constructor(
  128239. /**
  128240. * the xr session manager for this session
  128241. */
  128242. xrSessionManager: WebXRSessionManager,
  128243. /**
  128244. * the WebXR camera for this session. Mainly used for teleportation
  128245. */
  128246. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  128247. private _onInputSourcesChange;
  128248. private _addAndRemoveControllers;
  128249. /**
  128250. * Disposes of the object
  128251. */
  128252. dispose(): void;
  128253. }
  128254. }
  128255. declare module BABYLON {
  128256. /**
  128257. * This is the base class for all WebXR features.
  128258. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  128259. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  128260. */
  128261. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  128262. protected _xrSessionManager: WebXRSessionManager;
  128263. private _attached;
  128264. private _removeOnDetach;
  128265. /**
  128266. * Should auto-attach be disabled?
  128267. */
  128268. disableAutoAttach: boolean;
  128269. /**
  128270. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  128271. */
  128272. xrNativeFeatureName: string;
  128273. /**
  128274. * Construct a new (abstract) WebXR feature
  128275. * @param _xrSessionManager the xr session manager for this feature
  128276. */
  128277. constructor(_xrSessionManager: WebXRSessionManager);
  128278. /**
  128279. * Is this feature attached
  128280. */
  128281. get attached(): boolean;
  128282. /**
  128283. * attach this feature
  128284. *
  128285. * @param force should attachment be forced (even when already attached)
  128286. * @returns true if successful, false is failed or already attached
  128287. */
  128288. attach(force?: boolean): boolean;
  128289. /**
  128290. * detach this feature.
  128291. *
  128292. * @returns true if successful, false if failed or already detached
  128293. */
  128294. detach(): boolean;
  128295. /**
  128296. * Dispose this feature and all of the resources attached
  128297. */
  128298. dispose(): void;
  128299. /**
  128300. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  128301. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  128302. *
  128303. * @returns whether or not the feature is compatible in this environment
  128304. */
  128305. isCompatible(): boolean;
  128306. /**
  128307. * This is used to register callbacks that will automatically be removed when detach is called.
  128308. * @param observable the observable to which the observer will be attached
  128309. * @param callback the callback to register
  128310. */
  128311. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  128312. /**
  128313. * Code in this function will be executed on each xrFrame received from the browser.
  128314. * This function will not execute after the feature is detached.
  128315. * @param _xrFrame the current frame
  128316. */
  128317. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  128318. }
  128319. }
  128320. declare module BABYLON {
  128321. /**
  128322. * Renders a layer on top of an existing scene
  128323. */
  128324. export class UtilityLayerRenderer implements IDisposable {
  128325. /** the original scene that will be rendered on top of */
  128326. originalScene: Scene;
  128327. private _pointerCaptures;
  128328. private _lastPointerEvents;
  128329. private static _DefaultUtilityLayer;
  128330. private static _DefaultKeepDepthUtilityLayer;
  128331. private _sharedGizmoLight;
  128332. private _renderCamera;
  128333. /**
  128334. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  128335. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  128336. * @returns the camera that is used when rendering the utility layer
  128337. */
  128338. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  128339. /**
  128340. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  128341. * @param cam the camera that should be used when rendering the utility layer
  128342. */
  128343. setRenderCamera(cam: Nullable<Camera>): void;
  128344. /**
  128345. * @hidden
  128346. * Light which used by gizmos to get light shading
  128347. */
  128348. _getSharedGizmoLight(): HemisphericLight;
  128349. /**
  128350. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  128351. */
  128352. pickUtilitySceneFirst: boolean;
  128353. /**
  128354. * 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)
  128355. */
  128356. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  128357. /**
  128358. * 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)
  128359. */
  128360. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  128361. /**
  128362. * The scene that is rendered on top of the original scene
  128363. */
  128364. utilityLayerScene: Scene;
  128365. /**
  128366. * If the utility layer should automatically be rendered on top of existing scene
  128367. */
  128368. shouldRender: boolean;
  128369. /**
  128370. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  128371. */
  128372. onlyCheckPointerDownEvents: boolean;
  128373. /**
  128374. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  128375. */
  128376. processAllEvents: boolean;
  128377. /**
  128378. * Observable raised when the pointer move from the utility layer scene to the main scene
  128379. */
  128380. onPointerOutObservable: Observable<number>;
  128381. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  128382. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  128383. private _afterRenderObserver;
  128384. private _sceneDisposeObserver;
  128385. private _originalPointerObserver;
  128386. /**
  128387. * Instantiates a UtilityLayerRenderer
  128388. * @param originalScene the original scene that will be rendered on top of
  128389. * @param handleEvents boolean indicating if the utility layer should handle events
  128390. */
  128391. constructor(
  128392. /** the original scene that will be rendered on top of */
  128393. originalScene: Scene, handleEvents?: boolean);
  128394. private _notifyObservers;
  128395. /**
  128396. * Renders the utility layers scene on top of the original scene
  128397. */
  128398. render(): void;
  128399. /**
  128400. * Disposes of the renderer
  128401. */
  128402. dispose(): void;
  128403. private _updateCamera;
  128404. }
  128405. }
  128406. declare module BABYLON {
  128407. /**
  128408. * Options interface for the pointer selection module
  128409. */
  128410. export interface IWebXRControllerPointerSelectionOptions {
  128411. /**
  128412. * if provided, this scene will be used to render meshes.
  128413. */
  128414. customUtilityLayerScene?: Scene;
  128415. /**
  128416. * 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)
  128417. * If not disabled, the last picked point will be used to execute a pointer up event
  128418. * If disabled, pointer up event will be triggered right after the pointer down event.
  128419. * Used in screen and gaze target ray mode only
  128420. */
  128421. disablePointerUpOnTouchOut: boolean;
  128422. /**
  128423. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  128424. */
  128425. forceGazeMode: boolean;
  128426. /**
  128427. * 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
  128428. * to start a new countdown to the pointer down event.
  128429. * Defaults to 1.
  128430. */
  128431. gazeModePointerMovedFactor?: number;
  128432. /**
  128433. * Different button type to use instead of the main component
  128434. */
  128435. overrideButtonId?: string;
  128436. /**
  128437. * use this rendering group id for the meshes (optional)
  128438. */
  128439. renderingGroupId?: number;
  128440. /**
  128441. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  128442. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  128443. * 3000 means 3 seconds between pointing at something and selecting it
  128444. */
  128445. timeToSelect?: number;
  128446. /**
  128447. * Should meshes created here be added to a utility layer or the main scene
  128448. */
  128449. useUtilityLayer?: boolean;
  128450. /**
  128451. * Optional WebXR camera to be used for gaze selection
  128452. */
  128453. gazeCamera?: WebXRCamera;
  128454. /**
  128455. * the xr input to use with this pointer selection
  128456. */
  128457. xrInput: WebXRInput;
  128458. }
  128459. /**
  128460. * A module that will enable pointer selection for motion controllers of XR Input Sources
  128461. */
  128462. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  128463. private readonly _options;
  128464. private static _idCounter;
  128465. private _attachController;
  128466. private _controllers;
  128467. private _scene;
  128468. private _tmpVectorForPickCompare;
  128469. /**
  128470. * The module's name
  128471. */
  128472. static readonly Name: string;
  128473. /**
  128474. * The (Babylon) version of this module.
  128475. * This is an integer representing the implementation version.
  128476. * This number does not correspond to the WebXR specs version
  128477. */
  128478. static readonly Version: number;
  128479. /**
  128480. * Disable lighting on the laser pointer (so it will always be visible)
  128481. */
  128482. disablePointerLighting: boolean;
  128483. /**
  128484. * Disable lighting on the selection mesh (so it will always be visible)
  128485. */
  128486. disableSelectionMeshLighting: boolean;
  128487. /**
  128488. * Should the laser pointer be displayed
  128489. */
  128490. displayLaserPointer: boolean;
  128491. /**
  128492. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  128493. */
  128494. displaySelectionMesh: boolean;
  128495. /**
  128496. * This color will be set to the laser pointer when selection is triggered
  128497. */
  128498. laserPointerPickedColor: Color3;
  128499. /**
  128500. * Default color of the laser pointer
  128501. */
  128502. laserPointerDefaultColor: Color3;
  128503. /**
  128504. * default color of the selection ring
  128505. */
  128506. selectionMeshDefaultColor: Color3;
  128507. /**
  128508. * This color will be applied to the selection ring when selection is triggered
  128509. */
  128510. selectionMeshPickedColor: Color3;
  128511. /**
  128512. * Optional filter to be used for ray selection. This predicate shares behavior with
  128513. * scene.pointerMovePredicate which takes priority if it is also assigned.
  128514. */
  128515. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  128516. /**
  128517. * constructs a new background remover module
  128518. * @param _xrSessionManager the session manager for this module
  128519. * @param _options read-only options to be used in this module
  128520. */
  128521. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  128522. /**
  128523. * attach this feature
  128524. * Will usually be called by the features manager
  128525. *
  128526. * @returns true if successful.
  128527. */
  128528. attach(): boolean;
  128529. /**
  128530. * detach this feature.
  128531. * Will usually be called by the features manager
  128532. *
  128533. * @returns true if successful.
  128534. */
  128535. detach(): boolean;
  128536. /**
  128537. * Will get the mesh under a specific pointer.
  128538. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  128539. * @param controllerId the controllerId to check
  128540. * @returns The mesh under pointer or null if no mesh is under the pointer
  128541. */
  128542. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  128543. /**
  128544. * Get the xr controller that correlates to the pointer id in the pointer event
  128545. *
  128546. * @param id the pointer id to search for
  128547. * @returns the controller that correlates to this id or null if not found
  128548. */
  128549. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  128550. protected _onXRFrame(_xrFrame: XRFrame): void;
  128551. private _attachGazeMode;
  128552. private _attachScreenRayMode;
  128553. private _attachTrackedPointerRayMode;
  128554. private _convertNormalToDirectionOfRay;
  128555. private _detachController;
  128556. private _generateNewMeshPair;
  128557. private _pickingMoved;
  128558. private _updatePointerDistance;
  128559. /** @hidden */
  128560. get lasterPointerDefaultColor(): Color3;
  128561. }
  128562. }
  128563. declare module BABYLON {
  128564. /**
  128565. * Button which can be used to enter a different mode of XR
  128566. */
  128567. export class WebXREnterExitUIButton {
  128568. /** button element */
  128569. element: HTMLElement;
  128570. /** XR initialization options for the button */
  128571. sessionMode: XRSessionMode;
  128572. /** Reference space type */
  128573. referenceSpaceType: XRReferenceSpaceType;
  128574. /**
  128575. * Creates a WebXREnterExitUIButton
  128576. * @param element button element
  128577. * @param sessionMode XR initialization session mode
  128578. * @param referenceSpaceType the type of reference space to be used
  128579. */
  128580. constructor(
  128581. /** button element */
  128582. element: HTMLElement,
  128583. /** XR initialization options for the button */
  128584. sessionMode: XRSessionMode,
  128585. /** Reference space type */
  128586. referenceSpaceType: XRReferenceSpaceType);
  128587. /**
  128588. * Extendable function which can be used to update the button's visuals when the state changes
  128589. * @param activeButton the current active button in the UI
  128590. */
  128591. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  128592. }
  128593. /**
  128594. * Options to create the webXR UI
  128595. */
  128596. export class WebXREnterExitUIOptions {
  128597. /**
  128598. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  128599. */
  128600. customButtons?: Array<WebXREnterExitUIButton>;
  128601. /**
  128602. * A reference space type to use when creating the default button.
  128603. * Default is local-floor
  128604. */
  128605. referenceSpaceType?: XRReferenceSpaceType;
  128606. /**
  128607. * Context to enter xr with
  128608. */
  128609. renderTarget?: Nullable<WebXRRenderTarget>;
  128610. /**
  128611. * A session mode to use when creating the default button.
  128612. * Default is immersive-vr
  128613. */
  128614. sessionMode?: XRSessionMode;
  128615. /**
  128616. * A list of optional features to init the session with
  128617. */
  128618. optionalFeatures?: string[];
  128619. /**
  128620. * A list of optional features to init the session with
  128621. */
  128622. requiredFeatures?: string[];
  128623. }
  128624. /**
  128625. * UI to allow the user to enter/exit XR mode
  128626. */
  128627. export class WebXREnterExitUI implements IDisposable {
  128628. private scene;
  128629. /** version of the options passed to this UI */
  128630. options: WebXREnterExitUIOptions;
  128631. private _activeButton;
  128632. private _buttons;
  128633. /**
  128634. * The HTML Div Element to which buttons are added.
  128635. */
  128636. readonly overlay: HTMLDivElement;
  128637. /**
  128638. * Fired every time the active button is changed.
  128639. *
  128640. * When xr is entered via a button that launches xr that button will be the callback parameter
  128641. *
  128642. * When exiting xr the callback parameter will be null)
  128643. */
  128644. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  128645. /**
  128646. *
  128647. * @param scene babylon scene object to use
  128648. * @param options (read-only) version of the options passed to this UI
  128649. */
  128650. private constructor();
  128651. /**
  128652. * Creates UI to allow the user to enter/exit XR mode
  128653. * @param scene the scene to add the ui to
  128654. * @param helper the xr experience helper to enter/exit xr with
  128655. * @param options options to configure the UI
  128656. * @returns the created ui
  128657. */
  128658. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  128659. /**
  128660. * Disposes of the XR UI component
  128661. */
  128662. dispose(): void;
  128663. private _updateButtons;
  128664. }
  128665. }
  128666. declare module BABYLON {
  128667. /**
  128668. * Class containing static functions to help procedurally build meshes
  128669. */
  128670. export class LinesBuilder {
  128671. /**
  128672. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  128673. * * 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
  128674. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  128675. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  128676. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  128677. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  128678. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  128679. * * 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
  128680. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  128681. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128682. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  128683. * @param name defines the name of the new line system
  128684. * @param options defines the options used to create the line system
  128685. * @param scene defines the hosting scene
  128686. * @returns a new line system mesh
  128687. */
  128688. static CreateLineSystem(name: string, options: {
  128689. lines: Vector3[][];
  128690. updatable?: boolean;
  128691. instance?: Nullable<LinesMesh>;
  128692. colors?: Nullable<Color4[][]>;
  128693. useVertexAlpha?: boolean;
  128694. }, scene: Nullable<Scene>): LinesMesh;
  128695. /**
  128696. * Creates a line mesh
  128697. * 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
  128698. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  128699. * * The parameter `points` is an array successive Vector3
  128700. * * 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
  128701. * * The optional parameter `colors` is an array of successive Color4, one per line point
  128702. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  128703. * * When updating an instance, remember that only point positions can change, not the number of points
  128704. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128705. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  128706. * @param name defines the name of the new line system
  128707. * @param options defines the options used to create the line system
  128708. * @param scene defines the hosting scene
  128709. * @returns a new line mesh
  128710. */
  128711. static CreateLines(name: string, options: {
  128712. points: Vector3[];
  128713. updatable?: boolean;
  128714. instance?: Nullable<LinesMesh>;
  128715. colors?: Color4[];
  128716. useVertexAlpha?: boolean;
  128717. }, scene?: Nullable<Scene>): LinesMesh;
  128718. /**
  128719. * Creates a dashed line mesh
  128720. * * 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
  128721. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  128722. * * The parameter `points` is an array successive Vector3
  128723. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  128724. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  128725. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  128726. * * 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
  128727. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  128728. * * When updating an instance, remember that only point positions can change, not the number of points
  128729. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128730. * @param name defines the name of the mesh
  128731. * @param options defines the options used to create the mesh
  128732. * @param scene defines the hosting scene
  128733. * @returns the dashed line mesh
  128734. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  128735. */
  128736. static CreateDashedLines(name: string, options: {
  128737. points: Vector3[];
  128738. dashSize?: number;
  128739. gapSize?: number;
  128740. dashNb?: number;
  128741. updatable?: boolean;
  128742. instance?: LinesMesh;
  128743. useVertexAlpha?: boolean;
  128744. }, scene?: Nullable<Scene>): LinesMesh;
  128745. }
  128746. }
  128747. declare module BABYLON {
  128748. /**
  128749. * Construction options for a timer
  128750. */
  128751. export interface ITimerOptions<T> {
  128752. /**
  128753. * Time-to-end
  128754. */
  128755. timeout: number;
  128756. /**
  128757. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  128758. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  128759. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  128760. */
  128761. contextObservable: Observable<T>;
  128762. /**
  128763. * Optional parameters when adding an observer to the observable
  128764. */
  128765. observableParameters?: {
  128766. mask?: number;
  128767. insertFirst?: boolean;
  128768. scope?: any;
  128769. };
  128770. /**
  128771. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  128772. */
  128773. breakCondition?: (data?: ITimerData<T>) => boolean;
  128774. /**
  128775. * Will be triggered when the time condition has met
  128776. */
  128777. onEnded?: (data: ITimerData<any>) => void;
  128778. /**
  128779. * Will be triggered when the break condition has met (prematurely ended)
  128780. */
  128781. onAborted?: (data: ITimerData<any>) => void;
  128782. /**
  128783. * Optional function to execute on each tick (or count)
  128784. */
  128785. onTick?: (data: ITimerData<any>) => void;
  128786. }
  128787. /**
  128788. * An interface defining the data sent by the timer
  128789. */
  128790. export interface ITimerData<T> {
  128791. /**
  128792. * When did it start
  128793. */
  128794. startTime: number;
  128795. /**
  128796. * Time now
  128797. */
  128798. currentTime: number;
  128799. /**
  128800. * Time passed since started
  128801. */
  128802. deltaTime: number;
  128803. /**
  128804. * How much is completed, in [0.0...1.0].
  128805. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  128806. */
  128807. completeRate: number;
  128808. /**
  128809. * What the registered observable sent in the last count
  128810. */
  128811. payload: T;
  128812. }
  128813. /**
  128814. * The current state of the timer
  128815. */
  128816. export enum TimerState {
  128817. /**
  128818. * Timer initialized, not yet started
  128819. */
  128820. INIT = 0,
  128821. /**
  128822. * Timer started and counting
  128823. */
  128824. STARTED = 1,
  128825. /**
  128826. * Timer ended (whether aborted or time reached)
  128827. */
  128828. ENDED = 2
  128829. }
  128830. /**
  128831. * A simple version of the timer. Will take options and start the timer immediately after calling it
  128832. *
  128833. * @param options options with which to initialize this timer
  128834. */
  128835. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  128836. /**
  128837. * An advanced implementation of a timer class
  128838. */
  128839. export class AdvancedTimer<T = any> implements IDisposable {
  128840. /**
  128841. * Will notify each time the timer calculates the remaining time
  128842. */
  128843. onEachCountObservable: Observable<ITimerData<T>>;
  128844. /**
  128845. * Will trigger when the timer was aborted due to the break condition
  128846. */
  128847. onTimerAbortedObservable: Observable<ITimerData<T>>;
  128848. /**
  128849. * Will trigger when the timer ended successfully
  128850. */
  128851. onTimerEndedObservable: Observable<ITimerData<T>>;
  128852. /**
  128853. * Will trigger when the timer state has changed
  128854. */
  128855. onStateChangedObservable: Observable<TimerState>;
  128856. private _observer;
  128857. private _contextObservable;
  128858. private _observableParameters;
  128859. private _startTime;
  128860. private _timer;
  128861. private _state;
  128862. private _breakCondition;
  128863. private _timeToEnd;
  128864. private _breakOnNextTick;
  128865. /**
  128866. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  128867. * @param options construction options for this advanced timer
  128868. */
  128869. constructor(options: ITimerOptions<T>);
  128870. /**
  128871. * set a breaking condition for this timer. Default is to never break during count
  128872. * @param predicate the new break condition. Returns true to break, false otherwise
  128873. */
  128874. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  128875. /**
  128876. * Reset ALL associated observables in this advanced timer
  128877. */
  128878. clearObservables(): void;
  128879. /**
  128880. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  128881. *
  128882. * @param timeToEnd how much time to measure until timer ended
  128883. */
  128884. start(timeToEnd?: number): void;
  128885. /**
  128886. * Will force a stop on the next tick.
  128887. */
  128888. stop(): void;
  128889. /**
  128890. * Dispose this timer, clearing all resources
  128891. */
  128892. dispose(): void;
  128893. private _setState;
  128894. private _tick;
  128895. private _stop;
  128896. }
  128897. }
  128898. declare module BABYLON {
  128899. /**
  128900. * The options container for the teleportation module
  128901. */
  128902. export interface IWebXRTeleportationOptions {
  128903. /**
  128904. * if provided, this scene will be used to render meshes.
  128905. */
  128906. customUtilityLayerScene?: Scene;
  128907. /**
  128908. * Values to configure the default target mesh
  128909. */
  128910. defaultTargetMeshOptions?: {
  128911. /**
  128912. * Fill color of the teleportation area
  128913. */
  128914. teleportationFillColor?: string;
  128915. /**
  128916. * Border color for the teleportation area
  128917. */
  128918. teleportationBorderColor?: string;
  128919. /**
  128920. * Disable the mesh's animation sequence
  128921. */
  128922. disableAnimation?: boolean;
  128923. /**
  128924. * Disable lighting on the material or the ring and arrow
  128925. */
  128926. disableLighting?: boolean;
  128927. /**
  128928. * Override the default material of the torus and arrow
  128929. */
  128930. torusArrowMaterial?: Material;
  128931. };
  128932. /**
  128933. * A list of meshes to use as floor meshes.
  128934. * Meshes can be added and removed after initializing the feature using the
  128935. * addFloorMesh and removeFloorMesh functions
  128936. * If empty, rotation will still work
  128937. */
  128938. floorMeshes?: AbstractMesh[];
  128939. /**
  128940. * use this rendering group id for the meshes (optional)
  128941. */
  128942. renderingGroupId?: number;
  128943. /**
  128944. * Should teleportation move only to snap points
  128945. */
  128946. snapPointsOnly?: boolean;
  128947. /**
  128948. * An array of points to which the teleportation will snap to.
  128949. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  128950. */
  128951. snapPositions?: Vector3[];
  128952. /**
  128953. * How close should the teleportation ray be in order to snap to position.
  128954. * Default to 0.8 units (meters)
  128955. */
  128956. snapToPositionRadius?: number;
  128957. /**
  128958. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  128959. * If you want to support rotation, make sure your mesh has a direction indicator.
  128960. *
  128961. * When left untouched, the default mesh will be initialized.
  128962. */
  128963. teleportationTargetMesh?: AbstractMesh;
  128964. /**
  128965. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  128966. */
  128967. timeToTeleport?: number;
  128968. /**
  128969. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  128970. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  128971. */
  128972. useMainComponentOnly?: boolean;
  128973. /**
  128974. * Should meshes created here be added to a utility layer or the main scene
  128975. */
  128976. useUtilityLayer?: boolean;
  128977. /**
  128978. * Babylon XR Input class for controller
  128979. */
  128980. xrInput: WebXRInput;
  128981. }
  128982. /**
  128983. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  128984. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  128985. * the input of the attached controllers.
  128986. */
  128987. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  128988. private _options;
  128989. private _controllers;
  128990. private _currentTeleportationControllerId;
  128991. private _floorMeshes;
  128992. private _quadraticBezierCurve;
  128993. private _selectionFeature;
  128994. private _snapToPositions;
  128995. private _snappedToPoint;
  128996. private _teleportationRingMaterial?;
  128997. private _tmpRay;
  128998. private _tmpVector;
  128999. /**
  129000. * The module's name
  129001. */
  129002. static readonly Name: string;
  129003. /**
  129004. * The (Babylon) version of this module.
  129005. * This is an integer representing the implementation version.
  129006. * This number does not correspond to the webxr specs version
  129007. */
  129008. static readonly Version: number;
  129009. /**
  129010. * Is movement backwards enabled
  129011. */
  129012. backwardsMovementEnabled: boolean;
  129013. /**
  129014. * Distance to travel when moving backwards
  129015. */
  129016. backwardsTeleportationDistance: number;
  129017. /**
  129018. * The distance from the user to the inspection point in the direction of the controller
  129019. * A higher number will allow the user to move further
  129020. * defaults to 5 (meters, in xr units)
  129021. */
  129022. parabolicCheckRadius: number;
  129023. /**
  129024. * Should the module support parabolic ray on top of direct ray
  129025. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  129026. * Very helpful when moving between floors / different heights
  129027. */
  129028. parabolicRayEnabled: boolean;
  129029. /**
  129030. * How much rotation should be applied when rotating right and left
  129031. */
  129032. rotationAngle: number;
  129033. /**
  129034. * Is rotation enabled when moving forward?
  129035. * Disabling this feature will prevent the user from deciding the direction when teleporting
  129036. */
  129037. rotationEnabled: boolean;
  129038. /**
  129039. * constructs a new anchor system
  129040. * @param _xrSessionManager an instance of WebXRSessionManager
  129041. * @param _options configuration object for this feature
  129042. */
  129043. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  129044. /**
  129045. * Get the snapPointsOnly flag
  129046. */
  129047. get snapPointsOnly(): boolean;
  129048. /**
  129049. * Sets the snapPointsOnly flag
  129050. * @param snapToPoints should teleportation be exclusively to snap points
  129051. */
  129052. set snapPointsOnly(snapToPoints: boolean);
  129053. /**
  129054. * Add a new mesh to the floor meshes array
  129055. * @param mesh the mesh to use as floor mesh
  129056. */
  129057. addFloorMesh(mesh: AbstractMesh): void;
  129058. /**
  129059. * Add a new snap-to point to fix teleportation to this position
  129060. * @param newSnapPoint The new Snap-To point
  129061. */
  129062. addSnapPoint(newSnapPoint: Vector3): void;
  129063. attach(): boolean;
  129064. detach(): boolean;
  129065. dispose(): void;
  129066. /**
  129067. * Remove a mesh from the floor meshes array
  129068. * @param mesh the mesh to remove
  129069. */
  129070. removeFloorMesh(mesh: AbstractMesh): void;
  129071. /**
  129072. * Remove a mesh from the floor meshes array using its name
  129073. * @param name the mesh name to remove
  129074. */
  129075. removeFloorMeshByName(name: string): void;
  129076. /**
  129077. * 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
  129078. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  129079. * @returns was the point found and removed or not
  129080. */
  129081. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  129082. /**
  129083. * This function sets a selection feature that will be disabled when
  129084. * the forward ray is shown and will be reattached when hidden.
  129085. * This is used to remove the selection rays when moving.
  129086. * @param selectionFeature the feature to disable when forward movement is enabled
  129087. */
  129088. setSelectionFeature(selectionFeature: IWebXRFeature): void;
  129089. protected _onXRFrame(_xrFrame: XRFrame): void;
  129090. private _attachController;
  129091. private _createDefaultTargetMesh;
  129092. private _detachController;
  129093. private _findClosestSnapPointWithRadius;
  129094. private _setTargetMeshPosition;
  129095. private _setTargetMeshVisibility;
  129096. private _showParabolicPath;
  129097. private _teleportForward;
  129098. }
  129099. }
  129100. declare module BABYLON {
  129101. /**
  129102. * Options for the default xr helper
  129103. */
  129104. export class WebXRDefaultExperienceOptions {
  129105. /**
  129106. * Enable or disable default UI to enter XR
  129107. */
  129108. disableDefaultUI?: boolean;
  129109. /**
  129110. * Should teleportation not initialize. defaults to false.
  129111. */
  129112. disableTeleportation?: boolean;
  129113. /**
  129114. * Floor meshes that will be used for teleport
  129115. */
  129116. floorMeshes?: Array<AbstractMesh>;
  129117. /**
  129118. * If set to true, the first frame will not be used to reset position
  129119. * The first frame is mainly used when copying transformation from the old camera
  129120. * Mainly used in AR
  129121. */
  129122. ignoreNativeCameraTransformation?: boolean;
  129123. /**
  129124. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  129125. */
  129126. inputOptions?: IWebXRInputOptions;
  129127. /**
  129128. * optional configuration for the output canvas
  129129. */
  129130. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  129131. /**
  129132. * optional UI options. This can be used among other to change session mode and reference space type
  129133. */
  129134. uiOptions?: WebXREnterExitUIOptions;
  129135. /**
  129136. * When loading teleportation and pointer select, use stable versions instead of latest.
  129137. */
  129138. useStablePlugins?: boolean;
  129139. /**
  129140. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  129141. */
  129142. renderingGroupId?: number;
  129143. /**
  129144. * A list of optional features to init the session with
  129145. * If set to true, all features we support will be added
  129146. */
  129147. optionalFeatures?: boolean | string[];
  129148. }
  129149. /**
  129150. * Default experience which provides a similar setup to the previous webVRExperience
  129151. */
  129152. export class WebXRDefaultExperience {
  129153. /**
  129154. * Base experience
  129155. */
  129156. baseExperience: WebXRExperienceHelper;
  129157. /**
  129158. * Enables ui for entering/exiting xr
  129159. */
  129160. enterExitUI: WebXREnterExitUI;
  129161. /**
  129162. * Input experience extension
  129163. */
  129164. input: WebXRInput;
  129165. /**
  129166. * Enables laser pointer and selection
  129167. */
  129168. pointerSelection: WebXRControllerPointerSelection;
  129169. /**
  129170. * Default target xr should render to
  129171. */
  129172. renderTarget: WebXRRenderTarget;
  129173. /**
  129174. * Enables teleportation
  129175. */
  129176. teleportation: WebXRMotionControllerTeleportation;
  129177. private constructor();
  129178. /**
  129179. * Creates the default xr experience
  129180. * @param scene scene
  129181. * @param options options for basic configuration
  129182. * @returns resulting WebXRDefaultExperience
  129183. */
  129184. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  129185. /**
  129186. * DIsposes of the experience helper
  129187. */
  129188. dispose(): void;
  129189. }
  129190. }
  129191. declare module BABYLON {
  129192. /**
  129193. * Options to modify the vr teleportation behavior.
  129194. */
  129195. export interface VRTeleportationOptions {
  129196. /**
  129197. * The name of the mesh which should be used as the teleportation floor. (default: null)
  129198. */
  129199. floorMeshName?: string;
  129200. /**
  129201. * A list of meshes to be used as the teleportation floor. (default: empty)
  129202. */
  129203. floorMeshes?: Mesh[];
  129204. /**
  129205. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  129206. */
  129207. teleportationMode?: number;
  129208. /**
  129209. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  129210. */
  129211. teleportationTime?: number;
  129212. /**
  129213. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  129214. */
  129215. teleportationSpeed?: number;
  129216. /**
  129217. * The easing function used in the animation or null for Linear. (default CircleEase)
  129218. */
  129219. easingFunction?: EasingFunction;
  129220. }
  129221. /**
  129222. * Options to modify the vr experience helper's behavior.
  129223. */
  129224. export interface VRExperienceHelperOptions extends WebVROptions {
  129225. /**
  129226. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  129227. */
  129228. createDeviceOrientationCamera?: boolean;
  129229. /**
  129230. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  129231. */
  129232. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  129233. /**
  129234. * Uses the main button on the controller to toggle the laser casted. (default: true)
  129235. */
  129236. laserToggle?: boolean;
  129237. /**
  129238. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  129239. */
  129240. floorMeshes?: Mesh[];
  129241. /**
  129242. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  129243. */
  129244. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  129245. /**
  129246. * Defines if WebXR should be used instead of WebVR (if available)
  129247. */
  129248. useXR?: boolean;
  129249. }
  129250. /**
  129251. * Event containing information after VR has been entered
  129252. */
  129253. export class OnAfterEnteringVRObservableEvent {
  129254. /**
  129255. * If entering vr was successful
  129256. */
  129257. success: boolean;
  129258. }
  129259. /**
  129260. * Helps to quickly add VR support to an existing scene.
  129261. * See https://doc.babylonjs.com/how_to/webvr_helper
  129262. */
  129263. export class VRExperienceHelper {
  129264. /** Options to modify the vr experience helper's behavior. */
  129265. webVROptions: VRExperienceHelperOptions;
  129266. private _scene;
  129267. private _position;
  129268. private _btnVR;
  129269. private _btnVRDisplayed;
  129270. private _webVRsupported;
  129271. private _webVRready;
  129272. private _webVRrequesting;
  129273. private _webVRpresenting;
  129274. private _hasEnteredVR;
  129275. private _fullscreenVRpresenting;
  129276. private _inputElement;
  129277. private _webVRCamera;
  129278. private _vrDeviceOrientationCamera;
  129279. private _deviceOrientationCamera;
  129280. private _existingCamera;
  129281. private _onKeyDown;
  129282. private _onVrDisplayPresentChange;
  129283. private _onVRDisplayChanged;
  129284. private _onVRRequestPresentStart;
  129285. private _onVRRequestPresentComplete;
  129286. /**
  129287. * 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)
  129288. */
  129289. enableGazeEvenWhenNoPointerLock: boolean;
  129290. /**
  129291. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  129292. */
  129293. exitVROnDoubleTap: boolean;
  129294. /**
  129295. * Observable raised right before entering VR.
  129296. */
  129297. onEnteringVRObservable: Observable<VRExperienceHelper>;
  129298. /**
  129299. * Observable raised when entering VR has completed.
  129300. */
  129301. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  129302. /**
  129303. * Observable raised when exiting VR.
  129304. */
  129305. onExitingVRObservable: Observable<VRExperienceHelper>;
  129306. /**
  129307. * Observable raised when controller mesh is loaded.
  129308. */
  129309. onControllerMeshLoadedObservable: Observable<WebVRController>;
  129310. /** Return this.onEnteringVRObservable
  129311. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  129312. */
  129313. get onEnteringVR(): Observable<VRExperienceHelper>;
  129314. /** Return this.onExitingVRObservable
  129315. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  129316. */
  129317. get onExitingVR(): Observable<VRExperienceHelper>;
  129318. /** Return this.onControllerMeshLoadedObservable
  129319. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  129320. */
  129321. get onControllerMeshLoaded(): Observable<WebVRController>;
  129322. private _rayLength;
  129323. private _useCustomVRButton;
  129324. private _teleportationRequested;
  129325. private _teleportActive;
  129326. private _floorMeshName;
  129327. private _floorMeshesCollection;
  129328. private _teleportationMode;
  129329. private _teleportationTime;
  129330. private _teleportationSpeed;
  129331. private _teleportationEasing;
  129332. private _rotationAllowed;
  129333. private _teleportBackwardsVector;
  129334. private _teleportationTarget;
  129335. private _isDefaultTeleportationTarget;
  129336. private _postProcessMove;
  129337. private _teleportationFillColor;
  129338. private _teleportationBorderColor;
  129339. private _rotationAngle;
  129340. private _haloCenter;
  129341. private _cameraGazer;
  129342. private _padSensibilityUp;
  129343. private _padSensibilityDown;
  129344. private _leftController;
  129345. private _rightController;
  129346. private _gazeColor;
  129347. private _laserColor;
  129348. private _pickedLaserColor;
  129349. private _pickedGazeColor;
  129350. /**
  129351. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  129352. */
  129353. onNewMeshSelected: Observable<AbstractMesh>;
  129354. /**
  129355. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  129356. * This observable will provide the mesh and the controller used to select the mesh
  129357. */
  129358. onMeshSelectedWithController: Observable<{
  129359. mesh: AbstractMesh;
  129360. controller: WebVRController;
  129361. }>;
  129362. /**
  129363. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  129364. */
  129365. onNewMeshPicked: Observable<PickingInfo>;
  129366. private _circleEase;
  129367. /**
  129368. * Observable raised before camera teleportation
  129369. */
  129370. onBeforeCameraTeleport: Observable<Vector3>;
  129371. /**
  129372. * Observable raised after camera teleportation
  129373. */
  129374. onAfterCameraTeleport: Observable<Vector3>;
  129375. /**
  129376. * Observable raised when current selected mesh gets unselected
  129377. */
  129378. onSelectedMeshUnselected: Observable<AbstractMesh>;
  129379. private _raySelectionPredicate;
  129380. /**
  129381. * To be optionaly changed by user to define custom ray selection
  129382. */
  129383. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  129384. /**
  129385. * To be optionaly changed by user to define custom selection logic (after ray selection)
  129386. */
  129387. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  129388. /**
  129389. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  129390. */
  129391. teleportationEnabled: boolean;
  129392. private _defaultHeight;
  129393. private _teleportationInitialized;
  129394. private _interactionsEnabled;
  129395. private _interactionsRequested;
  129396. private _displayGaze;
  129397. private _displayLaserPointer;
  129398. /**
  129399. * The mesh used to display where the user is going to teleport.
  129400. */
  129401. get teleportationTarget(): Mesh;
  129402. /**
  129403. * Sets the mesh to be used to display where the user is going to teleport.
  129404. */
  129405. set teleportationTarget(value: Mesh);
  129406. /**
  129407. * 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
  129408. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  129409. * See https://doc.babylonjs.com/resources/baking_transformations
  129410. */
  129411. get gazeTrackerMesh(): Mesh;
  129412. set gazeTrackerMesh(value: Mesh);
  129413. /**
  129414. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  129415. */
  129416. updateGazeTrackerScale: boolean;
  129417. /**
  129418. * If the gaze trackers color should be updated when selecting meshes
  129419. */
  129420. updateGazeTrackerColor: boolean;
  129421. /**
  129422. * If the controller laser color should be updated when selecting meshes
  129423. */
  129424. updateControllerLaserColor: boolean;
  129425. /**
  129426. * The gaze tracking mesh corresponding to the left controller
  129427. */
  129428. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  129429. /**
  129430. * The gaze tracking mesh corresponding to the right controller
  129431. */
  129432. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  129433. /**
  129434. * If the ray of the gaze should be displayed.
  129435. */
  129436. get displayGaze(): boolean;
  129437. /**
  129438. * Sets if the ray of the gaze should be displayed.
  129439. */
  129440. set displayGaze(value: boolean);
  129441. /**
  129442. * If the ray of the LaserPointer should be displayed.
  129443. */
  129444. get displayLaserPointer(): boolean;
  129445. /**
  129446. * Sets if the ray of the LaserPointer should be displayed.
  129447. */
  129448. set displayLaserPointer(value: boolean);
  129449. /**
  129450. * The deviceOrientationCamera used as the camera when not in VR.
  129451. */
  129452. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  129453. /**
  129454. * Based on the current WebVR support, returns the current VR camera used.
  129455. */
  129456. get currentVRCamera(): Nullable<Camera>;
  129457. /**
  129458. * The webVRCamera which is used when in VR.
  129459. */
  129460. get webVRCamera(): WebVRFreeCamera;
  129461. /**
  129462. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  129463. */
  129464. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  129465. /**
  129466. * The html button that is used to trigger entering into VR.
  129467. */
  129468. get vrButton(): Nullable<HTMLButtonElement>;
  129469. private get _teleportationRequestInitiated();
  129470. /**
  129471. * Defines whether or not Pointer lock should be requested when switching to
  129472. * full screen.
  129473. */
  129474. requestPointerLockOnFullScreen: boolean;
  129475. /**
  129476. * If asking to force XR, this will be populated with the default xr experience
  129477. */
  129478. xr: WebXRDefaultExperience;
  129479. /**
  129480. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  129481. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  129482. */
  129483. xrTestDone: boolean;
  129484. /**
  129485. * Instantiates a VRExperienceHelper.
  129486. * Helps to quickly add VR support to an existing scene.
  129487. * @param scene The scene the VRExperienceHelper belongs to.
  129488. * @param webVROptions Options to modify the vr experience helper's behavior.
  129489. */
  129490. constructor(scene: Scene,
  129491. /** Options to modify the vr experience helper's behavior. */
  129492. webVROptions?: VRExperienceHelperOptions);
  129493. private completeVRInit;
  129494. private _onDefaultMeshLoaded;
  129495. private _onResize;
  129496. private _onFullscreenChange;
  129497. /**
  129498. * Gets a value indicating if we are currently in VR mode.
  129499. */
  129500. get isInVRMode(): boolean;
  129501. private onVrDisplayPresentChange;
  129502. private onVRDisplayChanged;
  129503. private moveButtonToBottomRight;
  129504. private displayVRButton;
  129505. private updateButtonVisibility;
  129506. private _cachedAngularSensibility;
  129507. /**
  129508. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  129509. * Otherwise, will use the fullscreen API.
  129510. */
  129511. enterVR(): void;
  129512. /**
  129513. * Attempt to exit VR, or fullscreen.
  129514. */
  129515. exitVR(): void;
  129516. /**
  129517. * The position of the vr experience helper.
  129518. */
  129519. get position(): Vector3;
  129520. /**
  129521. * Sets the position of the vr experience helper.
  129522. */
  129523. set position(value: Vector3);
  129524. /**
  129525. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  129526. */
  129527. enableInteractions(): void;
  129528. private get _noControllerIsActive();
  129529. private beforeRender;
  129530. private _isTeleportationFloor;
  129531. /**
  129532. * Adds a floor mesh to be used for teleportation.
  129533. * @param floorMesh the mesh to be used for teleportation.
  129534. */
  129535. addFloorMesh(floorMesh: Mesh): void;
  129536. /**
  129537. * Removes a floor mesh from being used for teleportation.
  129538. * @param floorMesh the mesh to be removed.
  129539. */
  129540. removeFloorMesh(floorMesh: Mesh): void;
  129541. /**
  129542. * Enables interactions and teleportation using the VR controllers and gaze.
  129543. * @param vrTeleportationOptions options to modify teleportation behavior.
  129544. */
  129545. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  129546. private _onNewGamepadConnected;
  129547. private _tryEnableInteractionOnController;
  129548. private _onNewGamepadDisconnected;
  129549. private _enableInteractionOnController;
  129550. private _checkTeleportWithRay;
  129551. private _checkRotate;
  129552. private _checkTeleportBackwards;
  129553. private _enableTeleportationOnController;
  129554. private _createTeleportationCircles;
  129555. private _displayTeleportationTarget;
  129556. private _hideTeleportationTarget;
  129557. private _rotateCamera;
  129558. private _moveTeleportationSelectorTo;
  129559. private _workingVector;
  129560. private _workingQuaternion;
  129561. private _workingMatrix;
  129562. /**
  129563. * Time Constant Teleportation Mode
  129564. */
  129565. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  129566. /**
  129567. * Speed Constant Teleportation Mode
  129568. */
  129569. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  129570. /**
  129571. * Teleports the users feet to the desired location
  129572. * @param location The location where the user's feet should be placed
  129573. */
  129574. teleportCamera(location: Vector3): void;
  129575. private _convertNormalToDirectionOfRay;
  129576. private _castRayAndSelectObject;
  129577. private _notifySelectedMeshUnselected;
  129578. /**
  129579. * Permanently set new colors for the laser pointer
  129580. * @param color the new laser color
  129581. * @param pickedColor the new laser color when picked mesh detected
  129582. */
  129583. setLaserColor(color: Color3, pickedColor?: Color3): void;
  129584. /**
  129585. * Set lighting enabled / disabled on the laser pointer of both controllers
  129586. * @param enabled should the lighting be enabled on the laser pointer
  129587. */
  129588. setLaserLightingState(enabled?: boolean): void;
  129589. /**
  129590. * Permanently set new colors for the gaze pointer
  129591. * @param color the new gaze color
  129592. * @param pickedColor the new gaze color when picked mesh detected
  129593. */
  129594. setGazeColor(color: Color3, pickedColor?: Color3): void;
  129595. /**
  129596. * Sets the color of the laser ray from the vr controllers.
  129597. * @param color new color for the ray.
  129598. */
  129599. changeLaserColor(color: Color3): void;
  129600. /**
  129601. * Sets the color of the ray from the vr headsets gaze.
  129602. * @param color new color for the ray.
  129603. */
  129604. changeGazeColor(color: Color3): void;
  129605. /**
  129606. * Exits VR and disposes of the vr experience helper
  129607. */
  129608. dispose(): void;
  129609. /**
  129610. * Gets the name of the VRExperienceHelper class
  129611. * @returns "VRExperienceHelper"
  129612. */
  129613. getClassName(): string;
  129614. }
  129615. }
  129616. declare module BABYLON {
  129617. /**
  129618. * Contains an array of blocks representing the octree
  129619. */
  129620. export interface IOctreeContainer<T> {
  129621. /**
  129622. * Blocks within the octree
  129623. */
  129624. blocks: Array<OctreeBlock<T>>;
  129625. }
  129626. /**
  129627. * Class used to store a cell in an octree
  129628. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129629. */
  129630. export class OctreeBlock<T> {
  129631. /**
  129632. * Gets the content of the current block
  129633. */
  129634. entries: T[];
  129635. /**
  129636. * Gets the list of block children
  129637. */
  129638. blocks: Array<OctreeBlock<T>>;
  129639. private _depth;
  129640. private _maxDepth;
  129641. private _capacity;
  129642. private _minPoint;
  129643. private _maxPoint;
  129644. private _boundingVectors;
  129645. private _creationFunc;
  129646. /**
  129647. * Creates a new block
  129648. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  129649. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  129650. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  129651. * @param depth defines the current depth of this block in the octree
  129652. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  129653. * @param creationFunc defines a callback to call when an element is added to the block
  129654. */
  129655. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  129656. /**
  129657. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  129658. */
  129659. get capacity(): number;
  129660. /**
  129661. * Gets the minimum vector (in world space) of the block's bounding box
  129662. */
  129663. get minPoint(): Vector3;
  129664. /**
  129665. * Gets the maximum vector (in world space) of the block's bounding box
  129666. */
  129667. get maxPoint(): Vector3;
  129668. /**
  129669. * Add a new element to this block
  129670. * @param entry defines the element to add
  129671. */
  129672. addEntry(entry: T): void;
  129673. /**
  129674. * Remove an element from this block
  129675. * @param entry defines the element to remove
  129676. */
  129677. removeEntry(entry: T): void;
  129678. /**
  129679. * Add an array of elements to this block
  129680. * @param entries defines the array of elements to add
  129681. */
  129682. addEntries(entries: T[]): void;
  129683. /**
  129684. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  129685. * @param frustumPlanes defines the frustum planes to test
  129686. * @param selection defines the array to store current content if selection is positive
  129687. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129688. */
  129689. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  129690. /**
  129691. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  129692. * @param sphereCenter defines the bounding sphere center
  129693. * @param sphereRadius defines the bounding sphere radius
  129694. * @param selection defines the array to store current content if selection is positive
  129695. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129696. */
  129697. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  129698. /**
  129699. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  129700. * @param ray defines the ray to test with
  129701. * @param selection defines the array to store current content if selection is positive
  129702. */
  129703. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  129704. /**
  129705. * Subdivide the content into child blocks (this block will then be empty)
  129706. */
  129707. createInnerBlocks(): void;
  129708. /**
  129709. * @hidden
  129710. */
  129711. 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;
  129712. }
  129713. }
  129714. declare module BABYLON {
  129715. /**
  129716. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  129717. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129718. */
  129719. export class Octree<T> {
  129720. /** 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.) */
  129721. maxDepth: number;
  129722. /**
  129723. * Blocks within the octree containing objects
  129724. */
  129725. blocks: Array<OctreeBlock<T>>;
  129726. /**
  129727. * Content stored in the octree
  129728. */
  129729. dynamicContent: T[];
  129730. private _maxBlockCapacity;
  129731. private _selectionContent;
  129732. private _creationFunc;
  129733. /**
  129734. * Creates a octree
  129735. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129736. * @param creationFunc function to be used to instatiate the octree
  129737. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  129738. * @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.)
  129739. */
  129740. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  129741. /** 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.) */
  129742. maxDepth?: number);
  129743. /**
  129744. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  129745. * @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);
  129746. * @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);
  129747. * @param entries meshes to be added to the octree blocks
  129748. */
  129749. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  129750. /**
  129751. * Adds a mesh to the octree
  129752. * @param entry Mesh to add to the octree
  129753. */
  129754. addMesh(entry: T): void;
  129755. /**
  129756. * Remove an element from the octree
  129757. * @param entry defines the element to remove
  129758. */
  129759. removeMesh(entry: T): void;
  129760. /**
  129761. * Selects an array of meshes within the frustum
  129762. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  129763. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  129764. * @returns array of meshes within the frustum
  129765. */
  129766. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  129767. /**
  129768. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  129769. * @param sphereCenter defines the bounding sphere center
  129770. * @param sphereRadius defines the bounding sphere radius
  129771. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129772. * @returns an array of objects that intersect the sphere
  129773. */
  129774. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  129775. /**
  129776. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  129777. * @param ray defines the ray to test with
  129778. * @returns array of intersected objects
  129779. */
  129780. intersectsRay(ray: Ray): SmartArray<T>;
  129781. /**
  129782. * Adds a mesh into the octree block if it intersects the block
  129783. */
  129784. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  129785. /**
  129786. * Adds a submesh into the octree block if it intersects the block
  129787. */
  129788. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  129789. }
  129790. }
  129791. declare module BABYLON {
  129792. interface Scene {
  129793. /**
  129794. * @hidden
  129795. * Backing Filed
  129796. */
  129797. _selectionOctree: Octree<AbstractMesh>;
  129798. /**
  129799. * Gets the octree used to boost mesh selection (picking)
  129800. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129801. */
  129802. selectionOctree: Octree<AbstractMesh>;
  129803. /**
  129804. * Creates or updates the octree used to boost selection (picking)
  129805. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129806. * @param maxCapacity defines the maximum capacity per leaf
  129807. * @param maxDepth defines the maximum depth of the octree
  129808. * @returns an octree of AbstractMesh
  129809. */
  129810. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  129811. }
  129812. interface AbstractMesh {
  129813. /**
  129814. * @hidden
  129815. * Backing Field
  129816. */
  129817. _submeshesOctree: Octree<SubMesh>;
  129818. /**
  129819. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  129820. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  129821. * @param maxCapacity defines the maximum size of each block (64 by default)
  129822. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  129823. * @returns the new octree
  129824. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  129825. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129826. */
  129827. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  129828. }
  129829. /**
  129830. * Defines the octree scene component responsible to manage any octrees
  129831. * in a given scene.
  129832. */
  129833. export class OctreeSceneComponent {
  129834. /**
  129835. * The component name help to identify the component in the list of scene components.
  129836. */
  129837. readonly name: string;
  129838. /**
  129839. * The scene the component belongs to.
  129840. */
  129841. scene: Scene;
  129842. /**
  129843. * Indicates if the meshes have been checked to make sure they are isEnabled()
  129844. */
  129845. readonly checksIsEnabled: boolean;
  129846. /**
  129847. * Creates a new instance of the component for the given scene
  129848. * @param scene Defines the scene to register the component in
  129849. */
  129850. constructor(scene: Scene);
  129851. /**
  129852. * Registers the component in a given scene
  129853. */
  129854. register(): void;
  129855. /**
  129856. * Return the list of active meshes
  129857. * @returns the list of active meshes
  129858. */
  129859. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  129860. /**
  129861. * Return the list of active sub meshes
  129862. * @param mesh The mesh to get the candidates sub meshes from
  129863. * @returns the list of active sub meshes
  129864. */
  129865. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  129866. private _tempRay;
  129867. /**
  129868. * Return the list of sub meshes intersecting with a given local ray
  129869. * @param mesh defines the mesh to find the submesh for
  129870. * @param localRay defines the ray in local space
  129871. * @returns the list of intersecting sub meshes
  129872. */
  129873. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  129874. /**
  129875. * Return the list of sub meshes colliding with a collider
  129876. * @param mesh defines the mesh to find the submesh for
  129877. * @param collider defines the collider to evaluate the collision against
  129878. * @returns the list of colliding sub meshes
  129879. */
  129880. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  129881. /**
  129882. * Rebuilds the elements related to this component in case of
  129883. * context lost for instance.
  129884. */
  129885. rebuild(): void;
  129886. /**
  129887. * Disposes the component and the associated ressources.
  129888. */
  129889. dispose(): void;
  129890. }
  129891. }
  129892. declare module BABYLON {
  129893. /**
  129894. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  129895. */
  129896. export class Gizmo implements IDisposable {
  129897. /** The utility layer the gizmo will be added to */
  129898. gizmoLayer: UtilityLayerRenderer;
  129899. /**
  129900. * The root mesh of the gizmo
  129901. */
  129902. _rootMesh: Mesh;
  129903. private _attachedMesh;
  129904. private _attachedNode;
  129905. /**
  129906. * Ratio for the scale of the gizmo (Default: 1)
  129907. */
  129908. protected _scaleRatio: number;
  129909. /**
  129910. * Ratio for the scale of the gizmo (Default: 1)
  129911. */
  129912. set scaleRatio(value: number);
  129913. get scaleRatio(): number;
  129914. /**
  129915. * If a custom mesh has been set (Default: false)
  129916. */
  129917. protected _customMeshSet: boolean;
  129918. /**
  129919. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  129920. * * When set, interactions will be enabled
  129921. */
  129922. get attachedMesh(): Nullable<AbstractMesh>;
  129923. set attachedMesh(value: Nullable<AbstractMesh>);
  129924. /**
  129925. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  129926. * * When set, interactions will be enabled
  129927. */
  129928. get attachedNode(): Nullable<Node>;
  129929. set attachedNode(value: Nullable<Node>);
  129930. /**
  129931. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  129932. * @param mesh The mesh to replace the default mesh of the gizmo
  129933. */
  129934. setCustomMesh(mesh: Mesh): void;
  129935. protected _updateGizmoRotationToMatchAttachedMesh: boolean;
  129936. /**
  129937. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  129938. */
  129939. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  129940. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  129941. /**
  129942. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  129943. */
  129944. updateGizmoPositionToMatchAttachedMesh: boolean;
  129945. /**
  129946. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  129947. */
  129948. updateScale: boolean;
  129949. protected _interactionsEnabled: boolean;
  129950. protected _attachedNodeChanged(value: Nullable<Node>): void;
  129951. private _beforeRenderObserver;
  129952. private _tempQuaternion;
  129953. private _tempVector;
  129954. private _tempVector2;
  129955. /**
  129956. * Creates a gizmo
  129957. * @param gizmoLayer The utility layer the gizmo will be added to
  129958. */
  129959. constructor(
  129960. /** The utility layer the gizmo will be added to */
  129961. gizmoLayer?: UtilityLayerRenderer);
  129962. /**
  129963. * Updates the gizmo to match the attached mesh's position/rotation
  129964. */
  129965. protected _update(): void;
  129966. /**
  129967. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  129968. * @param value Node, TransformNode or mesh
  129969. */
  129970. protected _matrixChanged(): void;
  129971. /**
  129972. * Disposes of the gizmo
  129973. */
  129974. dispose(): void;
  129975. }
  129976. }
  129977. declare module BABYLON {
  129978. /**
  129979. * Single plane drag gizmo
  129980. */
  129981. export class PlaneDragGizmo extends Gizmo {
  129982. /**
  129983. * Drag behavior responsible for the gizmos dragging interactions
  129984. */
  129985. dragBehavior: PointerDragBehavior;
  129986. private _pointerObserver;
  129987. /**
  129988. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  129989. */
  129990. snapDistance: number;
  129991. /**
  129992. * Event that fires each time the gizmo snaps to a new location.
  129993. * * snapDistance is the the change in distance
  129994. */
  129995. onSnapObservable: Observable<{
  129996. snapDistance: number;
  129997. }>;
  129998. private _plane;
  129999. private _coloredMaterial;
  130000. private _hoverMaterial;
  130001. private _isEnabled;
  130002. private _parent;
  130003. /** @hidden */
  130004. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  130005. /** @hidden */
  130006. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  130007. /**
  130008. * Creates a PlaneDragGizmo
  130009. * @param gizmoLayer The utility layer the gizmo will be added to
  130010. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  130011. * @param color The color of the gizmo
  130012. */
  130013. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  130014. protected _attachedNodeChanged(value: Nullable<Node>): void;
  130015. /**
  130016. * If the gizmo is enabled
  130017. */
  130018. set isEnabled(value: boolean);
  130019. get isEnabled(): boolean;
  130020. /**
  130021. * Disposes of the gizmo
  130022. */
  130023. dispose(): void;
  130024. }
  130025. }
  130026. declare module BABYLON {
  130027. /**
  130028. * Gizmo that enables dragging a mesh along 3 axis
  130029. */
  130030. export class PositionGizmo extends Gizmo {
  130031. /**
  130032. * Internal gizmo used for interactions on the x axis
  130033. */
  130034. xGizmo: AxisDragGizmo;
  130035. /**
  130036. * Internal gizmo used for interactions on the y axis
  130037. */
  130038. yGizmo: AxisDragGizmo;
  130039. /**
  130040. * Internal gizmo used for interactions on the z axis
  130041. */
  130042. zGizmo: AxisDragGizmo;
  130043. /**
  130044. * Internal gizmo used for interactions on the yz plane
  130045. */
  130046. xPlaneGizmo: PlaneDragGizmo;
  130047. /**
  130048. * Internal gizmo used for interactions on the xz plane
  130049. */
  130050. yPlaneGizmo: PlaneDragGizmo;
  130051. /**
  130052. * Internal gizmo used for interactions on the xy plane
  130053. */
  130054. zPlaneGizmo: PlaneDragGizmo;
  130055. /**
  130056. * private variables
  130057. */
  130058. private _meshAttached;
  130059. private _nodeAttached;
  130060. private _snapDistance;
  130061. /** Fires an event when any of it's sub gizmos are dragged */
  130062. onDragStartObservable: Observable<unknown>;
  130063. /** Fires an event when any of it's sub gizmos are released from dragging */
  130064. onDragEndObservable: Observable<unknown>;
  130065. /**
  130066. * If set to true, planar drag is enabled
  130067. */
  130068. private _planarGizmoEnabled;
  130069. get attachedMesh(): Nullable<AbstractMesh>;
  130070. set attachedMesh(mesh: Nullable<AbstractMesh>);
  130071. get attachedNode(): Nullable<Node>;
  130072. set attachedNode(node: Nullable<Node>);
  130073. /**
  130074. * Creates a PositionGizmo
  130075. * @param gizmoLayer The utility layer the gizmo will be added to
  130076. @param thickness display gizmo axis thickness
  130077. */
  130078. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  130079. /**
  130080. * If the planar drag gizmo is enabled
  130081. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  130082. */
  130083. set planarGizmoEnabled(value: boolean);
  130084. get planarGizmoEnabled(): boolean;
  130085. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  130086. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  130087. /**
  130088. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130089. */
  130090. set snapDistance(value: number);
  130091. get snapDistance(): number;
  130092. /**
  130093. * Ratio for the scale of the gizmo (Default: 1)
  130094. */
  130095. set scaleRatio(value: number);
  130096. get scaleRatio(): number;
  130097. /**
  130098. * Disposes of the gizmo
  130099. */
  130100. dispose(): void;
  130101. /**
  130102. * CustomMeshes are not supported by this gizmo
  130103. * @param mesh The mesh to replace the default mesh of the gizmo
  130104. */
  130105. setCustomMesh(mesh: Mesh): void;
  130106. }
  130107. }
  130108. declare module BABYLON {
  130109. /**
  130110. * Single axis drag gizmo
  130111. */
  130112. export class AxisDragGizmo extends Gizmo {
  130113. /**
  130114. * Drag behavior responsible for the gizmos dragging interactions
  130115. */
  130116. dragBehavior: PointerDragBehavior;
  130117. private _pointerObserver;
  130118. /**
  130119. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130120. */
  130121. snapDistance: number;
  130122. /**
  130123. * Event that fires each time the gizmo snaps to a new location.
  130124. * * snapDistance is the the change in distance
  130125. */
  130126. onSnapObservable: Observable<{
  130127. snapDistance: number;
  130128. }>;
  130129. private _isEnabled;
  130130. private _parent;
  130131. private _arrow;
  130132. private _coloredMaterial;
  130133. private _hoverMaterial;
  130134. /** @hidden */
  130135. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  130136. /** @hidden */
  130137. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  130138. /**
  130139. * Creates an AxisDragGizmo
  130140. * @param gizmoLayer The utility layer the gizmo will be added to
  130141. * @param dragAxis The axis which the gizmo will be able to drag on
  130142. * @param color The color of the gizmo
  130143. * @param thickness display gizmo axis thickness
  130144. */
  130145. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  130146. protected _attachedNodeChanged(value: Nullable<Node>): void;
  130147. /**
  130148. * If the gizmo is enabled
  130149. */
  130150. set isEnabled(value: boolean);
  130151. get isEnabled(): boolean;
  130152. /**
  130153. * Disposes of the gizmo
  130154. */
  130155. dispose(): void;
  130156. }
  130157. }
  130158. declare module BABYLON.Debug {
  130159. /**
  130160. * The Axes viewer will show 3 axes in a specific point in space
  130161. */
  130162. export class AxesViewer {
  130163. private _xAxis;
  130164. private _yAxis;
  130165. private _zAxis;
  130166. private _scaleLinesFactor;
  130167. private _instanced;
  130168. /**
  130169. * Gets the hosting scene
  130170. */
  130171. scene: Nullable<Scene>;
  130172. /**
  130173. * Gets or sets a number used to scale line length
  130174. */
  130175. scaleLines: number;
  130176. /** Gets the node hierarchy used to render x-axis */
  130177. get xAxis(): TransformNode;
  130178. /** Gets the node hierarchy used to render y-axis */
  130179. get yAxis(): TransformNode;
  130180. /** Gets the node hierarchy used to render z-axis */
  130181. get zAxis(): TransformNode;
  130182. /**
  130183. * Creates a new AxesViewer
  130184. * @param scene defines the hosting scene
  130185. * @param scaleLines defines a number used to scale line length (1 by default)
  130186. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  130187. * @param xAxis defines the node hierarchy used to render the x-axis
  130188. * @param yAxis defines the node hierarchy used to render the y-axis
  130189. * @param zAxis defines the node hierarchy used to render the z-axis
  130190. */
  130191. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  130192. /**
  130193. * Force the viewer to update
  130194. * @param position defines the position of the viewer
  130195. * @param xaxis defines the x axis of the viewer
  130196. * @param yaxis defines the y axis of the viewer
  130197. * @param zaxis defines the z axis of the viewer
  130198. */
  130199. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  130200. /**
  130201. * Creates an instance of this axes viewer.
  130202. * @returns a new axes viewer with instanced meshes
  130203. */
  130204. createInstance(): AxesViewer;
  130205. /** Releases resources */
  130206. dispose(): void;
  130207. private static _SetRenderingGroupId;
  130208. }
  130209. }
  130210. declare module BABYLON.Debug {
  130211. /**
  130212. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  130213. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  130214. */
  130215. export class BoneAxesViewer extends AxesViewer {
  130216. /**
  130217. * Gets or sets the target mesh where to display the axes viewer
  130218. */
  130219. mesh: Nullable<Mesh>;
  130220. /**
  130221. * Gets or sets the target bone where to display the axes viewer
  130222. */
  130223. bone: Nullable<Bone>;
  130224. /** Gets current position */
  130225. pos: Vector3;
  130226. /** Gets direction of X axis */
  130227. xaxis: Vector3;
  130228. /** Gets direction of Y axis */
  130229. yaxis: Vector3;
  130230. /** Gets direction of Z axis */
  130231. zaxis: Vector3;
  130232. /**
  130233. * Creates a new BoneAxesViewer
  130234. * @param scene defines the hosting scene
  130235. * @param bone defines the target bone
  130236. * @param mesh defines the target mesh
  130237. * @param scaleLines defines a scaling factor for line length (1 by default)
  130238. */
  130239. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  130240. /**
  130241. * Force the viewer to update
  130242. */
  130243. update(): void;
  130244. /** Releases resources */
  130245. dispose(): void;
  130246. }
  130247. }
  130248. declare module BABYLON {
  130249. /**
  130250. * Interface used to define scene explorer extensibility option
  130251. */
  130252. export interface IExplorerExtensibilityOption {
  130253. /**
  130254. * Define the option label
  130255. */
  130256. label: string;
  130257. /**
  130258. * Defines the action to execute on click
  130259. */
  130260. action: (entity: any) => void;
  130261. }
  130262. /**
  130263. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  130264. */
  130265. export interface IExplorerExtensibilityGroup {
  130266. /**
  130267. * Defines a predicate to test if a given type mut be extended
  130268. */
  130269. predicate: (entity: any) => boolean;
  130270. /**
  130271. * Gets the list of options added to a type
  130272. */
  130273. entries: IExplorerExtensibilityOption[];
  130274. }
  130275. /**
  130276. * Interface used to define the options to use to create the Inspector
  130277. */
  130278. export interface IInspectorOptions {
  130279. /**
  130280. * Display in overlay mode (default: false)
  130281. */
  130282. overlay?: boolean;
  130283. /**
  130284. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  130285. */
  130286. globalRoot?: HTMLElement;
  130287. /**
  130288. * Display the Scene explorer
  130289. */
  130290. showExplorer?: boolean;
  130291. /**
  130292. * Display the property inspector
  130293. */
  130294. showInspector?: boolean;
  130295. /**
  130296. * Display in embed mode (both panes on the right)
  130297. */
  130298. embedMode?: boolean;
  130299. /**
  130300. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  130301. */
  130302. handleResize?: boolean;
  130303. /**
  130304. * Allow the panes to popup (default: true)
  130305. */
  130306. enablePopup?: boolean;
  130307. /**
  130308. * Allow the panes to be closed by users (default: true)
  130309. */
  130310. enableClose?: boolean;
  130311. /**
  130312. * Optional list of extensibility entries
  130313. */
  130314. explorerExtensibility?: IExplorerExtensibilityGroup[];
  130315. /**
  130316. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  130317. */
  130318. inspectorURL?: string;
  130319. /**
  130320. * Optional initial tab (default to DebugLayerTab.Properties)
  130321. */
  130322. initialTab?: DebugLayerTab;
  130323. }
  130324. interface Scene {
  130325. /**
  130326. * @hidden
  130327. * Backing field
  130328. */
  130329. _debugLayer: DebugLayer;
  130330. /**
  130331. * Gets the debug layer (aka Inspector) associated with the scene
  130332. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130333. */
  130334. debugLayer: DebugLayer;
  130335. }
  130336. /**
  130337. * Enum of inspector action tab
  130338. */
  130339. export enum DebugLayerTab {
  130340. /**
  130341. * Properties tag (default)
  130342. */
  130343. Properties = 0,
  130344. /**
  130345. * Debug tab
  130346. */
  130347. Debug = 1,
  130348. /**
  130349. * Statistics tab
  130350. */
  130351. Statistics = 2,
  130352. /**
  130353. * Tools tab
  130354. */
  130355. Tools = 3,
  130356. /**
  130357. * Settings tab
  130358. */
  130359. Settings = 4
  130360. }
  130361. /**
  130362. * The debug layer (aka Inspector) is the go to tool in order to better understand
  130363. * what is happening in your scene
  130364. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130365. */
  130366. export class DebugLayer {
  130367. /**
  130368. * Define the url to get the inspector script from.
  130369. * By default it uses the babylonjs CDN.
  130370. * @ignoreNaming
  130371. */
  130372. static InspectorURL: string;
  130373. private _scene;
  130374. private BJSINSPECTOR;
  130375. private _onPropertyChangedObservable?;
  130376. /**
  130377. * Observable triggered when a property is changed through the inspector.
  130378. */
  130379. get onPropertyChangedObservable(): any;
  130380. /**
  130381. * Instantiates a new debug layer.
  130382. * The debug layer (aka Inspector) is the go to tool in order to better understand
  130383. * what is happening in your scene
  130384. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130385. * @param scene Defines the scene to inspect
  130386. */
  130387. constructor(scene: Scene);
  130388. /** Creates the inspector window. */
  130389. private _createInspector;
  130390. /**
  130391. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  130392. * @param entity defines the entity to select
  130393. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  130394. */
  130395. select(entity: any, lineContainerTitles?: string | string[]): void;
  130396. /** Get the inspector from bundle or global */
  130397. private _getGlobalInspector;
  130398. /**
  130399. * Get if the inspector is visible or not.
  130400. * @returns true if visible otherwise, false
  130401. */
  130402. isVisible(): boolean;
  130403. /**
  130404. * Hide the inspector and close its window.
  130405. */
  130406. hide(): void;
  130407. /**
  130408. * Update the scene in the inspector
  130409. */
  130410. setAsActiveScene(): void;
  130411. /**
  130412. * Launch the debugLayer.
  130413. * @param config Define the configuration of the inspector
  130414. * @return a promise fulfilled when the debug layer is visible
  130415. */
  130416. show(config?: IInspectorOptions): Promise<DebugLayer>;
  130417. }
  130418. }
  130419. declare module BABYLON {
  130420. /**
  130421. * Class containing static functions to help procedurally build meshes
  130422. */
  130423. export class BoxBuilder {
  130424. /**
  130425. * Creates a box mesh
  130426. * * The parameter `size` sets the size (float) of each box side (default 1)
  130427. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  130428. * * 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)
  130429. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  130430. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130431. * * 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
  130432. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130433. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  130434. * @param name defines the name of the mesh
  130435. * @param options defines the options used to create the mesh
  130436. * @param scene defines the hosting scene
  130437. * @returns the box mesh
  130438. */
  130439. static CreateBox(name: string, options: {
  130440. size?: number;
  130441. width?: number;
  130442. height?: number;
  130443. depth?: number;
  130444. faceUV?: Vector4[];
  130445. faceColors?: Color4[];
  130446. sideOrientation?: number;
  130447. frontUVs?: Vector4;
  130448. backUVs?: Vector4;
  130449. wrap?: boolean;
  130450. topBaseAt?: number;
  130451. bottomBaseAt?: number;
  130452. updatable?: boolean;
  130453. }, scene?: Nullable<Scene>): Mesh;
  130454. }
  130455. }
  130456. declare module BABYLON.Debug {
  130457. /**
  130458. * Used to show the physics impostor around the specific mesh
  130459. */
  130460. export class PhysicsViewer {
  130461. /** @hidden */
  130462. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  130463. /** @hidden */
  130464. protected _meshes: Array<Nullable<AbstractMesh>>;
  130465. /** @hidden */
  130466. protected _scene: Nullable<Scene>;
  130467. /** @hidden */
  130468. protected _numMeshes: number;
  130469. /** @hidden */
  130470. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  130471. private _renderFunction;
  130472. private _utilityLayer;
  130473. private _debugBoxMesh;
  130474. private _debugSphereMesh;
  130475. private _debugCylinderMesh;
  130476. private _debugMaterial;
  130477. private _debugMeshMeshes;
  130478. /**
  130479. * Creates a new PhysicsViewer
  130480. * @param scene defines the hosting scene
  130481. */
  130482. constructor(scene: Scene);
  130483. /** @hidden */
  130484. protected _updateDebugMeshes(): void;
  130485. /**
  130486. * Renders a specified physic impostor
  130487. * @param impostor defines the impostor to render
  130488. * @param targetMesh defines the mesh represented by the impostor
  130489. * @returns the new debug mesh used to render the impostor
  130490. */
  130491. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  130492. /**
  130493. * Hides a specified physic impostor
  130494. * @param impostor defines the impostor to hide
  130495. */
  130496. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  130497. private _getDebugMaterial;
  130498. private _getDebugBoxMesh;
  130499. private _getDebugSphereMesh;
  130500. private _getDebugCylinderMesh;
  130501. private _getDebugMeshMesh;
  130502. private _getDebugMesh;
  130503. /** Releases all resources */
  130504. dispose(): void;
  130505. }
  130506. }
  130507. declare module BABYLON {
  130508. /**
  130509. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  130510. * in order to better appreciate the issue one might have.
  130511. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  130512. */
  130513. export class RayHelper {
  130514. /**
  130515. * Defines the ray we are currently tryin to visualize.
  130516. */
  130517. ray: Nullable<Ray>;
  130518. private _renderPoints;
  130519. private _renderLine;
  130520. private _renderFunction;
  130521. private _scene;
  130522. private _onAfterRenderObserver;
  130523. private _onAfterStepObserver;
  130524. private _attachedToMesh;
  130525. private _meshSpaceDirection;
  130526. private _meshSpaceOrigin;
  130527. /**
  130528. * Helper function to create a colored helper in a scene in one line.
  130529. * @param ray Defines the ray we are currently tryin to visualize
  130530. * @param scene Defines the scene the ray is used in
  130531. * @param color Defines the color we want to see the ray in
  130532. * @returns The newly created ray helper.
  130533. */
  130534. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  130535. /**
  130536. * Instantiate a new ray helper.
  130537. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  130538. * in order to better appreciate the issue one might have.
  130539. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  130540. * @param ray Defines the ray we are currently tryin to visualize
  130541. */
  130542. constructor(ray: Ray);
  130543. /**
  130544. * Shows the ray we are willing to debug.
  130545. * @param scene Defines the scene the ray needs to be rendered in
  130546. * @param color Defines the color the ray needs to be rendered in
  130547. */
  130548. show(scene: Scene, color?: Color3): void;
  130549. /**
  130550. * Hides the ray we are debugging.
  130551. */
  130552. hide(): void;
  130553. private _render;
  130554. /**
  130555. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  130556. * @param mesh Defines the mesh we want the helper attached to
  130557. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  130558. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  130559. * @param length Defines the length of the ray
  130560. */
  130561. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  130562. /**
  130563. * Detach the ray helper from the mesh it has previously been attached to.
  130564. */
  130565. detachFromMesh(): void;
  130566. private _updateToMesh;
  130567. /**
  130568. * Dispose the helper and release its associated resources.
  130569. */
  130570. dispose(): void;
  130571. }
  130572. }
  130573. declare module BABYLON {
  130574. /**
  130575. * Defines the options associated with the creation of a SkeletonViewer.
  130576. */
  130577. export interface ISkeletonViewerOptions {
  130578. /** Should the system pause animations before building the Viewer? */
  130579. pauseAnimations: boolean;
  130580. /** Should the system return the skeleton to rest before building? */
  130581. returnToRest: boolean;
  130582. /** public Display Mode of the Viewer */
  130583. displayMode: number;
  130584. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  130585. displayOptions: ISkeletonViewerDisplayOptions;
  130586. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  130587. computeBonesUsingShaders: boolean;
  130588. }
  130589. /**
  130590. * Defines how to display the various bone meshes for the viewer.
  130591. */
  130592. export interface ISkeletonViewerDisplayOptions {
  130593. /** How far down to start tapering the bone spurs */
  130594. midStep?: number;
  130595. /** How big is the midStep? */
  130596. midStepFactor?: number;
  130597. /** Base for the Sphere Size */
  130598. sphereBaseSize?: number;
  130599. /** The ratio of the sphere to the longest bone in units */
  130600. sphereScaleUnit?: number;
  130601. /** Ratio for the Sphere Size */
  130602. sphereFactor?: number;
  130603. }
  130604. }
  130605. declare module BABYLON {
  130606. /**
  130607. * Class containing static functions to help procedurally build meshes
  130608. */
  130609. export class RibbonBuilder {
  130610. /**
  130611. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  130612. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  130613. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  130614. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  130615. * * 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
  130616. * * 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
  130617. * * 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
  130618. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130619. * * 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
  130620. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  130621. * * 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
  130622. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  130623. * * 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
  130624. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  130625. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130626. * @param name defines the name of the mesh
  130627. * @param options defines the options used to create the mesh
  130628. * @param scene defines the hosting scene
  130629. * @returns the ribbon mesh
  130630. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  130631. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130632. */
  130633. static CreateRibbon(name: string, options: {
  130634. pathArray: Vector3[][];
  130635. closeArray?: boolean;
  130636. closePath?: boolean;
  130637. offset?: number;
  130638. updatable?: boolean;
  130639. sideOrientation?: number;
  130640. frontUVs?: Vector4;
  130641. backUVs?: Vector4;
  130642. instance?: Mesh;
  130643. invertUV?: boolean;
  130644. uvs?: Vector2[];
  130645. colors?: Color4[];
  130646. }, scene?: Nullable<Scene>): Mesh;
  130647. }
  130648. }
  130649. declare module BABYLON {
  130650. /**
  130651. * Class containing static functions to help procedurally build meshes
  130652. */
  130653. export class ShapeBuilder {
  130654. /**
  130655. * 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.
  130656. * * 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.
  130657. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  130658. * * 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.
  130659. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  130660. * * 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
  130661. * * 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
  130662. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  130663. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130664. * * 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
  130665. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  130666. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  130667. * @param name defines the name of the mesh
  130668. * @param options defines the options used to create the mesh
  130669. * @param scene defines the hosting scene
  130670. * @returns the extruded shape mesh
  130671. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130672. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  130673. */
  130674. static ExtrudeShape(name: string, options: {
  130675. shape: Vector3[];
  130676. path: Vector3[];
  130677. scale?: number;
  130678. rotation?: number;
  130679. cap?: number;
  130680. updatable?: boolean;
  130681. sideOrientation?: number;
  130682. frontUVs?: Vector4;
  130683. backUVs?: Vector4;
  130684. instance?: Mesh;
  130685. invertUV?: boolean;
  130686. }, scene?: Nullable<Scene>): Mesh;
  130687. /**
  130688. * Creates an custom extruded shape mesh.
  130689. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  130690. * * 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.
  130691. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  130692. * * 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
  130693. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  130694. * * 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
  130695. * * It must returns a float value that will be the scale value applied to the shape on each path point
  130696. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  130697. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  130698. * * 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
  130699. * * 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
  130700. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  130701. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130702. * * 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
  130703. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  130704. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130705. * @param name defines the name of the mesh
  130706. * @param options defines the options used to create the mesh
  130707. * @param scene defines the hosting scene
  130708. * @returns the custom extruded shape mesh
  130709. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  130710. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130711. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  130712. */
  130713. static ExtrudeShapeCustom(name: string, options: {
  130714. shape: Vector3[];
  130715. path: Vector3[];
  130716. scaleFunction?: any;
  130717. rotationFunction?: any;
  130718. ribbonCloseArray?: boolean;
  130719. ribbonClosePath?: boolean;
  130720. cap?: number;
  130721. updatable?: boolean;
  130722. sideOrientation?: number;
  130723. frontUVs?: Vector4;
  130724. backUVs?: Vector4;
  130725. instance?: Mesh;
  130726. invertUV?: boolean;
  130727. }, scene?: Nullable<Scene>): Mesh;
  130728. private static _ExtrudeShapeGeneric;
  130729. }
  130730. }
  130731. declare module BABYLON.Debug {
  130732. /**
  130733. * Class used to render a debug view of a given skeleton
  130734. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  130735. */
  130736. export class SkeletonViewer {
  130737. /** defines the skeleton to render */
  130738. skeleton: Skeleton;
  130739. /** defines the mesh attached to the skeleton */
  130740. mesh: AbstractMesh;
  130741. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  130742. autoUpdateBonesMatrices: boolean;
  130743. /** defines the rendering group id to use with the viewer */
  130744. renderingGroupId: number;
  130745. /** is the options for the viewer */
  130746. options: Partial<ISkeletonViewerOptions>;
  130747. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_LINES */
  130748. static readonly DISPLAY_LINES: number;
  130749. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERES */
  130750. static readonly DISPLAY_SPHERES: number;
  130751. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERE_AND_SPURS */
  130752. static readonly DISPLAY_SPHERE_AND_SPURS: number;
  130753. /** If SkeletonViewer scene scope. */
  130754. private _scene;
  130755. /** Gets or sets the color used to render the skeleton */
  130756. color: Color3;
  130757. /** Array of the points of the skeleton fo the line view. */
  130758. private _debugLines;
  130759. /** The SkeletonViewers Mesh. */
  130760. private _debugMesh;
  130761. /** If SkeletonViewer is enabled. */
  130762. private _isEnabled;
  130763. /** If SkeletonViewer is ready. */
  130764. private _ready;
  130765. /** SkeletonViewer render observable. */
  130766. private _obs;
  130767. /** The Utility Layer to render the gizmos in. */
  130768. private _utilityLayer;
  130769. private _boneIndices;
  130770. /** Gets the Scene. */
  130771. get scene(): Scene;
  130772. /** Gets the utilityLayer. */
  130773. get utilityLayer(): Nullable<UtilityLayerRenderer>;
  130774. /** Checks Ready Status. */
  130775. get isReady(): Boolean;
  130776. /** Sets Ready Status. */
  130777. set ready(value: boolean);
  130778. /** Gets the debugMesh */
  130779. get debugMesh(): Nullable<AbstractMesh> | Nullable<LinesMesh>;
  130780. /** Sets the debugMesh */
  130781. set debugMesh(value: Nullable<AbstractMesh> | Nullable<LinesMesh>);
  130782. /** Gets the material */
  130783. get material(): StandardMaterial;
  130784. /** Sets the material */
  130785. set material(value: StandardMaterial);
  130786. /** Gets the material */
  130787. get displayMode(): number;
  130788. /** Sets the material */
  130789. set displayMode(value: number);
  130790. /**
  130791. * Creates a new SkeletonViewer
  130792. * @param skeleton defines the skeleton to render
  130793. * @param mesh defines the mesh attached to the skeleton
  130794. * @param scene defines the hosting scene
  130795. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  130796. * @param renderingGroupId defines the rendering group id to use with the viewer
  130797. * @param options All of the extra constructor options for the SkeletonViewer
  130798. */
  130799. constructor(
  130800. /** defines the skeleton to render */
  130801. skeleton: Skeleton,
  130802. /** defines the mesh attached to the skeleton */
  130803. mesh: AbstractMesh,
  130804. /** The Scene scope*/
  130805. scene: Scene,
  130806. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  130807. autoUpdateBonesMatrices?: boolean,
  130808. /** defines the rendering group id to use with the viewer */
  130809. renderingGroupId?: number,
  130810. /** is the options for the viewer */
  130811. options?: Partial<ISkeletonViewerOptions>);
  130812. /** The Dynamic bindings for the update functions */
  130813. private _bindObs;
  130814. /** Update the viewer to sync with current skeleton state, only used to manually update. */
  130815. update(): void;
  130816. /** Gets or sets a boolean indicating if the viewer is enabled */
  130817. set isEnabled(value: boolean);
  130818. get isEnabled(): boolean;
  130819. private _getBonePosition;
  130820. private _getLinesForBonesWithLength;
  130821. private _getLinesForBonesNoLength;
  130822. /** function to revert the mesh and scene back to the initial state. */
  130823. private _revert;
  130824. /** function to build and bind sphere joint points and spur bone representations. */
  130825. private _buildSpheresAndSpurs;
  130826. /** Update the viewer to sync with current skeleton state, only used for the line display. */
  130827. private _displayLinesUpdate;
  130828. /** Changes the displayMode of the skeleton viewer
  130829. * @param mode The displayMode numerical value
  130830. */
  130831. changeDisplayMode(mode: number): void;
  130832. /** Changes the displayMode of the skeleton viewer
  130833. * @param option String of the option name
  130834. * @param value The numerical option value
  130835. */
  130836. changeDisplayOptions(option: string, value: number): void;
  130837. /** Release associated resources */
  130838. dispose(): void;
  130839. }
  130840. }
  130841. declare module BABYLON {
  130842. /**
  130843. * Enum for Device Types
  130844. */
  130845. export enum DeviceType {
  130846. /** Generic */
  130847. Generic = 0,
  130848. /** Keyboard */
  130849. Keyboard = 1,
  130850. /** Mouse */
  130851. Mouse = 2,
  130852. /** Touch Pointers */
  130853. Touch = 3,
  130854. /** PS4 Dual Shock */
  130855. DualShock = 4,
  130856. /** Xbox */
  130857. Xbox = 5,
  130858. /** Switch Controller */
  130859. Switch = 6
  130860. }
  130861. /**
  130862. * Enum for All Pointers (Touch/Mouse)
  130863. */
  130864. export enum PointerInput {
  130865. /** Horizontal Axis */
  130866. Horizontal = 0,
  130867. /** Vertical Axis */
  130868. Vertical = 1,
  130869. /** Left Click or Touch */
  130870. LeftClick = 2,
  130871. /** Middle Click */
  130872. MiddleClick = 3,
  130873. /** Right Click */
  130874. RightClick = 4,
  130875. /** Browser Back */
  130876. BrowserBack = 5,
  130877. /** Browser Forward */
  130878. BrowserForward = 6
  130879. }
  130880. /**
  130881. * Enum for Dual Shock Gamepad
  130882. */
  130883. export enum DualShockInput {
  130884. /** Cross */
  130885. Cross = 0,
  130886. /** Circle */
  130887. Circle = 1,
  130888. /** Square */
  130889. Square = 2,
  130890. /** Triangle */
  130891. Triangle = 3,
  130892. /** L1 */
  130893. L1 = 4,
  130894. /** R1 */
  130895. R1 = 5,
  130896. /** L2 */
  130897. L2 = 6,
  130898. /** R2 */
  130899. R2 = 7,
  130900. /** Share */
  130901. Share = 8,
  130902. /** Options */
  130903. Options = 9,
  130904. /** L3 */
  130905. L3 = 10,
  130906. /** R3 */
  130907. R3 = 11,
  130908. /** DPadUp */
  130909. DPadUp = 12,
  130910. /** DPadDown */
  130911. DPadDown = 13,
  130912. /** DPadLeft */
  130913. DPadLeft = 14,
  130914. /** DRight */
  130915. DPadRight = 15,
  130916. /** Home */
  130917. Home = 16,
  130918. /** TouchPad */
  130919. TouchPad = 17,
  130920. /** LStickXAxis */
  130921. LStickXAxis = 18,
  130922. /** LStickYAxis */
  130923. LStickYAxis = 19,
  130924. /** RStickXAxis */
  130925. RStickXAxis = 20,
  130926. /** RStickYAxis */
  130927. RStickYAxis = 21
  130928. }
  130929. /**
  130930. * Enum for Xbox Gamepad
  130931. */
  130932. export enum XboxInput {
  130933. /** A */
  130934. A = 0,
  130935. /** B */
  130936. B = 1,
  130937. /** X */
  130938. X = 2,
  130939. /** Y */
  130940. Y = 3,
  130941. /** LB */
  130942. LB = 4,
  130943. /** RB */
  130944. RB = 5,
  130945. /** LT */
  130946. LT = 6,
  130947. /** RT */
  130948. RT = 7,
  130949. /** Back */
  130950. Back = 8,
  130951. /** Start */
  130952. Start = 9,
  130953. /** LS */
  130954. LS = 10,
  130955. /** RS */
  130956. RS = 11,
  130957. /** DPadUp */
  130958. DPadUp = 12,
  130959. /** DPadDown */
  130960. DPadDown = 13,
  130961. /** DPadLeft */
  130962. DPadLeft = 14,
  130963. /** DRight */
  130964. DPadRight = 15,
  130965. /** Home */
  130966. Home = 16,
  130967. /** LStickXAxis */
  130968. LStickXAxis = 17,
  130969. /** LStickYAxis */
  130970. LStickYAxis = 18,
  130971. /** RStickXAxis */
  130972. RStickXAxis = 19,
  130973. /** RStickYAxis */
  130974. RStickYAxis = 20
  130975. }
  130976. /**
  130977. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  130978. */
  130979. export enum SwitchInput {
  130980. /** B */
  130981. B = 0,
  130982. /** A */
  130983. A = 1,
  130984. /** Y */
  130985. Y = 2,
  130986. /** X */
  130987. X = 3,
  130988. /** L */
  130989. L = 4,
  130990. /** R */
  130991. R = 5,
  130992. /** ZL */
  130993. ZL = 6,
  130994. /** ZR */
  130995. ZR = 7,
  130996. /** Minus */
  130997. Minus = 8,
  130998. /** Plus */
  130999. Plus = 9,
  131000. /** LS */
  131001. LS = 10,
  131002. /** RS */
  131003. RS = 11,
  131004. /** DPadUp */
  131005. DPadUp = 12,
  131006. /** DPadDown */
  131007. DPadDown = 13,
  131008. /** DPadLeft */
  131009. DPadLeft = 14,
  131010. /** DRight */
  131011. DPadRight = 15,
  131012. /** Home */
  131013. Home = 16,
  131014. /** Capture */
  131015. Capture = 17,
  131016. /** LStickXAxis */
  131017. LStickXAxis = 18,
  131018. /** LStickYAxis */
  131019. LStickYAxis = 19,
  131020. /** RStickXAxis */
  131021. RStickXAxis = 20,
  131022. /** RStickYAxis */
  131023. RStickYAxis = 21
  131024. }
  131025. }
  131026. declare module BABYLON {
  131027. /**
  131028. * This class will take all inputs from Keyboard, Pointer, and
  131029. * any Gamepads and provide a polling system that all devices
  131030. * will use. This class assumes that there will only be one
  131031. * pointer device and one keyboard.
  131032. */
  131033. export class DeviceInputSystem implements IDisposable {
  131034. /**
  131035. * Callback to be triggered when a device is connected
  131036. */
  131037. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  131038. /**
  131039. * Callback to be triggered when a device is disconnected
  131040. */
  131041. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  131042. /**
  131043. * Callback to be triggered when event driven input is updated
  131044. */
  131045. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  131046. private _inputs;
  131047. private _gamepads;
  131048. private _keyboardActive;
  131049. private _pointerActive;
  131050. private _elementToAttachTo;
  131051. private _keyboardDownEvent;
  131052. private _keyboardUpEvent;
  131053. private _pointerMoveEvent;
  131054. private _pointerDownEvent;
  131055. private _pointerUpEvent;
  131056. private _gamepadConnectedEvent;
  131057. private _gamepadDisconnectedEvent;
  131058. private static _MAX_KEYCODES;
  131059. private static _MAX_POINTER_INPUTS;
  131060. private constructor();
  131061. /**
  131062. * Creates a new DeviceInputSystem instance
  131063. * @param engine Engine to pull input element from
  131064. * @returns The new instance
  131065. */
  131066. static Create(engine: Engine): DeviceInputSystem;
  131067. /**
  131068. * Checks for current device input value, given an id and input index
  131069. * @param deviceName Id of connected device
  131070. * @param inputIndex Index of device input
  131071. * @returns Current value of input
  131072. */
  131073. /**
  131074. * Checks for current device input value, given an id and input index. Throws exception if requested device not initialized.
  131075. * @param deviceType Enum specifiying device type
  131076. * @param deviceSlot "Slot" or index that device is referenced in
  131077. * @param inputIndex Id of input to be checked
  131078. * @returns Current value of input
  131079. */
  131080. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): number;
  131081. /**
  131082. * Dispose of all the eventlisteners
  131083. */
  131084. dispose(): void;
  131085. /**
  131086. * Add device and inputs to device array
  131087. * @param deviceType Enum specifiying device type
  131088. * @param deviceSlot "Slot" or index that device is referenced in
  131089. * @param numberOfInputs Number of input entries to create for given device
  131090. */
  131091. private _registerDevice;
  131092. /**
  131093. * Given a specific device name, remove that device from the device map
  131094. * @param deviceType Enum specifiying device type
  131095. * @param deviceSlot "Slot" or index that device is referenced in
  131096. */
  131097. private _unregisterDevice;
  131098. /**
  131099. * Handle all actions that come from keyboard interaction
  131100. */
  131101. private _handleKeyActions;
  131102. /**
  131103. * Handle all actions that come from pointer interaction
  131104. */
  131105. private _handlePointerActions;
  131106. /**
  131107. * Handle all actions that come from gamepad interaction
  131108. */
  131109. private _handleGamepadActions;
  131110. /**
  131111. * Update all non-event based devices with each frame
  131112. * @param deviceType Enum specifiying device type
  131113. * @param deviceSlot "Slot" or index that device is referenced in
  131114. * @param inputIndex Id of input to be checked
  131115. */
  131116. private _updateDevice;
  131117. /**
  131118. * Gets DeviceType from the device name
  131119. * @param deviceName Name of Device from DeviceInputSystem
  131120. * @returns DeviceType enum value
  131121. */
  131122. private _getGamepadDeviceType;
  131123. }
  131124. }
  131125. declare module BABYLON {
  131126. /**
  131127. * Type to handle enforcement of inputs
  131128. */
  131129. 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;
  131130. }
  131131. declare module BABYLON {
  131132. /**
  131133. * Class that handles all input for a specific device
  131134. */
  131135. export class DeviceSource<T extends DeviceType> {
  131136. /** Type of device */
  131137. readonly deviceType: DeviceType;
  131138. /** "Slot" or index that device is referenced in */
  131139. readonly deviceSlot: number;
  131140. /**
  131141. * Observable to handle device input changes per device
  131142. */
  131143. readonly onInputChangedObservable: Observable<{
  131144. inputIndex: DeviceInput<T>;
  131145. previousState: Nullable<number>;
  131146. currentState: Nullable<number>;
  131147. }>;
  131148. private readonly _deviceInputSystem;
  131149. /**
  131150. * Default Constructor
  131151. * @param deviceInputSystem Reference to DeviceInputSystem
  131152. * @param deviceType Type of device
  131153. * @param deviceSlot "Slot" or index that device is referenced in
  131154. */
  131155. constructor(deviceInputSystem: DeviceInputSystem,
  131156. /** Type of device */
  131157. deviceType: DeviceType,
  131158. /** "Slot" or index that device is referenced in */
  131159. deviceSlot?: number);
  131160. /**
  131161. * Get input for specific input
  131162. * @param inputIndex index of specific input on device
  131163. * @returns Input value from DeviceInputSystem
  131164. */
  131165. getInput(inputIndex: DeviceInput<T>): Nullable<number>;
  131166. }
  131167. /**
  131168. * Class to keep track of devices
  131169. */
  131170. export class DeviceSourceManager implements IDisposable {
  131171. /**
  131172. * Observable to be triggered when before a device is connected
  131173. */
  131174. readonly onBeforeDeviceConnectedObservable: Observable<{
  131175. deviceType: DeviceType;
  131176. deviceSlot: number;
  131177. }>;
  131178. /**
  131179. * Observable to be triggered when before a device is disconnected
  131180. */
  131181. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  131182. deviceType: DeviceType;
  131183. deviceSlot: number;
  131184. }>;
  131185. /**
  131186. * Observable to be triggered when after a device is connected
  131187. */
  131188. readonly onAfterDeviceConnectedObservable: Observable<{
  131189. deviceType: DeviceType;
  131190. deviceSlot: number;
  131191. }>;
  131192. /**
  131193. * Observable to be triggered when after a device is disconnected
  131194. */
  131195. readonly onAfterDeviceDisconnectedObservable: Observable<{
  131196. deviceType: DeviceType;
  131197. deviceSlot: number;
  131198. }>;
  131199. private readonly _devices;
  131200. private readonly _firstDevice;
  131201. private readonly _deviceInputSystem;
  131202. /**
  131203. * Default Constructor
  131204. * @param engine engine to pull input element from
  131205. */
  131206. constructor(engine: Engine);
  131207. /**
  131208. * Gets a DeviceSource, given a type and slot
  131209. * @param deviceType Enum specifying device type
  131210. * @param deviceSlot "Slot" or index that device is referenced in
  131211. * @returns DeviceSource object
  131212. */
  131213. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  131214. /**
  131215. * Gets an array of DeviceSource objects for a given device type
  131216. * @param deviceType Enum specifying device type
  131217. * @returns Array of DeviceSource objects
  131218. */
  131219. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  131220. /**
  131221. * Dispose of DeviceInputSystem and other parts
  131222. */
  131223. dispose(): void;
  131224. /**
  131225. * Function to add device name to device list
  131226. * @param deviceType Enum specifying device type
  131227. * @param deviceSlot "Slot" or index that device is referenced in
  131228. */
  131229. private _addDevice;
  131230. /**
  131231. * Function to remove device name to device list
  131232. * @param deviceType Enum specifying device type
  131233. * @param deviceSlot "Slot" or index that device is referenced in
  131234. */
  131235. private _removeDevice;
  131236. /**
  131237. * Updates array storing first connected device of each type
  131238. * @param type Type of Device
  131239. */
  131240. private _updateFirstDevices;
  131241. }
  131242. }
  131243. declare module BABYLON {
  131244. /**
  131245. * Options to create the null engine
  131246. */
  131247. export class NullEngineOptions {
  131248. /**
  131249. * Render width (Default: 512)
  131250. */
  131251. renderWidth: number;
  131252. /**
  131253. * Render height (Default: 256)
  131254. */
  131255. renderHeight: number;
  131256. /**
  131257. * Texture size (Default: 512)
  131258. */
  131259. textureSize: number;
  131260. /**
  131261. * If delta time between frames should be constant
  131262. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131263. */
  131264. deterministicLockstep: boolean;
  131265. /**
  131266. * Maximum about of steps between frames (Default: 4)
  131267. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131268. */
  131269. lockstepMaxSteps: number;
  131270. /**
  131271. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  131272. */
  131273. useHighPrecisionMatrix?: boolean;
  131274. }
  131275. /**
  131276. * The null engine class provides support for headless version of babylon.js.
  131277. * This can be used in server side scenario or for testing purposes
  131278. */
  131279. export class NullEngine extends Engine {
  131280. private _options;
  131281. /**
  131282. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  131283. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131284. * @returns true if engine is in deterministic lock step mode
  131285. */
  131286. isDeterministicLockStep(): boolean;
  131287. /**
  131288. * Gets the max steps when engine is running in deterministic lock step
  131289. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131290. * @returns the max steps
  131291. */
  131292. getLockstepMaxSteps(): number;
  131293. /**
  131294. * Gets the current hardware scaling level.
  131295. * By default the hardware scaling level is computed from the window device ratio.
  131296. * 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.
  131297. * @returns a number indicating the current hardware scaling level
  131298. */
  131299. getHardwareScalingLevel(): number;
  131300. constructor(options?: NullEngineOptions);
  131301. /**
  131302. * Creates a vertex buffer
  131303. * @param vertices the data for the vertex buffer
  131304. * @returns the new WebGL static buffer
  131305. */
  131306. createVertexBuffer(vertices: FloatArray): DataBuffer;
  131307. /**
  131308. * Creates a new index buffer
  131309. * @param indices defines the content of the index buffer
  131310. * @param updatable defines if the index buffer must be updatable
  131311. * @returns a new webGL buffer
  131312. */
  131313. createIndexBuffer(indices: IndicesArray): DataBuffer;
  131314. /**
  131315. * Clear the current render buffer or the current render target (if any is set up)
  131316. * @param color defines the color to use
  131317. * @param backBuffer defines if the back buffer must be cleared
  131318. * @param depth defines if the depth buffer must be cleared
  131319. * @param stencil defines if the stencil buffer must be cleared
  131320. */
  131321. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  131322. /**
  131323. * Gets the current render width
  131324. * @param useScreen defines if screen size must be used (or the current render target if any)
  131325. * @returns a number defining the current render width
  131326. */
  131327. getRenderWidth(useScreen?: boolean): number;
  131328. /**
  131329. * Gets the current render height
  131330. * @param useScreen defines if screen size must be used (or the current render target if any)
  131331. * @returns a number defining the current render height
  131332. */
  131333. getRenderHeight(useScreen?: boolean): number;
  131334. /**
  131335. * Set the WebGL's viewport
  131336. * @param viewport defines the viewport element to be used
  131337. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  131338. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  131339. */
  131340. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  131341. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  131342. /**
  131343. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  131344. * @param pipelineContext defines the pipeline context to use
  131345. * @param uniformsNames defines the list of uniform names
  131346. * @returns an array of webGL uniform locations
  131347. */
  131348. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  131349. /**
  131350. * Gets the lsit of active attributes for a given webGL program
  131351. * @param pipelineContext defines the pipeline context to use
  131352. * @param attributesNames defines the list of attribute names to get
  131353. * @returns an array of indices indicating the offset of each attribute
  131354. */
  131355. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  131356. /**
  131357. * Binds an effect to the webGL context
  131358. * @param effect defines the effect to bind
  131359. */
  131360. bindSamplers(effect: Effect): void;
  131361. /**
  131362. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  131363. * @param effect defines the effect to activate
  131364. */
  131365. enableEffect(effect: Effect): void;
  131366. /**
  131367. * Set various states to the webGL context
  131368. * @param culling defines backface culling state
  131369. * @param zOffset defines the value to apply to zOffset (0 by default)
  131370. * @param force defines if states must be applied even if cache is up to date
  131371. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  131372. */
  131373. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  131374. /**
  131375. * Set the value of an uniform to an array of int32
  131376. * @param uniform defines the webGL uniform location where to store the value
  131377. * @param array defines the array of int32 to store
  131378. */
  131379. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  131380. /**
  131381. * Set the value of an uniform to an array of int32 (stored as vec2)
  131382. * @param uniform defines the webGL uniform location where to store the value
  131383. * @param array defines the array of int32 to store
  131384. */
  131385. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  131386. /**
  131387. * Set the value of an uniform to an array of int32 (stored as vec3)
  131388. * @param uniform defines the webGL uniform location where to store the value
  131389. * @param array defines the array of int32 to store
  131390. */
  131391. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  131392. /**
  131393. * Set the value of an uniform to an array of int32 (stored as vec4)
  131394. * @param uniform defines the webGL uniform location where to store the value
  131395. * @param array defines the array of int32 to store
  131396. */
  131397. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  131398. /**
  131399. * Set the value of an uniform to an array of float32
  131400. * @param uniform defines the webGL uniform location where to store the value
  131401. * @param array defines the array of float32 to store
  131402. */
  131403. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  131404. /**
  131405. * Set the value of an uniform to an array of float32 (stored as vec2)
  131406. * @param uniform defines the webGL uniform location where to store the value
  131407. * @param array defines the array of float32 to store
  131408. */
  131409. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  131410. /**
  131411. * Set the value of an uniform to an array of float32 (stored as vec3)
  131412. * @param uniform defines the webGL uniform location where to store the value
  131413. * @param array defines the array of float32 to store
  131414. */
  131415. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  131416. /**
  131417. * Set the value of an uniform to an array of float32 (stored as vec4)
  131418. * @param uniform defines the webGL uniform location where to store the value
  131419. * @param array defines the array of float32 to store
  131420. */
  131421. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  131422. /**
  131423. * Set the value of an uniform to an array of number
  131424. * @param uniform defines the webGL uniform location where to store the value
  131425. * @param array defines the array of number to store
  131426. */
  131427. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  131428. /**
  131429. * Set the value of an uniform to an array of number (stored as vec2)
  131430. * @param uniform defines the webGL uniform location where to store the value
  131431. * @param array defines the array of number to store
  131432. */
  131433. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  131434. /**
  131435. * Set the value of an uniform to an array of number (stored as vec3)
  131436. * @param uniform defines the webGL uniform location where to store the value
  131437. * @param array defines the array of number to store
  131438. */
  131439. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  131440. /**
  131441. * Set the value of an uniform to an array of number (stored as vec4)
  131442. * @param uniform defines the webGL uniform location where to store the value
  131443. * @param array defines the array of number to store
  131444. */
  131445. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  131446. /**
  131447. * Set the value of an uniform to an array of float32 (stored as matrices)
  131448. * @param uniform defines the webGL uniform location where to store the value
  131449. * @param matrices defines the array of float32 to store
  131450. */
  131451. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  131452. /**
  131453. * Set the value of an uniform to a matrix (3x3)
  131454. * @param uniform defines the webGL uniform location where to store the value
  131455. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  131456. */
  131457. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  131458. /**
  131459. * Set the value of an uniform to a matrix (2x2)
  131460. * @param uniform defines the webGL uniform location where to store the value
  131461. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  131462. */
  131463. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  131464. /**
  131465. * Set the value of an uniform to a number (float)
  131466. * @param uniform defines the webGL uniform location where to store the value
  131467. * @param value defines the float number to store
  131468. */
  131469. setFloat(uniform: WebGLUniformLocation, value: number): void;
  131470. /**
  131471. * Set the value of an uniform to a vec2
  131472. * @param uniform defines the webGL uniform location where to store the value
  131473. * @param x defines the 1st component of the value
  131474. * @param y defines the 2nd component of the value
  131475. */
  131476. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  131477. /**
  131478. * Set the value of an uniform to a vec3
  131479. * @param uniform defines the webGL uniform location where to store the value
  131480. * @param x defines the 1st component of the value
  131481. * @param y defines the 2nd component of the value
  131482. * @param z defines the 3rd component of the value
  131483. */
  131484. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  131485. /**
  131486. * Set the value of an uniform to a boolean
  131487. * @param uniform defines the webGL uniform location where to store the value
  131488. * @param bool defines the boolean to store
  131489. */
  131490. setBool(uniform: WebGLUniformLocation, bool: number): void;
  131491. /**
  131492. * Set the value of an uniform to a vec4
  131493. * @param uniform defines the webGL uniform location where to store the value
  131494. * @param x defines the 1st component of the value
  131495. * @param y defines the 2nd component of the value
  131496. * @param z defines the 3rd component of the value
  131497. * @param w defines the 4th component of the value
  131498. */
  131499. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  131500. /**
  131501. * Sets the current alpha mode
  131502. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  131503. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  131504. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  131505. */
  131506. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  131507. /**
  131508. * Bind webGl buffers directly to the webGL context
  131509. * @param vertexBuffers defines the vertex buffer to bind
  131510. * @param indexBuffer defines the index buffer to bind
  131511. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  131512. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  131513. * @param effect defines the effect associated with the vertex buffer
  131514. */
  131515. bindBuffers(vertexBuffers: {
  131516. [key: string]: VertexBuffer;
  131517. }, indexBuffer: DataBuffer, effect: Effect): void;
  131518. /**
  131519. * Force the entire cache to be cleared
  131520. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  131521. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  131522. */
  131523. wipeCaches(bruteForce?: boolean): void;
  131524. /**
  131525. * Send a draw order
  131526. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  131527. * @param indexStart defines the starting index
  131528. * @param indexCount defines the number of index to draw
  131529. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131530. */
  131531. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  131532. /**
  131533. * Draw a list of indexed primitives
  131534. * @param fillMode defines the primitive to use
  131535. * @param indexStart defines the starting index
  131536. * @param indexCount defines the number of index to draw
  131537. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131538. */
  131539. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  131540. /**
  131541. * Draw a list of unindexed primitives
  131542. * @param fillMode defines the primitive to use
  131543. * @param verticesStart defines the index of first vertex to draw
  131544. * @param verticesCount defines the count of vertices to draw
  131545. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131546. */
  131547. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  131548. /** @hidden */
  131549. _createTexture(): WebGLTexture;
  131550. /** @hidden */
  131551. _releaseTexture(texture: InternalTexture): void;
  131552. /**
  131553. * Usually called from Texture.ts.
  131554. * Passed information to create a WebGLTexture
  131555. * @param urlArg defines a value which contains one of the following:
  131556. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  131557. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  131558. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  131559. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  131560. * @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)
  131561. * @param scene needed for loading to the correct scene
  131562. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  131563. * @param onLoad optional callback to be called upon successful completion
  131564. * @param onError optional callback to be called upon failure
  131565. * @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
  131566. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  131567. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  131568. * @param forcedExtension defines the extension to use to pick the right loader
  131569. * @param mimeType defines an optional mime type
  131570. * @returns a InternalTexture for assignment back into BABYLON.Texture
  131571. */
  131572. 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;
  131573. /**
  131574. * Creates a new render target texture
  131575. * @param size defines the size of the texture
  131576. * @param options defines the options used to create the texture
  131577. * @returns a new render target texture stored in an InternalTexture
  131578. */
  131579. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  131580. /**
  131581. * Update the sampling mode of a given texture
  131582. * @param samplingMode defines the required sampling mode
  131583. * @param texture defines the texture to update
  131584. */
  131585. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  131586. /**
  131587. * Binds the frame buffer to the specified texture.
  131588. * @param texture The texture to render to or null for the default canvas
  131589. * @param faceIndex The face of the texture to render to in case of cube texture
  131590. * @param requiredWidth The width of the target to render to
  131591. * @param requiredHeight The height of the target to render to
  131592. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  131593. * @param lodLevel defines le lod level to bind to the frame buffer
  131594. */
  131595. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  131596. /**
  131597. * Unbind the current render target texture from the webGL context
  131598. * @param texture defines the render target texture to unbind
  131599. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  131600. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  131601. */
  131602. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  131603. /**
  131604. * Creates a dynamic vertex buffer
  131605. * @param vertices the data for the dynamic vertex buffer
  131606. * @returns the new WebGL dynamic buffer
  131607. */
  131608. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  131609. /**
  131610. * Update the content of a dynamic texture
  131611. * @param texture defines the texture to update
  131612. * @param canvas defines the canvas containing the source
  131613. * @param invertY defines if data must be stored with Y axis inverted
  131614. * @param premulAlpha defines if alpha is stored as premultiplied
  131615. * @param format defines the format of the data
  131616. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  131617. */
  131618. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  131619. /**
  131620. * Gets a boolean indicating if all created effects are ready
  131621. * @returns true if all effects are ready
  131622. */
  131623. areAllEffectsReady(): boolean;
  131624. /**
  131625. * @hidden
  131626. * Get the current error code of the webGL context
  131627. * @returns the error code
  131628. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  131629. */
  131630. getError(): number;
  131631. /** @hidden */
  131632. _getUnpackAlignement(): number;
  131633. /** @hidden */
  131634. _unpackFlipY(value: boolean): void;
  131635. /**
  131636. * Update a dynamic index buffer
  131637. * @param indexBuffer defines the target index buffer
  131638. * @param indices defines the data to update
  131639. * @param offset defines the offset in the target index buffer where update should start
  131640. */
  131641. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  131642. /**
  131643. * Updates a dynamic vertex buffer.
  131644. * @param vertexBuffer the vertex buffer to update
  131645. * @param vertices the data used to update the vertex buffer
  131646. * @param byteOffset the byte offset of the data (optional)
  131647. * @param byteLength the byte length of the data (optional)
  131648. */
  131649. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  131650. /** @hidden */
  131651. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  131652. /** @hidden */
  131653. _bindTexture(channel: number, texture: InternalTexture): void;
  131654. protected _deleteBuffer(buffer: WebGLBuffer): void;
  131655. /**
  131656. * 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
  131657. */
  131658. releaseEffects(): void;
  131659. displayLoadingUI(): void;
  131660. hideLoadingUI(): void;
  131661. /** @hidden */
  131662. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131663. /** @hidden */
  131664. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131665. /** @hidden */
  131666. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131667. /** @hidden */
  131668. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  131669. }
  131670. }
  131671. declare module BABYLON {
  131672. /**
  131673. * @hidden
  131674. **/
  131675. export class _TimeToken {
  131676. _startTimeQuery: Nullable<WebGLQuery>;
  131677. _endTimeQuery: Nullable<WebGLQuery>;
  131678. _timeElapsedQuery: Nullable<WebGLQuery>;
  131679. _timeElapsedQueryEnded: boolean;
  131680. }
  131681. }
  131682. declare module BABYLON {
  131683. /** @hidden */
  131684. export class _OcclusionDataStorage {
  131685. /** @hidden */
  131686. occlusionInternalRetryCounter: number;
  131687. /** @hidden */
  131688. isOcclusionQueryInProgress: boolean;
  131689. /** @hidden */
  131690. isOccluded: boolean;
  131691. /** @hidden */
  131692. occlusionRetryCount: number;
  131693. /** @hidden */
  131694. occlusionType: number;
  131695. /** @hidden */
  131696. occlusionQueryAlgorithmType: number;
  131697. }
  131698. interface Engine {
  131699. /**
  131700. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  131701. * @return the new query
  131702. */
  131703. createQuery(): WebGLQuery;
  131704. /**
  131705. * Delete and release a webGL query
  131706. * @param query defines the query to delete
  131707. * @return the current engine
  131708. */
  131709. deleteQuery(query: WebGLQuery): Engine;
  131710. /**
  131711. * Check if a given query has resolved and got its value
  131712. * @param query defines the query to check
  131713. * @returns true if the query got its value
  131714. */
  131715. isQueryResultAvailable(query: WebGLQuery): boolean;
  131716. /**
  131717. * Gets the value of a given query
  131718. * @param query defines the query to check
  131719. * @returns the value of the query
  131720. */
  131721. getQueryResult(query: WebGLQuery): number;
  131722. /**
  131723. * Initiates an occlusion query
  131724. * @param algorithmType defines the algorithm to use
  131725. * @param query defines the query to use
  131726. * @returns the current engine
  131727. * @see https://doc.babylonjs.com/features/occlusionquery
  131728. */
  131729. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  131730. /**
  131731. * Ends an occlusion query
  131732. * @see https://doc.babylonjs.com/features/occlusionquery
  131733. * @param algorithmType defines the algorithm to use
  131734. * @returns the current engine
  131735. */
  131736. endOcclusionQuery(algorithmType: number): Engine;
  131737. /**
  131738. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  131739. * Please note that only one query can be issued at a time
  131740. * @returns a time token used to track the time span
  131741. */
  131742. startTimeQuery(): Nullable<_TimeToken>;
  131743. /**
  131744. * Ends a time query
  131745. * @param token defines the token used to measure the time span
  131746. * @returns the time spent (in ns)
  131747. */
  131748. endTimeQuery(token: _TimeToken): int;
  131749. /** @hidden */
  131750. _currentNonTimestampToken: Nullable<_TimeToken>;
  131751. /** @hidden */
  131752. _createTimeQuery(): WebGLQuery;
  131753. /** @hidden */
  131754. _deleteTimeQuery(query: WebGLQuery): void;
  131755. /** @hidden */
  131756. _getGlAlgorithmType(algorithmType: number): number;
  131757. /** @hidden */
  131758. _getTimeQueryResult(query: WebGLQuery): any;
  131759. /** @hidden */
  131760. _getTimeQueryAvailability(query: WebGLQuery): any;
  131761. }
  131762. interface AbstractMesh {
  131763. /**
  131764. * Backing filed
  131765. * @hidden
  131766. */
  131767. __occlusionDataStorage: _OcclusionDataStorage;
  131768. /**
  131769. * Access property
  131770. * @hidden
  131771. */
  131772. _occlusionDataStorage: _OcclusionDataStorage;
  131773. /**
  131774. * 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.
  131775. * The default value is -1 which means don't break the query and wait till the result
  131776. * @see https://doc.babylonjs.com/features/occlusionquery
  131777. */
  131778. occlusionRetryCount: number;
  131779. /**
  131780. * 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:
  131781. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  131782. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  131783. * * 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.
  131784. * @see https://doc.babylonjs.com/features/occlusionquery
  131785. */
  131786. occlusionType: number;
  131787. /**
  131788. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  131789. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  131790. * * 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.
  131791. * @see https://doc.babylonjs.com/features/occlusionquery
  131792. */
  131793. occlusionQueryAlgorithmType: number;
  131794. /**
  131795. * 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
  131796. * @see https://doc.babylonjs.com/features/occlusionquery
  131797. */
  131798. isOccluded: boolean;
  131799. /**
  131800. * Flag to check the progress status of the query
  131801. * @see https://doc.babylonjs.com/features/occlusionquery
  131802. */
  131803. isOcclusionQueryInProgress: boolean;
  131804. }
  131805. }
  131806. declare module BABYLON {
  131807. /** @hidden */
  131808. export var _forceTransformFeedbackToBundle: boolean;
  131809. interface Engine {
  131810. /**
  131811. * Creates a webGL transform feedback object
  131812. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  131813. * @returns the webGL transform feedback object
  131814. */
  131815. createTransformFeedback(): WebGLTransformFeedback;
  131816. /**
  131817. * Delete a webGL transform feedback object
  131818. * @param value defines the webGL transform feedback object to delete
  131819. */
  131820. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  131821. /**
  131822. * Bind a webGL transform feedback object to the webgl context
  131823. * @param value defines the webGL transform feedback object to bind
  131824. */
  131825. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  131826. /**
  131827. * Begins a transform feedback operation
  131828. * @param usePoints defines if points or triangles must be used
  131829. */
  131830. beginTransformFeedback(usePoints: boolean): void;
  131831. /**
  131832. * Ends a transform feedback operation
  131833. */
  131834. endTransformFeedback(): void;
  131835. /**
  131836. * Specify the varyings to use with transform feedback
  131837. * @param program defines the associated webGL program
  131838. * @param value defines the list of strings representing the varying names
  131839. */
  131840. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  131841. /**
  131842. * Bind a webGL buffer for a transform feedback operation
  131843. * @param value defines the webGL buffer to bind
  131844. */
  131845. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  131846. }
  131847. }
  131848. declare module BABYLON {
  131849. /**
  131850. * Class used to define an additional view for the engine
  131851. * @see https://doc.babylonjs.com/how_to/multi_canvases
  131852. */
  131853. export class EngineView {
  131854. /** Defines the canvas where to render the view */
  131855. target: HTMLCanvasElement;
  131856. /** Defines an optional camera used to render the view (will use active camera else) */
  131857. camera?: Camera;
  131858. }
  131859. interface Engine {
  131860. /**
  131861. * Gets or sets the HTML element to use for attaching events
  131862. */
  131863. inputElement: Nullable<HTMLElement>;
  131864. /**
  131865. * Gets the current engine view
  131866. * @see https://doc.babylonjs.com/how_to/multi_canvases
  131867. */
  131868. activeView: Nullable<EngineView>;
  131869. /** Gets or sets the list of views */
  131870. views: EngineView[];
  131871. /**
  131872. * Register a new child canvas
  131873. * @param canvas defines the canvas to register
  131874. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  131875. * @returns the associated view
  131876. */
  131877. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  131878. /**
  131879. * Remove a registered child canvas
  131880. * @param canvas defines the canvas to remove
  131881. * @returns the current engine
  131882. */
  131883. unRegisterView(canvas: HTMLCanvasElement): Engine;
  131884. }
  131885. }
  131886. declare module BABYLON {
  131887. interface Engine {
  131888. /** @hidden */
  131889. _excludedCompressedTextures: string[];
  131890. /** @hidden */
  131891. _textureFormatInUse: string;
  131892. /**
  131893. * Gets the list of texture formats supported
  131894. */
  131895. readonly texturesSupported: Array<string>;
  131896. /**
  131897. * Gets the texture format in use
  131898. */
  131899. readonly textureFormatInUse: Nullable<string>;
  131900. /**
  131901. * Set the compressed texture extensions or file names to skip.
  131902. *
  131903. * @param skippedFiles defines the list of those texture files you want to skip
  131904. * Example: [".dds", ".env", "myfile.png"]
  131905. */
  131906. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  131907. /**
  131908. * Set the compressed texture format to use, based on the formats you have, and the formats
  131909. * supported by the hardware / browser.
  131910. *
  131911. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  131912. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  131913. * to API arguments needed to compressed textures. This puts the burden on the container
  131914. * generator to house the arcane code for determining these for current & future formats.
  131915. *
  131916. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  131917. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  131918. *
  131919. * Note: The result of this call is not taken into account when a texture is base64.
  131920. *
  131921. * @param formatsAvailable defines the list of those format families you have created
  131922. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  131923. *
  131924. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  131925. * @returns The extension selected.
  131926. */
  131927. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  131928. }
  131929. }
  131930. declare module BABYLON {
  131931. /**
  131932. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  131933. */
  131934. export interface CubeMapInfo {
  131935. /**
  131936. * The pixel array for the front face.
  131937. * This is stored in format, left to right, up to down format.
  131938. */
  131939. front: Nullable<ArrayBufferView>;
  131940. /**
  131941. * The pixel array for the back face.
  131942. * This is stored in format, left to right, up to down format.
  131943. */
  131944. back: Nullable<ArrayBufferView>;
  131945. /**
  131946. * The pixel array for the left face.
  131947. * This is stored in format, left to right, up to down format.
  131948. */
  131949. left: Nullable<ArrayBufferView>;
  131950. /**
  131951. * The pixel array for the right face.
  131952. * This is stored in format, left to right, up to down format.
  131953. */
  131954. right: Nullable<ArrayBufferView>;
  131955. /**
  131956. * The pixel array for the up face.
  131957. * This is stored in format, left to right, up to down format.
  131958. */
  131959. up: Nullable<ArrayBufferView>;
  131960. /**
  131961. * The pixel array for the down face.
  131962. * This is stored in format, left to right, up to down format.
  131963. */
  131964. down: Nullable<ArrayBufferView>;
  131965. /**
  131966. * The size of the cubemap stored.
  131967. *
  131968. * Each faces will be size * size pixels.
  131969. */
  131970. size: number;
  131971. /**
  131972. * The format of the texture.
  131973. *
  131974. * RGBA, RGB.
  131975. */
  131976. format: number;
  131977. /**
  131978. * The type of the texture data.
  131979. *
  131980. * UNSIGNED_INT, FLOAT.
  131981. */
  131982. type: number;
  131983. /**
  131984. * Specifies whether the texture is in gamma space.
  131985. */
  131986. gammaSpace: boolean;
  131987. }
  131988. /**
  131989. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  131990. */
  131991. export class PanoramaToCubeMapTools {
  131992. private static FACE_LEFT;
  131993. private static FACE_RIGHT;
  131994. private static FACE_FRONT;
  131995. private static FACE_BACK;
  131996. private static FACE_DOWN;
  131997. private static FACE_UP;
  131998. /**
  131999. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  132000. *
  132001. * @param float32Array The source data.
  132002. * @param inputWidth The width of the input panorama.
  132003. * @param inputHeight The height of the input panorama.
  132004. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  132005. * @return The cubemap data
  132006. */
  132007. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  132008. private static CreateCubemapTexture;
  132009. private static CalcProjectionSpherical;
  132010. }
  132011. }
  132012. declare module BABYLON {
  132013. /**
  132014. * Helper class dealing with the extraction of spherical polynomial dataArray
  132015. * from a cube map.
  132016. */
  132017. export class CubeMapToSphericalPolynomialTools {
  132018. private static FileFaces;
  132019. /**
  132020. * Converts a texture to the according Spherical Polynomial data.
  132021. * This extracts the first 3 orders only as they are the only one used in the lighting.
  132022. *
  132023. * @param texture The texture to extract the information from.
  132024. * @return The Spherical Polynomial data.
  132025. */
  132026. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  132027. /**
  132028. * Converts a cubemap to the according Spherical Polynomial data.
  132029. * This extracts the first 3 orders only as they are the only one used in the lighting.
  132030. *
  132031. * @param cubeInfo The Cube map to extract the information from.
  132032. * @return The Spherical Polynomial data.
  132033. */
  132034. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  132035. }
  132036. }
  132037. declare module BABYLON {
  132038. interface BaseTexture {
  132039. /**
  132040. * Get the polynomial representation of the texture data.
  132041. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  132042. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  132043. */
  132044. sphericalPolynomial: Nullable<SphericalPolynomial>;
  132045. }
  132046. }
  132047. declare module BABYLON {
  132048. /** @hidden */
  132049. export var rgbdEncodePixelShader: {
  132050. name: string;
  132051. shader: string;
  132052. };
  132053. }
  132054. declare module BABYLON {
  132055. /** @hidden */
  132056. export var rgbdDecodePixelShader: {
  132057. name: string;
  132058. shader: string;
  132059. };
  132060. }
  132061. declare module BABYLON {
  132062. /**
  132063. * Raw texture data and descriptor sufficient for WebGL texture upload
  132064. */
  132065. export interface EnvironmentTextureInfo {
  132066. /**
  132067. * Version of the environment map
  132068. */
  132069. version: number;
  132070. /**
  132071. * Width of image
  132072. */
  132073. width: number;
  132074. /**
  132075. * Irradiance information stored in the file.
  132076. */
  132077. irradiance: any;
  132078. /**
  132079. * Specular information stored in the file.
  132080. */
  132081. specular: any;
  132082. }
  132083. /**
  132084. * Defines One Image in the file. It requires only the position in the file
  132085. * as well as the length.
  132086. */
  132087. interface BufferImageData {
  132088. /**
  132089. * Length of the image data.
  132090. */
  132091. length: number;
  132092. /**
  132093. * Position of the data from the null terminator delimiting the end of the JSON.
  132094. */
  132095. position: number;
  132096. }
  132097. /**
  132098. * Defines the specular data enclosed in the file.
  132099. * This corresponds to the version 1 of the data.
  132100. */
  132101. export interface EnvironmentTextureSpecularInfoV1 {
  132102. /**
  132103. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  132104. */
  132105. specularDataPosition?: number;
  132106. /**
  132107. * This contains all the images data needed to reconstruct the cubemap.
  132108. */
  132109. mipmaps: Array<BufferImageData>;
  132110. /**
  132111. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  132112. */
  132113. lodGenerationScale: number;
  132114. }
  132115. /**
  132116. * Sets of helpers addressing the serialization and deserialization of environment texture
  132117. * stored in a BabylonJS env file.
  132118. * Those files are usually stored as .env files.
  132119. */
  132120. export class EnvironmentTextureTools {
  132121. /**
  132122. * Magic number identifying the env file.
  132123. */
  132124. private static _MagicBytes;
  132125. /**
  132126. * Gets the environment info from an env file.
  132127. * @param data The array buffer containing the .env bytes.
  132128. * @returns the environment file info (the json header) if successfully parsed.
  132129. */
  132130. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  132131. /**
  132132. * Creates an environment texture from a loaded cube texture.
  132133. * @param texture defines the cube texture to convert in env file
  132134. * @return a promise containing the environment data if succesfull.
  132135. */
  132136. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  132137. /**
  132138. * Creates a JSON representation of the spherical data.
  132139. * @param texture defines the texture containing the polynomials
  132140. * @return the JSON representation of the spherical info
  132141. */
  132142. private static _CreateEnvTextureIrradiance;
  132143. /**
  132144. * Creates the ArrayBufferViews used for initializing environment texture image data.
  132145. * @param data the image data
  132146. * @param info parameters that determine what views will be created for accessing the underlying buffer
  132147. * @return the views described by info providing access to the underlying buffer
  132148. */
  132149. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  132150. /**
  132151. * Uploads the texture info contained in the env file to the GPU.
  132152. * @param texture defines the internal texture to upload to
  132153. * @param data defines the data to load
  132154. * @param info defines the texture info retrieved through the GetEnvInfo method
  132155. * @returns a promise
  132156. */
  132157. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  132158. private static _OnImageReadyAsync;
  132159. /**
  132160. * Uploads the levels of image data to the GPU.
  132161. * @param texture defines the internal texture to upload to
  132162. * @param imageData defines the array buffer views of image data [mipmap][face]
  132163. * @returns a promise
  132164. */
  132165. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  132166. /**
  132167. * Uploads spherical polynomials information to the texture.
  132168. * @param texture defines the texture we are trying to upload the information to
  132169. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  132170. */
  132171. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  132172. /** @hidden */
  132173. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  132174. }
  132175. }
  132176. declare module BABYLON {
  132177. /**
  132178. * Class used to inline functions in shader code
  132179. */
  132180. export class ShaderCodeInliner {
  132181. private static readonly _RegexpFindFunctionNameAndType;
  132182. private _sourceCode;
  132183. private _functionDescr;
  132184. private _numMaxIterations;
  132185. /** Gets or sets the token used to mark the functions to inline */
  132186. inlineToken: string;
  132187. /** Gets or sets the debug mode */
  132188. debug: boolean;
  132189. /** Gets the code after the inlining process */
  132190. get code(): string;
  132191. /**
  132192. * Initializes the inliner
  132193. * @param sourceCode shader code source to inline
  132194. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  132195. */
  132196. constructor(sourceCode: string, numMaxIterations?: number);
  132197. /**
  132198. * Start the processing of the shader code
  132199. */
  132200. processCode(): void;
  132201. private _collectFunctions;
  132202. private _processInlining;
  132203. private _extractBetweenMarkers;
  132204. private _skipWhitespaces;
  132205. private _removeComments;
  132206. private _replaceFunctionCallsByCode;
  132207. private _findBackward;
  132208. private _escapeRegExp;
  132209. private _replaceNames;
  132210. }
  132211. }
  132212. declare module BABYLON {
  132213. /**
  132214. * Container for accessors for natively-stored mesh data buffers.
  132215. */
  132216. class NativeDataBuffer extends DataBuffer {
  132217. /**
  132218. * Accessor value used to identify/retrieve a natively-stored index buffer.
  132219. */
  132220. nativeIndexBuffer?: any;
  132221. /**
  132222. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  132223. */
  132224. nativeVertexBuffer?: any;
  132225. }
  132226. /** @hidden */
  132227. class NativeTexture extends InternalTexture {
  132228. getInternalTexture(): InternalTexture;
  132229. getViewCount(): number;
  132230. }
  132231. /** @hidden */
  132232. export class NativeEngine extends Engine {
  132233. private readonly _native;
  132234. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  132235. private readonly INVALID_HANDLE;
  132236. private _boundBuffersVertexArray;
  132237. getHardwareScalingLevel(): number;
  132238. constructor();
  132239. dispose(): void;
  132240. /**
  132241. * Can be used to override the current requestAnimationFrame requester.
  132242. * @hidden
  132243. */
  132244. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  132245. /**
  132246. * Override default engine behavior.
  132247. * @param color
  132248. * @param backBuffer
  132249. * @param depth
  132250. * @param stencil
  132251. */
  132252. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  132253. /**
  132254. * Gets host document
  132255. * @returns the host document object
  132256. */
  132257. getHostDocument(): Nullable<Document>;
  132258. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  132259. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  132260. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  132261. protected _recordVertexArrayObject(vertexArray: any, vertexBuffers: {
  132262. [key: string]: VertexBuffer;
  132263. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  132264. bindBuffers(vertexBuffers: {
  132265. [key: string]: VertexBuffer;
  132266. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  132267. recordVertexArrayObject(vertexBuffers: {
  132268. [key: string]: VertexBuffer;
  132269. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  132270. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  132271. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  132272. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  132273. /**
  132274. * Draw a list of indexed primitives
  132275. * @param fillMode defines the primitive to use
  132276. * @param indexStart defines the starting index
  132277. * @param indexCount defines the number of index to draw
  132278. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  132279. */
  132280. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  132281. /**
  132282. * Draw a list of unindexed primitives
  132283. * @param fillMode defines the primitive to use
  132284. * @param verticesStart defines the index of first vertex to draw
  132285. * @param verticesCount defines the count of vertices to draw
  132286. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  132287. */
  132288. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  132289. createPipelineContext(): IPipelineContext;
  132290. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  132291. /** @hidden */
  132292. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  132293. /** @hidden */
  132294. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  132295. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  132296. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  132297. protected _setProgram(program: WebGLProgram): void;
  132298. _releaseEffect(effect: Effect): void;
  132299. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  132300. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  132301. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  132302. bindSamplers(effect: Effect): void;
  132303. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  132304. getRenderWidth(useScreen?: boolean): number;
  132305. getRenderHeight(useScreen?: boolean): number;
  132306. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  132307. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  132308. /**
  132309. * Set the z offset to apply to current rendering
  132310. * @param value defines the offset to apply
  132311. */
  132312. setZOffset(value: number): void;
  132313. /**
  132314. * Gets the current value of the zOffset
  132315. * @returns the current zOffset state
  132316. */
  132317. getZOffset(): number;
  132318. /**
  132319. * Enable or disable depth buffering
  132320. * @param enable defines the state to set
  132321. */
  132322. setDepthBuffer(enable: boolean): void;
  132323. /**
  132324. * Gets a boolean indicating if depth writing is enabled
  132325. * @returns the current depth writing state
  132326. */
  132327. getDepthWrite(): boolean;
  132328. /**
  132329. * Enable or disable depth writing
  132330. * @param enable defines the state to set
  132331. */
  132332. setDepthWrite(enable: boolean): void;
  132333. /**
  132334. * Enable or disable color writing
  132335. * @param enable defines the state to set
  132336. */
  132337. setColorWrite(enable: boolean): void;
  132338. /**
  132339. * Gets a boolean indicating if color writing is enabled
  132340. * @returns the current color writing state
  132341. */
  132342. getColorWrite(): boolean;
  132343. /**
  132344. * Sets alpha constants used by some alpha blending modes
  132345. * @param r defines the red component
  132346. * @param g defines the green component
  132347. * @param b defines the blue component
  132348. * @param a defines the alpha component
  132349. */
  132350. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  132351. /**
  132352. * Sets the current alpha mode
  132353. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  132354. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  132355. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  132356. */
  132357. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  132358. /**
  132359. * Gets the current alpha mode
  132360. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  132361. * @returns the current alpha mode
  132362. */
  132363. getAlphaMode(): number;
  132364. setInt(uniform: WebGLUniformLocation, int: number): void;
  132365. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  132366. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  132367. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  132368. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  132369. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  132370. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  132371. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  132372. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  132373. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  132374. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  132375. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  132376. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  132377. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  132378. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  132379. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  132380. setFloat(uniform: WebGLUniformLocation, value: number): void;
  132381. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  132382. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  132383. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  132384. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  132385. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  132386. wipeCaches(bruteForce?: boolean): void;
  132387. _createTexture(): WebGLTexture;
  132388. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  132389. /**
  132390. * Usually called from Texture.ts.
  132391. * Passed information to create a WebGLTexture
  132392. * @param url defines a value which contains one of the following:
  132393. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  132394. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  132395. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  132396. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  132397. * @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)
  132398. * @param scene needed for loading to the correct scene
  132399. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  132400. * @param onLoad optional callback to be called upon successful completion
  132401. * @param onError optional callback to be called upon failure
  132402. * @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
  132403. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  132404. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  132405. * @param forcedExtension defines the extension to use to pick the right loader
  132406. * @param mimeType defines an optional mime type
  132407. * @returns a InternalTexture for assignment back into BABYLON.Texture
  132408. */
  132409. 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;
  132410. /**
  132411. * Creates a cube texture
  132412. * @param rootUrl defines the url where the files to load is located
  132413. * @param scene defines the current scene
  132414. * @param files defines the list of files to load (1 per face)
  132415. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  132416. * @param onLoad defines an optional callback raised when the texture is loaded
  132417. * @param onError defines an optional callback raised if there is an issue to load the texture
  132418. * @param format defines the format of the data
  132419. * @param forcedExtension defines the extension to use to pick the right loader
  132420. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  132421. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  132422. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  132423. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  132424. * @returns the cube texture as an InternalTexture
  132425. */
  132426. 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;
  132427. private _getSamplingFilter;
  132428. private static _GetNativeTextureFormat;
  132429. createRenderTargetTexture(size: number | {
  132430. width: number;
  132431. height: number;
  132432. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  132433. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  132434. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  132435. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  132436. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  132437. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  132438. /**
  132439. * Updates a dynamic vertex buffer.
  132440. * @param vertexBuffer the vertex buffer to update
  132441. * @param data the data used to update the vertex buffer
  132442. * @param byteOffset the byte offset of the data (optional)
  132443. * @param byteLength the byte length of the data (optional)
  132444. */
  132445. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  132446. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  132447. private _updateAnisotropicLevel;
  132448. private _getAddressMode;
  132449. /** @hidden */
  132450. _bindTexture(channel: number, texture: InternalTexture): void;
  132451. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  132452. releaseEffects(): void;
  132453. /** @hidden */
  132454. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132455. /** @hidden */
  132456. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132457. /** @hidden */
  132458. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132459. /** @hidden */
  132460. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  132461. }
  132462. }
  132463. declare module BABYLON {
  132464. /**
  132465. * Gather the list of clipboard event types as constants.
  132466. */
  132467. export class ClipboardEventTypes {
  132468. /**
  132469. * The clipboard event is fired when a copy command is active (pressed).
  132470. */
  132471. static readonly COPY: number;
  132472. /**
  132473. * The clipboard event is fired when a cut command is active (pressed).
  132474. */
  132475. static readonly CUT: number;
  132476. /**
  132477. * The clipboard event is fired when a paste command is active (pressed).
  132478. */
  132479. static readonly PASTE: number;
  132480. }
  132481. /**
  132482. * This class is used to store clipboard related info for the onClipboardObservable event.
  132483. */
  132484. export class ClipboardInfo {
  132485. /**
  132486. * Defines the type of event (BABYLON.ClipboardEventTypes)
  132487. */
  132488. type: number;
  132489. /**
  132490. * Defines the related dom event
  132491. */
  132492. event: ClipboardEvent;
  132493. /**
  132494. *Creates an instance of ClipboardInfo.
  132495. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  132496. * @param event Defines the related dom event
  132497. */
  132498. constructor(
  132499. /**
  132500. * Defines the type of event (BABYLON.ClipboardEventTypes)
  132501. */
  132502. type: number,
  132503. /**
  132504. * Defines the related dom event
  132505. */
  132506. event: ClipboardEvent);
  132507. /**
  132508. * Get the clipboard event's type from the keycode.
  132509. * @param keyCode Defines the keyCode for the current keyboard event.
  132510. * @return {number}
  132511. */
  132512. static GetTypeFromCharacter(keyCode: number): number;
  132513. }
  132514. }
  132515. declare module BABYLON {
  132516. /**
  132517. * Google Daydream controller
  132518. */
  132519. export class DaydreamController extends WebVRController {
  132520. /**
  132521. * Base Url for the controller model.
  132522. */
  132523. static MODEL_BASE_URL: string;
  132524. /**
  132525. * File name for the controller model.
  132526. */
  132527. static MODEL_FILENAME: string;
  132528. /**
  132529. * Gamepad Id prefix used to identify Daydream Controller.
  132530. */
  132531. static readonly GAMEPAD_ID_PREFIX: string;
  132532. /**
  132533. * Creates a new DaydreamController from a gamepad
  132534. * @param vrGamepad the gamepad that the controller should be created from
  132535. */
  132536. constructor(vrGamepad: any);
  132537. /**
  132538. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132539. * @param scene scene in which to add meshes
  132540. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132541. */
  132542. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132543. /**
  132544. * Called once for each button that changed state since the last frame
  132545. * @param buttonIdx Which button index changed
  132546. * @param state New state of the button
  132547. * @param changes Which properties on the state changed since last frame
  132548. */
  132549. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132550. }
  132551. }
  132552. declare module BABYLON {
  132553. /**
  132554. * Gear VR Controller
  132555. */
  132556. export class GearVRController extends WebVRController {
  132557. /**
  132558. * Base Url for the controller model.
  132559. */
  132560. static MODEL_BASE_URL: string;
  132561. /**
  132562. * File name for the controller model.
  132563. */
  132564. static MODEL_FILENAME: string;
  132565. /**
  132566. * Gamepad Id prefix used to identify this controller.
  132567. */
  132568. static readonly GAMEPAD_ID_PREFIX: string;
  132569. private readonly _buttonIndexToObservableNameMap;
  132570. /**
  132571. * Creates a new GearVRController from a gamepad
  132572. * @param vrGamepad the gamepad that the controller should be created from
  132573. */
  132574. constructor(vrGamepad: any);
  132575. /**
  132576. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132577. * @param scene scene in which to add meshes
  132578. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132579. */
  132580. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132581. /**
  132582. * Called once for each button that changed state since the last frame
  132583. * @param buttonIdx Which button index changed
  132584. * @param state New state of the button
  132585. * @param changes Which properties on the state changed since last frame
  132586. */
  132587. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132588. }
  132589. }
  132590. declare module BABYLON {
  132591. /**
  132592. * Generic Controller
  132593. */
  132594. export class GenericController extends WebVRController {
  132595. /**
  132596. * Base Url for the controller model.
  132597. */
  132598. static readonly MODEL_BASE_URL: string;
  132599. /**
  132600. * File name for the controller model.
  132601. */
  132602. static readonly MODEL_FILENAME: string;
  132603. /**
  132604. * Creates a new GenericController from a gamepad
  132605. * @param vrGamepad the gamepad that the controller should be created from
  132606. */
  132607. constructor(vrGamepad: any);
  132608. /**
  132609. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132610. * @param scene scene in which to add meshes
  132611. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132612. */
  132613. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132614. /**
  132615. * Called once for each button that changed state since the last frame
  132616. * @param buttonIdx Which button index changed
  132617. * @param state New state of the button
  132618. * @param changes Which properties on the state changed since last frame
  132619. */
  132620. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132621. }
  132622. }
  132623. declare module BABYLON {
  132624. /**
  132625. * Oculus Touch Controller
  132626. */
  132627. export class OculusTouchController extends WebVRController {
  132628. /**
  132629. * Base Url for the controller model.
  132630. */
  132631. static MODEL_BASE_URL: string;
  132632. /**
  132633. * File name for the left controller model.
  132634. */
  132635. static MODEL_LEFT_FILENAME: string;
  132636. /**
  132637. * File name for the right controller model.
  132638. */
  132639. static MODEL_RIGHT_FILENAME: string;
  132640. /**
  132641. * Base Url for the Quest controller model.
  132642. */
  132643. static QUEST_MODEL_BASE_URL: string;
  132644. /**
  132645. * @hidden
  132646. * If the controllers are running on a device that needs the updated Quest controller models
  132647. */
  132648. static _IsQuest: boolean;
  132649. /**
  132650. * Fired when the secondary trigger on this controller is modified
  132651. */
  132652. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  132653. /**
  132654. * Fired when the thumb rest on this controller is modified
  132655. */
  132656. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  132657. /**
  132658. * Creates a new OculusTouchController from a gamepad
  132659. * @param vrGamepad the gamepad that the controller should be created from
  132660. */
  132661. constructor(vrGamepad: any);
  132662. /**
  132663. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132664. * @param scene scene in which to add meshes
  132665. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132666. */
  132667. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132668. /**
  132669. * Fired when the A button on this controller is modified
  132670. */
  132671. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132672. /**
  132673. * Fired when the B button on this controller is modified
  132674. */
  132675. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132676. /**
  132677. * Fired when the X button on this controller is modified
  132678. */
  132679. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132680. /**
  132681. * Fired when the Y button on this controller is modified
  132682. */
  132683. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132684. /**
  132685. * Called once for each button that changed state since the last frame
  132686. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  132687. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  132688. * 2) secondary trigger (same)
  132689. * 3) A (right) X (left), touch, pressed = value
  132690. * 4) B / Y
  132691. * 5) thumb rest
  132692. * @param buttonIdx Which button index changed
  132693. * @param state New state of the button
  132694. * @param changes Which properties on the state changed since last frame
  132695. */
  132696. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132697. }
  132698. }
  132699. declare module BABYLON {
  132700. /**
  132701. * Vive Controller
  132702. */
  132703. export class ViveController extends WebVRController {
  132704. /**
  132705. * Base Url for the controller model.
  132706. */
  132707. static MODEL_BASE_URL: string;
  132708. /**
  132709. * File name for the controller model.
  132710. */
  132711. static MODEL_FILENAME: string;
  132712. /**
  132713. * Creates a new ViveController from a gamepad
  132714. * @param vrGamepad the gamepad that the controller should be created from
  132715. */
  132716. constructor(vrGamepad: any);
  132717. /**
  132718. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132719. * @param scene scene in which to add meshes
  132720. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132721. */
  132722. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132723. /**
  132724. * Fired when the left button on this controller is modified
  132725. */
  132726. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132727. /**
  132728. * Fired when the right button on this controller is modified
  132729. */
  132730. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132731. /**
  132732. * Fired when the menu button on this controller is modified
  132733. */
  132734. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132735. /**
  132736. * Called once for each button that changed state since the last frame
  132737. * Vive mapping:
  132738. * 0: touchpad
  132739. * 1: trigger
  132740. * 2: left AND right buttons
  132741. * 3: menu button
  132742. * @param buttonIdx Which button index changed
  132743. * @param state New state of the button
  132744. * @param changes Which properties on the state changed since last frame
  132745. */
  132746. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132747. }
  132748. }
  132749. declare module BABYLON {
  132750. /**
  132751. * Defines the WindowsMotionController object that the state of the windows motion controller
  132752. */
  132753. export class WindowsMotionController extends WebVRController {
  132754. /**
  132755. * The base url used to load the left and right controller models
  132756. */
  132757. static MODEL_BASE_URL: string;
  132758. /**
  132759. * The name of the left controller model file
  132760. */
  132761. static MODEL_LEFT_FILENAME: string;
  132762. /**
  132763. * The name of the right controller model file
  132764. */
  132765. static MODEL_RIGHT_FILENAME: string;
  132766. /**
  132767. * The controller name prefix for this controller type
  132768. */
  132769. static readonly GAMEPAD_ID_PREFIX: string;
  132770. /**
  132771. * The controller id pattern for this controller type
  132772. */
  132773. private static readonly GAMEPAD_ID_PATTERN;
  132774. private _loadedMeshInfo;
  132775. protected readonly _mapping: {
  132776. buttons: string[];
  132777. buttonMeshNames: {
  132778. trigger: string;
  132779. menu: string;
  132780. grip: string;
  132781. thumbstick: string;
  132782. trackpad: string;
  132783. };
  132784. buttonObservableNames: {
  132785. trigger: string;
  132786. menu: string;
  132787. grip: string;
  132788. thumbstick: string;
  132789. trackpad: string;
  132790. };
  132791. axisMeshNames: string[];
  132792. pointingPoseMeshName: string;
  132793. };
  132794. /**
  132795. * Fired when the trackpad on this controller is clicked
  132796. */
  132797. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  132798. /**
  132799. * Fired when the trackpad on this controller is modified
  132800. */
  132801. onTrackpadValuesChangedObservable: Observable<StickValues>;
  132802. /**
  132803. * The current x and y values of this controller's trackpad
  132804. */
  132805. trackpad: StickValues;
  132806. /**
  132807. * Creates a new WindowsMotionController from a gamepad
  132808. * @param vrGamepad the gamepad that the controller should be created from
  132809. */
  132810. constructor(vrGamepad: any);
  132811. /**
  132812. * Fired when the trigger on this controller is modified
  132813. */
  132814. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132815. /**
  132816. * Fired when the menu button on this controller is modified
  132817. */
  132818. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132819. /**
  132820. * Fired when the grip button on this controller is modified
  132821. */
  132822. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132823. /**
  132824. * Fired when the thumbstick button on this controller is modified
  132825. */
  132826. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132827. /**
  132828. * Fired when the touchpad button on this controller is modified
  132829. */
  132830. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132831. /**
  132832. * Fired when the touchpad values on this controller are modified
  132833. */
  132834. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  132835. protected _updateTrackpad(): void;
  132836. /**
  132837. * Called once per frame by the engine.
  132838. */
  132839. update(): void;
  132840. /**
  132841. * Called once for each button that changed state since the last frame
  132842. * @param buttonIdx Which button index changed
  132843. * @param state New state of the button
  132844. * @param changes Which properties on the state changed since last frame
  132845. */
  132846. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132847. /**
  132848. * Moves the buttons on the controller mesh based on their current state
  132849. * @param buttonName the name of the button to move
  132850. * @param buttonValue the value of the button which determines the buttons new position
  132851. */
  132852. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  132853. /**
  132854. * Moves the axis on the controller mesh based on its current state
  132855. * @param axis the index of the axis
  132856. * @param axisValue the value of the axis which determines the meshes new position
  132857. * @hidden
  132858. */
  132859. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  132860. /**
  132861. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132862. * @param scene scene in which to add meshes
  132863. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132864. */
  132865. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  132866. /**
  132867. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  132868. * can be transformed by button presses and axes values, based on this._mapping.
  132869. *
  132870. * @param scene scene in which the meshes exist
  132871. * @param meshes list of meshes that make up the controller model to process
  132872. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  132873. */
  132874. private processModel;
  132875. private createMeshInfo;
  132876. /**
  132877. * Gets the ray of the controller in the direction the controller is pointing
  132878. * @param length the length the resulting ray should be
  132879. * @returns a ray in the direction the controller is pointing
  132880. */
  132881. getForwardRay(length?: number): Ray;
  132882. /**
  132883. * Disposes of the controller
  132884. */
  132885. dispose(): void;
  132886. }
  132887. /**
  132888. * This class represents a new windows motion controller in XR.
  132889. */
  132890. export class XRWindowsMotionController extends WindowsMotionController {
  132891. /**
  132892. * Changing the original WIndowsMotionController mapping to fir the new mapping
  132893. */
  132894. protected readonly _mapping: {
  132895. buttons: string[];
  132896. buttonMeshNames: {
  132897. trigger: string;
  132898. menu: string;
  132899. grip: string;
  132900. thumbstick: string;
  132901. trackpad: string;
  132902. };
  132903. buttonObservableNames: {
  132904. trigger: string;
  132905. menu: string;
  132906. grip: string;
  132907. thumbstick: string;
  132908. trackpad: string;
  132909. };
  132910. axisMeshNames: string[];
  132911. pointingPoseMeshName: string;
  132912. };
  132913. /**
  132914. * Construct a new XR-Based windows motion controller
  132915. *
  132916. * @param gamepadInfo the gamepad object from the browser
  132917. */
  132918. constructor(gamepadInfo: any);
  132919. /**
  132920. * holds the thumbstick values (X,Y)
  132921. */
  132922. thumbstickValues: StickValues;
  132923. /**
  132924. * Fired when the thumbstick on this controller is clicked
  132925. */
  132926. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  132927. /**
  132928. * Fired when the thumbstick on this controller is modified
  132929. */
  132930. onThumbstickValuesChangedObservable: Observable<StickValues>;
  132931. /**
  132932. * Fired when the touchpad button on this controller is modified
  132933. */
  132934. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  132935. /**
  132936. * Fired when the touchpad values on this controller are modified
  132937. */
  132938. onTrackpadValuesChangedObservable: Observable<StickValues>;
  132939. /**
  132940. * Fired when the thumbstick button on this controller is modified
  132941. * here to prevent breaking changes
  132942. */
  132943. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132944. /**
  132945. * updating the thumbstick(!) and not the trackpad.
  132946. * This is named this way due to the difference between WebVR and XR and to avoid
  132947. * changing the parent class.
  132948. */
  132949. protected _updateTrackpad(): void;
  132950. /**
  132951. * Disposes the class with joy
  132952. */
  132953. dispose(): void;
  132954. }
  132955. }
  132956. declare module BABYLON {
  132957. /**
  132958. * Class containing static functions to help procedurally build meshes
  132959. */
  132960. export class PolyhedronBuilder {
  132961. /**
  132962. * Creates a polyhedron mesh
  132963. * * 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
  132964. * * The parameter `size` (positive float, default 1) sets the polygon size
  132965. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  132966. * * 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`
  132967. * * 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
  132968. * * 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)`)
  132969. * * 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
  132970. * * 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
  132971. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  132972. * * 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
  132973. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  132974. * @param name defines the name of the mesh
  132975. * @param options defines the options used to create the mesh
  132976. * @param scene defines the hosting scene
  132977. * @returns the polyhedron mesh
  132978. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  132979. */
  132980. static CreatePolyhedron(name: string, options: {
  132981. type?: number;
  132982. size?: number;
  132983. sizeX?: number;
  132984. sizeY?: number;
  132985. sizeZ?: number;
  132986. custom?: any;
  132987. faceUV?: Vector4[];
  132988. faceColors?: Color4[];
  132989. flat?: boolean;
  132990. updatable?: boolean;
  132991. sideOrientation?: number;
  132992. frontUVs?: Vector4;
  132993. backUVs?: Vector4;
  132994. }, scene?: Nullable<Scene>): Mesh;
  132995. }
  132996. }
  132997. declare module BABYLON {
  132998. /**
  132999. * Gizmo that enables scaling a mesh along 3 axis
  133000. */
  133001. export class ScaleGizmo extends Gizmo {
  133002. /**
  133003. * Internal gizmo used for interactions on the x axis
  133004. */
  133005. xGizmo: AxisScaleGizmo;
  133006. /**
  133007. * Internal gizmo used for interactions on the y axis
  133008. */
  133009. yGizmo: AxisScaleGizmo;
  133010. /**
  133011. * Internal gizmo used for interactions on the z axis
  133012. */
  133013. zGizmo: AxisScaleGizmo;
  133014. /**
  133015. * Internal gizmo used to scale all axis equally
  133016. */
  133017. uniformScaleGizmo: AxisScaleGizmo;
  133018. private _meshAttached;
  133019. private _nodeAttached;
  133020. private _snapDistance;
  133021. private _uniformScalingMesh;
  133022. private _octahedron;
  133023. private _sensitivity;
  133024. /** Fires an event when any of it's sub gizmos are dragged */
  133025. onDragStartObservable: Observable<unknown>;
  133026. /** Fires an event when any of it's sub gizmos are released from dragging */
  133027. onDragEndObservable: Observable<unknown>;
  133028. get attachedMesh(): Nullable<AbstractMesh>;
  133029. set attachedMesh(mesh: Nullable<AbstractMesh>);
  133030. get attachedNode(): Nullable<Node>;
  133031. set attachedNode(node: Nullable<Node>);
  133032. /**
  133033. * Creates a ScaleGizmo
  133034. * @param gizmoLayer The utility layer the gizmo will be added to
  133035. * @param thickness display gizmo axis thickness
  133036. */
  133037. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  133038. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  133039. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  133040. /**
  133041. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133042. */
  133043. set snapDistance(value: number);
  133044. get snapDistance(): number;
  133045. /**
  133046. * Ratio for the scale of the gizmo (Default: 1)
  133047. */
  133048. set scaleRatio(value: number);
  133049. get scaleRatio(): number;
  133050. /**
  133051. * Sensitivity factor for dragging (Default: 1)
  133052. */
  133053. set sensitivity(value: number);
  133054. get sensitivity(): number;
  133055. /**
  133056. * Disposes of the gizmo
  133057. */
  133058. dispose(): void;
  133059. }
  133060. }
  133061. declare module BABYLON {
  133062. /**
  133063. * Single axis scale gizmo
  133064. */
  133065. export class AxisScaleGizmo extends Gizmo {
  133066. /**
  133067. * Drag behavior responsible for the gizmos dragging interactions
  133068. */
  133069. dragBehavior: PointerDragBehavior;
  133070. private _pointerObserver;
  133071. /**
  133072. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133073. */
  133074. snapDistance: number;
  133075. /**
  133076. * Event that fires each time the gizmo snaps to a new location.
  133077. * * snapDistance is the the change in distance
  133078. */
  133079. onSnapObservable: Observable<{
  133080. snapDistance: number;
  133081. }>;
  133082. /**
  133083. * If the scaling operation should be done on all axis (default: false)
  133084. */
  133085. uniformScaling: boolean;
  133086. /**
  133087. * Custom sensitivity value for the drag strength
  133088. */
  133089. sensitivity: number;
  133090. private _isEnabled;
  133091. private _parent;
  133092. private _arrow;
  133093. private _coloredMaterial;
  133094. private _hoverMaterial;
  133095. /**
  133096. * Creates an AxisScaleGizmo
  133097. * @param gizmoLayer The utility layer the gizmo will be added to
  133098. * @param dragAxis The axis which the gizmo will be able to scale on
  133099. * @param color The color of the gizmo
  133100. * @param thickness display gizmo axis thickness
  133101. */
  133102. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  133103. protected _attachedNodeChanged(value: Nullable<Node>): void;
  133104. /**
  133105. * If the gizmo is enabled
  133106. */
  133107. set isEnabled(value: boolean);
  133108. get isEnabled(): boolean;
  133109. /**
  133110. * Disposes of the gizmo
  133111. */
  133112. dispose(): void;
  133113. /**
  133114. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  133115. * @param mesh The mesh to replace the default mesh of the gizmo
  133116. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  133117. */
  133118. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  133119. }
  133120. }
  133121. declare module BABYLON {
  133122. /**
  133123. * Bounding box gizmo
  133124. */
  133125. export class BoundingBoxGizmo extends Gizmo {
  133126. private _lineBoundingBox;
  133127. private _rotateSpheresParent;
  133128. private _scaleBoxesParent;
  133129. private _boundingDimensions;
  133130. private _renderObserver;
  133131. private _pointerObserver;
  133132. private _scaleDragSpeed;
  133133. private _tmpQuaternion;
  133134. private _tmpVector;
  133135. private _tmpRotationMatrix;
  133136. /**
  133137. * 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)
  133138. */
  133139. ignoreChildren: boolean;
  133140. /**
  133141. * 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)
  133142. */
  133143. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  133144. /**
  133145. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  133146. */
  133147. rotationSphereSize: number;
  133148. /**
  133149. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  133150. */
  133151. scaleBoxSize: number;
  133152. /**
  133153. * 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)
  133154. */
  133155. fixedDragMeshScreenSize: boolean;
  133156. /**
  133157. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  133158. */
  133159. fixedDragMeshScreenSizeDistanceFactor: number;
  133160. /**
  133161. * Fired when a rotation sphere or scale box is dragged
  133162. */
  133163. onDragStartObservable: Observable<{}>;
  133164. /**
  133165. * Fired when a scale box is dragged
  133166. */
  133167. onScaleBoxDragObservable: Observable<{}>;
  133168. /**
  133169. * Fired when a scale box drag is ended
  133170. */
  133171. onScaleBoxDragEndObservable: Observable<{}>;
  133172. /**
  133173. * Fired when a rotation sphere is dragged
  133174. */
  133175. onRotationSphereDragObservable: Observable<{}>;
  133176. /**
  133177. * Fired when a rotation sphere drag is ended
  133178. */
  133179. onRotationSphereDragEndObservable: Observable<{}>;
  133180. /**
  133181. * 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)
  133182. */
  133183. scalePivot: Nullable<Vector3>;
  133184. /**
  133185. * Mesh used as a pivot to rotate the attached node
  133186. */
  133187. private _anchorMesh;
  133188. private _existingMeshScale;
  133189. private _dragMesh;
  133190. private pointerDragBehavior;
  133191. private coloredMaterial;
  133192. private hoverColoredMaterial;
  133193. /**
  133194. * Sets the color of the bounding box gizmo
  133195. * @param color the color to set
  133196. */
  133197. setColor(color: Color3): void;
  133198. /**
  133199. * Creates an BoundingBoxGizmo
  133200. * @param gizmoLayer The utility layer the gizmo will be added to
  133201. * @param color The color of the gizmo
  133202. */
  133203. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  133204. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  133205. private _selectNode;
  133206. /**
  133207. * Updates the bounding box information for the Gizmo
  133208. */
  133209. updateBoundingBox(): void;
  133210. private _updateRotationSpheres;
  133211. private _updateScaleBoxes;
  133212. /**
  133213. * Enables rotation on the specified axis and disables rotation on the others
  133214. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  133215. */
  133216. setEnabledRotationAxis(axis: string): void;
  133217. /**
  133218. * Enables/disables scaling
  133219. * @param enable if scaling should be enabled
  133220. * @param homogeneousScaling defines if scaling should only be homogeneous
  133221. */
  133222. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  133223. private _updateDummy;
  133224. /**
  133225. * Enables a pointer drag behavior on the bounding box of the gizmo
  133226. */
  133227. enableDragBehavior(): void;
  133228. /**
  133229. * Disposes of the gizmo
  133230. */
  133231. dispose(): void;
  133232. /**
  133233. * 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)
  133234. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  133235. * @returns the bounding box mesh with the passed in mesh as a child
  133236. */
  133237. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  133238. /**
  133239. * CustomMeshes are not supported by this gizmo
  133240. * @param mesh The mesh to replace the default mesh of the gizmo
  133241. */
  133242. setCustomMesh(mesh: Mesh): void;
  133243. }
  133244. }
  133245. declare module BABYLON {
  133246. /**
  133247. * Single plane rotation gizmo
  133248. */
  133249. export class PlaneRotationGizmo extends Gizmo {
  133250. /**
  133251. * Drag behavior responsible for the gizmos dragging interactions
  133252. */
  133253. dragBehavior: PointerDragBehavior;
  133254. private _pointerObserver;
  133255. /**
  133256. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  133257. */
  133258. snapDistance: number;
  133259. /**
  133260. * Event that fires each time the gizmo snaps to a new location.
  133261. * * snapDistance is the the change in distance
  133262. */
  133263. onSnapObservable: Observable<{
  133264. snapDistance: number;
  133265. }>;
  133266. private _isEnabled;
  133267. private _parent;
  133268. /**
  133269. * Creates a PlaneRotationGizmo
  133270. * @param gizmoLayer The utility layer the gizmo will be added to
  133271. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  133272. * @param color The color of the gizmo
  133273. * @param tessellation Amount of tessellation to be used when creating rotation circles
  133274. * @param useEulerRotation Use and update Euler angle instead of quaternion
  133275. * @param thickness display gizmo axis thickness
  133276. */
  133277. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  133278. protected _attachedNodeChanged(value: Nullable<Node>): void;
  133279. /**
  133280. * If the gizmo is enabled
  133281. */
  133282. set isEnabled(value: boolean);
  133283. get isEnabled(): boolean;
  133284. /**
  133285. * Disposes of the gizmo
  133286. */
  133287. dispose(): void;
  133288. }
  133289. }
  133290. declare module BABYLON {
  133291. /**
  133292. * Gizmo that enables rotating a mesh along 3 axis
  133293. */
  133294. export class RotationGizmo extends Gizmo {
  133295. /**
  133296. * Internal gizmo used for interactions on the x axis
  133297. */
  133298. xGizmo: PlaneRotationGizmo;
  133299. /**
  133300. * Internal gizmo used for interactions on the y axis
  133301. */
  133302. yGizmo: PlaneRotationGizmo;
  133303. /**
  133304. * Internal gizmo used for interactions on the z axis
  133305. */
  133306. zGizmo: PlaneRotationGizmo;
  133307. /** Fires an event when any of it's sub gizmos are dragged */
  133308. onDragStartObservable: Observable<unknown>;
  133309. /** Fires an event when any of it's sub gizmos are released from dragging */
  133310. onDragEndObservable: Observable<unknown>;
  133311. private _meshAttached;
  133312. private _nodeAttached;
  133313. get attachedMesh(): Nullable<AbstractMesh>;
  133314. set attachedMesh(mesh: Nullable<AbstractMesh>);
  133315. get attachedNode(): Nullable<Node>;
  133316. set attachedNode(node: Nullable<Node>);
  133317. /**
  133318. * Creates a RotationGizmo
  133319. * @param gizmoLayer The utility layer the gizmo will be added to
  133320. * @param tessellation Amount of tessellation to be used when creating rotation circles
  133321. * @param useEulerRotation Use and update Euler angle instead of quaternion
  133322. * @param thickness display gizmo axis thickness
  133323. */
  133324. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  133325. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  133326. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  133327. /**
  133328. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133329. */
  133330. set snapDistance(value: number);
  133331. get snapDistance(): number;
  133332. /**
  133333. * Ratio for the scale of the gizmo (Default: 1)
  133334. */
  133335. set scaleRatio(value: number);
  133336. get scaleRatio(): number;
  133337. /**
  133338. * Disposes of the gizmo
  133339. */
  133340. dispose(): void;
  133341. /**
  133342. * CustomMeshes are not supported by this gizmo
  133343. * @param mesh The mesh to replace the default mesh of the gizmo
  133344. */
  133345. setCustomMesh(mesh: Mesh): void;
  133346. }
  133347. }
  133348. declare module BABYLON {
  133349. /**
  133350. * Helps setup gizmo's in the scene to rotate/scale/position nodes
  133351. */
  133352. export class GizmoManager implements IDisposable {
  133353. private scene;
  133354. /**
  133355. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  133356. */
  133357. gizmos: {
  133358. positionGizmo: Nullable<PositionGizmo>;
  133359. rotationGizmo: Nullable<RotationGizmo>;
  133360. scaleGizmo: Nullable<ScaleGizmo>;
  133361. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  133362. };
  133363. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  133364. clearGizmoOnEmptyPointerEvent: boolean;
  133365. /** Fires an event when the manager is attached to a mesh */
  133366. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  133367. /** Fires an event when the manager is attached to a node */
  133368. onAttachedToNodeObservable: Observable<Nullable<Node>>;
  133369. private _gizmosEnabled;
  133370. private _pointerObserver;
  133371. private _attachedMesh;
  133372. private _attachedNode;
  133373. private _boundingBoxColor;
  133374. private _defaultUtilityLayer;
  133375. private _defaultKeepDepthUtilityLayer;
  133376. private _thickness;
  133377. /**
  133378. * When bounding box gizmo is enabled, this can be used to track drag/end events
  133379. */
  133380. boundingBoxDragBehavior: SixDofDragBehavior;
  133381. /**
  133382. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  133383. */
  133384. attachableMeshes: Nullable<Array<AbstractMesh>>;
  133385. /**
  133386. * Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
  133387. */
  133388. attachableNodes: Nullable<Array<Node>>;
  133389. /**
  133390. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
  133391. */
  133392. usePointerToAttachGizmos: boolean;
  133393. /**
  133394. * Utility layer that the bounding box gizmo belongs to
  133395. */
  133396. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  133397. /**
  133398. * Utility layer that all gizmos besides bounding box belong to
  133399. */
  133400. get utilityLayer(): UtilityLayerRenderer;
  133401. /**
  133402. * Instatiates a gizmo manager
  133403. * @param scene the scene to overlay the gizmos on top of
  133404. * @param thickness display gizmo axis thickness
  133405. */
  133406. constructor(scene: Scene, thickness?: number);
  133407. /**
  133408. * Attaches a set of gizmos to the specified mesh
  133409. * @param mesh The mesh the gizmo's should be attached to
  133410. */
  133411. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  133412. /**
  133413. * Attaches a set of gizmos to the specified node
  133414. * @param node The node the gizmo's should be attached to
  133415. */
  133416. attachToNode(node: Nullable<Node>): void;
  133417. /**
  133418. * If the position gizmo is enabled
  133419. */
  133420. set positionGizmoEnabled(value: boolean);
  133421. get positionGizmoEnabled(): boolean;
  133422. /**
  133423. * If the rotation gizmo is enabled
  133424. */
  133425. set rotationGizmoEnabled(value: boolean);
  133426. get rotationGizmoEnabled(): boolean;
  133427. /**
  133428. * If the scale gizmo is enabled
  133429. */
  133430. set scaleGizmoEnabled(value: boolean);
  133431. get scaleGizmoEnabled(): boolean;
  133432. /**
  133433. * If the boundingBox gizmo is enabled
  133434. */
  133435. set boundingBoxGizmoEnabled(value: boolean);
  133436. get boundingBoxGizmoEnabled(): boolean;
  133437. /**
  133438. * Disposes of the gizmo manager
  133439. */
  133440. dispose(): void;
  133441. }
  133442. }
  133443. declare module BABYLON {
  133444. /**
  133445. * A directional light is defined by a direction (what a surprise!).
  133446. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  133447. * 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.
  133448. * Documentation: https://doc.babylonjs.com/babylon101/lights
  133449. */
  133450. export class DirectionalLight extends ShadowLight {
  133451. private _shadowFrustumSize;
  133452. /**
  133453. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  133454. */
  133455. get shadowFrustumSize(): number;
  133456. /**
  133457. * Specifies a fix frustum size for the shadow generation.
  133458. */
  133459. set shadowFrustumSize(value: number);
  133460. private _shadowOrthoScale;
  133461. /**
  133462. * Gets the shadow projection scale against the optimal computed one.
  133463. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  133464. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  133465. */
  133466. get shadowOrthoScale(): number;
  133467. /**
  133468. * Sets the shadow projection scale against the optimal computed one.
  133469. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  133470. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  133471. */
  133472. set shadowOrthoScale(value: number);
  133473. /**
  133474. * Automatically compute the projection matrix to best fit (including all the casters)
  133475. * on each frame.
  133476. */
  133477. autoUpdateExtends: boolean;
  133478. /**
  133479. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  133480. * on each frame. autoUpdateExtends must be set to true for this to work
  133481. */
  133482. autoCalcShadowZBounds: boolean;
  133483. private _orthoLeft;
  133484. private _orthoRight;
  133485. private _orthoTop;
  133486. private _orthoBottom;
  133487. /**
  133488. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  133489. * The directional light is emitted from everywhere in the given direction.
  133490. * It can cast shadows.
  133491. * Documentation : https://doc.babylonjs.com/babylon101/lights
  133492. * @param name The friendly name of the light
  133493. * @param direction The direction of the light
  133494. * @param scene The scene the light belongs to
  133495. */
  133496. constructor(name: string, direction: Vector3, scene: Scene);
  133497. /**
  133498. * Returns the string "DirectionalLight".
  133499. * @return The class name
  133500. */
  133501. getClassName(): string;
  133502. /**
  133503. * Returns the integer 1.
  133504. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  133505. */
  133506. getTypeID(): number;
  133507. /**
  133508. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  133509. * Returns the DirectionalLight Shadow projection matrix.
  133510. */
  133511. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133512. /**
  133513. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  133514. * Returns the DirectionalLight Shadow projection matrix.
  133515. */
  133516. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  133517. /**
  133518. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  133519. * Returns the DirectionalLight Shadow projection matrix.
  133520. */
  133521. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133522. protected _buildUniformLayout(): void;
  133523. /**
  133524. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  133525. * @param effect The effect to update
  133526. * @param lightIndex The index of the light in the effect to update
  133527. * @returns The directional light
  133528. */
  133529. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  133530. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  133531. /**
  133532. * Gets the minZ used for shadow according to both the scene and the light.
  133533. *
  133534. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  133535. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  133536. * @param activeCamera The camera we are returning the min for
  133537. * @returns the depth min z
  133538. */
  133539. getDepthMinZ(activeCamera: Camera): number;
  133540. /**
  133541. * Gets the maxZ used for shadow according to both the scene and the light.
  133542. *
  133543. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  133544. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  133545. * @param activeCamera The camera we are returning the max for
  133546. * @returns the depth max z
  133547. */
  133548. getDepthMaxZ(activeCamera: Camera): number;
  133549. /**
  133550. * Prepares the list of defines specific to the light type.
  133551. * @param defines the list of defines
  133552. * @param lightIndex defines the index of the light for the effect
  133553. */
  133554. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  133555. }
  133556. }
  133557. declare module BABYLON {
  133558. /**
  133559. * Class containing static functions to help procedurally build meshes
  133560. */
  133561. export class HemisphereBuilder {
  133562. /**
  133563. * Creates a hemisphere mesh
  133564. * @param name defines the name of the mesh
  133565. * @param options defines the options used to create the mesh
  133566. * @param scene defines the hosting scene
  133567. * @returns the hemisphere mesh
  133568. */
  133569. static CreateHemisphere(name: string, options: {
  133570. segments?: number;
  133571. diameter?: number;
  133572. sideOrientation?: number;
  133573. }, scene: any): Mesh;
  133574. }
  133575. }
  133576. declare module BABYLON {
  133577. /**
  133578. * A spot light is defined by a position, a direction, an angle, and an exponent.
  133579. * These values define a cone of light starting from the position, emitting toward the direction.
  133580. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  133581. * and the exponent defines the speed of the decay of the light with distance (reach).
  133582. * Documentation: https://doc.babylonjs.com/babylon101/lights
  133583. */
  133584. export class SpotLight extends ShadowLight {
  133585. private _angle;
  133586. private _innerAngle;
  133587. private _cosHalfAngle;
  133588. private _lightAngleScale;
  133589. private _lightAngleOffset;
  133590. /**
  133591. * Gets the cone angle of the spot light in Radians.
  133592. */
  133593. get angle(): number;
  133594. /**
  133595. * Sets the cone angle of the spot light in Radians.
  133596. */
  133597. set angle(value: number);
  133598. /**
  133599. * Only used in gltf falloff mode, this defines the angle where
  133600. * the directional falloff will start before cutting at angle which could be seen
  133601. * as outer angle.
  133602. */
  133603. get innerAngle(): number;
  133604. /**
  133605. * Only used in gltf falloff mode, this defines the angle where
  133606. * the directional falloff will start before cutting at angle which could be seen
  133607. * as outer angle.
  133608. */
  133609. set innerAngle(value: number);
  133610. private _shadowAngleScale;
  133611. /**
  133612. * Allows scaling the angle of the light for shadow generation only.
  133613. */
  133614. get shadowAngleScale(): number;
  133615. /**
  133616. * Allows scaling the angle of the light for shadow generation only.
  133617. */
  133618. set shadowAngleScale(value: number);
  133619. /**
  133620. * The light decay speed with the distance from the emission spot.
  133621. */
  133622. exponent: number;
  133623. private _projectionTextureMatrix;
  133624. /**
  133625. * Allows reading the projecton texture
  133626. */
  133627. get projectionTextureMatrix(): Matrix;
  133628. protected _projectionTextureLightNear: number;
  133629. /**
  133630. * Gets the near clip of the Spotlight for texture projection.
  133631. */
  133632. get projectionTextureLightNear(): number;
  133633. /**
  133634. * Sets the near clip of the Spotlight for texture projection.
  133635. */
  133636. set projectionTextureLightNear(value: number);
  133637. protected _projectionTextureLightFar: number;
  133638. /**
  133639. * Gets the far clip of the Spotlight for texture projection.
  133640. */
  133641. get projectionTextureLightFar(): number;
  133642. /**
  133643. * Sets the far clip of the Spotlight for texture projection.
  133644. */
  133645. set projectionTextureLightFar(value: number);
  133646. protected _projectionTextureUpDirection: Vector3;
  133647. /**
  133648. * Gets the Up vector of the Spotlight for texture projection.
  133649. */
  133650. get projectionTextureUpDirection(): Vector3;
  133651. /**
  133652. * Sets the Up vector of the Spotlight for texture projection.
  133653. */
  133654. set projectionTextureUpDirection(value: Vector3);
  133655. private _projectionTexture;
  133656. /**
  133657. * Gets the projection texture of the light.
  133658. */
  133659. get projectionTexture(): Nullable<BaseTexture>;
  133660. /**
  133661. * Sets the projection texture of the light.
  133662. */
  133663. set projectionTexture(value: Nullable<BaseTexture>);
  133664. private _projectionTextureViewLightDirty;
  133665. private _projectionTextureProjectionLightDirty;
  133666. private _projectionTextureDirty;
  133667. private _projectionTextureViewTargetVector;
  133668. private _projectionTextureViewLightMatrix;
  133669. private _projectionTextureProjectionLightMatrix;
  133670. private _projectionTextureScalingMatrix;
  133671. /**
  133672. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  133673. * It can cast shadows.
  133674. * Documentation : https://doc.babylonjs.com/babylon101/lights
  133675. * @param name The light friendly name
  133676. * @param position The position of the spot light in the scene
  133677. * @param direction The direction of the light in the scene
  133678. * @param angle The cone angle of the light in Radians
  133679. * @param exponent The light decay speed with the distance from the emission spot
  133680. * @param scene The scene the lights belongs to
  133681. */
  133682. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  133683. /**
  133684. * Returns the string "SpotLight".
  133685. * @returns the class name
  133686. */
  133687. getClassName(): string;
  133688. /**
  133689. * Returns the integer 2.
  133690. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  133691. */
  133692. getTypeID(): number;
  133693. /**
  133694. * Overrides the direction setter to recompute the projection texture view light Matrix.
  133695. */
  133696. protected _setDirection(value: Vector3): void;
  133697. /**
  133698. * Overrides the position setter to recompute the projection texture view light Matrix.
  133699. */
  133700. protected _setPosition(value: Vector3): void;
  133701. /**
  133702. * 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.
  133703. * Returns the SpotLight.
  133704. */
  133705. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133706. protected _computeProjectionTextureViewLightMatrix(): void;
  133707. protected _computeProjectionTextureProjectionLightMatrix(): void;
  133708. /**
  133709. * Main function for light texture projection matrix computing.
  133710. */
  133711. protected _computeProjectionTextureMatrix(): void;
  133712. protected _buildUniformLayout(): void;
  133713. private _computeAngleValues;
  133714. /**
  133715. * Sets the passed Effect "effect" with the Light textures.
  133716. * @param effect The effect to update
  133717. * @param lightIndex The index of the light in the effect to update
  133718. * @returns The light
  133719. */
  133720. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  133721. /**
  133722. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  133723. * @param effect The effect to update
  133724. * @param lightIndex The index of the light in the effect to update
  133725. * @returns The spot light
  133726. */
  133727. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  133728. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  133729. /**
  133730. * Disposes the light and the associated resources.
  133731. */
  133732. dispose(): void;
  133733. /**
  133734. * Prepares the list of defines specific to the light type.
  133735. * @param defines the list of defines
  133736. * @param lightIndex defines the index of the light for the effect
  133737. */
  133738. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  133739. }
  133740. }
  133741. declare module BABYLON {
  133742. /**
  133743. * Gizmo that enables viewing a light
  133744. */
  133745. export class LightGizmo extends Gizmo {
  133746. private _lightMesh;
  133747. private _material;
  133748. private _cachedPosition;
  133749. private _cachedForward;
  133750. private _attachedMeshParent;
  133751. /**
  133752. * Creates a LightGizmo
  133753. * @param gizmoLayer The utility layer the gizmo will be added to
  133754. */
  133755. constructor(gizmoLayer?: UtilityLayerRenderer);
  133756. private _light;
  133757. /**
  133758. * The light that the gizmo is attached to
  133759. */
  133760. set light(light: Nullable<Light>);
  133761. get light(): Nullable<Light>;
  133762. /**
  133763. * Gets the material used to render the light gizmo
  133764. */
  133765. get material(): StandardMaterial;
  133766. /**
  133767. * @hidden
  133768. * Updates the gizmo to match the attached mesh's position/rotation
  133769. */
  133770. protected _update(): void;
  133771. private static _Scale;
  133772. /**
  133773. * Creates the lines for a light mesh
  133774. */
  133775. private static _CreateLightLines;
  133776. /**
  133777. * Disposes of the light gizmo
  133778. */
  133779. dispose(): void;
  133780. private static _CreateHemisphericLightMesh;
  133781. private static _CreatePointLightMesh;
  133782. private static _CreateSpotLightMesh;
  133783. private static _CreateDirectionalLightMesh;
  133784. }
  133785. }
  133786. declare module BABYLON {
  133787. /**
  133788. * Gizmo that enables viewing a camera
  133789. */
  133790. export class CameraGizmo extends Gizmo {
  133791. private _cameraMesh;
  133792. private _cameraLinesMesh;
  133793. private _material;
  133794. /**
  133795. * Creates a CameraGizmo
  133796. * @param gizmoLayer The utility layer the gizmo will be added to
  133797. */
  133798. constructor(gizmoLayer?: UtilityLayerRenderer);
  133799. private _camera;
  133800. /** Gets or sets a boolean indicating if frustum lines must be rendered (true by default)) */
  133801. get displayFrustum(): boolean;
  133802. set displayFrustum(value: boolean);
  133803. /**
  133804. * The camera that the gizmo is attached to
  133805. */
  133806. set camera(camera: Nullable<Camera>);
  133807. get camera(): Nullable<Camera>;
  133808. /**
  133809. * Gets the material used to render the camera gizmo
  133810. */
  133811. get material(): StandardMaterial;
  133812. /**
  133813. * @hidden
  133814. * Updates the gizmo to match the attached mesh's position/rotation
  133815. */
  133816. protected _update(): void;
  133817. private static _Scale;
  133818. private _invProjection;
  133819. /**
  133820. * Disposes of the camera gizmo
  133821. */
  133822. dispose(): void;
  133823. private static _CreateCameraMesh;
  133824. private static _CreateCameraFrustum;
  133825. }
  133826. }
  133827. declare module BABYLON {
  133828. /** @hidden */
  133829. export var backgroundFragmentDeclaration: {
  133830. name: string;
  133831. shader: string;
  133832. };
  133833. }
  133834. declare module BABYLON {
  133835. /** @hidden */
  133836. export var backgroundUboDeclaration: {
  133837. name: string;
  133838. shader: string;
  133839. };
  133840. }
  133841. declare module BABYLON {
  133842. /** @hidden */
  133843. export var backgroundPixelShader: {
  133844. name: string;
  133845. shader: string;
  133846. };
  133847. }
  133848. declare module BABYLON {
  133849. /** @hidden */
  133850. export var backgroundVertexDeclaration: {
  133851. name: string;
  133852. shader: string;
  133853. };
  133854. }
  133855. declare module BABYLON {
  133856. /** @hidden */
  133857. export var backgroundVertexShader: {
  133858. name: string;
  133859. shader: string;
  133860. };
  133861. }
  133862. declare module BABYLON {
  133863. /**
  133864. * Background material used to create an efficient environement around your scene.
  133865. */
  133866. export class BackgroundMaterial extends PushMaterial {
  133867. /**
  133868. * Standard reflectance value at parallel view angle.
  133869. */
  133870. static StandardReflectance0: number;
  133871. /**
  133872. * Standard reflectance value at grazing angle.
  133873. */
  133874. static StandardReflectance90: number;
  133875. protected _primaryColor: Color3;
  133876. /**
  133877. * Key light Color (multiply against the environement texture)
  133878. */
  133879. primaryColor: Color3;
  133880. protected __perceptualColor: Nullable<Color3>;
  133881. /**
  133882. * Experimental Internal Use Only.
  133883. *
  133884. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  133885. * This acts as a helper to set the primary color to a more "human friendly" value.
  133886. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  133887. * output color as close as possible from the chosen value.
  133888. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  133889. * part of lighting setup.)
  133890. */
  133891. get _perceptualColor(): Nullable<Color3>;
  133892. set _perceptualColor(value: Nullable<Color3>);
  133893. protected _primaryColorShadowLevel: float;
  133894. /**
  133895. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  133896. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  133897. */
  133898. get primaryColorShadowLevel(): float;
  133899. set primaryColorShadowLevel(value: float);
  133900. protected _primaryColorHighlightLevel: float;
  133901. /**
  133902. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  133903. * The primary color is used at the level chosen to define what the white area would look.
  133904. */
  133905. get primaryColorHighlightLevel(): float;
  133906. set primaryColorHighlightLevel(value: float);
  133907. protected _reflectionTexture: Nullable<BaseTexture>;
  133908. /**
  133909. * Reflection Texture used in the material.
  133910. * Should be author in a specific way for the best result (refer to the documentation).
  133911. */
  133912. reflectionTexture: Nullable<BaseTexture>;
  133913. protected _reflectionBlur: float;
  133914. /**
  133915. * Reflection Texture level of blur.
  133916. *
  133917. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  133918. * texture twice.
  133919. */
  133920. reflectionBlur: float;
  133921. protected _diffuseTexture: Nullable<BaseTexture>;
  133922. /**
  133923. * Diffuse Texture used in the material.
  133924. * Should be author in a specific way for the best result (refer to the documentation).
  133925. */
  133926. diffuseTexture: Nullable<BaseTexture>;
  133927. protected _shadowLights: Nullable<IShadowLight[]>;
  133928. /**
  133929. * Specify the list of lights casting shadow on the material.
  133930. * All scene shadow lights will be included if null.
  133931. */
  133932. shadowLights: Nullable<IShadowLight[]>;
  133933. protected _shadowLevel: float;
  133934. /**
  133935. * Helps adjusting the shadow to a softer level if required.
  133936. * 0 means black shadows and 1 means no shadows.
  133937. */
  133938. shadowLevel: float;
  133939. protected _sceneCenter: Vector3;
  133940. /**
  133941. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  133942. * It is usually zero but might be interesting to modify according to your setup.
  133943. */
  133944. sceneCenter: Vector3;
  133945. protected _opacityFresnel: boolean;
  133946. /**
  133947. * This helps specifying that the material is falling off to the sky box at grazing angle.
  133948. * This helps ensuring a nice transition when the camera goes under the ground.
  133949. */
  133950. opacityFresnel: boolean;
  133951. protected _reflectionFresnel: boolean;
  133952. /**
  133953. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  133954. * This helps adding a mirror texture on the ground.
  133955. */
  133956. reflectionFresnel: boolean;
  133957. protected _reflectionFalloffDistance: number;
  133958. /**
  133959. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  133960. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  133961. */
  133962. reflectionFalloffDistance: number;
  133963. protected _reflectionAmount: number;
  133964. /**
  133965. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  133966. */
  133967. reflectionAmount: number;
  133968. protected _reflectionReflectance0: number;
  133969. /**
  133970. * This specifies the weight of the reflection at grazing angle.
  133971. */
  133972. reflectionReflectance0: number;
  133973. protected _reflectionReflectance90: number;
  133974. /**
  133975. * This specifies the weight of the reflection at a perpendicular point of view.
  133976. */
  133977. reflectionReflectance90: number;
  133978. /**
  133979. * Sets the reflection reflectance fresnel values according to the default standard
  133980. * empirically know to work well :-)
  133981. */
  133982. set reflectionStandardFresnelWeight(value: number);
  133983. protected _useRGBColor: boolean;
  133984. /**
  133985. * Helps to directly use the maps channels instead of their level.
  133986. */
  133987. useRGBColor: boolean;
  133988. protected _enableNoise: boolean;
  133989. /**
  133990. * This helps reducing the banding effect that could occur on the background.
  133991. */
  133992. enableNoise: boolean;
  133993. /**
  133994. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  133995. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  133996. * Recommended to be keep at 1.0 except for special cases.
  133997. */
  133998. get fovMultiplier(): number;
  133999. set fovMultiplier(value: number);
  134000. private _fovMultiplier;
  134001. /**
  134002. * Enable the FOV adjustment feature controlled by fovMultiplier.
  134003. */
  134004. useEquirectangularFOV: boolean;
  134005. private _maxSimultaneousLights;
  134006. /**
  134007. * Number of Simultaneous lights allowed on the material.
  134008. */
  134009. maxSimultaneousLights: int;
  134010. private _shadowOnly;
  134011. /**
  134012. * Make the material only render shadows
  134013. */
  134014. shadowOnly: boolean;
  134015. /**
  134016. * Default configuration related to image processing available in the Background Material.
  134017. */
  134018. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  134019. /**
  134020. * Keep track of the image processing observer to allow dispose and replace.
  134021. */
  134022. private _imageProcessingObserver;
  134023. /**
  134024. * Attaches a new image processing configuration to the PBR Material.
  134025. * @param configuration (if null the scene configuration will be use)
  134026. */
  134027. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  134028. /**
  134029. * Gets the image processing configuration used either in this material.
  134030. */
  134031. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  134032. /**
  134033. * Sets the Default image processing configuration used either in the this material.
  134034. *
  134035. * If sets to null, the scene one is in use.
  134036. */
  134037. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  134038. /**
  134039. * Gets wether the color curves effect is enabled.
  134040. */
  134041. get cameraColorCurvesEnabled(): boolean;
  134042. /**
  134043. * Sets wether the color curves effect is enabled.
  134044. */
  134045. set cameraColorCurvesEnabled(value: boolean);
  134046. /**
  134047. * Gets wether the color grading effect is enabled.
  134048. */
  134049. get cameraColorGradingEnabled(): boolean;
  134050. /**
  134051. * Gets wether the color grading effect is enabled.
  134052. */
  134053. set cameraColorGradingEnabled(value: boolean);
  134054. /**
  134055. * Gets wether tonemapping is enabled or not.
  134056. */
  134057. get cameraToneMappingEnabled(): boolean;
  134058. /**
  134059. * Sets wether tonemapping is enabled or not
  134060. */
  134061. set cameraToneMappingEnabled(value: boolean);
  134062. /**
  134063. * The camera exposure used on this material.
  134064. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  134065. * This corresponds to a photographic exposure.
  134066. */
  134067. get cameraExposure(): float;
  134068. /**
  134069. * The camera exposure used on this material.
  134070. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  134071. * This corresponds to a photographic exposure.
  134072. */
  134073. set cameraExposure(value: float);
  134074. /**
  134075. * Gets The camera contrast used on this material.
  134076. */
  134077. get cameraContrast(): float;
  134078. /**
  134079. * Sets The camera contrast used on this material.
  134080. */
  134081. set cameraContrast(value: float);
  134082. /**
  134083. * Gets the Color Grading 2D Lookup Texture.
  134084. */
  134085. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  134086. /**
  134087. * Sets the Color Grading 2D Lookup Texture.
  134088. */
  134089. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  134090. /**
  134091. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  134092. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  134093. * 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;
  134094. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  134095. */
  134096. get cameraColorCurves(): Nullable<ColorCurves>;
  134097. /**
  134098. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  134099. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  134100. * 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;
  134101. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  134102. */
  134103. set cameraColorCurves(value: Nullable<ColorCurves>);
  134104. /**
  134105. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  134106. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  134107. */
  134108. switchToBGR: boolean;
  134109. private _renderTargets;
  134110. private _reflectionControls;
  134111. private _white;
  134112. private _primaryShadowColor;
  134113. private _primaryHighlightColor;
  134114. /**
  134115. * Instantiates a Background Material in the given scene
  134116. * @param name The friendly name of the material
  134117. * @param scene The scene to add the material to
  134118. */
  134119. constructor(name: string, scene: Scene);
  134120. /**
  134121. * Gets a boolean indicating that current material needs to register RTT
  134122. */
  134123. get hasRenderTargetTextures(): boolean;
  134124. /**
  134125. * The entire material has been created in order to prevent overdraw.
  134126. * @returns false
  134127. */
  134128. needAlphaTesting(): boolean;
  134129. /**
  134130. * The entire material has been created in order to prevent overdraw.
  134131. * @returns true if blending is enable
  134132. */
  134133. needAlphaBlending(): boolean;
  134134. /**
  134135. * Checks wether the material is ready to be rendered for a given mesh.
  134136. * @param mesh The mesh to render
  134137. * @param subMesh The submesh to check against
  134138. * @param useInstances Specify wether or not the material is used with instances
  134139. * @returns true if all the dependencies are ready (Textures, Effects...)
  134140. */
  134141. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  134142. /**
  134143. * Compute the primary color according to the chosen perceptual color.
  134144. */
  134145. private _computePrimaryColorFromPerceptualColor;
  134146. /**
  134147. * Compute the highlights and shadow colors according to their chosen levels.
  134148. */
  134149. private _computePrimaryColors;
  134150. /**
  134151. * Build the uniform buffer used in the material.
  134152. */
  134153. buildUniformLayout(): void;
  134154. /**
  134155. * Unbind the material.
  134156. */
  134157. unbind(): void;
  134158. /**
  134159. * Bind only the world matrix to the material.
  134160. * @param world The world matrix to bind.
  134161. */
  134162. bindOnlyWorldMatrix(world: Matrix): void;
  134163. /**
  134164. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  134165. * @param world The world matrix to bind.
  134166. * @param subMesh The submesh to bind for.
  134167. */
  134168. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  134169. /**
  134170. * Checks to see if a texture is used in the material.
  134171. * @param texture - Base texture to use.
  134172. * @returns - Boolean specifying if a texture is used in the material.
  134173. */
  134174. hasTexture(texture: BaseTexture): boolean;
  134175. /**
  134176. * Dispose the material.
  134177. * @param forceDisposeEffect Force disposal of the associated effect.
  134178. * @param forceDisposeTextures Force disposal of the associated textures.
  134179. */
  134180. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  134181. /**
  134182. * Clones the material.
  134183. * @param name The cloned name.
  134184. * @returns The cloned material.
  134185. */
  134186. clone(name: string): BackgroundMaterial;
  134187. /**
  134188. * Serializes the current material to its JSON representation.
  134189. * @returns The JSON representation.
  134190. */
  134191. serialize(): any;
  134192. /**
  134193. * Gets the class name of the material
  134194. * @returns "BackgroundMaterial"
  134195. */
  134196. getClassName(): string;
  134197. /**
  134198. * Parse a JSON input to create back a background material.
  134199. * @param source The JSON data to parse
  134200. * @param scene The scene to create the parsed material in
  134201. * @param rootUrl The root url of the assets the material depends upon
  134202. * @returns the instantiated BackgroundMaterial.
  134203. */
  134204. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  134205. }
  134206. }
  134207. declare module BABYLON {
  134208. /**
  134209. * Represents the different options available during the creation of
  134210. * a Environment helper.
  134211. *
  134212. * This can control the default ground, skybox and image processing setup of your scene.
  134213. */
  134214. export interface IEnvironmentHelperOptions {
  134215. /**
  134216. * Specifies whether or not to create a ground.
  134217. * True by default.
  134218. */
  134219. createGround: boolean;
  134220. /**
  134221. * Specifies the ground size.
  134222. * 15 by default.
  134223. */
  134224. groundSize: number;
  134225. /**
  134226. * The texture used on the ground for the main color.
  134227. * Comes from the BabylonJS CDN by default.
  134228. *
  134229. * Remarks: Can be either a texture or a url.
  134230. */
  134231. groundTexture: string | BaseTexture;
  134232. /**
  134233. * The color mixed in the ground texture by default.
  134234. * BabylonJS clearColor by default.
  134235. */
  134236. groundColor: Color3;
  134237. /**
  134238. * Specifies the ground opacity.
  134239. * 1 by default.
  134240. */
  134241. groundOpacity: number;
  134242. /**
  134243. * Enables the ground to receive shadows.
  134244. * True by default.
  134245. */
  134246. enableGroundShadow: boolean;
  134247. /**
  134248. * Helps preventing the shadow to be fully black on the ground.
  134249. * 0.5 by default.
  134250. */
  134251. groundShadowLevel: number;
  134252. /**
  134253. * Creates a mirror texture attach to the ground.
  134254. * false by default.
  134255. */
  134256. enableGroundMirror: boolean;
  134257. /**
  134258. * Specifies the ground mirror size ratio.
  134259. * 0.3 by default as the default kernel is 64.
  134260. */
  134261. groundMirrorSizeRatio: number;
  134262. /**
  134263. * Specifies the ground mirror blur kernel size.
  134264. * 64 by default.
  134265. */
  134266. groundMirrorBlurKernel: number;
  134267. /**
  134268. * Specifies the ground mirror visibility amount.
  134269. * 1 by default
  134270. */
  134271. groundMirrorAmount: number;
  134272. /**
  134273. * Specifies the ground mirror reflectance weight.
  134274. * This uses the standard weight of the background material to setup the fresnel effect
  134275. * of the mirror.
  134276. * 1 by default.
  134277. */
  134278. groundMirrorFresnelWeight: number;
  134279. /**
  134280. * Specifies the ground mirror Falloff distance.
  134281. * This can helps reducing the size of the reflection.
  134282. * 0 by Default.
  134283. */
  134284. groundMirrorFallOffDistance: number;
  134285. /**
  134286. * Specifies the ground mirror texture type.
  134287. * Unsigned Int by Default.
  134288. */
  134289. groundMirrorTextureType: number;
  134290. /**
  134291. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  134292. * the shown objects.
  134293. */
  134294. groundYBias: number;
  134295. /**
  134296. * Specifies whether or not to create a skybox.
  134297. * True by default.
  134298. */
  134299. createSkybox: boolean;
  134300. /**
  134301. * Specifies the skybox size.
  134302. * 20 by default.
  134303. */
  134304. skyboxSize: number;
  134305. /**
  134306. * The texture used on the skybox for the main color.
  134307. * Comes from the BabylonJS CDN by default.
  134308. *
  134309. * Remarks: Can be either a texture or a url.
  134310. */
  134311. skyboxTexture: string | BaseTexture;
  134312. /**
  134313. * The color mixed in the skybox texture by default.
  134314. * BabylonJS clearColor by default.
  134315. */
  134316. skyboxColor: Color3;
  134317. /**
  134318. * The background rotation around the Y axis of the scene.
  134319. * This helps aligning the key lights of your scene with the background.
  134320. * 0 by default.
  134321. */
  134322. backgroundYRotation: number;
  134323. /**
  134324. * Compute automatically the size of the elements to best fit with the scene.
  134325. */
  134326. sizeAuto: boolean;
  134327. /**
  134328. * Default position of the rootMesh if autoSize is not true.
  134329. */
  134330. rootPosition: Vector3;
  134331. /**
  134332. * Sets up the image processing in the scene.
  134333. * true by default.
  134334. */
  134335. setupImageProcessing: boolean;
  134336. /**
  134337. * The texture used as your environment texture in the scene.
  134338. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  134339. *
  134340. * Remarks: Can be either a texture or a url.
  134341. */
  134342. environmentTexture: string | BaseTexture;
  134343. /**
  134344. * The value of the exposure to apply to the scene.
  134345. * 0.6 by default if setupImageProcessing is true.
  134346. */
  134347. cameraExposure: number;
  134348. /**
  134349. * The value of the contrast to apply to the scene.
  134350. * 1.6 by default if setupImageProcessing is true.
  134351. */
  134352. cameraContrast: number;
  134353. /**
  134354. * Specifies whether or not tonemapping should be enabled in the scene.
  134355. * true by default if setupImageProcessing is true.
  134356. */
  134357. toneMappingEnabled: boolean;
  134358. }
  134359. /**
  134360. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  134361. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  134362. * It also helps with the default setup of your imageProcessing configuration.
  134363. */
  134364. export class EnvironmentHelper {
  134365. /**
  134366. * Default ground texture URL.
  134367. */
  134368. private static _groundTextureCDNUrl;
  134369. /**
  134370. * Default skybox texture URL.
  134371. */
  134372. private static _skyboxTextureCDNUrl;
  134373. /**
  134374. * Default environment texture URL.
  134375. */
  134376. private static _environmentTextureCDNUrl;
  134377. /**
  134378. * Creates the default options for the helper.
  134379. */
  134380. private static _getDefaultOptions;
  134381. private _rootMesh;
  134382. /**
  134383. * Gets the root mesh created by the helper.
  134384. */
  134385. get rootMesh(): Mesh;
  134386. private _skybox;
  134387. /**
  134388. * Gets the skybox created by the helper.
  134389. */
  134390. get skybox(): Nullable<Mesh>;
  134391. private _skyboxTexture;
  134392. /**
  134393. * Gets the skybox texture created by the helper.
  134394. */
  134395. get skyboxTexture(): Nullable<BaseTexture>;
  134396. private _skyboxMaterial;
  134397. /**
  134398. * Gets the skybox material created by the helper.
  134399. */
  134400. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  134401. private _ground;
  134402. /**
  134403. * Gets the ground mesh created by the helper.
  134404. */
  134405. get ground(): Nullable<Mesh>;
  134406. private _groundTexture;
  134407. /**
  134408. * Gets the ground texture created by the helper.
  134409. */
  134410. get groundTexture(): Nullable<BaseTexture>;
  134411. private _groundMirror;
  134412. /**
  134413. * Gets the ground mirror created by the helper.
  134414. */
  134415. get groundMirror(): Nullable<MirrorTexture>;
  134416. /**
  134417. * Gets the ground mirror render list to helps pushing the meshes
  134418. * you wish in the ground reflection.
  134419. */
  134420. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  134421. private _groundMaterial;
  134422. /**
  134423. * Gets the ground material created by the helper.
  134424. */
  134425. get groundMaterial(): Nullable<BackgroundMaterial>;
  134426. /**
  134427. * Stores the creation options.
  134428. */
  134429. private readonly _scene;
  134430. private _options;
  134431. /**
  134432. * This observable will be notified with any error during the creation of the environment,
  134433. * mainly texture creation errors.
  134434. */
  134435. onErrorObservable: Observable<{
  134436. message?: string;
  134437. exception?: any;
  134438. }>;
  134439. /**
  134440. * constructor
  134441. * @param options Defines the options we want to customize the helper
  134442. * @param scene The scene to add the material to
  134443. */
  134444. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  134445. /**
  134446. * Updates the background according to the new options
  134447. * @param options
  134448. */
  134449. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  134450. /**
  134451. * Sets the primary color of all the available elements.
  134452. * @param color the main color to affect to the ground and the background
  134453. */
  134454. setMainColor(color: Color3): void;
  134455. /**
  134456. * Setup the image processing according to the specified options.
  134457. */
  134458. private _setupImageProcessing;
  134459. /**
  134460. * Setup the environment texture according to the specified options.
  134461. */
  134462. private _setupEnvironmentTexture;
  134463. /**
  134464. * Setup the background according to the specified options.
  134465. */
  134466. private _setupBackground;
  134467. /**
  134468. * Get the scene sizes according to the setup.
  134469. */
  134470. private _getSceneSize;
  134471. /**
  134472. * Setup the ground according to the specified options.
  134473. */
  134474. private _setupGround;
  134475. /**
  134476. * Setup the ground material according to the specified options.
  134477. */
  134478. private _setupGroundMaterial;
  134479. /**
  134480. * Setup the ground diffuse texture according to the specified options.
  134481. */
  134482. private _setupGroundDiffuseTexture;
  134483. /**
  134484. * Setup the ground mirror texture according to the specified options.
  134485. */
  134486. private _setupGroundMirrorTexture;
  134487. /**
  134488. * Setup the ground to receive the mirror texture.
  134489. */
  134490. private _setupMirrorInGroundMaterial;
  134491. /**
  134492. * Setup the skybox according to the specified options.
  134493. */
  134494. private _setupSkybox;
  134495. /**
  134496. * Setup the skybox material according to the specified options.
  134497. */
  134498. private _setupSkyboxMaterial;
  134499. /**
  134500. * Setup the skybox reflection texture according to the specified options.
  134501. */
  134502. private _setupSkyboxReflectionTexture;
  134503. private _errorHandler;
  134504. /**
  134505. * Dispose all the elements created by the Helper.
  134506. */
  134507. dispose(): void;
  134508. }
  134509. }
  134510. declare module BABYLON {
  134511. /**
  134512. * Display a 360/180 degree texture on an approximately spherical surface, useful for VR applications or skyboxes.
  134513. * As a subclass of TransformNode, this allow parenting to the camera or multiple textures with different locations in the scene.
  134514. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  134515. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  134516. */
  134517. export abstract class TextureDome<T extends Texture> extends TransformNode {
  134518. protected onError: Nullable<(message?: string, exception?: any) => void>;
  134519. /**
  134520. * Define the source as a Monoscopic panoramic 360/180.
  134521. */
  134522. static readonly MODE_MONOSCOPIC: number;
  134523. /**
  134524. * Define the source as a Stereoscopic TopBottom/OverUnder panoramic 360/180.
  134525. */
  134526. static readonly MODE_TOPBOTTOM: number;
  134527. /**
  134528. * Define the source as a Stereoscopic Side by Side panoramic 360/180.
  134529. */
  134530. static readonly MODE_SIDEBYSIDE: number;
  134531. private _halfDome;
  134532. protected _useDirectMapping: boolean;
  134533. /**
  134534. * The texture being displayed on the sphere
  134535. */
  134536. protected _texture: T;
  134537. /**
  134538. * Gets the texture being displayed on the sphere
  134539. */
  134540. get texture(): T;
  134541. /**
  134542. * Sets the texture being displayed on the sphere
  134543. */
  134544. set texture(newTexture: T);
  134545. /**
  134546. * The skybox material
  134547. */
  134548. protected _material: BackgroundMaterial;
  134549. /**
  134550. * The surface used for the dome
  134551. */
  134552. protected _mesh: Mesh;
  134553. /**
  134554. * Gets the mesh used for the dome.
  134555. */
  134556. get mesh(): Mesh;
  134557. /**
  134558. * A mesh that will be used to mask the back of the dome in case it is a 180 degree movie.
  134559. */
  134560. private _halfDomeMask;
  134561. /**
  134562. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  134563. * Also see the options.resolution property.
  134564. */
  134565. get fovMultiplier(): number;
  134566. set fovMultiplier(value: number);
  134567. protected _textureMode: number;
  134568. /**
  134569. * Gets or set the current texture mode for the texture. It can be:
  134570. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134571. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134572. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134573. */
  134574. get textureMode(): number;
  134575. /**
  134576. * Sets the current texture mode for the texture. It can be:
  134577. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134578. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134579. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134580. */
  134581. set textureMode(value: number);
  134582. /**
  134583. * Is it a 180 degrees dome (half dome) or 360 texture (full dome)
  134584. */
  134585. get halfDome(): boolean;
  134586. /**
  134587. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  134588. */
  134589. set halfDome(enabled: boolean);
  134590. /**
  134591. * Oberserver used in Stereoscopic VR Mode.
  134592. */
  134593. private _onBeforeCameraRenderObserver;
  134594. /**
  134595. * Observable raised when an error occured while loading the 360 image
  134596. */
  134597. onLoadErrorObservable: Observable<string>;
  134598. /**
  134599. * Create an instance of this class and pass through the parameters to the relevant classes- Texture, StandardMaterial, and Mesh.
  134600. * @param name Element's name, child elements will append suffixes for their own names.
  134601. * @param textureUrlOrElement defines the url(s) or the (video) HTML element to use
  134602. * @param options An object containing optional or exposed sub element properties
  134603. */
  134604. constructor(name: string, textureUrlOrElement: string | string[] | HTMLVideoElement, options: {
  134605. resolution?: number;
  134606. clickToPlay?: boolean;
  134607. autoPlay?: boolean;
  134608. loop?: boolean;
  134609. size?: number;
  134610. poster?: string;
  134611. faceForward?: boolean;
  134612. useDirectMapping?: boolean;
  134613. halfDomeMode?: boolean;
  134614. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  134615. protected abstract _initTexture(urlsOrElement: string | string[] | HTMLElement, scene: Scene, options: any): T;
  134616. protected _changeTextureMode(value: number): void;
  134617. /**
  134618. * Releases resources associated with this node.
  134619. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  134620. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  134621. */
  134622. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  134623. }
  134624. }
  134625. declare module BABYLON {
  134626. /**
  134627. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  134628. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  134629. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  134630. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  134631. */
  134632. export class PhotoDome extends TextureDome<Texture> {
  134633. /**
  134634. * Define the image as a Monoscopic panoramic 360 image.
  134635. */
  134636. static readonly MODE_MONOSCOPIC: number;
  134637. /**
  134638. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  134639. */
  134640. static readonly MODE_TOPBOTTOM: number;
  134641. /**
  134642. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  134643. */
  134644. static readonly MODE_SIDEBYSIDE: number;
  134645. /**
  134646. * Gets or sets the texture being displayed on the sphere
  134647. */
  134648. get photoTexture(): Texture;
  134649. /**
  134650. * sets the texture being displayed on the sphere
  134651. */
  134652. set photoTexture(value: Texture);
  134653. /**
  134654. * Gets the current video mode for the video. It can be:
  134655. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134656. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134657. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134658. */
  134659. get imageMode(): number;
  134660. /**
  134661. * Sets the current video mode for the video. It can be:
  134662. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134663. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134664. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134665. */
  134666. set imageMode(value: number);
  134667. protected _initTexture(urlsOrElement: string, scene: Scene, options: any): Texture;
  134668. }
  134669. }
  134670. declare module BABYLON {
  134671. /**
  134672. * Class used to host RGBD texture specific utilities
  134673. */
  134674. export class RGBDTextureTools {
  134675. /**
  134676. * Expand the RGBD Texture from RGBD to Half Float if possible.
  134677. * @param texture the texture to expand.
  134678. */
  134679. static ExpandRGBDTexture(texture: Texture): void;
  134680. }
  134681. }
  134682. declare module BABYLON {
  134683. /**
  134684. * Class used to host texture specific utilities
  134685. */
  134686. export class BRDFTextureTools {
  134687. /**
  134688. * Prevents texture cache collision
  134689. */
  134690. private static _instanceNumber;
  134691. /**
  134692. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  134693. * @param scene defines the hosting scene
  134694. * @returns the environment BRDF texture
  134695. */
  134696. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  134697. private static _environmentBRDFBase64Texture;
  134698. }
  134699. }
  134700. declare module BABYLON {
  134701. /**
  134702. * @hidden
  134703. */
  134704. export interface IMaterialClearCoatDefines {
  134705. CLEARCOAT: boolean;
  134706. CLEARCOAT_DEFAULTIOR: boolean;
  134707. CLEARCOAT_TEXTURE: boolean;
  134708. CLEARCOAT_TEXTUREDIRECTUV: number;
  134709. CLEARCOAT_BUMP: boolean;
  134710. CLEARCOAT_BUMPDIRECTUV: number;
  134711. CLEARCOAT_TINT: boolean;
  134712. CLEARCOAT_TINT_TEXTURE: boolean;
  134713. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  134714. /** @hidden */
  134715. _areTexturesDirty: boolean;
  134716. }
  134717. /**
  134718. * Define the code related to the clear coat parameters of the pbr material.
  134719. */
  134720. export class PBRClearCoatConfiguration {
  134721. /**
  134722. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  134723. * The default fits with a polyurethane material.
  134724. */
  134725. private static readonly _DefaultIndexOfRefraction;
  134726. private _isEnabled;
  134727. /**
  134728. * Defines if the clear coat is enabled in the material.
  134729. */
  134730. isEnabled: boolean;
  134731. /**
  134732. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  134733. */
  134734. intensity: number;
  134735. /**
  134736. * Defines the clear coat layer roughness.
  134737. */
  134738. roughness: number;
  134739. private _indexOfRefraction;
  134740. /**
  134741. * Defines the index of refraction of the clear coat.
  134742. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  134743. * The default fits with a polyurethane material.
  134744. * Changing the default value is more performance intensive.
  134745. */
  134746. indexOfRefraction: number;
  134747. private _texture;
  134748. /**
  134749. * Stores the clear coat values in a texture.
  134750. */
  134751. texture: Nullable<BaseTexture>;
  134752. private _bumpTexture;
  134753. /**
  134754. * Define the clear coat specific bump texture.
  134755. */
  134756. bumpTexture: Nullable<BaseTexture>;
  134757. private _isTintEnabled;
  134758. /**
  134759. * Defines if the clear coat tint is enabled in the material.
  134760. */
  134761. isTintEnabled: boolean;
  134762. /**
  134763. * Defines the clear coat tint of the material.
  134764. * This is only use if tint is enabled
  134765. */
  134766. tintColor: Color3;
  134767. /**
  134768. * Defines the distance at which the tint color should be found in the
  134769. * clear coat media.
  134770. * This is only use if tint is enabled
  134771. */
  134772. tintColorAtDistance: number;
  134773. /**
  134774. * Defines the clear coat layer thickness.
  134775. * This is only use if tint is enabled
  134776. */
  134777. tintThickness: number;
  134778. private _tintTexture;
  134779. /**
  134780. * Stores the clear tint values in a texture.
  134781. * rgb is tint
  134782. * a is a thickness factor
  134783. */
  134784. tintTexture: Nullable<BaseTexture>;
  134785. /** @hidden */
  134786. private _internalMarkAllSubMeshesAsTexturesDirty;
  134787. /** @hidden */
  134788. _markAllSubMeshesAsTexturesDirty(): void;
  134789. /**
  134790. * Instantiate a new istance of clear coat configuration.
  134791. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  134792. */
  134793. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  134794. /**
  134795. * Gets wehter the submesh is ready to be used or not.
  134796. * @param defines the list of "defines" to update.
  134797. * @param scene defines the scene the material belongs to.
  134798. * @param engine defines the engine the material belongs to.
  134799. * @param disableBumpMap defines wether the material disables bump or not.
  134800. * @returns - boolean indicating that the submesh is ready or not.
  134801. */
  134802. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  134803. /**
  134804. * Checks to see if a texture is used in the material.
  134805. * @param defines the list of "defines" to update.
  134806. * @param scene defines the scene to the material belongs to.
  134807. */
  134808. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  134809. /**
  134810. * Binds the material data.
  134811. * @param uniformBuffer defines the Uniform buffer to fill in.
  134812. * @param scene defines the scene the material belongs to.
  134813. * @param engine defines the engine the material belongs to.
  134814. * @param disableBumpMap defines wether the material disables bump or not.
  134815. * @param isFrozen defines wether the material is frozen or not.
  134816. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  134817. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  134818. */
  134819. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  134820. /**
  134821. * Checks to see if a texture is used in the material.
  134822. * @param texture - Base texture to use.
  134823. * @returns - Boolean specifying if a texture is used in the material.
  134824. */
  134825. hasTexture(texture: BaseTexture): boolean;
  134826. /**
  134827. * Returns an array of the actively used textures.
  134828. * @param activeTextures Array of BaseTextures
  134829. */
  134830. getActiveTextures(activeTextures: BaseTexture[]): void;
  134831. /**
  134832. * Returns the animatable textures.
  134833. * @param animatables Array of animatable textures.
  134834. */
  134835. getAnimatables(animatables: IAnimatable[]): void;
  134836. /**
  134837. * Disposes the resources of the material.
  134838. * @param forceDisposeTextures - Forces the disposal of all textures.
  134839. */
  134840. dispose(forceDisposeTextures?: boolean): void;
  134841. /**
  134842. * Get the current class name of the texture useful for serialization or dynamic coding.
  134843. * @returns "PBRClearCoatConfiguration"
  134844. */
  134845. getClassName(): string;
  134846. /**
  134847. * Add fallbacks to the effect fallbacks list.
  134848. * @param defines defines the Base texture to use.
  134849. * @param fallbacks defines the current fallback list.
  134850. * @param currentRank defines the current fallback rank.
  134851. * @returns the new fallback rank.
  134852. */
  134853. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  134854. /**
  134855. * Add the required uniforms to the current list.
  134856. * @param uniforms defines the current uniform list.
  134857. */
  134858. static AddUniforms(uniforms: string[]): void;
  134859. /**
  134860. * Add the required samplers to the current list.
  134861. * @param samplers defines the current sampler list.
  134862. */
  134863. static AddSamplers(samplers: string[]): void;
  134864. /**
  134865. * Add the required uniforms to the current buffer.
  134866. * @param uniformBuffer defines the current uniform buffer.
  134867. */
  134868. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  134869. /**
  134870. * Makes a duplicate of the current configuration into another one.
  134871. * @param clearCoatConfiguration define the config where to copy the info
  134872. */
  134873. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  134874. /**
  134875. * Serializes this clear coat configuration.
  134876. * @returns - An object with the serialized config.
  134877. */
  134878. serialize(): any;
  134879. /**
  134880. * Parses a anisotropy Configuration from a serialized object.
  134881. * @param source - Serialized object.
  134882. * @param scene Defines the scene we are parsing for
  134883. * @param rootUrl Defines the rootUrl to load from
  134884. */
  134885. parse(source: any, scene: Scene, rootUrl: string): void;
  134886. }
  134887. }
  134888. declare module BABYLON {
  134889. /**
  134890. * @hidden
  134891. */
  134892. export interface IMaterialAnisotropicDefines {
  134893. ANISOTROPIC: boolean;
  134894. ANISOTROPIC_TEXTURE: boolean;
  134895. ANISOTROPIC_TEXTUREDIRECTUV: number;
  134896. MAINUV1: boolean;
  134897. _areTexturesDirty: boolean;
  134898. _needUVs: boolean;
  134899. }
  134900. /**
  134901. * Define the code related to the anisotropic parameters of the pbr material.
  134902. */
  134903. export class PBRAnisotropicConfiguration {
  134904. private _isEnabled;
  134905. /**
  134906. * Defines if the anisotropy is enabled in the material.
  134907. */
  134908. isEnabled: boolean;
  134909. /**
  134910. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  134911. */
  134912. intensity: number;
  134913. /**
  134914. * Defines if the effect is along the tangents, bitangents or in between.
  134915. * By default, the effect is "strectching" the highlights along the tangents.
  134916. */
  134917. direction: Vector2;
  134918. private _texture;
  134919. /**
  134920. * Stores the anisotropy values in a texture.
  134921. * rg is direction (like normal from -1 to 1)
  134922. * b is a intensity
  134923. */
  134924. texture: Nullable<BaseTexture>;
  134925. /** @hidden */
  134926. private _internalMarkAllSubMeshesAsTexturesDirty;
  134927. /** @hidden */
  134928. _markAllSubMeshesAsTexturesDirty(): void;
  134929. /**
  134930. * Instantiate a new istance of anisotropy configuration.
  134931. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  134932. */
  134933. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  134934. /**
  134935. * Specifies that the submesh is ready to be used.
  134936. * @param defines the list of "defines" to update.
  134937. * @param scene defines the scene the material belongs to.
  134938. * @returns - boolean indicating that the submesh is ready or not.
  134939. */
  134940. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  134941. /**
  134942. * Checks to see if a texture is used in the material.
  134943. * @param defines the list of "defines" to update.
  134944. * @param mesh the mesh we are preparing the defines for.
  134945. * @param scene defines the scene the material belongs to.
  134946. */
  134947. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  134948. /**
  134949. * Binds the material data.
  134950. * @param uniformBuffer defines the Uniform buffer to fill in.
  134951. * @param scene defines the scene the material belongs to.
  134952. * @param isFrozen defines wether the material is frozen or not.
  134953. */
  134954. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  134955. /**
  134956. * Checks to see if a texture is used in the material.
  134957. * @param texture - Base texture to use.
  134958. * @returns - Boolean specifying if a texture is used in the material.
  134959. */
  134960. hasTexture(texture: BaseTexture): boolean;
  134961. /**
  134962. * Returns an array of the actively used textures.
  134963. * @param activeTextures Array of BaseTextures
  134964. */
  134965. getActiveTextures(activeTextures: BaseTexture[]): void;
  134966. /**
  134967. * Returns the animatable textures.
  134968. * @param animatables Array of animatable textures.
  134969. */
  134970. getAnimatables(animatables: IAnimatable[]): void;
  134971. /**
  134972. * Disposes the resources of the material.
  134973. * @param forceDisposeTextures - Forces the disposal of all textures.
  134974. */
  134975. dispose(forceDisposeTextures?: boolean): void;
  134976. /**
  134977. * Get the current class name of the texture useful for serialization or dynamic coding.
  134978. * @returns "PBRAnisotropicConfiguration"
  134979. */
  134980. getClassName(): string;
  134981. /**
  134982. * Add fallbacks to the effect fallbacks list.
  134983. * @param defines defines the Base texture to use.
  134984. * @param fallbacks defines the current fallback list.
  134985. * @param currentRank defines the current fallback rank.
  134986. * @returns the new fallback rank.
  134987. */
  134988. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  134989. /**
  134990. * Add the required uniforms to the current list.
  134991. * @param uniforms defines the current uniform list.
  134992. */
  134993. static AddUniforms(uniforms: string[]): void;
  134994. /**
  134995. * Add the required uniforms to the current buffer.
  134996. * @param uniformBuffer defines the current uniform buffer.
  134997. */
  134998. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  134999. /**
  135000. * Add the required samplers to the current list.
  135001. * @param samplers defines the current sampler list.
  135002. */
  135003. static AddSamplers(samplers: string[]): void;
  135004. /**
  135005. * Makes a duplicate of the current configuration into another one.
  135006. * @param anisotropicConfiguration define the config where to copy the info
  135007. */
  135008. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  135009. /**
  135010. * Serializes this anisotropy configuration.
  135011. * @returns - An object with the serialized config.
  135012. */
  135013. serialize(): any;
  135014. /**
  135015. * Parses a anisotropy Configuration from a serialized object.
  135016. * @param source - Serialized object.
  135017. * @param scene Defines the scene we are parsing for
  135018. * @param rootUrl Defines the rootUrl to load from
  135019. */
  135020. parse(source: any, scene: Scene, rootUrl: string): void;
  135021. }
  135022. }
  135023. declare module BABYLON {
  135024. /**
  135025. * @hidden
  135026. */
  135027. export interface IMaterialBRDFDefines {
  135028. BRDF_V_HEIGHT_CORRELATED: boolean;
  135029. MS_BRDF_ENERGY_CONSERVATION: boolean;
  135030. SPHERICAL_HARMONICS: boolean;
  135031. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  135032. /** @hidden */
  135033. _areMiscDirty: boolean;
  135034. }
  135035. /**
  135036. * Define the code related to the BRDF parameters of the pbr material.
  135037. */
  135038. export class PBRBRDFConfiguration {
  135039. /**
  135040. * Default value used for the energy conservation.
  135041. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  135042. */
  135043. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  135044. /**
  135045. * Default value used for the Smith Visibility Height Correlated mode.
  135046. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  135047. */
  135048. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  135049. /**
  135050. * Default value used for the IBL diffuse part.
  135051. * This can help switching back to the polynomials mode globally which is a tiny bit
  135052. * less GPU intensive at the drawback of a lower quality.
  135053. */
  135054. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  135055. /**
  135056. * Default value used for activating energy conservation for the specular workflow.
  135057. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  135058. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  135059. */
  135060. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  135061. private _useEnergyConservation;
  135062. /**
  135063. * Defines if the material uses energy conservation.
  135064. */
  135065. useEnergyConservation: boolean;
  135066. private _useSmithVisibilityHeightCorrelated;
  135067. /**
  135068. * LEGACY Mode set to false
  135069. * Defines if the material uses height smith correlated visibility term.
  135070. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  135071. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  135072. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  135073. * Not relying on height correlated will also disable energy conservation.
  135074. */
  135075. useSmithVisibilityHeightCorrelated: boolean;
  135076. private _useSphericalHarmonics;
  135077. /**
  135078. * LEGACY Mode set to false
  135079. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  135080. * diffuse part of the IBL.
  135081. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  135082. * to the ground truth.
  135083. */
  135084. useSphericalHarmonics: boolean;
  135085. private _useSpecularGlossinessInputEnergyConservation;
  135086. /**
  135087. * Defines if the material uses energy conservation, when the specular workflow is active.
  135088. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  135089. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  135090. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  135091. */
  135092. useSpecularGlossinessInputEnergyConservation: boolean;
  135093. /** @hidden */
  135094. private _internalMarkAllSubMeshesAsMiscDirty;
  135095. /** @hidden */
  135096. _markAllSubMeshesAsMiscDirty(): void;
  135097. /**
  135098. * Instantiate a new istance of clear coat configuration.
  135099. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  135100. */
  135101. constructor(markAllSubMeshesAsMiscDirty: () => void);
  135102. /**
  135103. * Checks to see if a texture is used in the material.
  135104. * @param defines the list of "defines" to update.
  135105. */
  135106. prepareDefines(defines: IMaterialBRDFDefines): void;
  135107. /**
  135108. * Get the current class name of the texture useful for serialization or dynamic coding.
  135109. * @returns "PBRClearCoatConfiguration"
  135110. */
  135111. getClassName(): string;
  135112. /**
  135113. * Makes a duplicate of the current configuration into another one.
  135114. * @param brdfConfiguration define the config where to copy the info
  135115. */
  135116. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  135117. /**
  135118. * Serializes this BRDF configuration.
  135119. * @returns - An object with the serialized config.
  135120. */
  135121. serialize(): any;
  135122. /**
  135123. * Parses a anisotropy Configuration from a serialized object.
  135124. * @param source - Serialized object.
  135125. * @param scene Defines the scene we are parsing for
  135126. * @param rootUrl Defines the rootUrl to load from
  135127. */
  135128. parse(source: any, scene: Scene, rootUrl: string): void;
  135129. }
  135130. }
  135131. declare module BABYLON {
  135132. /**
  135133. * @hidden
  135134. */
  135135. export interface IMaterialSheenDefines {
  135136. SHEEN: boolean;
  135137. SHEEN_TEXTURE: boolean;
  135138. SHEEN_TEXTUREDIRECTUV: number;
  135139. SHEEN_LINKWITHALBEDO: boolean;
  135140. SHEEN_ROUGHNESS: boolean;
  135141. SHEEN_ALBEDOSCALING: boolean;
  135142. /** @hidden */
  135143. _areTexturesDirty: boolean;
  135144. }
  135145. /**
  135146. * Define the code related to the Sheen parameters of the pbr material.
  135147. */
  135148. export class PBRSheenConfiguration {
  135149. private _isEnabled;
  135150. /**
  135151. * Defines if the material uses sheen.
  135152. */
  135153. isEnabled: boolean;
  135154. private _linkSheenWithAlbedo;
  135155. /**
  135156. * Defines if the sheen is linked to the sheen color.
  135157. */
  135158. linkSheenWithAlbedo: boolean;
  135159. /**
  135160. * Defines the sheen intensity.
  135161. */
  135162. intensity: number;
  135163. /**
  135164. * Defines the sheen color.
  135165. */
  135166. color: Color3;
  135167. private _texture;
  135168. /**
  135169. * Stores the sheen tint values in a texture.
  135170. * rgb is tint
  135171. * a is a intensity or roughness if roughness has been defined
  135172. */
  135173. texture: Nullable<BaseTexture>;
  135174. private _roughness;
  135175. /**
  135176. * Defines the sheen roughness.
  135177. * It is not taken into account if linkSheenWithAlbedo is true.
  135178. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  135179. */
  135180. roughness: Nullable<number>;
  135181. private _albedoScaling;
  135182. /**
  135183. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  135184. * It allows the strength of the sheen effect to not depend on the base color of the material,
  135185. * making it easier to setup and tweak the effect
  135186. */
  135187. albedoScaling: boolean;
  135188. /** @hidden */
  135189. private _internalMarkAllSubMeshesAsTexturesDirty;
  135190. /** @hidden */
  135191. _markAllSubMeshesAsTexturesDirty(): void;
  135192. /**
  135193. * Instantiate a new istance of clear coat configuration.
  135194. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  135195. */
  135196. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  135197. /**
  135198. * Specifies that the submesh is ready to be used.
  135199. * @param defines the list of "defines" to update.
  135200. * @param scene defines the scene the material belongs to.
  135201. * @returns - boolean indicating that the submesh is ready or not.
  135202. */
  135203. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  135204. /**
  135205. * Checks to see if a texture is used in the material.
  135206. * @param defines the list of "defines" to update.
  135207. * @param scene defines the scene the material belongs to.
  135208. */
  135209. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  135210. /**
  135211. * Binds the material data.
  135212. * @param uniformBuffer defines the Uniform buffer to fill in.
  135213. * @param scene defines the scene the material belongs to.
  135214. * @param isFrozen defines wether the material is frozen or not.
  135215. */
  135216. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  135217. /**
  135218. * Checks to see if a texture is used in the material.
  135219. * @param texture - Base texture to use.
  135220. * @returns - Boolean specifying if a texture is used in the material.
  135221. */
  135222. hasTexture(texture: BaseTexture): boolean;
  135223. /**
  135224. * Returns an array of the actively used textures.
  135225. * @param activeTextures Array of BaseTextures
  135226. */
  135227. getActiveTextures(activeTextures: BaseTexture[]): void;
  135228. /**
  135229. * Returns the animatable textures.
  135230. * @param animatables Array of animatable textures.
  135231. */
  135232. getAnimatables(animatables: IAnimatable[]): void;
  135233. /**
  135234. * Disposes the resources of the material.
  135235. * @param forceDisposeTextures - Forces the disposal of all textures.
  135236. */
  135237. dispose(forceDisposeTextures?: boolean): void;
  135238. /**
  135239. * Get the current class name of the texture useful for serialization or dynamic coding.
  135240. * @returns "PBRSheenConfiguration"
  135241. */
  135242. getClassName(): string;
  135243. /**
  135244. * Add fallbacks to the effect fallbacks list.
  135245. * @param defines defines the Base texture to use.
  135246. * @param fallbacks defines the current fallback list.
  135247. * @param currentRank defines the current fallback rank.
  135248. * @returns the new fallback rank.
  135249. */
  135250. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135251. /**
  135252. * Add the required uniforms to the current list.
  135253. * @param uniforms defines the current uniform list.
  135254. */
  135255. static AddUniforms(uniforms: string[]): void;
  135256. /**
  135257. * Add the required uniforms to the current buffer.
  135258. * @param uniformBuffer defines the current uniform buffer.
  135259. */
  135260. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135261. /**
  135262. * Add the required samplers to the current list.
  135263. * @param samplers defines the current sampler list.
  135264. */
  135265. static AddSamplers(samplers: string[]): void;
  135266. /**
  135267. * Makes a duplicate of the current configuration into another one.
  135268. * @param sheenConfiguration define the config where to copy the info
  135269. */
  135270. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  135271. /**
  135272. * Serializes this BRDF configuration.
  135273. * @returns - An object with the serialized config.
  135274. */
  135275. serialize(): any;
  135276. /**
  135277. * Parses a anisotropy Configuration from a serialized object.
  135278. * @param source - Serialized object.
  135279. * @param scene Defines the scene we are parsing for
  135280. * @param rootUrl Defines the rootUrl to load from
  135281. */
  135282. parse(source: any, scene: Scene, rootUrl: string): void;
  135283. }
  135284. }
  135285. declare module BABYLON {
  135286. /**
  135287. * @hidden
  135288. */
  135289. export interface IMaterialSubSurfaceDefines {
  135290. SUBSURFACE: boolean;
  135291. SS_REFRACTION: boolean;
  135292. SS_TRANSLUCENCY: boolean;
  135293. SS_SCATTERING: boolean;
  135294. SS_THICKNESSANDMASK_TEXTURE: boolean;
  135295. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  135296. SS_REFRACTIONMAP_3D: boolean;
  135297. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  135298. SS_LODINREFRACTIONALPHA: boolean;
  135299. SS_GAMMAREFRACTION: boolean;
  135300. SS_RGBDREFRACTION: boolean;
  135301. SS_LINEARSPECULARREFRACTION: boolean;
  135302. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  135303. SS_ALBEDOFORREFRACTIONTINT: boolean;
  135304. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  135305. /** @hidden */
  135306. _areTexturesDirty: boolean;
  135307. }
  135308. /**
  135309. * Define the code related to the sub surface parameters of the pbr material.
  135310. */
  135311. export class PBRSubSurfaceConfiguration {
  135312. private _isRefractionEnabled;
  135313. /**
  135314. * Defines if the refraction is enabled in the material.
  135315. */
  135316. isRefractionEnabled: boolean;
  135317. private _isTranslucencyEnabled;
  135318. /**
  135319. * Defines if the translucency is enabled in the material.
  135320. */
  135321. isTranslucencyEnabled: boolean;
  135322. private _isScatteringEnabled;
  135323. /**
  135324. * Defines if the sub surface scattering is enabled in the material.
  135325. */
  135326. isScatteringEnabled: boolean;
  135327. private _scatteringDiffusionProfileIndex;
  135328. /**
  135329. * Diffusion profile for subsurface scattering.
  135330. * Useful for better scattering in the skins or foliages.
  135331. */
  135332. get scatteringDiffusionProfile(): Nullable<Color3>;
  135333. set scatteringDiffusionProfile(c: Nullable<Color3>);
  135334. /**
  135335. * Defines the refraction intensity of the material.
  135336. * The refraction when enabled replaces the Diffuse part of the material.
  135337. * The intensity helps transitionning between diffuse and refraction.
  135338. */
  135339. refractionIntensity: number;
  135340. /**
  135341. * Defines the translucency intensity of the material.
  135342. * When translucency has been enabled, this defines how much of the "translucency"
  135343. * is addded to the diffuse part of the material.
  135344. */
  135345. translucencyIntensity: number;
  135346. /**
  135347. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  135348. */
  135349. useAlbedoToTintRefraction: boolean;
  135350. private _thicknessTexture;
  135351. /**
  135352. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  135353. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  135354. * 0 would mean minimumThickness
  135355. * 1 would mean maximumThickness
  135356. * The other channels might be use as a mask to vary the different effects intensity.
  135357. */
  135358. thicknessTexture: Nullable<BaseTexture>;
  135359. private _refractionTexture;
  135360. /**
  135361. * Defines the texture to use for refraction.
  135362. */
  135363. refractionTexture: Nullable<BaseTexture>;
  135364. private _indexOfRefraction;
  135365. /**
  135366. * Index of refraction of the material base layer.
  135367. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  135368. *
  135369. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  135370. *
  135371. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  135372. */
  135373. indexOfRefraction: number;
  135374. private _volumeIndexOfRefraction;
  135375. /**
  135376. * Index of refraction of the material's volume.
  135377. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  135378. *
  135379. * This ONLY impacts refraction. If not provided or given a non-valid value,
  135380. * the volume will use the same IOR as the surface.
  135381. */
  135382. get volumeIndexOfRefraction(): number;
  135383. set volumeIndexOfRefraction(value: number);
  135384. private _invertRefractionY;
  135385. /**
  135386. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  135387. */
  135388. invertRefractionY: boolean;
  135389. private _linkRefractionWithTransparency;
  135390. /**
  135391. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  135392. * Materials half opaque for instance using refraction could benefit from this control.
  135393. */
  135394. linkRefractionWithTransparency: boolean;
  135395. /**
  135396. * Defines the minimum thickness stored in the thickness map.
  135397. * If no thickness map is defined, this value will be used to simulate thickness.
  135398. */
  135399. minimumThickness: number;
  135400. /**
  135401. * Defines the maximum thickness stored in the thickness map.
  135402. */
  135403. maximumThickness: number;
  135404. /**
  135405. * Defines the volume tint of the material.
  135406. * This is used for both translucency and scattering.
  135407. */
  135408. tintColor: Color3;
  135409. /**
  135410. * Defines the distance at which the tint color should be found in the media.
  135411. * This is used for refraction only.
  135412. */
  135413. tintColorAtDistance: number;
  135414. /**
  135415. * Defines how far each channel transmit through the media.
  135416. * It is defined as a color to simplify it selection.
  135417. */
  135418. diffusionDistance: Color3;
  135419. private _useMaskFromThicknessTexture;
  135420. /**
  135421. * Stores the intensity of the different subsurface effects in the thickness texture.
  135422. * * the green channel is the translucency intensity.
  135423. * * the blue channel is the scattering intensity.
  135424. * * the alpha channel is the refraction intensity.
  135425. */
  135426. useMaskFromThicknessTexture: boolean;
  135427. private _scene;
  135428. /** @hidden */
  135429. private _internalMarkAllSubMeshesAsTexturesDirty;
  135430. private _internalMarkScenePrePassDirty;
  135431. /** @hidden */
  135432. _markAllSubMeshesAsTexturesDirty(): void;
  135433. /** @hidden */
  135434. _markScenePrePassDirty(): void;
  135435. /**
  135436. * Instantiate a new istance of sub surface configuration.
  135437. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  135438. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  135439. * @param scene The scene
  135440. */
  135441. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  135442. /**
  135443. * Gets wehter the submesh is ready to be used or not.
  135444. * @param defines the list of "defines" to update.
  135445. * @param scene defines the scene the material belongs to.
  135446. * @returns - boolean indicating that the submesh is ready or not.
  135447. */
  135448. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  135449. /**
  135450. * Checks to see if a texture is used in the material.
  135451. * @param defines the list of "defines" to update.
  135452. * @param scene defines the scene to the material belongs to.
  135453. */
  135454. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  135455. /**
  135456. * Binds the material data.
  135457. * @param uniformBuffer defines the Uniform buffer to fill in.
  135458. * @param scene defines the scene the material belongs to.
  135459. * @param engine defines the engine the material belongs to.
  135460. * @param isFrozen defines whether the material is frozen or not.
  135461. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  135462. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  135463. */
  135464. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  135465. /**
  135466. * Unbinds the material from the mesh.
  135467. * @param activeEffect defines the effect that should be unbound from.
  135468. * @returns true if unbound, otherwise false
  135469. */
  135470. unbind(activeEffect: Effect): boolean;
  135471. /**
  135472. * Returns the texture used for refraction or null if none is used.
  135473. * @param scene defines the scene the material belongs to.
  135474. * @returns - Refraction texture if present. If no refraction texture and refraction
  135475. * is linked with transparency, returns environment texture. Otherwise, returns null.
  135476. */
  135477. private _getRefractionTexture;
  135478. /**
  135479. * Returns true if alpha blending should be disabled.
  135480. */
  135481. get disableAlphaBlending(): boolean;
  135482. /**
  135483. * Fills the list of render target textures.
  135484. * @param renderTargets the list of render targets to update
  135485. */
  135486. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  135487. /**
  135488. * Checks to see if a texture is used in the material.
  135489. * @param texture - Base texture to use.
  135490. * @returns - Boolean specifying if a texture is used in the material.
  135491. */
  135492. hasTexture(texture: BaseTexture): boolean;
  135493. /**
  135494. * Gets a boolean indicating that current material needs to register RTT
  135495. * @returns true if this uses a render target otherwise false.
  135496. */
  135497. hasRenderTargetTextures(): boolean;
  135498. /**
  135499. * Returns an array of the actively used textures.
  135500. * @param activeTextures Array of BaseTextures
  135501. */
  135502. getActiveTextures(activeTextures: BaseTexture[]): void;
  135503. /**
  135504. * Returns the animatable textures.
  135505. * @param animatables Array of animatable textures.
  135506. */
  135507. getAnimatables(animatables: IAnimatable[]): void;
  135508. /**
  135509. * Disposes the resources of the material.
  135510. * @param forceDisposeTextures - Forces the disposal of all textures.
  135511. */
  135512. dispose(forceDisposeTextures?: boolean): void;
  135513. /**
  135514. * Get the current class name of the texture useful for serialization or dynamic coding.
  135515. * @returns "PBRSubSurfaceConfiguration"
  135516. */
  135517. getClassName(): string;
  135518. /**
  135519. * Add fallbacks to the effect fallbacks list.
  135520. * @param defines defines the Base texture to use.
  135521. * @param fallbacks defines the current fallback list.
  135522. * @param currentRank defines the current fallback rank.
  135523. * @returns the new fallback rank.
  135524. */
  135525. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135526. /**
  135527. * Add the required uniforms to the current list.
  135528. * @param uniforms defines the current uniform list.
  135529. */
  135530. static AddUniforms(uniforms: string[]): void;
  135531. /**
  135532. * Add the required samplers to the current list.
  135533. * @param samplers defines the current sampler list.
  135534. */
  135535. static AddSamplers(samplers: string[]): void;
  135536. /**
  135537. * Add the required uniforms to the current buffer.
  135538. * @param uniformBuffer defines the current uniform buffer.
  135539. */
  135540. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135541. /**
  135542. * Makes a duplicate of the current configuration into another one.
  135543. * @param configuration define the config where to copy the info
  135544. */
  135545. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  135546. /**
  135547. * Serializes this Sub Surface configuration.
  135548. * @returns - An object with the serialized config.
  135549. */
  135550. serialize(): any;
  135551. /**
  135552. * Parses a anisotropy Configuration from a serialized object.
  135553. * @param source - Serialized object.
  135554. * @param scene Defines the scene we are parsing for
  135555. * @param rootUrl Defines the rootUrl to load from
  135556. */
  135557. parse(source: any, scene: Scene, rootUrl: string): void;
  135558. }
  135559. }
  135560. declare module BABYLON {
  135561. /** @hidden */
  135562. export var pbrFragmentDeclaration: {
  135563. name: string;
  135564. shader: string;
  135565. };
  135566. }
  135567. declare module BABYLON {
  135568. /** @hidden */
  135569. export var pbrUboDeclaration: {
  135570. name: string;
  135571. shader: string;
  135572. };
  135573. }
  135574. declare module BABYLON {
  135575. /** @hidden */
  135576. export var pbrFragmentExtraDeclaration: {
  135577. name: string;
  135578. shader: string;
  135579. };
  135580. }
  135581. declare module BABYLON {
  135582. /** @hidden */
  135583. export var pbrFragmentSamplersDeclaration: {
  135584. name: string;
  135585. shader: string;
  135586. };
  135587. }
  135588. declare module BABYLON {
  135589. /** @hidden */
  135590. export var importanceSampling: {
  135591. name: string;
  135592. shader: string;
  135593. };
  135594. }
  135595. declare module BABYLON {
  135596. /** @hidden */
  135597. export var pbrHelperFunctions: {
  135598. name: string;
  135599. shader: string;
  135600. };
  135601. }
  135602. declare module BABYLON {
  135603. /** @hidden */
  135604. export var harmonicsFunctions: {
  135605. name: string;
  135606. shader: string;
  135607. };
  135608. }
  135609. declare module BABYLON {
  135610. /** @hidden */
  135611. export var pbrDirectLightingSetupFunctions: {
  135612. name: string;
  135613. shader: string;
  135614. };
  135615. }
  135616. declare module BABYLON {
  135617. /** @hidden */
  135618. export var pbrDirectLightingFalloffFunctions: {
  135619. name: string;
  135620. shader: string;
  135621. };
  135622. }
  135623. declare module BABYLON {
  135624. /** @hidden */
  135625. export var pbrBRDFFunctions: {
  135626. name: string;
  135627. shader: string;
  135628. };
  135629. }
  135630. declare module BABYLON {
  135631. /** @hidden */
  135632. export var hdrFilteringFunctions: {
  135633. name: string;
  135634. shader: string;
  135635. };
  135636. }
  135637. declare module BABYLON {
  135638. /** @hidden */
  135639. export var pbrDirectLightingFunctions: {
  135640. name: string;
  135641. shader: string;
  135642. };
  135643. }
  135644. declare module BABYLON {
  135645. /** @hidden */
  135646. export var pbrIBLFunctions: {
  135647. name: string;
  135648. shader: string;
  135649. };
  135650. }
  135651. declare module BABYLON {
  135652. /** @hidden */
  135653. export var pbrBlockAlbedoOpacity: {
  135654. name: string;
  135655. shader: string;
  135656. };
  135657. }
  135658. declare module BABYLON {
  135659. /** @hidden */
  135660. export var pbrBlockReflectivity: {
  135661. name: string;
  135662. shader: string;
  135663. };
  135664. }
  135665. declare module BABYLON {
  135666. /** @hidden */
  135667. export var pbrBlockAmbientOcclusion: {
  135668. name: string;
  135669. shader: string;
  135670. };
  135671. }
  135672. declare module BABYLON {
  135673. /** @hidden */
  135674. export var pbrBlockAlphaFresnel: {
  135675. name: string;
  135676. shader: string;
  135677. };
  135678. }
  135679. declare module BABYLON {
  135680. /** @hidden */
  135681. export var pbrBlockAnisotropic: {
  135682. name: string;
  135683. shader: string;
  135684. };
  135685. }
  135686. declare module BABYLON {
  135687. /** @hidden */
  135688. export var pbrBlockReflection: {
  135689. name: string;
  135690. shader: string;
  135691. };
  135692. }
  135693. declare module BABYLON {
  135694. /** @hidden */
  135695. export var pbrBlockSheen: {
  135696. name: string;
  135697. shader: string;
  135698. };
  135699. }
  135700. declare module BABYLON {
  135701. /** @hidden */
  135702. export var pbrBlockClearcoat: {
  135703. name: string;
  135704. shader: string;
  135705. };
  135706. }
  135707. declare module BABYLON {
  135708. /** @hidden */
  135709. export var pbrBlockSubSurface: {
  135710. name: string;
  135711. shader: string;
  135712. };
  135713. }
  135714. declare module BABYLON {
  135715. /** @hidden */
  135716. export var pbrBlockNormalGeometric: {
  135717. name: string;
  135718. shader: string;
  135719. };
  135720. }
  135721. declare module BABYLON {
  135722. /** @hidden */
  135723. export var pbrBlockNormalFinal: {
  135724. name: string;
  135725. shader: string;
  135726. };
  135727. }
  135728. declare module BABYLON {
  135729. /** @hidden */
  135730. export var pbrBlockLightmapInit: {
  135731. name: string;
  135732. shader: string;
  135733. };
  135734. }
  135735. declare module BABYLON {
  135736. /** @hidden */
  135737. export var pbrBlockGeometryInfo: {
  135738. name: string;
  135739. shader: string;
  135740. };
  135741. }
  135742. declare module BABYLON {
  135743. /** @hidden */
  135744. export var pbrBlockReflectance0: {
  135745. name: string;
  135746. shader: string;
  135747. };
  135748. }
  135749. declare module BABYLON {
  135750. /** @hidden */
  135751. export var pbrBlockReflectance: {
  135752. name: string;
  135753. shader: string;
  135754. };
  135755. }
  135756. declare module BABYLON {
  135757. /** @hidden */
  135758. export var pbrBlockDirectLighting: {
  135759. name: string;
  135760. shader: string;
  135761. };
  135762. }
  135763. declare module BABYLON {
  135764. /** @hidden */
  135765. export var pbrBlockFinalLitComponents: {
  135766. name: string;
  135767. shader: string;
  135768. };
  135769. }
  135770. declare module BABYLON {
  135771. /** @hidden */
  135772. export var pbrBlockFinalUnlitComponents: {
  135773. name: string;
  135774. shader: string;
  135775. };
  135776. }
  135777. declare module BABYLON {
  135778. /** @hidden */
  135779. export var pbrBlockFinalColorComposition: {
  135780. name: string;
  135781. shader: string;
  135782. };
  135783. }
  135784. declare module BABYLON {
  135785. /** @hidden */
  135786. export var pbrBlockImageProcessing: {
  135787. name: string;
  135788. shader: string;
  135789. };
  135790. }
  135791. declare module BABYLON {
  135792. /** @hidden */
  135793. export var pbrDebug: {
  135794. name: string;
  135795. shader: string;
  135796. };
  135797. }
  135798. declare module BABYLON {
  135799. /** @hidden */
  135800. export var pbrPixelShader: {
  135801. name: string;
  135802. shader: string;
  135803. };
  135804. }
  135805. declare module BABYLON {
  135806. /** @hidden */
  135807. export var pbrVertexDeclaration: {
  135808. name: string;
  135809. shader: string;
  135810. };
  135811. }
  135812. declare module BABYLON {
  135813. /** @hidden */
  135814. export var pbrVertexShader: {
  135815. name: string;
  135816. shader: string;
  135817. };
  135818. }
  135819. declare module BABYLON {
  135820. /**
  135821. * Manages the defines for the PBR Material.
  135822. * @hidden
  135823. */
  135824. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  135825. PBR: boolean;
  135826. NUM_SAMPLES: string;
  135827. REALTIME_FILTERING: boolean;
  135828. MAINUV1: boolean;
  135829. MAINUV2: boolean;
  135830. UV1: boolean;
  135831. UV2: boolean;
  135832. ALBEDO: boolean;
  135833. GAMMAALBEDO: boolean;
  135834. ALBEDODIRECTUV: number;
  135835. VERTEXCOLOR: boolean;
  135836. DETAIL: boolean;
  135837. DETAILDIRECTUV: number;
  135838. DETAIL_NORMALBLENDMETHOD: number;
  135839. AMBIENT: boolean;
  135840. AMBIENTDIRECTUV: number;
  135841. AMBIENTINGRAYSCALE: boolean;
  135842. OPACITY: boolean;
  135843. VERTEXALPHA: boolean;
  135844. OPACITYDIRECTUV: number;
  135845. OPACITYRGB: boolean;
  135846. ALPHATEST: boolean;
  135847. DEPTHPREPASS: boolean;
  135848. ALPHABLEND: boolean;
  135849. ALPHAFROMALBEDO: boolean;
  135850. ALPHATESTVALUE: string;
  135851. SPECULAROVERALPHA: boolean;
  135852. RADIANCEOVERALPHA: boolean;
  135853. ALPHAFRESNEL: boolean;
  135854. LINEARALPHAFRESNEL: boolean;
  135855. PREMULTIPLYALPHA: boolean;
  135856. EMISSIVE: boolean;
  135857. EMISSIVEDIRECTUV: number;
  135858. REFLECTIVITY: boolean;
  135859. REFLECTIVITYDIRECTUV: number;
  135860. SPECULARTERM: boolean;
  135861. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  135862. MICROSURFACEAUTOMATIC: boolean;
  135863. LODBASEDMICROSFURACE: boolean;
  135864. MICROSURFACEMAP: boolean;
  135865. MICROSURFACEMAPDIRECTUV: number;
  135866. METALLICWORKFLOW: boolean;
  135867. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  135868. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  135869. METALLNESSSTOREINMETALMAPBLUE: boolean;
  135870. AOSTOREINMETALMAPRED: boolean;
  135871. METALLIC_REFLECTANCE: boolean;
  135872. METALLIC_REFLECTANCEDIRECTUV: number;
  135873. ENVIRONMENTBRDF: boolean;
  135874. ENVIRONMENTBRDF_RGBD: boolean;
  135875. NORMAL: boolean;
  135876. TANGENT: boolean;
  135877. BUMP: boolean;
  135878. BUMPDIRECTUV: number;
  135879. OBJECTSPACE_NORMALMAP: boolean;
  135880. PARALLAX: boolean;
  135881. PARALLAXOCCLUSION: boolean;
  135882. NORMALXYSCALE: boolean;
  135883. LIGHTMAP: boolean;
  135884. LIGHTMAPDIRECTUV: number;
  135885. USELIGHTMAPASSHADOWMAP: boolean;
  135886. GAMMALIGHTMAP: boolean;
  135887. RGBDLIGHTMAP: boolean;
  135888. REFLECTION: boolean;
  135889. REFLECTIONMAP_3D: boolean;
  135890. REFLECTIONMAP_SPHERICAL: boolean;
  135891. REFLECTIONMAP_PLANAR: boolean;
  135892. REFLECTIONMAP_CUBIC: boolean;
  135893. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  135894. REFLECTIONMAP_PROJECTION: boolean;
  135895. REFLECTIONMAP_SKYBOX: boolean;
  135896. REFLECTIONMAP_EXPLICIT: boolean;
  135897. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  135898. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  135899. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  135900. INVERTCUBICMAP: boolean;
  135901. USESPHERICALFROMREFLECTIONMAP: boolean;
  135902. USEIRRADIANCEMAP: boolean;
  135903. SPHERICAL_HARMONICS: boolean;
  135904. USESPHERICALINVERTEX: boolean;
  135905. REFLECTIONMAP_OPPOSITEZ: boolean;
  135906. LODINREFLECTIONALPHA: boolean;
  135907. GAMMAREFLECTION: boolean;
  135908. RGBDREFLECTION: boolean;
  135909. LINEARSPECULARREFLECTION: boolean;
  135910. RADIANCEOCCLUSION: boolean;
  135911. HORIZONOCCLUSION: boolean;
  135912. INSTANCES: boolean;
  135913. THIN_INSTANCES: boolean;
  135914. PREPASS: boolean;
  135915. SCENE_MRT_COUNT: number;
  135916. NUM_BONE_INFLUENCERS: number;
  135917. BonesPerMesh: number;
  135918. BONETEXTURE: boolean;
  135919. NONUNIFORMSCALING: boolean;
  135920. MORPHTARGETS: boolean;
  135921. MORPHTARGETS_NORMAL: boolean;
  135922. MORPHTARGETS_TANGENT: boolean;
  135923. MORPHTARGETS_UV: boolean;
  135924. NUM_MORPH_INFLUENCERS: number;
  135925. IMAGEPROCESSING: boolean;
  135926. VIGNETTE: boolean;
  135927. VIGNETTEBLENDMODEMULTIPLY: boolean;
  135928. VIGNETTEBLENDMODEOPAQUE: boolean;
  135929. TONEMAPPING: boolean;
  135930. TONEMAPPING_ACES: boolean;
  135931. CONTRAST: boolean;
  135932. COLORCURVES: boolean;
  135933. COLORGRADING: boolean;
  135934. COLORGRADING3D: boolean;
  135935. SAMPLER3DGREENDEPTH: boolean;
  135936. SAMPLER3DBGRMAP: boolean;
  135937. IMAGEPROCESSINGPOSTPROCESS: boolean;
  135938. EXPOSURE: boolean;
  135939. MULTIVIEW: boolean;
  135940. USEPHYSICALLIGHTFALLOFF: boolean;
  135941. USEGLTFLIGHTFALLOFF: boolean;
  135942. TWOSIDEDLIGHTING: boolean;
  135943. SHADOWFLOAT: boolean;
  135944. CLIPPLANE: boolean;
  135945. CLIPPLANE2: boolean;
  135946. CLIPPLANE3: boolean;
  135947. CLIPPLANE4: boolean;
  135948. CLIPPLANE5: boolean;
  135949. CLIPPLANE6: boolean;
  135950. POINTSIZE: boolean;
  135951. FOG: boolean;
  135952. LOGARITHMICDEPTH: boolean;
  135953. FORCENORMALFORWARD: boolean;
  135954. SPECULARAA: boolean;
  135955. CLEARCOAT: boolean;
  135956. CLEARCOAT_DEFAULTIOR: boolean;
  135957. CLEARCOAT_TEXTURE: boolean;
  135958. CLEARCOAT_TEXTUREDIRECTUV: number;
  135959. CLEARCOAT_BUMP: boolean;
  135960. CLEARCOAT_BUMPDIRECTUV: number;
  135961. CLEARCOAT_TINT: boolean;
  135962. CLEARCOAT_TINT_TEXTURE: boolean;
  135963. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  135964. ANISOTROPIC: boolean;
  135965. ANISOTROPIC_TEXTURE: boolean;
  135966. ANISOTROPIC_TEXTUREDIRECTUV: number;
  135967. BRDF_V_HEIGHT_CORRELATED: boolean;
  135968. MS_BRDF_ENERGY_CONSERVATION: boolean;
  135969. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  135970. SHEEN: boolean;
  135971. SHEEN_TEXTURE: boolean;
  135972. SHEEN_TEXTUREDIRECTUV: number;
  135973. SHEEN_LINKWITHALBEDO: boolean;
  135974. SHEEN_ROUGHNESS: boolean;
  135975. SHEEN_ALBEDOSCALING: boolean;
  135976. SUBSURFACE: boolean;
  135977. SS_REFRACTION: boolean;
  135978. SS_TRANSLUCENCY: boolean;
  135979. SS_SCATTERING: boolean;
  135980. SS_THICKNESSANDMASK_TEXTURE: boolean;
  135981. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  135982. SS_REFRACTIONMAP_3D: boolean;
  135983. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  135984. SS_LODINREFRACTIONALPHA: boolean;
  135985. SS_GAMMAREFRACTION: boolean;
  135986. SS_RGBDREFRACTION: boolean;
  135987. SS_LINEARSPECULARREFRACTION: boolean;
  135988. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  135989. SS_ALBEDOFORREFRACTIONTINT: boolean;
  135990. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  135991. UNLIT: boolean;
  135992. DEBUGMODE: number;
  135993. /**
  135994. * Initializes the PBR Material defines.
  135995. */
  135996. constructor();
  135997. /**
  135998. * Resets the PBR Material defines.
  135999. */
  136000. reset(): void;
  136001. }
  136002. /**
  136003. * The Physically based material base class of BJS.
  136004. *
  136005. * This offers the main features of a standard PBR material.
  136006. * For more information, please refer to the documentation :
  136007. * https://doc.babylonjs.com/how_to/physically_based_rendering
  136008. */
  136009. export abstract class PBRBaseMaterial extends PushMaterial {
  136010. /**
  136011. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  136012. */
  136013. static readonly PBRMATERIAL_OPAQUE: number;
  136014. /**
  136015. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  136016. */
  136017. static readonly PBRMATERIAL_ALPHATEST: number;
  136018. /**
  136019. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136020. */
  136021. static readonly PBRMATERIAL_ALPHABLEND: number;
  136022. /**
  136023. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136024. * They are also discarded below the alpha cutoff threshold to improve performances.
  136025. */
  136026. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  136027. /**
  136028. * Defines the default value of how much AO map is occluding the analytical lights
  136029. * (point spot...).
  136030. */
  136031. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  136032. /**
  136033. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  136034. */
  136035. static readonly LIGHTFALLOFF_PHYSICAL: number;
  136036. /**
  136037. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  136038. * to enhance interoperability with other engines.
  136039. */
  136040. static readonly LIGHTFALLOFF_GLTF: number;
  136041. /**
  136042. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  136043. * to enhance interoperability with other materials.
  136044. */
  136045. static readonly LIGHTFALLOFF_STANDARD: number;
  136046. /**
  136047. * Intensity of the direct lights e.g. the four lights available in your scene.
  136048. * This impacts both the direct diffuse and specular highlights.
  136049. */
  136050. protected _directIntensity: number;
  136051. /**
  136052. * Intensity of the emissive part of the material.
  136053. * This helps controlling the emissive effect without modifying the emissive color.
  136054. */
  136055. protected _emissiveIntensity: number;
  136056. /**
  136057. * Intensity of the environment e.g. how much the environment will light the object
  136058. * either through harmonics for rough material or through the refelction for shiny ones.
  136059. */
  136060. protected _environmentIntensity: number;
  136061. /**
  136062. * This is a special control allowing the reduction of the specular highlights coming from the
  136063. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  136064. */
  136065. protected _specularIntensity: number;
  136066. /**
  136067. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  136068. */
  136069. private _lightingInfos;
  136070. /**
  136071. * Debug Control allowing disabling the bump map on this material.
  136072. */
  136073. protected _disableBumpMap: boolean;
  136074. /**
  136075. * AKA Diffuse Texture in standard nomenclature.
  136076. */
  136077. protected _albedoTexture: Nullable<BaseTexture>;
  136078. /**
  136079. * AKA Occlusion Texture in other nomenclature.
  136080. */
  136081. protected _ambientTexture: Nullable<BaseTexture>;
  136082. /**
  136083. * AKA Occlusion Texture Intensity in other nomenclature.
  136084. */
  136085. protected _ambientTextureStrength: number;
  136086. /**
  136087. * Defines how much the AO map is occluding the analytical lights (point spot...).
  136088. * 1 means it completely occludes it
  136089. * 0 mean it has no impact
  136090. */
  136091. protected _ambientTextureImpactOnAnalyticalLights: number;
  136092. /**
  136093. * Stores the alpha values in a texture.
  136094. */
  136095. protected _opacityTexture: Nullable<BaseTexture>;
  136096. /**
  136097. * Stores the reflection values in a texture.
  136098. */
  136099. protected _reflectionTexture: Nullable<BaseTexture>;
  136100. /**
  136101. * Stores the emissive values in a texture.
  136102. */
  136103. protected _emissiveTexture: Nullable<BaseTexture>;
  136104. /**
  136105. * AKA Specular texture in other nomenclature.
  136106. */
  136107. protected _reflectivityTexture: Nullable<BaseTexture>;
  136108. /**
  136109. * Used to switch from specular/glossiness to metallic/roughness workflow.
  136110. */
  136111. protected _metallicTexture: Nullable<BaseTexture>;
  136112. /**
  136113. * Specifies the metallic scalar of the metallic/roughness workflow.
  136114. * Can also be used to scale the metalness values of the metallic texture.
  136115. */
  136116. protected _metallic: Nullable<number>;
  136117. /**
  136118. * Specifies the roughness scalar of the metallic/roughness workflow.
  136119. * Can also be used to scale the roughness values of the metallic texture.
  136120. */
  136121. protected _roughness: Nullable<number>;
  136122. /**
  136123. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  136124. * By default the indexOfrefraction is used to compute F0;
  136125. *
  136126. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  136127. *
  136128. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  136129. * F90 = metallicReflectanceColor;
  136130. */
  136131. protected _metallicF0Factor: number;
  136132. /**
  136133. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  136134. * By default the F90 is always 1;
  136135. *
  136136. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  136137. *
  136138. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  136139. * F90 = metallicReflectanceColor;
  136140. */
  136141. protected _metallicReflectanceColor: Color3;
  136142. /**
  136143. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  136144. * This is multiply against the scalar values defined in the material.
  136145. */
  136146. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  136147. /**
  136148. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  136149. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  136150. */
  136151. protected _microSurfaceTexture: Nullable<BaseTexture>;
  136152. /**
  136153. * Stores surface normal data used to displace a mesh in a texture.
  136154. */
  136155. protected _bumpTexture: Nullable<BaseTexture>;
  136156. /**
  136157. * Stores the pre-calculated light information of a mesh in a texture.
  136158. */
  136159. protected _lightmapTexture: Nullable<BaseTexture>;
  136160. /**
  136161. * The color of a material in ambient lighting.
  136162. */
  136163. protected _ambientColor: Color3;
  136164. /**
  136165. * AKA Diffuse Color in other nomenclature.
  136166. */
  136167. protected _albedoColor: Color3;
  136168. /**
  136169. * AKA Specular Color in other nomenclature.
  136170. */
  136171. protected _reflectivityColor: Color3;
  136172. /**
  136173. * The color applied when light is reflected from a material.
  136174. */
  136175. protected _reflectionColor: Color3;
  136176. /**
  136177. * The color applied when light is emitted from a material.
  136178. */
  136179. protected _emissiveColor: Color3;
  136180. /**
  136181. * AKA Glossiness in other nomenclature.
  136182. */
  136183. protected _microSurface: number;
  136184. /**
  136185. * Specifies that the material will use the light map as a show map.
  136186. */
  136187. protected _useLightmapAsShadowmap: boolean;
  136188. /**
  136189. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  136190. * makes the reflect vector face the model (under horizon).
  136191. */
  136192. protected _useHorizonOcclusion: boolean;
  136193. /**
  136194. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  136195. * too much the area relying on ambient texture to define their ambient occlusion.
  136196. */
  136197. protected _useRadianceOcclusion: boolean;
  136198. /**
  136199. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  136200. */
  136201. protected _useAlphaFromAlbedoTexture: boolean;
  136202. /**
  136203. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  136204. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  136205. */
  136206. protected _useSpecularOverAlpha: boolean;
  136207. /**
  136208. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  136209. */
  136210. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  136211. /**
  136212. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  136213. */
  136214. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  136215. /**
  136216. * Specifies if the metallic texture contains the roughness information in its green channel.
  136217. */
  136218. protected _useRoughnessFromMetallicTextureGreen: boolean;
  136219. /**
  136220. * Specifies if the metallic texture contains the metallness information in its blue channel.
  136221. */
  136222. protected _useMetallnessFromMetallicTextureBlue: boolean;
  136223. /**
  136224. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  136225. */
  136226. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  136227. /**
  136228. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  136229. */
  136230. protected _useAmbientInGrayScale: boolean;
  136231. /**
  136232. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  136233. * The material will try to infer what glossiness each pixel should be.
  136234. */
  136235. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  136236. /**
  136237. * Defines the falloff type used in this material.
  136238. * It by default is Physical.
  136239. */
  136240. protected _lightFalloff: number;
  136241. /**
  136242. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  136243. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  136244. */
  136245. protected _useRadianceOverAlpha: boolean;
  136246. /**
  136247. * Allows using an object space normal map (instead of tangent space).
  136248. */
  136249. protected _useObjectSpaceNormalMap: boolean;
  136250. /**
  136251. * Allows using the bump map in parallax mode.
  136252. */
  136253. protected _useParallax: boolean;
  136254. /**
  136255. * Allows using the bump map in parallax occlusion mode.
  136256. */
  136257. protected _useParallaxOcclusion: boolean;
  136258. /**
  136259. * Controls the scale bias of the parallax mode.
  136260. */
  136261. protected _parallaxScaleBias: number;
  136262. /**
  136263. * If sets to true, disables all the lights affecting the material.
  136264. */
  136265. protected _disableLighting: boolean;
  136266. /**
  136267. * Number of Simultaneous lights allowed on the material.
  136268. */
  136269. protected _maxSimultaneousLights: number;
  136270. /**
  136271. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  136272. */
  136273. protected _invertNormalMapX: boolean;
  136274. /**
  136275. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  136276. */
  136277. protected _invertNormalMapY: boolean;
  136278. /**
  136279. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  136280. */
  136281. protected _twoSidedLighting: boolean;
  136282. /**
  136283. * Defines the alpha limits in alpha test mode.
  136284. */
  136285. protected _alphaCutOff: number;
  136286. /**
  136287. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  136288. */
  136289. protected _forceAlphaTest: boolean;
  136290. /**
  136291. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136292. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  136293. */
  136294. protected _useAlphaFresnel: boolean;
  136295. /**
  136296. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136297. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  136298. */
  136299. protected _useLinearAlphaFresnel: boolean;
  136300. /**
  136301. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  136302. * from cos thetav and roughness:
  136303. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  136304. */
  136305. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  136306. /**
  136307. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  136308. */
  136309. protected _forceIrradianceInFragment: boolean;
  136310. private _realTimeFiltering;
  136311. /**
  136312. * Enables realtime filtering on the texture.
  136313. */
  136314. get realTimeFiltering(): boolean;
  136315. set realTimeFiltering(b: boolean);
  136316. private _realTimeFilteringQuality;
  136317. /**
  136318. * Quality switch for realtime filtering
  136319. */
  136320. get realTimeFilteringQuality(): number;
  136321. set realTimeFilteringQuality(n: number);
  136322. /**
  136323. * Can this material render to several textures at once
  136324. */
  136325. get canRenderToMRT(): boolean;
  136326. /**
  136327. * Force normal to face away from face.
  136328. */
  136329. protected _forceNormalForward: boolean;
  136330. /**
  136331. * Enables specular anti aliasing in the PBR shader.
  136332. * It will both interacts on the Geometry for analytical and IBL lighting.
  136333. * It also prefilter the roughness map based on the bump values.
  136334. */
  136335. protected _enableSpecularAntiAliasing: boolean;
  136336. /**
  136337. * Default configuration related to image processing available in the PBR Material.
  136338. */
  136339. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  136340. /**
  136341. * Keep track of the image processing observer to allow dispose and replace.
  136342. */
  136343. private _imageProcessingObserver;
  136344. /**
  136345. * Attaches a new image processing configuration to the PBR Material.
  136346. * @param configuration
  136347. */
  136348. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  136349. /**
  136350. * Stores the available render targets.
  136351. */
  136352. private _renderTargets;
  136353. /**
  136354. * Sets the global ambient color for the material used in lighting calculations.
  136355. */
  136356. private _globalAmbientColor;
  136357. /**
  136358. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  136359. */
  136360. private _useLogarithmicDepth;
  136361. /**
  136362. * If set to true, no lighting calculations will be applied.
  136363. */
  136364. private _unlit;
  136365. private _debugMode;
  136366. /**
  136367. * @hidden
  136368. * This is reserved for the inspector.
  136369. * Defines the material debug mode.
  136370. * It helps seeing only some components of the material while troubleshooting.
  136371. */
  136372. debugMode: number;
  136373. /**
  136374. * @hidden
  136375. * This is reserved for the inspector.
  136376. * Specify from where on screen the debug mode should start.
  136377. * The value goes from -1 (full screen) to 1 (not visible)
  136378. * It helps with side by side comparison against the final render
  136379. * This defaults to -1
  136380. */
  136381. private debugLimit;
  136382. /**
  136383. * @hidden
  136384. * This is reserved for the inspector.
  136385. * As the default viewing range might not be enough (if the ambient is really small for instance)
  136386. * You can use the factor to better multiply the final value.
  136387. */
  136388. private debugFactor;
  136389. /**
  136390. * Defines the clear coat layer parameters for the material.
  136391. */
  136392. readonly clearCoat: PBRClearCoatConfiguration;
  136393. /**
  136394. * Defines the anisotropic parameters for the material.
  136395. */
  136396. readonly anisotropy: PBRAnisotropicConfiguration;
  136397. /**
  136398. * Defines the BRDF parameters for the material.
  136399. */
  136400. readonly brdf: PBRBRDFConfiguration;
  136401. /**
  136402. * Defines the Sheen parameters for the material.
  136403. */
  136404. readonly sheen: PBRSheenConfiguration;
  136405. /**
  136406. * Defines the SubSurface parameters for the material.
  136407. */
  136408. readonly subSurface: PBRSubSurfaceConfiguration;
  136409. /**
  136410. * Defines the detail map parameters for the material.
  136411. */
  136412. readonly detailMap: DetailMapConfiguration;
  136413. protected _rebuildInParallel: boolean;
  136414. /**
  136415. * Instantiates a new PBRMaterial instance.
  136416. *
  136417. * @param name The material name
  136418. * @param scene The scene the material will be use in.
  136419. */
  136420. constructor(name: string, scene: Scene);
  136421. /**
  136422. * Gets a boolean indicating that current material needs to register RTT
  136423. */
  136424. get hasRenderTargetTextures(): boolean;
  136425. /**
  136426. * Gets the name of the material class.
  136427. */
  136428. getClassName(): string;
  136429. /**
  136430. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  136431. */
  136432. get useLogarithmicDepth(): boolean;
  136433. /**
  136434. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  136435. */
  136436. set useLogarithmicDepth(value: boolean);
  136437. /**
  136438. * Returns true if alpha blending should be disabled.
  136439. */
  136440. protected get _disableAlphaBlending(): boolean;
  136441. /**
  136442. * Specifies whether or not this material should be rendered in alpha blend mode.
  136443. */
  136444. needAlphaBlending(): boolean;
  136445. /**
  136446. * Specifies whether or not this material should be rendered in alpha test mode.
  136447. */
  136448. needAlphaTesting(): boolean;
  136449. /**
  136450. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  136451. */
  136452. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  136453. /**
  136454. * Gets the texture used for the alpha test.
  136455. */
  136456. getAlphaTestTexture(): Nullable<BaseTexture>;
  136457. /**
  136458. * Specifies that the submesh is ready to be used.
  136459. * @param mesh - BJS mesh.
  136460. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  136461. * @param useInstances - Specifies that instances should be used.
  136462. * @returns - boolean indicating that the submesh is ready or not.
  136463. */
  136464. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  136465. /**
  136466. * Specifies if the material uses metallic roughness workflow.
  136467. * @returns boolean specifiying if the material uses metallic roughness workflow.
  136468. */
  136469. isMetallicWorkflow(): boolean;
  136470. private _prepareEffect;
  136471. private _prepareDefines;
  136472. /**
  136473. * Force shader compilation
  136474. */
  136475. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  136476. /**
  136477. * Initializes the uniform buffer layout for the shader.
  136478. */
  136479. buildUniformLayout(): void;
  136480. /**
  136481. * Unbinds the material from the mesh
  136482. */
  136483. unbind(): void;
  136484. /**
  136485. * Binds the submesh data.
  136486. * @param world - The world matrix.
  136487. * @param mesh - The BJS mesh.
  136488. * @param subMesh - A submesh of the BJS mesh.
  136489. */
  136490. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  136491. /**
  136492. * Returns the animatable textures.
  136493. * @returns - Array of animatable textures.
  136494. */
  136495. getAnimatables(): IAnimatable[];
  136496. /**
  136497. * Returns the texture used for reflections.
  136498. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  136499. */
  136500. private _getReflectionTexture;
  136501. /**
  136502. * Returns an array of the actively used textures.
  136503. * @returns - Array of BaseTextures
  136504. */
  136505. getActiveTextures(): BaseTexture[];
  136506. /**
  136507. * Checks to see if a texture is used in the material.
  136508. * @param texture - Base texture to use.
  136509. * @returns - Boolean specifying if a texture is used in the material.
  136510. */
  136511. hasTexture(texture: BaseTexture): boolean;
  136512. /**
  136513. * Sets the required values to the prepass renderer.
  136514. * @param prePassRenderer defines the prepass renderer to setup
  136515. */
  136516. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  136517. /**
  136518. * Disposes the resources of the material.
  136519. * @param forceDisposeEffect - Forces the disposal of effects.
  136520. * @param forceDisposeTextures - Forces the disposal of all textures.
  136521. */
  136522. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  136523. }
  136524. }
  136525. declare module BABYLON {
  136526. /**
  136527. * The Physically based material of BJS.
  136528. *
  136529. * This offers the main features of a standard PBR material.
  136530. * For more information, please refer to the documentation :
  136531. * https://doc.babylonjs.com/how_to/physically_based_rendering
  136532. */
  136533. export class PBRMaterial extends PBRBaseMaterial {
  136534. /**
  136535. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  136536. */
  136537. static readonly PBRMATERIAL_OPAQUE: number;
  136538. /**
  136539. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  136540. */
  136541. static readonly PBRMATERIAL_ALPHATEST: number;
  136542. /**
  136543. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136544. */
  136545. static readonly PBRMATERIAL_ALPHABLEND: number;
  136546. /**
  136547. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136548. * They are also discarded below the alpha cutoff threshold to improve performances.
  136549. */
  136550. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  136551. /**
  136552. * Defines the default value of how much AO map is occluding the analytical lights
  136553. * (point spot...).
  136554. */
  136555. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  136556. /**
  136557. * Intensity of the direct lights e.g. the four lights available in your scene.
  136558. * This impacts both the direct diffuse and specular highlights.
  136559. */
  136560. directIntensity: number;
  136561. /**
  136562. * Intensity of the emissive part of the material.
  136563. * This helps controlling the emissive effect without modifying the emissive color.
  136564. */
  136565. emissiveIntensity: number;
  136566. /**
  136567. * Intensity of the environment e.g. how much the environment will light the object
  136568. * either through harmonics for rough material or through the refelction for shiny ones.
  136569. */
  136570. environmentIntensity: number;
  136571. /**
  136572. * This is a special control allowing the reduction of the specular highlights coming from the
  136573. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  136574. */
  136575. specularIntensity: number;
  136576. /**
  136577. * Debug Control allowing disabling the bump map on this material.
  136578. */
  136579. disableBumpMap: boolean;
  136580. /**
  136581. * AKA Diffuse Texture in standard nomenclature.
  136582. */
  136583. albedoTexture: BaseTexture;
  136584. /**
  136585. * AKA Occlusion Texture in other nomenclature.
  136586. */
  136587. ambientTexture: BaseTexture;
  136588. /**
  136589. * AKA Occlusion Texture Intensity in other nomenclature.
  136590. */
  136591. ambientTextureStrength: number;
  136592. /**
  136593. * Defines how much the AO map is occluding the analytical lights (point spot...).
  136594. * 1 means it completely occludes it
  136595. * 0 mean it has no impact
  136596. */
  136597. ambientTextureImpactOnAnalyticalLights: number;
  136598. /**
  136599. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  136600. */
  136601. opacityTexture: BaseTexture;
  136602. /**
  136603. * Stores the reflection values in a texture.
  136604. */
  136605. reflectionTexture: Nullable<BaseTexture>;
  136606. /**
  136607. * Stores the emissive values in a texture.
  136608. */
  136609. emissiveTexture: BaseTexture;
  136610. /**
  136611. * AKA Specular texture in other nomenclature.
  136612. */
  136613. reflectivityTexture: BaseTexture;
  136614. /**
  136615. * Used to switch from specular/glossiness to metallic/roughness workflow.
  136616. */
  136617. metallicTexture: BaseTexture;
  136618. /**
  136619. * Specifies the metallic scalar of the metallic/roughness workflow.
  136620. * Can also be used to scale the metalness values of the metallic texture.
  136621. */
  136622. metallic: Nullable<number>;
  136623. /**
  136624. * Specifies the roughness scalar of the metallic/roughness workflow.
  136625. * Can also be used to scale the roughness values of the metallic texture.
  136626. */
  136627. roughness: Nullable<number>;
  136628. /**
  136629. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  136630. * By default the indexOfrefraction is used to compute F0;
  136631. *
  136632. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  136633. *
  136634. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  136635. * F90 = metallicReflectanceColor;
  136636. */
  136637. metallicF0Factor: number;
  136638. /**
  136639. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  136640. * By default the F90 is always 1;
  136641. *
  136642. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  136643. *
  136644. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  136645. * F90 = metallicReflectanceColor;
  136646. */
  136647. metallicReflectanceColor: Color3;
  136648. /**
  136649. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  136650. * This is multiply against the scalar values defined in the material.
  136651. */
  136652. metallicReflectanceTexture: Nullable<BaseTexture>;
  136653. /**
  136654. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  136655. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  136656. */
  136657. microSurfaceTexture: BaseTexture;
  136658. /**
  136659. * Stores surface normal data used to displace a mesh in a texture.
  136660. */
  136661. bumpTexture: BaseTexture;
  136662. /**
  136663. * Stores the pre-calculated light information of a mesh in a texture.
  136664. */
  136665. lightmapTexture: BaseTexture;
  136666. /**
  136667. * Stores the refracted light information in a texture.
  136668. */
  136669. get refractionTexture(): Nullable<BaseTexture>;
  136670. set refractionTexture(value: Nullable<BaseTexture>);
  136671. /**
  136672. * The color of a material in ambient lighting.
  136673. */
  136674. ambientColor: Color3;
  136675. /**
  136676. * AKA Diffuse Color in other nomenclature.
  136677. */
  136678. albedoColor: Color3;
  136679. /**
  136680. * AKA Specular Color in other nomenclature.
  136681. */
  136682. reflectivityColor: Color3;
  136683. /**
  136684. * The color reflected from the material.
  136685. */
  136686. reflectionColor: Color3;
  136687. /**
  136688. * The color emitted from the material.
  136689. */
  136690. emissiveColor: Color3;
  136691. /**
  136692. * AKA Glossiness in other nomenclature.
  136693. */
  136694. microSurface: number;
  136695. /**
  136696. * Index of refraction of the material base layer.
  136697. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  136698. *
  136699. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  136700. *
  136701. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  136702. */
  136703. get indexOfRefraction(): number;
  136704. set indexOfRefraction(value: number);
  136705. /**
  136706. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  136707. */
  136708. get invertRefractionY(): boolean;
  136709. set invertRefractionY(value: boolean);
  136710. /**
  136711. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  136712. * Materials half opaque for instance using refraction could benefit from this control.
  136713. */
  136714. get linkRefractionWithTransparency(): boolean;
  136715. set linkRefractionWithTransparency(value: boolean);
  136716. /**
  136717. * If true, the light map contains occlusion information instead of lighting info.
  136718. */
  136719. useLightmapAsShadowmap: boolean;
  136720. /**
  136721. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  136722. */
  136723. useAlphaFromAlbedoTexture: boolean;
  136724. /**
  136725. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  136726. */
  136727. forceAlphaTest: boolean;
  136728. /**
  136729. * Defines the alpha limits in alpha test mode.
  136730. */
  136731. alphaCutOff: number;
  136732. /**
  136733. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  136734. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  136735. */
  136736. useSpecularOverAlpha: boolean;
  136737. /**
  136738. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  136739. */
  136740. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  136741. /**
  136742. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  136743. */
  136744. useRoughnessFromMetallicTextureAlpha: boolean;
  136745. /**
  136746. * Specifies if the metallic texture contains the roughness information in its green channel.
  136747. */
  136748. useRoughnessFromMetallicTextureGreen: boolean;
  136749. /**
  136750. * Specifies if the metallic texture contains the metallness information in its blue channel.
  136751. */
  136752. useMetallnessFromMetallicTextureBlue: boolean;
  136753. /**
  136754. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  136755. */
  136756. useAmbientOcclusionFromMetallicTextureRed: boolean;
  136757. /**
  136758. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  136759. */
  136760. useAmbientInGrayScale: boolean;
  136761. /**
  136762. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  136763. * The material will try to infer what glossiness each pixel should be.
  136764. */
  136765. useAutoMicroSurfaceFromReflectivityMap: boolean;
  136766. /**
  136767. * BJS is using an harcoded light falloff based on a manually sets up range.
  136768. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  136769. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  136770. */
  136771. get usePhysicalLightFalloff(): boolean;
  136772. /**
  136773. * BJS is using an harcoded light falloff based on a manually sets up range.
  136774. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  136775. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  136776. */
  136777. set usePhysicalLightFalloff(value: boolean);
  136778. /**
  136779. * In order to support the falloff compatibility with gltf, a special mode has been added
  136780. * to reproduce the gltf light falloff.
  136781. */
  136782. get useGLTFLightFalloff(): boolean;
  136783. /**
  136784. * In order to support the falloff compatibility with gltf, a special mode has been added
  136785. * to reproduce the gltf light falloff.
  136786. */
  136787. set useGLTFLightFalloff(value: boolean);
  136788. /**
  136789. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  136790. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  136791. */
  136792. useRadianceOverAlpha: boolean;
  136793. /**
  136794. * Allows using an object space normal map (instead of tangent space).
  136795. */
  136796. useObjectSpaceNormalMap: boolean;
  136797. /**
  136798. * Allows using the bump map in parallax mode.
  136799. */
  136800. useParallax: boolean;
  136801. /**
  136802. * Allows using the bump map in parallax occlusion mode.
  136803. */
  136804. useParallaxOcclusion: boolean;
  136805. /**
  136806. * Controls the scale bias of the parallax mode.
  136807. */
  136808. parallaxScaleBias: number;
  136809. /**
  136810. * If sets to true, disables all the lights affecting the material.
  136811. */
  136812. disableLighting: boolean;
  136813. /**
  136814. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  136815. */
  136816. forceIrradianceInFragment: boolean;
  136817. /**
  136818. * Number of Simultaneous lights allowed on the material.
  136819. */
  136820. maxSimultaneousLights: number;
  136821. /**
  136822. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  136823. */
  136824. invertNormalMapX: boolean;
  136825. /**
  136826. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  136827. */
  136828. invertNormalMapY: boolean;
  136829. /**
  136830. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  136831. */
  136832. twoSidedLighting: boolean;
  136833. /**
  136834. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136835. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  136836. */
  136837. useAlphaFresnel: boolean;
  136838. /**
  136839. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136840. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  136841. */
  136842. useLinearAlphaFresnel: boolean;
  136843. /**
  136844. * Let user defines the brdf lookup texture used for IBL.
  136845. * A default 8bit version is embedded but you could point at :
  136846. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  136847. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  136848. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  136849. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  136850. */
  136851. environmentBRDFTexture: Nullable<BaseTexture>;
  136852. /**
  136853. * Force normal to face away from face.
  136854. */
  136855. forceNormalForward: boolean;
  136856. /**
  136857. * Enables specular anti aliasing in the PBR shader.
  136858. * It will both interacts on the Geometry for analytical and IBL lighting.
  136859. * It also prefilter the roughness map based on the bump values.
  136860. */
  136861. enableSpecularAntiAliasing: boolean;
  136862. /**
  136863. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  136864. * makes the reflect vector face the model (under horizon).
  136865. */
  136866. useHorizonOcclusion: boolean;
  136867. /**
  136868. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  136869. * too much the area relying on ambient texture to define their ambient occlusion.
  136870. */
  136871. useRadianceOcclusion: boolean;
  136872. /**
  136873. * If set to true, no lighting calculations will be applied.
  136874. */
  136875. unlit: boolean;
  136876. /**
  136877. * Gets the image processing configuration used either in this material.
  136878. */
  136879. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  136880. /**
  136881. * Sets the Default image processing configuration used either in the this material.
  136882. *
  136883. * If sets to null, the scene one is in use.
  136884. */
  136885. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  136886. /**
  136887. * Gets wether the color curves effect is enabled.
  136888. */
  136889. get cameraColorCurvesEnabled(): boolean;
  136890. /**
  136891. * Sets wether the color curves effect is enabled.
  136892. */
  136893. set cameraColorCurvesEnabled(value: boolean);
  136894. /**
  136895. * Gets wether the color grading effect is enabled.
  136896. */
  136897. get cameraColorGradingEnabled(): boolean;
  136898. /**
  136899. * Gets wether the color grading effect is enabled.
  136900. */
  136901. set cameraColorGradingEnabled(value: boolean);
  136902. /**
  136903. * Gets wether tonemapping is enabled or not.
  136904. */
  136905. get cameraToneMappingEnabled(): boolean;
  136906. /**
  136907. * Sets wether tonemapping is enabled or not
  136908. */
  136909. set cameraToneMappingEnabled(value: boolean);
  136910. /**
  136911. * The camera exposure used on this material.
  136912. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  136913. * This corresponds to a photographic exposure.
  136914. */
  136915. get cameraExposure(): number;
  136916. /**
  136917. * The camera exposure used on this material.
  136918. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  136919. * This corresponds to a photographic exposure.
  136920. */
  136921. set cameraExposure(value: number);
  136922. /**
  136923. * Gets The camera contrast used on this material.
  136924. */
  136925. get cameraContrast(): number;
  136926. /**
  136927. * Sets The camera contrast used on this material.
  136928. */
  136929. set cameraContrast(value: number);
  136930. /**
  136931. * Gets the Color Grading 2D Lookup Texture.
  136932. */
  136933. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  136934. /**
  136935. * Sets the Color Grading 2D Lookup Texture.
  136936. */
  136937. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  136938. /**
  136939. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  136940. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  136941. * 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;
  136942. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  136943. */
  136944. get cameraColorCurves(): Nullable<ColorCurves>;
  136945. /**
  136946. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  136947. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  136948. * 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;
  136949. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  136950. */
  136951. set cameraColorCurves(value: Nullable<ColorCurves>);
  136952. /**
  136953. * Instantiates a new PBRMaterial instance.
  136954. *
  136955. * @param name The material name
  136956. * @param scene The scene the material will be use in.
  136957. */
  136958. constructor(name: string, scene: Scene);
  136959. /**
  136960. * Returns the name of this material class.
  136961. */
  136962. getClassName(): string;
  136963. /**
  136964. * Makes a duplicate of the current material.
  136965. * @param name - name to use for the new material.
  136966. */
  136967. clone(name: string): PBRMaterial;
  136968. /**
  136969. * Serializes this PBR Material.
  136970. * @returns - An object with the serialized material.
  136971. */
  136972. serialize(): any;
  136973. /**
  136974. * Parses a PBR Material from a serialized object.
  136975. * @param source - Serialized object.
  136976. * @param scene - BJS scene instance.
  136977. * @param rootUrl - url for the scene object
  136978. * @returns - PBRMaterial
  136979. */
  136980. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  136981. }
  136982. }
  136983. declare module BABYLON {
  136984. /**
  136985. * Direct draw surface info
  136986. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  136987. */
  136988. export interface DDSInfo {
  136989. /**
  136990. * Width of the texture
  136991. */
  136992. width: number;
  136993. /**
  136994. * Width of the texture
  136995. */
  136996. height: number;
  136997. /**
  136998. * Number of Mipmaps for the texture
  136999. * @see https://en.wikipedia.org/wiki/Mipmap
  137000. */
  137001. mipmapCount: number;
  137002. /**
  137003. * If the textures format is a known fourCC format
  137004. * @see https://www.fourcc.org/
  137005. */
  137006. isFourCC: boolean;
  137007. /**
  137008. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  137009. */
  137010. isRGB: boolean;
  137011. /**
  137012. * If the texture is a lumincance format
  137013. */
  137014. isLuminance: boolean;
  137015. /**
  137016. * If this is a cube texture
  137017. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  137018. */
  137019. isCube: boolean;
  137020. /**
  137021. * If the texture is a compressed format eg. FOURCC_DXT1
  137022. */
  137023. isCompressed: boolean;
  137024. /**
  137025. * The dxgiFormat of the texture
  137026. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  137027. */
  137028. dxgiFormat: number;
  137029. /**
  137030. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  137031. */
  137032. textureType: number;
  137033. /**
  137034. * Sphericle polynomial created for the dds texture
  137035. */
  137036. sphericalPolynomial?: SphericalPolynomial;
  137037. }
  137038. /**
  137039. * Class used to provide DDS decompression tools
  137040. */
  137041. export class DDSTools {
  137042. /**
  137043. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  137044. */
  137045. static StoreLODInAlphaChannel: boolean;
  137046. /**
  137047. * Gets DDS information from an array buffer
  137048. * @param data defines the array buffer view to read data from
  137049. * @returns the DDS information
  137050. */
  137051. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  137052. private static _FloatView;
  137053. private static _Int32View;
  137054. private static _ToHalfFloat;
  137055. private static _FromHalfFloat;
  137056. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  137057. private static _GetHalfFloatRGBAArrayBuffer;
  137058. private static _GetFloatRGBAArrayBuffer;
  137059. private static _GetFloatAsUIntRGBAArrayBuffer;
  137060. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  137061. private static _GetRGBAArrayBuffer;
  137062. private static _ExtractLongWordOrder;
  137063. private static _GetRGBArrayBuffer;
  137064. private static _GetLuminanceArrayBuffer;
  137065. /**
  137066. * Uploads DDS Levels to a Babylon Texture
  137067. * @hidden
  137068. */
  137069. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  137070. }
  137071. interface ThinEngine {
  137072. /**
  137073. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  137074. * @param rootUrl defines the url where the file to load is located
  137075. * @param scene defines the current scene
  137076. * @param lodScale defines scale to apply to the mip map selection
  137077. * @param lodOffset defines offset to apply to the mip map selection
  137078. * @param onLoad defines an optional callback raised when the texture is loaded
  137079. * @param onError defines an optional callback raised if there is an issue to load the texture
  137080. * @param format defines the format of the data
  137081. * @param forcedExtension defines the extension to use to pick the right loader
  137082. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  137083. * @returns the cube texture as an InternalTexture
  137084. */
  137085. 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;
  137086. }
  137087. }
  137088. declare module BABYLON {
  137089. /**
  137090. * Implementation of the DDS Texture Loader.
  137091. * @hidden
  137092. */
  137093. export class _DDSTextureLoader implements IInternalTextureLoader {
  137094. /**
  137095. * Defines wether the loader supports cascade loading the different faces.
  137096. */
  137097. readonly supportCascades: boolean;
  137098. /**
  137099. * This returns if the loader support the current file information.
  137100. * @param extension defines the file extension of the file being loaded
  137101. * @returns true if the loader can load the specified file
  137102. */
  137103. canLoad(extension: string): boolean;
  137104. /**
  137105. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  137106. * @param data contains the texture data
  137107. * @param texture defines the BabylonJS internal texture
  137108. * @param createPolynomials will be true if polynomials have been requested
  137109. * @param onLoad defines the callback to trigger once the texture is ready
  137110. * @param onError defines the callback to trigger in case of error
  137111. */
  137112. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  137113. /**
  137114. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  137115. * @param data contains the texture data
  137116. * @param texture defines the BabylonJS internal texture
  137117. * @param callback defines the method to call once ready to upload
  137118. */
  137119. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  137120. }
  137121. }
  137122. declare module BABYLON {
  137123. /**
  137124. * Implementation of the ENV Texture Loader.
  137125. * @hidden
  137126. */
  137127. export class _ENVTextureLoader implements IInternalTextureLoader {
  137128. /**
  137129. * Defines wether the loader supports cascade loading the different faces.
  137130. */
  137131. readonly supportCascades: boolean;
  137132. /**
  137133. * This returns if the loader support the current file information.
  137134. * @param extension defines the file extension of the file being loaded
  137135. * @returns true if the loader can load the specified file
  137136. */
  137137. canLoad(extension: string): boolean;
  137138. /**
  137139. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  137140. * @param data contains the texture data
  137141. * @param texture defines the BabylonJS internal texture
  137142. * @param createPolynomials will be true if polynomials have been requested
  137143. * @param onLoad defines the callback to trigger once the texture is ready
  137144. * @param onError defines the callback to trigger in case of error
  137145. */
  137146. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  137147. /**
  137148. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  137149. * @param data contains the texture data
  137150. * @param texture defines the BabylonJS internal texture
  137151. * @param callback defines the method to call once ready to upload
  137152. */
  137153. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  137154. }
  137155. }
  137156. declare module BABYLON {
  137157. /**
  137158. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  137159. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  137160. */
  137161. export class KhronosTextureContainer {
  137162. /** contents of the KTX container file */
  137163. data: ArrayBufferView;
  137164. private static HEADER_LEN;
  137165. private static COMPRESSED_2D;
  137166. private static COMPRESSED_3D;
  137167. private static TEX_2D;
  137168. private static TEX_3D;
  137169. /**
  137170. * Gets the openGL type
  137171. */
  137172. glType: number;
  137173. /**
  137174. * Gets the openGL type size
  137175. */
  137176. glTypeSize: number;
  137177. /**
  137178. * Gets the openGL format
  137179. */
  137180. glFormat: number;
  137181. /**
  137182. * Gets the openGL internal format
  137183. */
  137184. glInternalFormat: number;
  137185. /**
  137186. * Gets the base internal format
  137187. */
  137188. glBaseInternalFormat: number;
  137189. /**
  137190. * Gets image width in pixel
  137191. */
  137192. pixelWidth: number;
  137193. /**
  137194. * Gets image height in pixel
  137195. */
  137196. pixelHeight: number;
  137197. /**
  137198. * Gets image depth in pixels
  137199. */
  137200. pixelDepth: number;
  137201. /**
  137202. * Gets the number of array elements
  137203. */
  137204. numberOfArrayElements: number;
  137205. /**
  137206. * Gets the number of faces
  137207. */
  137208. numberOfFaces: number;
  137209. /**
  137210. * Gets the number of mipmap levels
  137211. */
  137212. numberOfMipmapLevels: number;
  137213. /**
  137214. * Gets the bytes of key value data
  137215. */
  137216. bytesOfKeyValueData: number;
  137217. /**
  137218. * Gets the load type
  137219. */
  137220. loadType: number;
  137221. /**
  137222. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  137223. */
  137224. isInvalid: boolean;
  137225. /**
  137226. * Creates a new KhronosTextureContainer
  137227. * @param data contents of the KTX container file
  137228. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  137229. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  137230. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  137231. */
  137232. constructor(
  137233. /** contents of the KTX container file */
  137234. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  137235. /**
  137236. * Uploads KTX content to a Babylon Texture.
  137237. * It is assumed that the texture has already been created & is currently bound
  137238. * @hidden
  137239. */
  137240. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  137241. private _upload2DCompressedLevels;
  137242. /**
  137243. * Checks if the given data starts with a KTX file identifier.
  137244. * @param data the data to check
  137245. * @returns true if the data is a KTX file or false otherwise
  137246. */
  137247. static IsValid(data: ArrayBufferView): boolean;
  137248. }
  137249. }
  137250. declare module BABYLON {
  137251. /**
  137252. * Class for loading KTX2 files
  137253. * !!! Experimental Extension Subject to Changes !!!
  137254. * @hidden
  137255. */
  137256. export class KhronosTextureContainer2 {
  137257. private static _ModulePromise;
  137258. private static _TranscodeFormat;
  137259. constructor(engine: ThinEngine);
  137260. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  137261. private _determineTranscodeFormat;
  137262. /**
  137263. * Checks if the given data starts with a KTX2 file identifier.
  137264. * @param data the data to check
  137265. * @returns true if the data is a KTX2 file or false otherwise
  137266. */
  137267. static IsValid(data: ArrayBufferView): boolean;
  137268. }
  137269. }
  137270. declare module BABYLON {
  137271. /**
  137272. * Implementation of the KTX Texture Loader.
  137273. * @hidden
  137274. */
  137275. export class _KTXTextureLoader implements IInternalTextureLoader {
  137276. /**
  137277. * Defines wether the loader supports cascade loading the different faces.
  137278. */
  137279. readonly supportCascades: boolean;
  137280. /**
  137281. * This returns if the loader support the current file information.
  137282. * @param extension defines the file extension of the file being loaded
  137283. * @param mimeType defines the optional mime type of the file being loaded
  137284. * @returns true if the loader can load the specified file
  137285. */
  137286. canLoad(extension: string, mimeType?: string): boolean;
  137287. /**
  137288. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  137289. * @param data contains the texture data
  137290. * @param texture defines the BabylonJS internal texture
  137291. * @param createPolynomials will be true if polynomials have been requested
  137292. * @param onLoad defines the callback to trigger once the texture is ready
  137293. * @param onError defines the callback to trigger in case of error
  137294. */
  137295. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  137296. /**
  137297. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  137298. * @param data contains the texture data
  137299. * @param texture defines the BabylonJS internal texture
  137300. * @param callback defines the method to call once ready to upload
  137301. */
  137302. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  137303. }
  137304. }
  137305. declare module BABYLON {
  137306. /** @hidden */
  137307. export var _forceSceneHelpersToBundle: boolean;
  137308. interface Scene {
  137309. /**
  137310. * Creates a default light for the scene.
  137311. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  137312. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  137313. */
  137314. createDefaultLight(replace?: boolean): void;
  137315. /**
  137316. * Creates a default camera for the scene.
  137317. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  137318. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  137319. * @param replace has default false, when true replaces the active camera in the scene
  137320. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  137321. */
  137322. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  137323. /**
  137324. * Creates a default camera and a default light.
  137325. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  137326. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  137327. * @param replace has the default false, when true replaces the active camera/light in the scene
  137328. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  137329. */
  137330. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  137331. /**
  137332. * Creates a new sky box
  137333. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  137334. * @param environmentTexture defines the texture to use as environment texture
  137335. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  137336. * @param scale defines the overall scale of the skybox
  137337. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  137338. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  137339. * @returns a new mesh holding the sky box
  137340. */
  137341. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  137342. /**
  137343. * Creates a new environment
  137344. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  137345. * @param options defines the options you can use to configure the environment
  137346. * @returns the new EnvironmentHelper
  137347. */
  137348. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  137349. /**
  137350. * Creates a new VREXperienceHelper
  137351. * @see https://doc.babylonjs.com/how_to/webvr_helper
  137352. * @param webVROptions defines the options used to create the new VREXperienceHelper
  137353. * @returns a new VREXperienceHelper
  137354. */
  137355. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  137356. /**
  137357. * Creates a new WebXRDefaultExperience
  137358. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  137359. * @param options experience options
  137360. * @returns a promise for a new WebXRDefaultExperience
  137361. */
  137362. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  137363. }
  137364. }
  137365. declare module BABYLON {
  137366. /**
  137367. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  137368. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  137369. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  137370. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  137371. */
  137372. export class VideoDome extends TextureDome<VideoTexture> {
  137373. /**
  137374. * Define the video source as a Monoscopic panoramic 360 video.
  137375. */
  137376. static readonly MODE_MONOSCOPIC: number;
  137377. /**
  137378. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  137379. */
  137380. static readonly MODE_TOPBOTTOM: number;
  137381. /**
  137382. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  137383. */
  137384. static readonly MODE_SIDEBYSIDE: number;
  137385. /**
  137386. * Get the video texture associated with this video dome
  137387. */
  137388. get videoTexture(): VideoTexture;
  137389. /**
  137390. * Get the video mode of this dome
  137391. */
  137392. get videoMode(): number;
  137393. /**
  137394. * Set the video mode of this dome.
  137395. * @see textureMode
  137396. */
  137397. set videoMode(value: number);
  137398. protected _initTexture(urlsOrElement: string | string[] | HTMLVideoElement, scene: Scene, options: any): VideoTexture;
  137399. }
  137400. }
  137401. declare module BABYLON {
  137402. /**
  137403. * This class can be used to get instrumentation data from a Babylon engine
  137404. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  137405. */
  137406. export class EngineInstrumentation implements IDisposable {
  137407. /**
  137408. * Define the instrumented engine.
  137409. */
  137410. engine: Engine;
  137411. private _captureGPUFrameTime;
  137412. private _gpuFrameTimeToken;
  137413. private _gpuFrameTime;
  137414. private _captureShaderCompilationTime;
  137415. private _shaderCompilationTime;
  137416. private _onBeginFrameObserver;
  137417. private _onEndFrameObserver;
  137418. private _onBeforeShaderCompilationObserver;
  137419. private _onAfterShaderCompilationObserver;
  137420. /**
  137421. * Gets the perf counter used for GPU frame time
  137422. */
  137423. get gpuFrameTimeCounter(): PerfCounter;
  137424. /**
  137425. * Gets the GPU frame time capture status
  137426. */
  137427. get captureGPUFrameTime(): boolean;
  137428. /**
  137429. * Enable or disable the GPU frame time capture
  137430. */
  137431. set captureGPUFrameTime(value: boolean);
  137432. /**
  137433. * Gets the perf counter used for shader compilation time
  137434. */
  137435. get shaderCompilationTimeCounter(): PerfCounter;
  137436. /**
  137437. * Gets the shader compilation time capture status
  137438. */
  137439. get captureShaderCompilationTime(): boolean;
  137440. /**
  137441. * Enable or disable the shader compilation time capture
  137442. */
  137443. set captureShaderCompilationTime(value: boolean);
  137444. /**
  137445. * Instantiates a new engine instrumentation.
  137446. * This class can be used to get instrumentation data from a Babylon engine
  137447. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  137448. * @param engine Defines the engine to instrument
  137449. */
  137450. constructor(
  137451. /**
  137452. * Define the instrumented engine.
  137453. */
  137454. engine: Engine);
  137455. /**
  137456. * Dispose and release associated resources.
  137457. */
  137458. dispose(): void;
  137459. }
  137460. }
  137461. declare module BABYLON {
  137462. /**
  137463. * This class can be used to get instrumentation data from a Babylon engine
  137464. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  137465. */
  137466. export class SceneInstrumentation implements IDisposable {
  137467. /**
  137468. * Defines the scene to instrument
  137469. */
  137470. scene: Scene;
  137471. private _captureActiveMeshesEvaluationTime;
  137472. private _activeMeshesEvaluationTime;
  137473. private _captureRenderTargetsRenderTime;
  137474. private _renderTargetsRenderTime;
  137475. private _captureFrameTime;
  137476. private _frameTime;
  137477. private _captureRenderTime;
  137478. private _renderTime;
  137479. private _captureInterFrameTime;
  137480. private _interFrameTime;
  137481. private _captureParticlesRenderTime;
  137482. private _particlesRenderTime;
  137483. private _captureSpritesRenderTime;
  137484. private _spritesRenderTime;
  137485. private _capturePhysicsTime;
  137486. private _physicsTime;
  137487. private _captureAnimationsTime;
  137488. private _animationsTime;
  137489. private _captureCameraRenderTime;
  137490. private _cameraRenderTime;
  137491. private _onBeforeActiveMeshesEvaluationObserver;
  137492. private _onAfterActiveMeshesEvaluationObserver;
  137493. private _onBeforeRenderTargetsRenderObserver;
  137494. private _onAfterRenderTargetsRenderObserver;
  137495. private _onAfterRenderObserver;
  137496. private _onBeforeDrawPhaseObserver;
  137497. private _onAfterDrawPhaseObserver;
  137498. private _onBeforeAnimationsObserver;
  137499. private _onBeforeParticlesRenderingObserver;
  137500. private _onAfterParticlesRenderingObserver;
  137501. private _onBeforeSpritesRenderingObserver;
  137502. private _onAfterSpritesRenderingObserver;
  137503. private _onBeforePhysicsObserver;
  137504. private _onAfterPhysicsObserver;
  137505. private _onAfterAnimationsObserver;
  137506. private _onBeforeCameraRenderObserver;
  137507. private _onAfterCameraRenderObserver;
  137508. /**
  137509. * Gets the perf counter used for active meshes evaluation time
  137510. */
  137511. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  137512. /**
  137513. * Gets the active meshes evaluation time capture status
  137514. */
  137515. get captureActiveMeshesEvaluationTime(): boolean;
  137516. /**
  137517. * Enable or disable the active meshes evaluation time capture
  137518. */
  137519. set captureActiveMeshesEvaluationTime(value: boolean);
  137520. /**
  137521. * Gets the perf counter used for render targets render time
  137522. */
  137523. get renderTargetsRenderTimeCounter(): PerfCounter;
  137524. /**
  137525. * Gets the render targets render time capture status
  137526. */
  137527. get captureRenderTargetsRenderTime(): boolean;
  137528. /**
  137529. * Enable or disable the render targets render time capture
  137530. */
  137531. set captureRenderTargetsRenderTime(value: boolean);
  137532. /**
  137533. * Gets the perf counter used for particles render time
  137534. */
  137535. get particlesRenderTimeCounter(): PerfCounter;
  137536. /**
  137537. * Gets the particles render time capture status
  137538. */
  137539. get captureParticlesRenderTime(): boolean;
  137540. /**
  137541. * Enable or disable the particles render time capture
  137542. */
  137543. set captureParticlesRenderTime(value: boolean);
  137544. /**
  137545. * Gets the perf counter used for sprites render time
  137546. */
  137547. get spritesRenderTimeCounter(): PerfCounter;
  137548. /**
  137549. * Gets the sprites render time capture status
  137550. */
  137551. get captureSpritesRenderTime(): boolean;
  137552. /**
  137553. * Enable or disable the sprites render time capture
  137554. */
  137555. set captureSpritesRenderTime(value: boolean);
  137556. /**
  137557. * Gets the perf counter used for physics time
  137558. */
  137559. get physicsTimeCounter(): PerfCounter;
  137560. /**
  137561. * Gets the physics time capture status
  137562. */
  137563. get capturePhysicsTime(): boolean;
  137564. /**
  137565. * Enable or disable the physics time capture
  137566. */
  137567. set capturePhysicsTime(value: boolean);
  137568. /**
  137569. * Gets the perf counter used for animations time
  137570. */
  137571. get animationsTimeCounter(): PerfCounter;
  137572. /**
  137573. * Gets the animations time capture status
  137574. */
  137575. get captureAnimationsTime(): boolean;
  137576. /**
  137577. * Enable or disable the animations time capture
  137578. */
  137579. set captureAnimationsTime(value: boolean);
  137580. /**
  137581. * Gets the perf counter used for frame time capture
  137582. */
  137583. get frameTimeCounter(): PerfCounter;
  137584. /**
  137585. * Gets the frame time capture status
  137586. */
  137587. get captureFrameTime(): boolean;
  137588. /**
  137589. * Enable or disable the frame time capture
  137590. */
  137591. set captureFrameTime(value: boolean);
  137592. /**
  137593. * Gets the perf counter used for inter-frames time capture
  137594. */
  137595. get interFrameTimeCounter(): PerfCounter;
  137596. /**
  137597. * Gets the inter-frames time capture status
  137598. */
  137599. get captureInterFrameTime(): boolean;
  137600. /**
  137601. * Enable or disable the inter-frames time capture
  137602. */
  137603. set captureInterFrameTime(value: boolean);
  137604. /**
  137605. * Gets the perf counter used for render time capture
  137606. */
  137607. get renderTimeCounter(): PerfCounter;
  137608. /**
  137609. * Gets the render time capture status
  137610. */
  137611. get captureRenderTime(): boolean;
  137612. /**
  137613. * Enable or disable the render time capture
  137614. */
  137615. set captureRenderTime(value: boolean);
  137616. /**
  137617. * Gets the perf counter used for camera render time capture
  137618. */
  137619. get cameraRenderTimeCounter(): PerfCounter;
  137620. /**
  137621. * Gets the camera render time capture status
  137622. */
  137623. get captureCameraRenderTime(): boolean;
  137624. /**
  137625. * Enable or disable the camera render time capture
  137626. */
  137627. set captureCameraRenderTime(value: boolean);
  137628. /**
  137629. * Gets the perf counter used for draw calls
  137630. */
  137631. get drawCallsCounter(): PerfCounter;
  137632. /**
  137633. * Instantiates a new scene instrumentation.
  137634. * This class can be used to get instrumentation data from a Babylon engine
  137635. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  137636. * @param scene Defines the scene to instrument
  137637. */
  137638. constructor(
  137639. /**
  137640. * Defines the scene to instrument
  137641. */
  137642. scene: Scene);
  137643. /**
  137644. * Dispose and release associated resources.
  137645. */
  137646. dispose(): void;
  137647. }
  137648. }
  137649. declare module BABYLON {
  137650. /** @hidden */
  137651. export var glowMapGenerationPixelShader: {
  137652. name: string;
  137653. shader: string;
  137654. };
  137655. }
  137656. declare module BABYLON {
  137657. /** @hidden */
  137658. export var glowMapGenerationVertexShader: {
  137659. name: string;
  137660. shader: string;
  137661. };
  137662. }
  137663. declare module BABYLON {
  137664. /**
  137665. * Effect layer options. This helps customizing the behaviour
  137666. * of the effect layer.
  137667. */
  137668. export interface IEffectLayerOptions {
  137669. /**
  137670. * Multiplication factor apply to the canvas size to compute the render target size
  137671. * used to generated the objects (the smaller the faster).
  137672. */
  137673. mainTextureRatio: number;
  137674. /**
  137675. * Enforces a fixed size texture to ensure effect stability across devices.
  137676. */
  137677. mainTextureFixedSize?: number;
  137678. /**
  137679. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  137680. */
  137681. alphaBlendingMode: number;
  137682. /**
  137683. * The camera attached to the layer.
  137684. */
  137685. camera: Nullable<Camera>;
  137686. /**
  137687. * The rendering group to draw the layer in.
  137688. */
  137689. renderingGroupId: number;
  137690. }
  137691. /**
  137692. * The effect layer Helps adding post process effect blended with the main pass.
  137693. *
  137694. * This can be for instance use to generate glow or higlight effects on the scene.
  137695. *
  137696. * The effect layer class can not be used directly and is intented to inherited from to be
  137697. * customized per effects.
  137698. */
  137699. export abstract class EffectLayer {
  137700. private _vertexBuffers;
  137701. private _indexBuffer;
  137702. private _cachedDefines;
  137703. private _effectLayerMapGenerationEffect;
  137704. private _effectLayerOptions;
  137705. private _mergeEffect;
  137706. protected _scene: Scene;
  137707. protected _engine: Engine;
  137708. protected _maxSize: number;
  137709. protected _mainTextureDesiredSize: ISize;
  137710. protected _mainTexture: RenderTargetTexture;
  137711. protected _shouldRender: boolean;
  137712. protected _postProcesses: PostProcess[];
  137713. protected _textures: BaseTexture[];
  137714. protected _emissiveTextureAndColor: {
  137715. texture: Nullable<BaseTexture>;
  137716. color: Color4;
  137717. };
  137718. /**
  137719. * The name of the layer
  137720. */
  137721. name: string;
  137722. /**
  137723. * The clear color of the texture used to generate the glow map.
  137724. */
  137725. neutralColor: Color4;
  137726. /**
  137727. * Specifies whether the highlight layer is enabled or not.
  137728. */
  137729. isEnabled: boolean;
  137730. /**
  137731. * Gets the camera attached to the layer.
  137732. */
  137733. get camera(): Nullable<Camera>;
  137734. /**
  137735. * Gets the rendering group id the layer should render in.
  137736. */
  137737. get renderingGroupId(): number;
  137738. set renderingGroupId(renderingGroupId: number);
  137739. /**
  137740. * An event triggered when the effect layer has been disposed.
  137741. */
  137742. onDisposeObservable: Observable<EffectLayer>;
  137743. /**
  137744. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  137745. */
  137746. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  137747. /**
  137748. * An event triggered when the generated texture is being merged in the scene.
  137749. */
  137750. onBeforeComposeObservable: Observable<EffectLayer>;
  137751. /**
  137752. * An event triggered when the mesh is rendered into the effect render target.
  137753. */
  137754. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  137755. /**
  137756. * An event triggered after the mesh has been rendered into the effect render target.
  137757. */
  137758. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  137759. /**
  137760. * An event triggered when the generated texture has been merged in the scene.
  137761. */
  137762. onAfterComposeObservable: Observable<EffectLayer>;
  137763. /**
  137764. * An event triggered when the efffect layer changes its size.
  137765. */
  137766. onSizeChangedObservable: Observable<EffectLayer>;
  137767. /** @hidden */
  137768. static _SceneComponentInitialization: (scene: Scene) => void;
  137769. /**
  137770. * Instantiates a new effect Layer and references it in the scene.
  137771. * @param name The name of the layer
  137772. * @param scene The scene to use the layer in
  137773. */
  137774. constructor(
  137775. /** The Friendly of the effect in the scene */
  137776. name: string, scene: Scene);
  137777. /**
  137778. * Get the effect name of the layer.
  137779. * @return The effect name
  137780. */
  137781. abstract getEffectName(): string;
  137782. /**
  137783. * Checks for the readiness of the element composing the layer.
  137784. * @param subMesh the mesh to check for
  137785. * @param useInstances specify whether or not to use instances to render the mesh
  137786. * @return true if ready otherwise, false
  137787. */
  137788. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  137789. /**
  137790. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  137791. * @returns true if the effect requires stencil during the main canvas render pass.
  137792. */
  137793. abstract needStencil(): boolean;
  137794. /**
  137795. * Create the merge effect. This is the shader use to blit the information back
  137796. * to the main canvas at the end of the scene rendering.
  137797. * @returns The effect containing the shader used to merge the effect on the main canvas
  137798. */
  137799. protected abstract _createMergeEffect(): Effect;
  137800. /**
  137801. * Creates the render target textures and post processes used in the effect layer.
  137802. */
  137803. protected abstract _createTextureAndPostProcesses(): void;
  137804. /**
  137805. * Implementation specific of rendering the generating effect on the main canvas.
  137806. * @param effect The effect used to render through
  137807. */
  137808. protected abstract _internalRender(effect: Effect): void;
  137809. /**
  137810. * Sets the required values for both the emissive texture and and the main color.
  137811. */
  137812. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  137813. /**
  137814. * Free any resources and references associated to a mesh.
  137815. * Internal use
  137816. * @param mesh The mesh to free.
  137817. */
  137818. abstract _disposeMesh(mesh: Mesh): void;
  137819. /**
  137820. * Serializes this layer (Glow or Highlight for example)
  137821. * @returns a serialized layer object
  137822. */
  137823. abstract serialize?(): any;
  137824. /**
  137825. * Initializes the effect layer with the required options.
  137826. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  137827. */
  137828. protected _init(options: Partial<IEffectLayerOptions>): void;
  137829. /**
  137830. * Generates the index buffer of the full screen quad blending to the main canvas.
  137831. */
  137832. private _generateIndexBuffer;
  137833. /**
  137834. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  137835. */
  137836. private _generateVertexBuffer;
  137837. /**
  137838. * Sets the main texture desired size which is the closest power of two
  137839. * of the engine canvas size.
  137840. */
  137841. private _setMainTextureSize;
  137842. /**
  137843. * Creates the main texture for the effect layer.
  137844. */
  137845. protected _createMainTexture(): void;
  137846. /**
  137847. * Adds specific effects defines.
  137848. * @param defines The defines to add specifics to.
  137849. */
  137850. protected _addCustomEffectDefines(defines: string[]): void;
  137851. /**
  137852. * Checks for the readiness of the element composing the layer.
  137853. * @param subMesh the mesh to check for
  137854. * @param useInstances specify whether or not to use instances to render the mesh
  137855. * @param emissiveTexture the associated emissive texture used to generate the glow
  137856. * @return true if ready otherwise, false
  137857. */
  137858. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  137859. /**
  137860. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  137861. */
  137862. render(): void;
  137863. /**
  137864. * Determine if a given mesh will be used in the current effect.
  137865. * @param mesh mesh to test
  137866. * @returns true if the mesh will be used
  137867. */
  137868. hasMesh(mesh: AbstractMesh): boolean;
  137869. /**
  137870. * Returns true if the layer contains information to display, otherwise false.
  137871. * @returns true if the glow layer should be rendered
  137872. */
  137873. shouldRender(): boolean;
  137874. /**
  137875. * Returns true if the mesh should render, otherwise false.
  137876. * @param mesh The mesh to render
  137877. * @returns true if it should render otherwise false
  137878. */
  137879. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  137880. /**
  137881. * Returns true if the mesh can be rendered, otherwise false.
  137882. * @param mesh The mesh to render
  137883. * @param material The material used on the mesh
  137884. * @returns true if it can be rendered otherwise false
  137885. */
  137886. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  137887. /**
  137888. * Returns true if the mesh should render, otherwise false.
  137889. * @param mesh The mesh to render
  137890. * @returns true if it should render otherwise false
  137891. */
  137892. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  137893. /**
  137894. * Renders the submesh passed in parameter to the generation map.
  137895. */
  137896. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  137897. /**
  137898. * Defines whether the current material of the mesh should be use to render the effect.
  137899. * @param mesh defines the current mesh to render
  137900. */
  137901. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  137902. /**
  137903. * Rebuild the required buffers.
  137904. * @hidden Internal use only.
  137905. */
  137906. _rebuild(): void;
  137907. /**
  137908. * Dispose only the render target textures and post process.
  137909. */
  137910. private _disposeTextureAndPostProcesses;
  137911. /**
  137912. * Dispose the highlight layer and free resources.
  137913. */
  137914. dispose(): void;
  137915. /**
  137916. * Gets the class name of the effect layer
  137917. * @returns the string with the class name of the effect layer
  137918. */
  137919. getClassName(): string;
  137920. /**
  137921. * Creates an effect layer from parsed effect layer data
  137922. * @param parsedEffectLayer defines effect layer data
  137923. * @param scene defines the current scene
  137924. * @param rootUrl defines the root URL containing the effect layer information
  137925. * @returns a parsed effect Layer
  137926. */
  137927. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  137928. }
  137929. }
  137930. declare module BABYLON {
  137931. interface AbstractScene {
  137932. /**
  137933. * The list of effect layers (highlights/glow) added to the scene
  137934. * @see https://doc.babylonjs.com/how_to/highlight_layer
  137935. * @see https://doc.babylonjs.com/how_to/glow_layer
  137936. */
  137937. effectLayers: Array<EffectLayer>;
  137938. /**
  137939. * Removes the given effect layer from this scene.
  137940. * @param toRemove defines the effect layer to remove
  137941. * @returns the index of the removed effect layer
  137942. */
  137943. removeEffectLayer(toRemove: EffectLayer): number;
  137944. /**
  137945. * Adds the given effect layer to this scene
  137946. * @param newEffectLayer defines the effect layer to add
  137947. */
  137948. addEffectLayer(newEffectLayer: EffectLayer): void;
  137949. }
  137950. /**
  137951. * Defines the layer scene component responsible to manage any effect layers
  137952. * in a given scene.
  137953. */
  137954. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  137955. /**
  137956. * The component name helpfull to identify the component in the list of scene components.
  137957. */
  137958. readonly name: string;
  137959. /**
  137960. * The scene the component belongs to.
  137961. */
  137962. scene: Scene;
  137963. private _engine;
  137964. private _renderEffects;
  137965. private _needStencil;
  137966. private _previousStencilState;
  137967. /**
  137968. * Creates a new instance of the component for the given scene
  137969. * @param scene Defines the scene to register the component in
  137970. */
  137971. constructor(scene: Scene);
  137972. /**
  137973. * Registers the component in a given scene
  137974. */
  137975. register(): void;
  137976. /**
  137977. * Rebuilds the elements related to this component in case of
  137978. * context lost for instance.
  137979. */
  137980. rebuild(): void;
  137981. /**
  137982. * Serializes the component data to the specified json object
  137983. * @param serializationObject The object to serialize to
  137984. */
  137985. serialize(serializationObject: any): void;
  137986. /**
  137987. * Adds all the elements from the container to the scene
  137988. * @param container the container holding the elements
  137989. */
  137990. addFromContainer(container: AbstractScene): void;
  137991. /**
  137992. * Removes all the elements in the container from the scene
  137993. * @param container contains the elements to remove
  137994. * @param dispose if the removed element should be disposed (default: false)
  137995. */
  137996. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  137997. /**
  137998. * Disposes the component and the associated ressources.
  137999. */
  138000. dispose(): void;
  138001. private _isReadyForMesh;
  138002. private _renderMainTexture;
  138003. private _setStencil;
  138004. private _setStencilBack;
  138005. private _draw;
  138006. private _drawCamera;
  138007. private _drawRenderingGroup;
  138008. }
  138009. }
  138010. declare module BABYLON {
  138011. /** @hidden */
  138012. export var glowMapMergePixelShader: {
  138013. name: string;
  138014. shader: string;
  138015. };
  138016. }
  138017. declare module BABYLON {
  138018. /** @hidden */
  138019. export var glowMapMergeVertexShader: {
  138020. name: string;
  138021. shader: string;
  138022. };
  138023. }
  138024. declare module BABYLON {
  138025. interface AbstractScene {
  138026. /**
  138027. * Return a the first highlight layer of the scene with a given name.
  138028. * @param name The name of the highlight layer to look for.
  138029. * @return The highlight layer if found otherwise null.
  138030. */
  138031. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  138032. }
  138033. /**
  138034. * Glow layer options. This helps customizing the behaviour
  138035. * of the glow layer.
  138036. */
  138037. export interface IGlowLayerOptions {
  138038. /**
  138039. * Multiplication factor apply to the canvas size to compute the render target size
  138040. * used to generated the glowing objects (the smaller the faster).
  138041. */
  138042. mainTextureRatio: number;
  138043. /**
  138044. * Enforces a fixed size texture to ensure resize independant blur.
  138045. */
  138046. mainTextureFixedSize?: number;
  138047. /**
  138048. * How big is the kernel of the blur texture.
  138049. */
  138050. blurKernelSize: number;
  138051. /**
  138052. * The camera attached to the layer.
  138053. */
  138054. camera: Nullable<Camera>;
  138055. /**
  138056. * Enable MSAA by chosing the number of samples.
  138057. */
  138058. mainTextureSamples?: number;
  138059. /**
  138060. * The rendering group to draw the layer in.
  138061. */
  138062. renderingGroupId: number;
  138063. }
  138064. /**
  138065. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  138066. *
  138067. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  138068. *
  138069. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  138070. */
  138071. export class GlowLayer extends EffectLayer {
  138072. /**
  138073. * Effect Name of the layer.
  138074. */
  138075. static readonly EffectName: string;
  138076. /**
  138077. * The default blur kernel size used for the glow.
  138078. */
  138079. static DefaultBlurKernelSize: number;
  138080. /**
  138081. * The default texture size ratio used for the glow.
  138082. */
  138083. static DefaultTextureRatio: number;
  138084. /**
  138085. * Sets the kernel size of the blur.
  138086. */
  138087. set blurKernelSize(value: number);
  138088. /**
  138089. * Gets the kernel size of the blur.
  138090. */
  138091. get blurKernelSize(): number;
  138092. /**
  138093. * Sets the glow intensity.
  138094. */
  138095. set intensity(value: number);
  138096. /**
  138097. * Gets the glow intensity.
  138098. */
  138099. get intensity(): number;
  138100. private _options;
  138101. private _intensity;
  138102. private _horizontalBlurPostprocess1;
  138103. private _verticalBlurPostprocess1;
  138104. private _horizontalBlurPostprocess2;
  138105. private _verticalBlurPostprocess2;
  138106. private _blurTexture1;
  138107. private _blurTexture2;
  138108. private _postProcesses1;
  138109. private _postProcesses2;
  138110. private _includedOnlyMeshes;
  138111. private _excludedMeshes;
  138112. private _meshesUsingTheirOwnMaterials;
  138113. /**
  138114. * Callback used to let the user override the color selection on a per mesh basis
  138115. */
  138116. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  138117. /**
  138118. * Callback used to let the user override the texture selection on a per mesh basis
  138119. */
  138120. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  138121. /**
  138122. * Instantiates a new glow Layer and references it to the scene.
  138123. * @param name The name of the layer
  138124. * @param scene The scene to use the layer in
  138125. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  138126. */
  138127. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  138128. /**
  138129. * Get the effect name of the layer.
  138130. * @return The effect name
  138131. */
  138132. getEffectName(): string;
  138133. /**
  138134. * Create the merge effect. This is the shader use to blit the information back
  138135. * to the main canvas at the end of the scene rendering.
  138136. */
  138137. protected _createMergeEffect(): Effect;
  138138. /**
  138139. * Creates the render target textures and post processes used in the glow layer.
  138140. */
  138141. protected _createTextureAndPostProcesses(): void;
  138142. /**
  138143. * Checks for the readiness of the element composing the layer.
  138144. * @param subMesh the mesh to check for
  138145. * @param useInstances specify wether or not to use instances to render the mesh
  138146. * @param emissiveTexture the associated emissive texture used to generate the glow
  138147. * @return true if ready otherwise, false
  138148. */
  138149. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  138150. /**
  138151. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  138152. */
  138153. needStencil(): boolean;
  138154. /**
  138155. * Returns true if the mesh can be rendered, otherwise false.
  138156. * @param mesh The mesh to render
  138157. * @param material The material used on the mesh
  138158. * @returns true if it can be rendered otherwise false
  138159. */
  138160. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  138161. /**
  138162. * Implementation specific of rendering the generating effect on the main canvas.
  138163. * @param effect The effect used to render through
  138164. */
  138165. protected _internalRender(effect: Effect): void;
  138166. /**
  138167. * Sets the required values for both the emissive texture and and the main color.
  138168. */
  138169. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  138170. /**
  138171. * Returns true if the mesh should render, otherwise false.
  138172. * @param mesh The mesh to render
  138173. * @returns true if it should render otherwise false
  138174. */
  138175. protected _shouldRenderMesh(mesh: Mesh): boolean;
  138176. /**
  138177. * Adds specific effects defines.
  138178. * @param defines The defines to add specifics to.
  138179. */
  138180. protected _addCustomEffectDefines(defines: string[]): void;
  138181. /**
  138182. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  138183. * @param mesh The mesh to exclude from the glow layer
  138184. */
  138185. addExcludedMesh(mesh: Mesh): void;
  138186. /**
  138187. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  138188. * @param mesh The mesh to remove
  138189. */
  138190. removeExcludedMesh(mesh: Mesh): void;
  138191. /**
  138192. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  138193. * @param mesh The mesh to include in the glow layer
  138194. */
  138195. addIncludedOnlyMesh(mesh: Mesh): void;
  138196. /**
  138197. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  138198. * @param mesh The mesh to remove
  138199. */
  138200. removeIncludedOnlyMesh(mesh: Mesh): void;
  138201. /**
  138202. * Determine if a given mesh will be used in the glow layer
  138203. * @param mesh The mesh to test
  138204. * @returns true if the mesh will be highlighted by the current glow layer
  138205. */
  138206. hasMesh(mesh: AbstractMesh): boolean;
  138207. /**
  138208. * Defines whether the current material of the mesh should be use to render the effect.
  138209. * @param mesh defines the current mesh to render
  138210. */
  138211. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  138212. /**
  138213. * Add a mesh to be rendered through its own material and not with emissive only.
  138214. * @param mesh The mesh for which we need to use its material
  138215. */
  138216. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  138217. /**
  138218. * Remove a mesh from being rendered through its own material and not with emissive only.
  138219. * @param mesh The mesh for which we need to not use its material
  138220. */
  138221. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  138222. /**
  138223. * Free any resources and references associated to a mesh.
  138224. * Internal use
  138225. * @param mesh The mesh to free.
  138226. * @hidden
  138227. */
  138228. _disposeMesh(mesh: Mesh): void;
  138229. /**
  138230. * Gets the class name of the effect layer
  138231. * @returns the string with the class name of the effect layer
  138232. */
  138233. getClassName(): string;
  138234. /**
  138235. * Serializes this glow layer
  138236. * @returns a serialized glow layer object
  138237. */
  138238. serialize(): any;
  138239. /**
  138240. * Creates a Glow Layer from parsed glow layer data
  138241. * @param parsedGlowLayer defines glow layer data
  138242. * @param scene defines the current scene
  138243. * @param rootUrl defines the root URL containing the glow layer information
  138244. * @returns a parsed Glow Layer
  138245. */
  138246. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  138247. }
  138248. }
  138249. declare module BABYLON {
  138250. /** @hidden */
  138251. export var glowBlurPostProcessPixelShader: {
  138252. name: string;
  138253. shader: string;
  138254. };
  138255. }
  138256. declare module BABYLON {
  138257. interface AbstractScene {
  138258. /**
  138259. * Return a the first highlight layer of the scene with a given name.
  138260. * @param name The name of the highlight layer to look for.
  138261. * @return The highlight layer if found otherwise null.
  138262. */
  138263. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  138264. }
  138265. /**
  138266. * Highlight layer options. This helps customizing the behaviour
  138267. * of the highlight layer.
  138268. */
  138269. export interface IHighlightLayerOptions {
  138270. /**
  138271. * Multiplication factor apply to the canvas size to compute the render target size
  138272. * used to generated the glowing objects (the smaller the faster).
  138273. */
  138274. mainTextureRatio: number;
  138275. /**
  138276. * Enforces a fixed size texture to ensure resize independant blur.
  138277. */
  138278. mainTextureFixedSize?: number;
  138279. /**
  138280. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  138281. * of the picture to blur (the smaller the faster).
  138282. */
  138283. blurTextureSizeRatio: number;
  138284. /**
  138285. * How big in texel of the blur texture is the vertical blur.
  138286. */
  138287. blurVerticalSize: number;
  138288. /**
  138289. * How big in texel of the blur texture is the horizontal blur.
  138290. */
  138291. blurHorizontalSize: number;
  138292. /**
  138293. * Alpha blending mode used to apply the blur. Default is combine.
  138294. */
  138295. alphaBlendingMode: number;
  138296. /**
  138297. * The camera attached to the layer.
  138298. */
  138299. camera: Nullable<Camera>;
  138300. /**
  138301. * Should we display highlight as a solid stroke?
  138302. */
  138303. isStroke?: boolean;
  138304. /**
  138305. * The rendering group to draw the layer in.
  138306. */
  138307. renderingGroupId: number;
  138308. }
  138309. /**
  138310. * The highlight layer Helps adding a glow effect around a mesh.
  138311. *
  138312. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  138313. * glowy meshes to your scene.
  138314. *
  138315. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  138316. */
  138317. export class HighlightLayer extends EffectLayer {
  138318. name: string;
  138319. /**
  138320. * Effect Name of the highlight layer.
  138321. */
  138322. static readonly EffectName: string;
  138323. /**
  138324. * The neutral color used during the preparation of the glow effect.
  138325. * This is black by default as the blend operation is a blend operation.
  138326. */
  138327. static NeutralColor: Color4;
  138328. /**
  138329. * Stencil value used for glowing meshes.
  138330. */
  138331. static GlowingMeshStencilReference: number;
  138332. /**
  138333. * Stencil value used for the other meshes in the scene.
  138334. */
  138335. static NormalMeshStencilReference: number;
  138336. /**
  138337. * Specifies whether or not the inner glow is ACTIVE in the layer.
  138338. */
  138339. innerGlow: boolean;
  138340. /**
  138341. * Specifies whether or not the outer glow is ACTIVE in the layer.
  138342. */
  138343. outerGlow: boolean;
  138344. /**
  138345. * Specifies the horizontal size of the blur.
  138346. */
  138347. set blurHorizontalSize(value: number);
  138348. /**
  138349. * Specifies the vertical size of the blur.
  138350. */
  138351. set blurVerticalSize(value: number);
  138352. /**
  138353. * Gets the horizontal size of the blur.
  138354. */
  138355. get blurHorizontalSize(): number;
  138356. /**
  138357. * Gets the vertical size of the blur.
  138358. */
  138359. get blurVerticalSize(): number;
  138360. /**
  138361. * An event triggered when the highlight layer is being blurred.
  138362. */
  138363. onBeforeBlurObservable: Observable<HighlightLayer>;
  138364. /**
  138365. * An event triggered when the highlight layer has been blurred.
  138366. */
  138367. onAfterBlurObservable: Observable<HighlightLayer>;
  138368. private _instanceGlowingMeshStencilReference;
  138369. private _options;
  138370. private _downSamplePostprocess;
  138371. private _horizontalBlurPostprocess;
  138372. private _verticalBlurPostprocess;
  138373. private _blurTexture;
  138374. private _meshes;
  138375. private _excludedMeshes;
  138376. /**
  138377. * Instantiates a new highlight Layer and references it to the scene..
  138378. * @param name The name of the layer
  138379. * @param scene The scene to use the layer in
  138380. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  138381. */
  138382. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  138383. /**
  138384. * Get the effect name of the layer.
  138385. * @return The effect name
  138386. */
  138387. getEffectName(): string;
  138388. /**
  138389. * Create the merge effect. This is the shader use to blit the information back
  138390. * to the main canvas at the end of the scene rendering.
  138391. */
  138392. protected _createMergeEffect(): Effect;
  138393. /**
  138394. * Creates the render target textures and post processes used in the highlight layer.
  138395. */
  138396. protected _createTextureAndPostProcesses(): void;
  138397. /**
  138398. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  138399. */
  138400. needStencil(): boolean;
  138401. /**
  138402. * Checks for the readiness of the element composing the layer.
  138403. * @param subMesh the mesh to check for
  138404. * @param useInstances specify wether or not to use instances to render the mesh
  138405. * @param emissiveTexture the associated emissive texture used to generate the glow
  138406. * @return true if ready otherwise, false
  138407. */
  138408. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  138409. /**
  138410. * Implementation specific of rendering the generating effect on the main canvas.
  138411. * @param effect The effect used to render through
  138412. */
  138413. protected _internalRender(effect: Effect): void;
  138414. /**
  138415. * Returns true if the layer contains information to display, otherwise false.
  138416. */
  138417. shouldRender(): boolean;
  138418. /**
  138419. * Returns true if the mesh should render, otherwise false.
  138420. * @param mesh The mesh to render
  138421. * @returns true if it should render otherwise false
  138422. */
  138423. protected _shouldRenderMesh(mesh: Mesh): boolean;
  138424. /**
  138425. * Returns true if the mesh can be rendered, otherwise false.
  138426. * @param mesh The mesh to render
  138427. * @param material The material used on the mesh
  138428. * @returns true if it can be rendered otherwise false
  138429. */
  138430. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  138431. /**
  138432. * Adds specific effects defines.
  138433. * @param defines The defines to add specifics to.
  138434. */
  138435. protected _addCustomEffectDefines(defines: string[]): void;
  138436. /**
  138437. * Sets the required values for both the emissive texture and and the main color.
  138438. */
  138439. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  138440. /**
  138441. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  138442. * @param mesh The mesh to exclude from the highlight layer
  138443. */
  138444. addExcludedMesh(mesh: Mesh): void;
  138445. /**
  138446. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  138447. * @param mesh The mesh to highlight
  138448. */
  138449. removeExcludedMesh(mesh: Mesh): void;
  138450. /**
  138451. * Determine if a given mesh will be highlighted by the current HighlightLayer
  138452. * @param mesh mesh to test
  138453. * @returns true if the mesh will be highlighted by the current HighlightLayer
  138454. */
  138455. hasMesh(mesh: AbstractMesh): boolean;
  138456. /**
  138457. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  138458. * @param mesh The mesh to highlight
  138459. * @param color The color of the highlight
  138460. * @param glowEmissiveOnly Extract the glow from the emissive texture
  138461. */
  138462. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  138463. /**
  138464. * Remove a mesh from the highlight layer in order to make it stop glowing.
  138465. * @param mesh The mesh to highlight
  138466. */
  138467. removeMesh(mesh: Mesh): void;
  138468. /**
  138469. * Remove all the meshes currently referenced in the highlight layer
  138470. */
  138471. removeAllMeshes(): void;
  138472. /**
  138473. * Force the stencil to the normal expected value for none glowing parts
  138474. */
  138475. private _defaultStencilReference;
  138476. /**
  138477. * Free any resources and references associated to a mesh.
  138478. * Internal use
  138479. * @param mesh The mesh to free.
  138480. * @hidden
  138481. */
  138482. _disposeMesh(mesh: Mesh): void;
  138483. /**
  138484. * Dispose the highlight layer and free resources.
  138485. */
  138486. dispose(): void;
  138487. /**
  138488. * Gets the class name of the effect layer
  138489. * @returns the string with the class name of the effect layer
  138490. */
  138491. getClassName(): string;
  138492. /**
  138493. * Serializes this Highlight layer
  138494. * @returns a serialized Highlight layer object
  138495. */
  138496. serialize(): any;
  138497. /**
  138498. * Creates a Highlight layer from parsed Highlight layer data
  138499. * @param parsedHightlightLayer defines the Highlight layer data
  138500. * @param scene defines the current scene
  138501. * @param rootUrl defines the root URL containing the Highlight layer information
  138502. * @returns a parsed Highlight layer
  138503. */
  138504. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  138505. }
  138506. }
  138507. declare module BABYLON {
  138508. interface AbstractScene {
  138509. /**
  138510. * The list of layers (background and foreground) of the scene
  138511. */
  138512. layers: Array<Layer>;
  138513. }
  138514. /**
  138515. * Defines the layer scene component responsible to manage any layers
  138516. * in a given scene.
  138517. */
  138518. export class LayerSceneComponent implements ISceneComponent {
  138519. /**
  138520. * The component name helpfull to identify the component in the list of scene components.
  138521. */
  138522. readonly name: string;
  138523. /**
  138524. * The scene the component belongs to.
  138525. */
  138526. scene: Scene;
  138527. private _engine;
  138528. /**
  138529. * Creates a new instance of the component for the given scene
  138530. * @param scene Defines the scene to register the component in
  138531. */
  138532. constructor(scene: Scene);
  138533. /**
  138534. * Registers the component in a given scene
  138535. */
  138536. register(): void;
  138537. /**
  138538. * Rebuilds the elements related to this component in case of
  138539. * context lost for instance.
  138540. */
  138541. rebuild(): void;
  138542. /**
  138543. * Disposes the component and the associated ressources.
  138544. */
  138545. dispose(): void;
  138546. private _draw;
  138547. private _drawCameraPredicate;
  138548. private _drawCameraBackground;
  138549. private _drawCameraForeground;
  138550. private _drawRenderTargetPredicate;
  138551. private _drawRenderTargetBackground;
  138552. private _drawRenderTargetForeground;
  138553. /**
  138554. * Adds all the elements from the container to the scene
  138555. * @param container the container holding the elements
  138556. */
  138557. addFromContainer(container: AbstractScene): void;
  138558. /**
  138559. * Removes all the elements in the container from the scene
  138560. * @param container contains the elements to remove
  138561. * @param dispose if the removed element should be disposed (default: false)
  138562. */
  138563. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  138564. }
  138565. }
  138566. declare module BABYLON {
  138567. /** @hidden */
  138568. export var layerPixelShader: {
  138569. name: string;
  138570. shader: string;
  138571. };
  138572. }
  138573. declare module BABYLON {
  138574. /** @hidden */
  138575. export var layerVertexShader: {
  138576. name: string;
  138577. shader: string;
  138578. };
  138579. }
  138580. declare module BABYLON {
  138581. /**
  138582. * This represents a full screen 2d layer.
  138583. * This can be useful to display a picture in the background of your scene for instance.
  138584. * @see https://www.babylonjs-playground.com/#08A2BS#1
  138585. */
  138586. export class Layer {
  138587. /**
  138588. * Define the name of the layer.
  138589. */
  138590. name: string;
  138591. /**
  138592. * Define the texture the layer should display.
  138593. */
  138594. texture: Nullable<Texture>;
  138595. /**
  138596. * Is the layer in background or foreground.
  138597. */
  138598. isBackground: boolean;
  138599. /**
  138600. * Define the color of the layer (instead of texture).
  138601. */
  138602. color: Color4;
  138603. /**
  138604. * Define the scale of the layer in order to zoom in out of the texture.
  138605. */
  138606. scale: Vector2;
  138607. /**
  138608. * Define an offset for the layer in order to shift the texture.
  138609. */
  138610. offset: Vector2;
  138611. /**
  138612. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  138613. */
  138614. alphaBlendingMode: number;
  138615. /**
  138616. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  138617. * Alpha test will not mix with the background color in case of transparency.
  138618. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  138619. */
  138620. alphaTest: boolean;
  138621. /**
  138622. * Define a mask to restrict the layer to only some of the scene cameras.
  138623. */
  138624. layerMask: number;
  138625. /**
  138626. * Define the list of render target the layer is visible into.
  138627. */
  138628. renderTargetTextures: RenderTargetTexture[];
  138629. /**
  138630. * Define if the layer is only used in renderTarget or if it also
  138631. * renders in the main frame buffer of the canvas.
  138632. */
  138633. renderOnlyInRenderTargetTextures: boolean;
  138634. private _scene;
  138635. private _vertexBuffers;
  138636. private _indexBuffer;
  138637. private _effect;
  138638. private _previousDefines;
  138639. /**
  138640. * An event triggered when the layer is disposed.
  138641. */
  138642. onDisposeObservable: Observable<Layer>;
  138643. private _onDisposeObserver;
  138644. /**
  138645. * Back compatibility with callback before the onDisposeObservable existed.
  138646. * The set callback will be triggered when the layer has been disposed.
  138647. */
  138648. set onDispose(callback: () => void);
  138649. /**
  138650. * An event triggered before rendering the scene
  138651. */
  138652. onBeforeRenderObservable: Observable<Layer>;
  138653. private _onBeforeRenderObserver;
  138654. /**
  138655. * Back compatibility with callback before the onBeforeRenderObservable existed.
  138656. * The set callback will be triggered just before rendering the layer.
  138657. */
  138658. set onBeforeRender(callback: () => void);
  138659. /**
  138660. * An event triggered after rendering the scene
  138661. */
  138662. onAfterRenderObservable: Observable<Layer>;
  138663. private _onAfterRenderObserver;
  138664. /**
  138665. * Back compatibility with callback before the onAfterRenderObservable existed.
  138666. * The set callback will be triggered just after rendering the layer.
  138667. */
  138668. set onAfterRender(callback: () => void);
  138669. /**
  138670. * Instantiates a new layer.
  138671. * This represents a full screen 2d layer.
  138672. * This can be useful to display a picture in the background of your scene for instance.
  138673. * @see https://www.babylonjs-playground.com/#08A2BS#1
  138674. * @param name Define the name of the layer in the scene
  138675. * @param imgUrl Define the url of the texture to display in the layer
  138676. * @param scene Define the scene the layer belongs to
  138677. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  138678. * @param color Defines a color for the layer
  138679. */
  138680. constructor(
  138681. /**
  138682. * Define the name of the layer.
  138683. */
  138684. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  138685. private _createIndexBuffer;
  138686. /** @hidden */
  138687. _rebuild(): void;
  138688. /**
  138689. * Renders the layer in the scene.
  138690. */
  138691. render(): void;
  138692. /**
  138693. * Disposes and releases the associated ressources.
  138694. */
  138695. dispose(): void;
  138696. }
  138697. }
  138698. declare module BABYLON {
  138699. /** @hidden */
  138700. export var lensFlarePixelShader: {
  138701. name: string;
  138702. shader: string;
  138703. };
  138704. }
  138705. declare module BABYLON {
  138706. /** @hidden */
  138707. export var lensFlareVertexShader: {
  138708. name: string;
  138709. shader: string;
  138710. };
  138711. }
  138712. declare module BABYLON {
  138713. /**
  138714. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  138715. * It is usually composed of several `lensFlare`.
  138716. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138717. */
  138718. export class LensFlareSystem {
  138719. /**
  138720. * Define the name of the lens flare system
  138721. */
  138722. name: string;
  138723. /**
  138724. * List of lens flares used in this system.
  138725. */
  138726. lensFlares: LensFlare[];
  138727. /**
  138728. * Define a limit from the border the lens flare can be visible.
  138729. */
  138730. borderLimit: number;
  138731. /**
  138732. * Define a viewport border we do not want to see the lens flare in.
  138733. */
  138734. viewportBorder: number;
  138735. /**
  138736. * Define a predicate which could limit the list of meshes able to occlude the effect.
  138737. */
  138738. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  138739. /**
  138740. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  138741. */
  138742. layerMask: number;
  138743. /**
  138744. * Define the id of the lens flare system in the scene.
  138745. * (equal to name by default)
  138746. */
  138747. id: string;
  138748. private _scene;
  138749. private _emitter;
  138750. private _vertexBuffers;
  138751. private _indexBuffer;
  138752. private _effect;
  138753. private _positionX;
  138754. private _positionY;
  138755. private _isEnabled;
  138756. /** @hidden */
  138757. static _SceneComponentInitialization: (scene: Scene) => void;
  138758. /**
  138759. * Instantiates a lens flare system.
  138760. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  138761. * It is usually composed of several `lensFlare`.
  138762. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138763. * @param name Define the name of the lens flare system in the scene
  138764. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  138765. * @param scene Define the scene the lens flare system belongs to
  138766. */
  138767. constructor(
  138768. /**
  138769. * Define the name of the lens flare system
  138770. */
  138771. name: string, emitter: any, scene: Scene);
  138772. /**
  138773. * Define if the lens flare system is enabled.
  138774. */
  138775. get isEnabled(): boolean;
  138776. set isEnabled(value: boolean);
  138777. /**
  138778. * Get the scene the effects belongs to.
  138779. * @returns the scene holding the lens flare system
  138780. */
  138781. getScene(): Scene;
  138782. /**
  138783. * Get the emitter of the lens flare system.
  138784. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  138785. * @returns the emitter of the lens flare system
  138786. */
  138787. getEmitter(): any;
  138788. /**
  138789. * Set the emitter of the lens flare system.
  138790. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  138791. * @param newEmitter Define the new emitter of the system
  138792. */
  138793. setEmitter(newEmitter: any): void;
  138794. /**
  138795. * Get the lens flare system emitter position.
  138796. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  138797. * @returns the position
  138798. */
  138799. getEmitterPosition(): Vector3;
  138800. /**
  138801. * @hidden
  138802. */
  138803. computeEffectivePosition(globalViewport: Viewport): boolean;
  138804. /** @hidden */
  138805. _isVisible(): boolean;
  138806. /**
  138807. * @hidden
  138808. */
  138809. render(): boolean;
  138810. /**
  138811. * Dispose and release the lens flare with its associated resources.
  138812. */
  138813. dispose(): void;
  138814. /**
  138815. * Parse a lens flare system from a JSON repressentation
  138816. * @param parsedLensFlareSystem Define the JSON to parse
  138817. * @param scene Define the scene the parsed system should be instantiated in
  138818. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  138819. * @returns the parsed system
  138820. */
  138821. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  138822. /**
  138823. * Serialize the current Lens Flare System into a JSON representation.
  138824. * @returns the serialized JSON
  138825. */
  138826. serialize(): any;
  138827. }
  138828. }
  138829. declare module BABYLON {
  138830. /**
  138831. * This represents one of the lens effect in a `lensFlareSystem`.
  138832. * It controls one of the indiviual texture used in the effect.
  138833. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138834. */
  138835. export class LensFlare {
  138836. /**
  138837. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  138838. */
  138839. size: number;
  138840. /**
  138841. * 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.
  138842. */
  138843. position: number;
  138844. /**
  138845. * Define the lens color.
  138846. */
  138847. color: Color3;
  138848. /**
  138849. * Define the lens texture.
  138850. */
  138851. texture: Nullable<Texture>;
  138852. /**
  138853. * Define the alpha mode to render this particular lens.
  138854. */
  138855. alphaMode: number;
  138856. private _system;
  138857. /**
  138858. * Creates a new Lens Flare.
  138859. * This represents one of the lens effect in a `lensFlareSystem`.
  138860. * It controls one of the indiviual texture used in the effect.
  138861. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138862. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  138863. * @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.
  138864. * @param color Define the lens color
  138865. * @param imgUrl Define the lens texture url
  138866. * @param system Define the `lensFlareSystem` this flare is part of
  138867. * @returns The newly created Lens Flare
  138868. */
  138869. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  138870. /**
  138871. * Instantiates a new Lens Flare.
  138872. * This represents one of the lens effect in a `lensFlareSystem`.
  138873. * It controls one of the indiviual texture used in the effect.
  138874. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138875. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  138876. * @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.
  138877. * @param color Define the lens color
  138878. * @param imgUrl Define the lens texture url
  138879. * @param system Define the `lensFlareSystem` this flare is part of
  138880. */
  138881. constructor(
  138882. /**
  138883. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  138884. */
  138885. size: number,
  138886. /**
  138887. * 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.
  138888. */
  138889. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  138890. /**
  138891. * Dispose and release the lens flare with its associated resources.
  138892. */
  138893. dispose(): void;
  138894. }
  138895. }
  138896. declare module BABYLON {
  138897. interface AbstractScene {
  138898. /**
  138899. * The list of lens flare system added to the scene
  138900. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138901. */
  138902. lensFlareSystems: Array<LensFlareSystem>;
  138903. /**
  138904. * Removes the given lens flare system from this scene.
  138905. * @param toRemove The lens flare system to remove
  138906. * @returns The index of the removed lens flare system
  138907. */
  138908. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  138909. /**
  138910. * Adds the given lens flare system to this scene
  138911. * @param newLensFlareSystem The lens flare system to add
  138912. */
  138913. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  138914. /**
  138915. * Gets a lens flare system using its name
  138916. * @param name defines the name to look for
  138917. * @returns the lens flare system or null if not found
  138918. */
  138919. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  138920. /**
  138921. * Gets a lens flare system using its id
  138922. * @param id defines the id to look for
  138923. * @returns the lens flare system or null if not found
  138924. */
  138925. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  138926. }
  138927. /**
  138928. * Defines the lens flare scene component responsible to manage any lens flares
  138929. * in a given scene.
  138930. */
  138931. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  138932. /**
  138933. * The component name helpfull to identify the component in the list of scene components.
  138934. */
  138935. readonly name: string;
  138936. /**
  138937. * The scene the component belongs to.
  138938. */
  138939. scene: Scene;
  138940. /**
  138941. * Creates a new instance of the component for the given scene
  138942. * @param scene Defines the scene to register the component in
  138943. */
  138944. constructor(scene: Scene);
  138945. /**
  138946. * Registers the component in a given scene
  138947. */
  138948. register(): void;
  138949. /**
  138950. * Rebuilds the elements related to this component in case of
  138951. * context lost for instance.
  138952. */
  138953. rebuild(): void;
  138954. /**
  138955. * Adds all the elements from the container to the scene
  138956. * @param container the container holding the elements
  138957. */
  138958. addFromContainer(container: AbstractScene): void;
  138959. /**
  138960. * Removes all the elements in the container from the scene
  138961. * @param container contains the elements to remove
  138962. * @param dispose if the removed element should be disposed (default: false)
  138963. */
  138964. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  138965. /**
  138966. * Serializes the component data to the specified json object
  138967. * @param serializationObject The object to serialize to
  138968. */
  138969. serialize(serializationObject: any): void;
  138970. /**
  138971. * Disposes the component and the associated ressources.
  138972. */
  138973. dispose(): void;
  138974. private _draw;
  138975. }
  138976. }
  138977. declare module BABYLON {
  138978. /** @hidden */
  138979. export var depthPixelShader: {
  138980. name: string;
  138981. shader: string;
  138982. };
  138983. }
  138984. declare module BABYLON {
  138985. /** @hidden */
  138986. export var depthVertexShader: {
  138987. name: string;
  138988. shader: string;
  138989. };
  138990. }
  138991. declare module BABYLON {
  138992. /**
  138993. * This represents a depth renderer in Babylon.
  138994. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  138995. */
  138996. export class DepthRenderer {
  138997. private _scene;
  138998. private _depthMap;
  138999. private _effect;
  139000. private readonly _storeNonLinearDepth;
  139001. private readonly _clearColor;
  139002. /** Get if the depth renderer is using packed depth or not */
  139003. readonly isPacked: boolean;
  139004. private _cachedDefines;
  139005. private _camera;
  139006. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  139007. enabled: boolean;
  139008. /**
  139009. * Specifiess that the depth renderer will only be used within
  139010. * the camera it is created for.
  139011. * This can help forcing its rendering during the camera processing.
  139012. */
  139013. useOnlyInActiveCamera: boolean;
  139014. /** @hidden */
  139015. static _SceneComponentInitialization: (scene: Scene) => void;
  139016. /**
  139017. * Instantiates a depth renderer
  139018. * @param scene The scene the renderer belongs to
  139019. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  139020. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  139021. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  139022. */
  139023. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  139024. /**
  139025. * Creates the depth rendering effect and checks if the effect is ready.
  139026. * @param subMesh The submesh to be used to render the depth map of
  139027. * @param useInstances If multiple world instances should be used
  139028. * @returns if the depth renderer is ready to render the depth map
  139029. */
  139030. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  139031. /**
  139032. * Gets the texture which the depth map will be written to.
  139033. * @returns The depth map texture
  139034. */
  139035. getDepthMap(): RenderTargetTexture;
  139036. /**
  139037. * Disposes of the depth renderer.
  139038. */
  139039. dispose(): void;
  139040. }
  139041. }
  139042. declare module BABYLON {
  139043. /** @hidden */
  139044. export var minmaxReduxPixelShader: {
  139045. name: string;
  139046. shader: string;
  139047. };
  139048. }
  139049. declare module BABYLON {
  139050. /**
  139051. * This class computes a min/max reduction from a texture: it means it computes the minimum
  139052. * and maximum values from all values of the texture.
  139053. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  139054. * The source values are read from the red channel of the texture.
  139055. */
  139056. export class MinMaxReducer {
  139057. /**
  139058. * Observable triggered when the computation has been performed
  139059. */
  139060. onAfterReductionPerformed: Observable<{
  139061. min: number;
  139062. max: number;
  139063. }>;
  139064. protected _camera: Camera;
  139065. protected _sourceTexture: Nullable<RenderTargetTexture>;
  139066. protected _reductionSteps: Nullable<Array<PostProcess>>;
  139067. protected _postProcessManager: PostProcessManager;
  139068. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  139069. protected _forceFullscreenViewport: boolean;
  139070. /**
  139071. * Creates a min/max reducer
  139072. * @param camera The camera to use for the post processes
  139073. */
  139074. constructor(camera: Camera);
  139075. /**
  139076. * Gets the texture used to read the values from.
  139077. */
  139078. get sourceTexture(): Nullable<RenderTargetTexture>;
  139079. /**
  139080. * Sets the source texture to read the values from.
  139081. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  139082. * because in such textures '1' value must not be taken into account to compute the maximum
  139083. * as this value is used to clear the texture.
  139084. * Note that the computation is not activated by calling this function, you must call activate() for that!
  139085. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  139086. * @param depthRedux Indicates if the texture is a depth texture or not
  139087. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  139088. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  139089. */
  139090. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  139091. /**
  139092. * Defines the refresh rate of the computation.
  139093. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  139094. */
  139095. get refreshRate(): number;
  139096. set refreshRate(value: number);
  139097. protected _activated: boolean;
  139098. /**
  139099. * Gets the activation status of the reducer
  139100. */
  139101. get activated(): boolean;
  139102. /**
  139103. * Activates the reduction computation.
  139104. * When activated, the observers registered in onAfterReductionPerformed are
  139105. * called after the compuation is performed
  139106. */
  139107. activate(): void;
  139108. /**
  139109. * Deactivates the reduction computation.
  139110. */
  139111. deactivate(): void;
  139112. /**
  139113. * Disposes the min/max reducer
  139114. * @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.
  139115. */
  139116. dispose(disposeAll?: boolean): void;
  139117. }
  139118. }
  139119. declare module BABYLON {
  139120. /**
  139121. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  139122. */
  139123. export class DepthReducer extends MinMaxReducer {
  139124. private _depthRenderer;
  139125. private _depthRendererId;
  139126. /**
  139127. * Gets the depth renderer used for the computation.
  139128. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  139129. */
  139130. get depthRenderer(): Nullable<DepthRenderer>;
  139131. /**
  139132. * Creates a depth reducer
  139133. * @param camera The camera used to render the depth texture
  139134. */
  139135. constructor(camera: Camera);
  139136. /**
  139137. * Sets the depth renderer to use to generate the depth map
  139138. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  139139. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  139140. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  139141. */
  139142. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  139143. /** @hidden */
  139144. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  139145. /**
  139146. * Activates the reduction computation.
  139147. * When activated, the observers registered in onAfterReductionPerformed are
  139148. * called after the compuation is performed
  139149. */
  139150. activate(): void;
  139151. /**
  139152. * Deactivates the reduction computation.
  139153. */
  139154. deactivate(): void;
  139155. /**
  139156. * Disposes the depth reducer
  139157. * @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.
  139158. */
  139159. dispose(disposeAll?: boolean): void;
  139160. }
  139161. }
  139162. declare module BABYLON {
  139163. /**
  139164. * A CSM implementation allowing casting shadows on large scenes.
  139165. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  139166. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  139167. */
  139168. export class CascadedShadowGenerator extends ShadowGenerator {
  139169. private static readonly frustumCornersNDCSpace;
  139170. /**
  139171. * Name of the CSM class
  139172. */
  139173. static CLASSNAME: string;
  139174. /**
  139175. * Defines the default number of cascades used by the CSM.
  139176. */
  139177. static readonly DEFAULT_CASCADES_COUNT: number;
  139178. /**
  139179. * Defines the minimum number of cascades used by the CSM.
  139180. */
  139181. static readonly MIN_CASCADES_COUNT: number;
  139182. /**
  139183. * Defines the maximum number of cascades used by the CSM.
  139184. */
  139185. static readonly MAX_CASCADES_COUNT: number;
  139186. protected _validateFilter(filter: number): number;
  139187. /**
  139188. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  139189. */
  139190. penumbraDarkness: number;
  139191. private _numCascades;
  139192. /**
  139193. * Gets or set the number of cascades used by the CSM.
  139194. */
  139195. get numCascades(): number;
  139196. set numCascades(value: number);
  139197. /**
  139198. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  139199. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  139200. */
  139201. stabilizeCascades: boolean;
  139202. private _freezeShadowCastersBoundingInfo;
  139203. private _freezeShadowCastersBoundingInfoObservable;
  139204. /**
  139205. * Enables or disables the shadow casters bounding info computation.
  139206. * If your shadow casters don't move, you can disable this feature.
  139207. * If it is enabled, the bounding box computation is done every frame.
  139208. */
  139209. get freezeShadowCastersBoundingInfo(): boolean;
  139210. set freezeShadowCastersBoundingInfo(freeze: boolean);
  139211. private _scbiMin;
  139212. private _scbiMax;
  139213. protected _computeShadowCastersBoundingInfo(): void;
  139214. protected _shadowCastersBoundingInfo: BoundingInfo;
  139215. /**
  139216. * Gets or sets the shadow casters bounding info.
  139217. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  139218. * so that the system won't overwrite the bounds you provide
  139219. */
  139220. get shadowCastersBoundingInfo(): BoundingInfo;
  139221. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  139222. protected _breaksAreDirty: boolean;
  139223. protected _minDistance: number;
  139224. protected _maxDistance: number;
  139225. /**
  139226. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  139227. *
  139228. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  139229. * If you don't know these values, simply leave them to their defaults and don't call this function.
  139230. * @param min minimal distance for the breaks (default to 0.)
  139231. * @param max maximal distance for the breaks (default to 1.)
  139232. */
  139233. setMinMaxDistance(min: number, max: number): void;
  139234. /** Gets the minimal distance used in the cascade break computation */
  139235. get minDistance(): number;
  139236. /** Gets the maximal distance used in the cascade break computation */
  139237. get maxDistance(): number;
  139238. /**
  139239. * Gets the class name of that object
  139240. * @returns "CascadedShadowGenerator"
  139241. */
  139242. getClassName(): string;
  139243. private _cascadeMinExtents;
  139244. private _cascadeMaxExtents;
  139245. /**
  139246. * Gets a cascade minimum extents
  139247. * @param cascadeIndex index of the cascade
  139248. * @returns the minimum cascade extents
  139249. */
  139250. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  139251. /**
  139252. * Gets a cascade maximum extents
  139253. * @param cascadeIndex index of the cascade
  139254. * @returns the maximum cascade extents
  139255. */
  139256. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  139257. private _cascades;
  139258. private _currentLayer;
  139259. private _viewSpaceFrustumsZ;
  139260. private _viewMatrices;
  139261. private _projectionMatrices;
  139262. private _transformMatrices;
  139263. private _transformMatricesAsArray;
  139264. private _frustumLengths;
  139265. private _lightSizeUVCorrection;
  139266. private _depthCorrection;
  139267. private _frustumCornersWorldSpace;
  139268. private _frustumCenter;
  139269. private _shadowCameraPos;
  139270. private _shadowMaxZ;
  139271. /**
  139272. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  139273. * It defaults to camera.maxZ
  139274. */
  139275. get shadowMaxZ(): number;
  139276. /**
  139277. * Sets the shadow max z distance.
  139278. */
  139279. set shadowMaxZ(value: number);
  139280. protected _debug: boolean;
  139281. /**
  139282. * Gets or sets the debug flag.
  139283. * When enabled, the cascades are materialized by different colors on the screen.
  139284. */
  139285. get debug(): boolean;
  139286. set debug(dbg: boolean);
  139287. private _depthClamp;
  139288. /**
  139289. * Gets or sets the depth clamping value.
  139290. *
  139291. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  139292. * to account for the shadow casters far away.
  139293. *
  139294. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  139295. */
  139296. get depthClamp(): boolean;
  139297. set depthClamp(value: boolean);
  139298. private _cascadeBlendPercentage;
  139299. /**
  139300. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  139301. * It defaults to 0.1 (10% blending).
  139302. */
  139303. get cascadeBlendPercentage(): number;
  139304. set cascadeBlendPercentage(value: number);
  139305. private _lambda;
  139306. /**
  139307. * Gets or set the lambda parameter.
  139308. * This parameter is used to split the camera frustum and create the cascades.
  139309. * 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.
  139310. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  139311. */
  139312. get lambda(): number;
  139313. set lambda(value: number);
  139314. /**
  139315. * Gets the view matrix corresponding to a given cascade
  139316. * @param cascadeNum cascade to retrieve the view matrix from
  139317. * @returns the cascade view matrix
  139318. */
  139319. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  139320. /**
  139321. * Gets the projection matrix corresponding to a given cascade
  139322. * @param cascadeNum cascade to retrieve the projection matrix from
  139323. * @returns the cascade projection matrix
  139324. */
  139325. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  139326. /**
  139327. * Gets the transformation matrix corresponding to a given cascade
  139328. * @param cascadeNum cascade to retrieve the transformation matrix from
  139329. * @returns the cascade transformation matrix
  139330. */
  139331. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  139332. private _depthRenderer;
  139333. /**
  139334. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  139335. *
  139336. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  139337. *
  139338. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  139339. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  139340. * @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
  139341. */
  139342. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  139343. private _depthReducer;
  139344. private _autoCalcDepthBounds;
  139345. /**
  139346. * Gets or sets the autoCalcDepthBounds property.
  139347. *
  139348. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  139349. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  139350. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  139351. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  139352. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  139353. */
  139354. get autoCalcDepthBounds(): boolean;
  139355. set autoCalcDepthBounds(value: boolean);
  139356. /**
  139357. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  139358. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  139359. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  139360. * for setting the refresh rate on the renderer yourself!
  139361. */
  139362. get autoCalcDepthBoundsRefreshRate(): number;
  139363. set autoCalcDepthBoundsRefreshRate(value: number);
  139364. /**
  139365. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  139366. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  139367. * you change the camera near/far planes!
  139368. */
  139369. splitFrustum(): void;
  139370. private _splitFrustum;
  139371. private _computeMatrices;
  139372. private _computeFrustumInWorldSpace;
  139373. private _computeCascadeFrustum;
  139374. /**
  139375. * Support test.
  139376. */
  139377. static get IsSupported(): boolean;
  139378. /** @hidden */
  139379. static _SceneComponentInitialization: (scene: Scene) => void;
  139380. /**
  139381. * Creates a Cascaded Shadow Generator object.
  139382. * A ShadowGenerator is the required tool to use the shadows.
  139383. * Each directional light casting shadows needs to use its own ShadowGenerator.
  139384. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  139385. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  139386. * @param light The directional light object generating the shadows.
  139387. * @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.
  139388. */
  139389. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  139390. protected _initializeGenerator(): void;
  139391. protected _createTargetRenderTexture(): void;
  139392. protected _initializeShadowMap(): void;
  139393. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  139394. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  139395. /**
  139396. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  139397. * @param defines Defines of the material we want to update
  139398. * @param lightIndex Index of the light in the enabled light list of the material
  139399. */
  139400. prepareDefines(defines: any, lightIndex: number): void;
  139401. /**
  139402. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  139403. * defined in the generator but impacting the effect).
  139404. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  139405. * @param effect The effect we are binfing the information for
  139406. */
  139407. bindShadowLight(lightIndex: string, effect: Effect): void;
  139408. /**
  139409. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  139410. * (eq to view projection * shadow projection matrices)
  139411. * @returns The transform matrix used to create the shadow map
  139412. */
  139413. getTransformMatrix(): Matrix;
  139414. /**
  139415. * Disposes the ShadowGenerator.
  139416. * Returns nothing.
  139417. */
  139418. dispose(): void;
  139419. /**
  139420. * Serializes the shadow generator setup to a json object.
  139421. * @returns The serialized JSON object
  139422. */
  139423. serialize(): any;
  139424. /**
  139425. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  139426. * @param parsedShadowGenerator The JSON object to parse
  139427. * @param scene The scene to create the shadow map for
  139428. * @returns The parsed shadow generator
  139429. */
  139430. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  139431. }
  139432. }
  139433. declare module BABYLON {
  139434. /**
  139435. * Defines the shadow generator component responsible to manage any shadow generators
  139436. * in a given scene.
  139437. */
  139438. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  139439. /**
  139440. * The component name helpfull to identify the component in the list of scene components.
  139441. */
  139442. readonly name: string;
  139443. /**
  139444. * The scene the component belongs to.
  139445. */
  139446. scene: Scene;
  139447. /**
  139448. * Creates a new instance of the component for the given scene
  139449. * @param scene Defines the scene to register the component in
  139450. */
  139451. constructor(scene: Scene);
  139452. /**
  139453. * Registers the component in a given scene
  139454. */
  139455. register(): void;
  139456. /**
  139457. * Rebuilds the elements related to this component in case of
  139458. * context lost for instance.
  139459. */
  139460. rebuild(): void;
  139461. /**
  139462. * Serializes the component data to the specified json object
  139463. * @param serializationObject The object to serialize to
  139464. */
  139465. serialize(serializationObject: any): void;
  139466. /**
  139467. * Adds all the elements from the container to the scene
  139468. * @param container the container holding the elements
  139469. */
  139470. addFromContainer(container: AbstractScene): void;
  139471. /**
  139472. * Removes all the elements in the container from the scene
  139473. * @param container contains the elements to remove
  139474. * @param dispose if the removed element should be disposed (default: false)
  139475. */
  139476. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  139477. /**
  139478. * Rebuilds the elements related to this component in case of
  139479. * context lost for instance.
  139480. */
  139481. dispose(): void;
  139482. private _gatherRenderTargets;
  139483. }
  139484. }
  139485. declare module BABYLON {
  139486. /**
  139487. * A point light is a light defined by an unique point in world space.
  139488. * The light is emitted in every direction from this point.
  139489. * A good example of a point light is a standard light bulb.
  139490. * Documentation: https://doc.babylonjs.com/babylon101/lights
  139491. */
  139492. export class PointLight extends ShadowLight {
  139493. private _shadowAngle;
  139494. /**
  139495. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139496. * This specifies what angle the shadow will use to be created.
  139497. *
  139498. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  139499. */
  139500. get shadowAngle(): number;
  139501. /**
  139502. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139503. * This specifies what angle the shadow will use to be created.
  139504. *
  139505. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  139506. */
  139507. set shadowAngle(value: number);
  139508. /**
  139509. * Gets the direction if it has been set.
  139510. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139511. */
  139512. get direction(): Vector3;
  139513. /**
  139514. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139515. */
  139516. set direction(value: Vector3);
  139517. /**
  139518. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  139519. * A PointLight emits the light in every direction.
  139520. * It can cast shadows.
  139521. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  139522. * ```javascript
  139523. * var pointLight = new PointLight("pl", camera.position, scene);
  139524. * ```
  139525. * Documentation : https://doc.babylonjs.com/babylon101/lights
  139526. * @param name The light friendly name
  139527. * @param position The position of the point light in the scene
  139528. * @param scene The scene the lights belongs to
  139529. */
  139530. constructor(name: string, position: Vector3, scene: Scene);
  139531. /**
  139532. * Returns the string "PointLight"
  139533. * @returns the class name
  139534. */
  139535. getClassName(): string;
  139536. /**
  139537. * Returns the integer 0.
  139538. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  139539. */
  139540. getTypeID(): number;
  139541. /**
  139542. * Specifies wether or not the shadowmap should be a cube texture.
  139543. * @returns true if the shadowmap needs to be a cube texture.
  139544. */
  139545. needCube(): boolean;
  139546. /**
  139547. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  139548. * @param faceIndex The index of the face we are computed the direction to generate shadow
  139549. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  139550. */
  139551. getShadowDirection(faceIndex?: number): Vector3;
  139552. /**
  139553. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  139554. * - fov = PI / 2
  139555. * - aspect ratio : 1.0
  139556. * - z-near and far equal to the active camera minZ and maxZ.
  139557. * Returns the PointLight.
  139558. */
  139559. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  139560. protected _buildUniformLayout(): void;
  139561. /**
  139562. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  139563. * @param effect The effect to update
  139564. * @param lightIndex The index of the light in the effect to update
  139565. * @returns The point light
  139566. */
  139567. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  139568. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  139569. /**
  139570. * Prepares the list of defines specific to the light type.
  139571. * @param defines the list of defines
  139572. * @param lightIndex defines the index of the light for the effect
  139573. */
  139574. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  139575. }
  139576. }
  139577. declare module BABYLON {
  139578. /**
  139579. * Header information of HDR texture files.
  139580. */
  139581. export interface HDRInfo {
  139582. /**
  139583. * The height of the texture in pixels.
  139584. */
  139585. height: number;
  139586. /**
  139587. * The width of the texture in pixels.
  139588. */
  139589. width: number;
  139590. /**
  139591. * The index of the beginning of the data in the binary file.
  139592. */
  139593. dataPosition: number;
  139594. }
  139595. /**
  139596. * This groups tools to convert HDR texture to native colors array.
  139597. */
  139598. export class HDRTools {
  139599. private static Ldexp;
  139600. private static Rgbe2float;
  139601. private static readStringLine;
  139602. /**
  139603. * Reads header information from an RGBE texture stored in a native array.
  139604. * More information on this format are available here:
  139605. * https://en.wikipedia.org/wiki/RGBE_image_format
  139606. *
  139607. * @param uint8array The binary file stored in native array.
  139608. * @return The header information.
  139609. */
  139610. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  139611. /**
  139612. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  139613. * This RGBE texture needs to store the information as a panorama.
  139614. *
  139615. * More information on this format are available here:
  139616. * https://en.wikipedia.org/wiki/RGBE_image_format
  139617. *
  139618. * @param buffer The binary file stored in an array buffer.
  139619. * @param size The expected size of the extracted cubemap.
  139620. * @return The Cube Map information.
  139621. */
  139622. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  139623. /**
  139624. * Returns the pixels data extracted from an RGBE texture.
  139625. * This pixels will be stored left to right up to down in the R G B order in one array.
  139626. *
  139627. * More information on this format are available here:
  139628. * https://en.wikipedia.org/wiki/RGBE_image_format
  139629. *
  139630. * @param uint8array The binary file stored in an array buffer.
  139631. * @param hdrInfo The header information of the file.
  139632. * @return The pixels data in RGB right to left up to down order.
  139633. */
  139634. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  139635. private static RGBE_ReadPixels_RLE;
  139636. private static RGBE_ReadPixels_NOT_RLE;
  139637. }
  139638. }
  139639. declare module BABYLON {
  139640. /**
  139641. * Effect Render Options
  139642. */
  139643. export interface IEffectRendererOptions {
  139644. /**
  139645. * Defines the vertices positions.
  139646. */
  139647. positions?: number[];
  139648. /**
  139649. * Defines the indices.
  139650. */
  139651. indices?: number[];
  139652. }
  139653. /**
  139654. * Helper class to render one or more effects.
  139655. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  139656. */
  139657. export class EffectRenderer {
  139658. private engine;
  139659. private static _DefaultOptions;
  139660. private _vertexBuffers;
  139661. private _indexBuffer;
  139662. private _fullscreenViewport;
  139663. /**
  139664. * Creates an effect renderer
  139665. * @param engine the engine to use for rendering
  139666. * @param options defines the options of the effect renderer
  139667. */
  139668. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  139669. /**
  139670. * Sets the current viewport in normalized coordinates 0-1
  139671. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  139672. */
  139673. setViewport(viewport?: Viewport): void;
  139674. /**
  139675. * Binds the embedded attributes buffer to the effect.
  139676. * @param effect Defines the effect to bind the attributes for
  139677. */
  139678. bindBuffers(effect: Effect): void;
  139679. /**
  139680. * Sets the current effect wrapper to use during draw.
  139681. * The effect needs to be ready before calling this api.
  139682. * This also sets the default full screen position attribute.
  139683. * @param effectWrapper Defines the effect to draw with
  139684. */
  139685. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  139686. /**
  139687. * Restores engine states
  139688. */
  139689. restoreStates(): void;
  139690. /**
  139691. * Draws a full screen quad.
  139692. */
  139693. draw(): void;
  139694. private isRenderTargetTexture;
  139695. /**
  139696. * renders one or more effects to a specified texture
  139697. * @param effectWrapper the effect to renderer
  139698. * @param outputTexture texture to draw to, if null it will render to the screen.
  139699. */
  139700. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  139701. /**
  139702. * Disposes of the effect renderer
  139703. */
  139704. dispose(): void;
  139705. }
  139706. /**
  139707. * Options to create an EffectWrapper
  139708. */
  139709. interface EffectWrapperCreationOptions {
  139710. /**
  139711. * Engine to use to create the effect
  139712. */
  139713. engine: ThinEngine;
  139714. /**
  139715. * Fragment shader for the effect
  139716. */
  139717. fragmentShader: string;
  139718. /**
  139719. * Use the shader store instead of direct source code
  139720. */
  139721. useShaderStore?: boolean;
  139722. /**
  139723. * Vertex shader for the effect
  139724. */
  139725. vertexShader?: string;
  139726. /**
  139727. * Attributes to use in the shader
  139728. */
  139729. attributeNames?: Array<string>;
  139730. /**
  139731. * Uniforms to use in the shader
  139732. */
  139733. uniformNames?: Array<string>;
  139734. /**
  139735. * Texture sampler names to use in the shader
  139736. */
  139737. samplerNames?: Array<string>;
  139738. /**
  139739. * Defines to use in the shader
  139740. */
  139741. defines?: Array<string>;
  139742. /**
  139743. * Callback when effect is compiled
  139744. */
  139745. onCompiled?: Nullable<(effect: Effect) => void>;
  139746. /**
  139747. * The friendly name of the effect displayed in Spector.
  139748. */
  139749. name?: string;
  139750. }
  139751. /**
  139752. * Wraps an effect to be used for rendering
  139753. */
  139754. export class EffectWrapper {
  139755. /**
  139756. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  139757. */
  139758. onApplyObservable: Observable<{}>;
  139759. /**
  139760. * The underlying effect
  139761. */
  139762. effect: Effect;
  139763. /**
  139764. * Creates an effect to be renderer
  139765. * @param creationOptions options to create the effect
  139766. */
  139767. constructor(creationOptions: EffectWrapperCreationOptions);
  139768. /**
  139769. * Disposes of the effect wrapper
  139770. */
  139771. dispose(): void;
  139772. }
  139773. }
  139774. declare module BABYLON {
  139775. /** @hidden */
  139776. export var hdrFilteringVertexShader: {
  139777. name: string;
  139778. shader: string;
  139779. };
  139780. }
  139781. declare module BABYLON {
  139782. /** @hidden */
  139783. export var hdrFilteringPixelShader: {
  139784. name: string;
  139785. shader: string;
  139786. };
  139787. }
  139788. declare module BABYLON {
  139789. /**
  139790. * Options for texture filtering
  139791. */
  139792. interface IHDRFilteringOptions {
  139793. /**
  139794. * Scales pixel intensity for the input HDR map.
  139795. */
  139796. hdrScale?: number;
  139797. /**
  139798. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  139799. */
  139800. quality?: number;
  139801. }
  139802. /**
  139803. * Filters HDR maps to get correct renderings of PBR reflections
  139804. */
  139805. export class HDRFiltering {
  139806. private _engine;
  139807. private _effectRenderer;
  139808. private _effectWrapper;
  139809. private _lodGenerationOffset;
  139810. private _lodGenerationScale;
  139811. /**
  139812. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  139813. * you care about baking speed.
  139814. */
  139815. quality: number;
  139816. /**
  139817. * Scales pixel intensity for the input HDR map.
  139818. */
  139819. hdrScale: number;
  139820. /**
  139821. * Instantiates HDR filter for reflection maps
  139822. *
  139823. * @param engine Thin engine
  139824. * @param options Options
  139825. */
  139826. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  139827. private _createRenderTarget;
  139828. private _prefilterInternal;
  139829. private _createEffect;
  139830. /**
  139831. * Get a value indicating if the filter is ready to be used
  139832. * @param texture Texture to filter
  139833. * @returns true if the filter is ready
  139834. */
  139835. isReady(texture: BaseTexture): boolean;
  139836. /**
  139837. * Prefilters a cube texture to have mipmap levels representing roughness values.
  139838. * Prefiltering will be invoked at the end of next rendering pass.
  139839. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  139840. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  139841. * @param texture Texture to filter
  139842. * @param onFinished Callback when filtering is done
  139843. * @return Promise called when prefiltering is done
  139844. */
  139845. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  139846. }
  139847. }
  139848. declare module BABYLON {
  139849. /**
  139850. * This represents a texture coming from an HDR input.
  139851. *
  139852. * The only supported format is currently panorama picture stored in RGBE format.
  139853. * Example of such files can be found on HDRLib: http://hdrlib.com/
  139854. */
  139855. export class HDRCubeTexture extends BaseTexture {
  139856. private static _facesMapping;
  139857. private _generateHarmonics;
  139858. private _noMipmap;
  139859. private _prefilterOnLoad;
  139860. private _textureMatrix;
  139861. private _size;
  139862. private _onLoad;
  139863. private _onError;
  139864. /**
  139865. * The texture URL.
  139866. */
  139867. url: string;
  139868. protected _isBlocking: boolean;
  139869. /**
  139870. * Sets wether or not the texture is blocking during loading.
  139871. */
  139872. set isBlocking(value: boolean);
  139873. /**
  139874. * Gets wether or not the texture is blocking during loading.
  139875. */
  139876. get isBlocking(): boolean;
  139877. protected _rotationY: number;
  139878. /**
  139879. * Sets texture matrix rotation angle around Y axis in radians.
  139880. */
  139881. set rotationY(value: number);
  139882. /**
  139883. * Gets texture matrix rotation angle around Y axis radians.
  139884. */
  139885. get rotationY(): number;
  139886. /**
  139887. * Gets or sets the center of the bounding box associated with the cube texture
  139888. * It must define where the camera used to render the texture was set
  139889. */
  139890. boundingBoxPosition: Vector3;
  139891. private _boundingBoxSize;
  139892. /**
  139893. * Gets or sets the size of the bounding box associated with the cube texture
  139894. * When defined, the cubemap will switch to local mode
  139895. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  139896. * @example https://www.babylonjs-playground.com/#RNASML
  139897. */
  139898. set boundingBoxSize(value: Vector3);
  139899. get boundingBoxSize(): Vector3;
  139900. /**
  139901. * Instantiates an HDRTexture from the following parameters.
  139902. *
  139903. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  139904. * @param sceneOrEngine The scene or engine the texture will be used in
  139905. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  139906. * @param noMipmap Forces to not generate the mipmap if true
  139907. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  139908. * @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)
  139909. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  139910. */
  139911. 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>);
  139912. /**
  139913. * Get the current class name of the texture useful for serialization or dynamic coding.
  139914. * @returns "HDRCubeTexture"
  139915. */
  139916. getClassName(): string;
  139917. /**
  139918. * Occurs when the file is raw .hdr file.
  139919. */
  139920. private loadTexture;
  139921. clone(): HDRCubeTexture;
  139922. delayLoad(): void;
  139923. /**
  139924. * Get the texture reflection matrix used to rotate/transform the reflection.
  139925. * @returns the reflection matrix
  139926. */
  139927. getReflectionTextureMatrix(): Matrix;
  139928. /**
  139929. * Set the texture reflection matrix used to rotate/transform the reflection.
  139930. * @param value Define the reflection matrix to set
  139931. */
  139932. setReflectionTextureMatrix(value: Matrix): void;
  139933. /**
  139934. * Parses a JSON representation of an HDR Texture in order to create the texture
  139935. * @param parsedTexture Define the JSON representation
  139936. * @param scene Define the scene the texture should be created in
  139937. * @param rootUrl Define the root url in case we need to load relative dependencies
  139938. * @returns the newly created texture after parsing
  139939. */
  139940. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  139941. serialize(): any;
  139942. }
  139943. }
  139944. declare module BABYLON {
  139945. /**
  139946. * Class used to control physics engine
  139947. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  139948. */
  139949. export class PhysicsEngine implements IPhysicsEngine {
  139950. private _physicsPlugin;
  139951. /**
  139952. * Global value used to control the smallest number supported by the simulation
  139953. */
  139954. static Epsilon: number;
  139955. private _impostors;
  139956. private _joints;
  139957. private _subTimeStep;
  139958. /**
  139959. * Gets the gravity vector used by the simulation
  139960. */
  139961. gravity: Vector3;
  139962. /**
  139963. * Factory used to create the default physics plugin.
  139964. * @returns The default physics plugin
  139965. */
  139966. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  139967. /**
  139968. * Creates a new Physics Engine
  139969. * @param gravity defines the gravity vector used by the simulation
  139970. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  139971. */
  139972. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  139973. /**
  139974. * Sets the gravity vector used by the simulation
  139975. * @param gravity defines the gravity vector to use
  139976. */
  139977. setGravity(gravity: Vector3): void;
  139978. /**
  139979. * Set the time step of the physics engine.
  139980. * Default is 1/60.
  139981. * To slow it down, enter 1/600 for example.
  139982. * To speed it up, 1/30
  139983. * @param newTimeStep defines the new timestep to apply to this world.
  139984. */
  139985. setTimeStep(newTimeStep?: number): void;
  139986. /**
  139987. * Get the time step of the physics engine.
  139988. * @returns the current time step
  139989. */
  139990. getTimeStep(): number;
  139991. /**
  139992. * Set the sub time step of the physics engine.
  139993. * Default is 0 meaning there is no sub steps
  139994. * To increase physics resolution precision, set a small value (like 1 ms)
  139995. * @param subTimeStep defines the new sub timestep used for physics resolution.
  139996. */
  139997. setSubTimeStep(subTimeStep?: number): void;
  139998. /**
  139999. * Get the sub time step of the physics engine.
  140000. * @returns the current sub time step
  140001. */
  140002. getSubTimeStep(): number;
  140003. /**
  140004. * Release all resources
  140005. */
  140006. dispose(): void;
  140007. /**
  140008. * Gets the name of the current physics plugin
  140009. * @returns the name of the plugin
  140010. */
  140011. getPhysicsPluginName(): string;
  140012. /**
  140013. * Adding a new impostor for the impostor tracking.
  140014. * This will be done by the impostor itself.
  140015. * @param impostor the impostor to add
  140016. */
  140017. addImpostor(impostor: PhysicsImpostor): void;
  140018. /**
  140019. * Remove an impostor from the engine.
  140020. * This impostor and its mesh will not longer be updated by the physics engine.
  140021. * @param impostor the impostor to remove
  140022. */
  140023. removeImpostor(impostor: PhysicsImpostor): void;
  140024. /**
  140025. * Add a joint to the physics engine
  140026. * @param mainImpostor defines the main impostor to which the joint is added.
  140027. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  140028. * @param joint defines the joint that will connect both impostors.
  140029. */
  140030. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  140031. /**
  140032. * Removes a joint from the simulation
  140033. * @param mainImpostor defines the impostor used with the joint
  140034. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  140035. * @param joint defines the joint to remove
  140036. */
  140037. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  140038. /**
  140039. * Called by the scene. No need to call it.
  140040. * @param delta defines the timespam between frames
  140041. */
  140042. _step(delta: number): void;
  140043. /**
  140044. * Gets the current plugin used to run the simulation
  140045. * @returns current plugin
  140046. */
  140047. getPhysicsPlugin(): IPhysicsEnginePlugin;
  140048. /**
  140049. * Gets the list of physic impostors
  140050. * @returns an array of PhysicsImpostor
  140051. */
  140052. getImpostors(): Array<PhysicsImpostor>;
  140053. /**
  140054. * Gets the impostor for a physics enabled object
  140055. * @param object defines the object impersonated by the impostor
  140056. * @returns the PhysicsImpostor or null if not found
  140057. */
  140058. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  140059. /**
  140060. * Gets the impostor for a physics body object
  140061. * @param body defines physics body used by the impostor
  140062. * @returns the PhysicsImpostor or null if not found
  140063. */
  140064. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  140065. /**
  140066. * Does a raycast in the physics world
  140067. * @param from when should the ray start?
  140068. * @param to when should the ray end?
  140069. * @returns PhysicsRaycastResult
  140070. */
  140071. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140072. }
  140073. }
  140074. declare module BABYLON {
  140075. /** @hidden */
  140076. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  140077. private _useDeltaForWorldStep;
  140078. world: any;
  140079. name: string;
  140080. private _physicsMaterials;
  140081. private _fixedTimeStep;
  140082. private _cannonRaycastResult;
  140083. private _raycastResult;
  140084. private _physicsBodysToRemoveAfterStep;
  140085. private _firstFrame;
  140086. BJSCANNON: any;
  140087. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  140088. setGravity(gravity: Vector3): void;
  140089. setTimeStep(timeStep: number): void;
  140090. getTimeStep(): number;
  140091. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  140092. private _removeMarkedPhysicsBodiesFromWorld;
  140093. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140094. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140095. generatePhysicsBody(impostor: PhysicsImpostor): void;
  140096. private _processChildMeshes;
  140097. removePhysicsBody(impostor: PhysicsImpostor): void;
  140098. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  140099. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  140100. private _addMaterial;
  140101. private _checkWithEpsilon;
  140102. private _createShape;
  140103. private _createHeightmap;
  140104. private _minus90X;
  140105. private _plus90X;
  140106. private _tmpPosition;
  140107. private _tmpDeltaPosition;
  140108. private _tmpUnityRotation;
  140109. private _updatePhysicsBodyTransformation;
  140110. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  140111. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  140112. isSupported(): boolean;
  140113. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140114. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140115. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140116. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140117. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  140118. getBodyMass(impostor: PhysicsImpostor): number;
  140119. getBodyFriction(impostor: PhysicsImpostor): number;
  140120. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  140121. getBodyRestitution(impostor: PhysicsImpostor): number;
  140122. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  140123. sleepBody(impostor: PhysicsImpostor): void;
  140124. wakeUpBody(impostor: PhysicsImpostor): void;
  140125. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  140126. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  140127. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  140128. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  140129. getRadius(impostor: PhysicsImpostor): number;
  140130. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  140131. dispose(): void;
  140132. private _extendNamespace;
  140133. /**
  140134. * Does a raycast in the physics world
  140135. * @param from when should the ray start?
  140136. * @param to when should the ray end?
  140137. * @returns PhysicsRaycastResult
  140138. */
  140139. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140140. }
  140141. }
  140142. declare module BABYLON {
  140143. /** @hidden */
  140144. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  140145. private _useDeltaForWorldStep;
  140146. world: any;
  140147. name: string;
  140148. BJSOIMO: any;
  140149. private _raycastResult;
  140150. private _fixedTimeStep;
  140151. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  140152. setGravity(gravity: Vector3): void;
  140153. setTimeStep(timeStep: number): void;
  140154. getTimeStep(): number;
  140155. private _tmpImpostorsArray;
  140156. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  140157. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140158. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140159. generatePhysicsBody(impostor: PhysicsImpostor): void;
  140160. private _tmpPositionVector;
  140161. removePhysicsBody(impostor: PhysicsImpostor): void;
  140162. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  140163. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  140164. isSupported(): boolean;
  140165. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  140166. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  140167. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140168. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140169. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140170. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140171. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  140172. getBodyMass(impostor: PhysicsImpostor): number;
  140173. getBodyFriction(impostor: PhysicsImpostor): number;
  140174. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  140175. getBodyRestitution(impostor: PhysicsImpostor): number;
  140176. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  140177. sleepBody(impostor: PhysicsImpostor): void;
  140178. wakeUpBody(impostor: PhysicsImpostor): void;
  140179. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  140180. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  140181. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  140182. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  140183. getRadius(impostor: PhysicsImpostor): number;
  140184. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  140185. dispose(): void;
  140186. /**
  140187. * Does a raycast in the physics world
  140188. * @param from when should the ray start?
  140189. * @param to when should the ray end?
  140190. * @returns PhysicsRaycastResult
  140191. */
  140192. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140193. }
  140194. }
  140195. declare module BABYLON {
  140196. /**
  140197. * AmmoJS Physics plugin
  140198. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  140199. * @see https://github.com/kripken/ammo.js/
  140200. */
  140201. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  140202. private _useDeltaForWorldStep;
  140203. /**
  140204. * Reference to the Ammo library
  140205. */
  140206. bjsAMMO: any;
  140207. /**
  140208. * Created ammoJS world which physics bodies are added to
  140209. */
  140210. world: any;
  140211. /**
  140212. * Name of the plugin
  140213. */
  140214. name: string;
  140215. private _timeStep;
  140216. private _fixedTimeStep;
  140217. private _maxSteps;
  140218. private _tmpQuaternion;
  140219. private _tmpAmmoTransform;
  140220. private _tmpAmmoQuaternion;
  140221. private _tmpAmmoConcreteContactResultCallback;
  140222. private _collisionConfiguration;
  140223. private _dispatcher;
  140224. private _overlappingPairCache;
  140225. private _solver;
  140226. private _softBodySolver;
  140227. private _tmpAmmoVectorA;
  140228. private _tmpAmmoVectorB;
  140229. private _tmpAmmoVectorC;
  140230. private _tmpAmmoVectorD;
  140231. private _tmpContactCallbackResult;
  140232. private _tmpAmmoVectorRCA;
  140233. private _tmpAmmoVectorRCB;
  140234. private _raycastResult;
  140235. private static readonly DISABLE_COLLISION_FLAG;
  140236. private static readonly KINEMATIC_FLAG;
  140237. private static readonly DISABLE_DEACTIVATION_FLAG;
  140238. /**
  140239. * Initializes the ammoJS plugin
  140240. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  140241. * @param ammoInjection can be used to inject your own ammo reference
  140242. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  140243. */
  140244. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  140245. /**
  140246. * Sets the gravity of the physics world (m/(s^2))
  140247. * @param gravity Gravity to set
  140248. */
  140249. setGravity(gravity: Vector3): void;
  140250. /**
  140251. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  140252. * @param timeStep timestep to use in seconds
  140253. */
  140254. setTimeStep(timeStep: number): void;
  140255. /**
  140256. * 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)
  140257. * @param fixedTimeStep fixedTimeStep to use in seconds
  140258. */
  140259. setFixedTimeStep(fixedTimeStep: number): void;
  140260. /**
  140261. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  140262. * @param maxSteps the maximum number of steps by the physics engine per frame
  140263. */
  140264. setMaxSteps(maxSteps: number): void;
  140265. /**
  140266. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  140267. * @returns the current timestep in seconds
  140268. */
  140269. getTimeStep(): number;
  140270. /**
  140271. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  140272. */
  140273. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  140274. private _isImpostorInContact;
  140275. private _isImpostorPairInContact;
  140276. private _stepSimulation;
  140277. /**
  140278. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  140279. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  140280. * After the step the babylon meshes are set to the position of the physics imposters
  140281. * @param delta amount of time to step forward
  140282. * @param impostors array of imposters to update before/after the step
  140283. */
  140284. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  140285. /**
  140286. * Update babylon mesh to match physics world object
  140287. * @param impostor imposter to match
  140288. */
  140289. private _afterSoftStep;
  140290. /**
  140291. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  140292. * @param impostor imposter to match
  140293. */
  140294. private _ropeStep;
  140295. /**
  140296. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  140297. * @param impostor imposter to match
  140298. */
  140299. private _softbodyOrClothStep;
  140300. private _tmpMatrix;
  140301. /**
  140302. * Applies an impulse on the imposter
  140303. * @param impostor imposter to apply impulse to
  140304. * @param force amount of force to be applied to the imposter
  140305. * @param contactPoint the location to apply the impulse on the imposter
  140306. */
  140307. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140308. /**
  140309. * Applies a force on the imposter
  140310. * @param impostor imposter to apply force
  140311. * @param force amount of force to be applied to the imposter
  140312. * @param contactPoint the location to apply the force on the imposter
  140313. */
  140314. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140315. /**
  140316. * Creates a physics body using the plugin
  140317. * @param impostor the imposter to create the physics body on
  140318. */
  140319. generatePhysicsBody(impostor: PhysicsImpostor): void;
  140320. /**
  140321. * Removes the physics body from the imposter and disposes of the body's memory
  140322. * @param impostor imposter to remove the physics body from
  140323. */
  140324. removePhysicsBody(impostor: PhysicsImpostor): void;
  140325. /**
  140326. * Generates a joint
  140327. * @param impostorJoint the imposter joint to create the joint with
  140328. */
  140329. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  140330. /**
  140331. * Removes a joint
  140332. * @param impostorJoint the imposter joint to remove the joint from
  140333. */
  140334. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  140335. private _addMeshVerts;
  140336. /**
  140337. * Initialise the soft body vertices to match its object's (mesh) vertices
  140338. * Softbody vertices (nodes) are in world space and to match this
  140339. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  140340. * @param impostor to create the softbody for
  140341. */
  140342. private _softVertexData;
  140343. /**
  140344. * Create an impostor's soft body
  140345. * @param impostor to create the softbody for
  140346. */
  140347. private _createSoftbody;
  140348. /**
  140349. * Create cloth for an impostor
  140350. * @param impostor to create the softbody for
  140351. */
  140352. private _createCloth;
  140353. /**
  140354. * Create rope for an impostor
  140355. * @param impostor to create the softbody for
  140356. */
  140357. private _createRope;
  140358. /**
  140359. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  140360. * @param impostor to create the custom physics shape for
  140361. */
  140362. private _createCustom;
  140363. private _addHullVerts;
  140364. private _createShape;
  140365. /**
  140366. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  140367. * @param impostor imposter containing the physics body and babylon object
  140368. */
  140369. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  140370. /**
  140371. * Sets the babylon object's position/rotation from the physics body's position/rotation
  140372. * @param impostor imposter containing the physics body and babylon object
  140373. * @param newPosition new position
  140374. * @param newRotation new rotation
  140375. */
  140376. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  140377. /**
  140378. * If this plugin is supported
  140379. * @returns true if its supported
  140380. */
  140381. isSupported(): boolean;
  140382. /**
  140383. * Sets the linear velocity of the physics body
  140384. * @param impostor imposter to set the velocity on
  140385. * @param velocity velocity to set
  140386. */
  140387. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140388. /**
  140389. * Sets the angular velocity of the physics body
  140390. * @param impostor imposter to set the velocity on
  140391. * @param velocity velocity to set
  140392. */
  140393. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140394. /**
  140395. * gets the linear velocity
  140396. * @param impostor imposter to get linear velocity from
  140397. * @returns linear velocity
  140398. */
  140399. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140400. /**
  140401. * gets the angular velocity
  140402. * @param impostor imposter to get angular velocity from
  140403. * @returns angular velocity
  140404. */
  140405. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140406. /**
  140407. * Sets the mass of physics body
  140408. * @param impostor imposter to set the mass on
  140409. * @param mass mass to set
  140410. */
  140411. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  140412. /**
  140413. * Gets the mass of the physics body
  140414. * @param impostor imposter to get the mass from
  140415. * @returns mass
  140416. */
  140417. getBodyMass(impostor: PhysicsImpostor): number;
  140418. /**
  140419. * Gets friction of the impostor
  140420. * @param impostor impostor to get friction from
  140421. * @returns friction value
  140422. */
  140423. getBodyFriction(impostor: PhysicsImpostor): number;
  140424. /**
  140425. * Sets friction of the impostor
  140426. * @param impostor impostor to set friction on
  140427. * @param friction friction value
  140428. */
  140429. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  140430. /**
  140431. * Gets restitution of the impostor
  140432. * @param impostor impostor to get restitution from
  140433. * @returns restitution value
  140434. */
  140435. getBodyRestitution(impostor: PhysicsImpostor): number;
  140436. /**
  140437. * Sets resitution of the impostor
  140438. * @param impostor impostor to set resitution on
  140439. * @param restitution resitution value
  140440. */
  140441. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  140442. /**
  140443. * Gets pressure inside the impostor
  140444. * @param impostor impostor to get pressure from
  140445. * @returns pressure value
  140446. */
  140447. getBodyPressure(impostor: PhysicsImpostor): number;
  140448. /**
  140449. * Sets pressure inside a soft body impostor
  140450. * Cloth and rope must remain 0 pressure
  140451. * @param impostor impostor to set pressure on
  140452. * @param pressure pressure value
  140453. */
  140454. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  140455. /**
  140456. * Gets stiffness of the impostor
  140457. * @param impostor impostor to get stiffness from
  140458. * @returns pressure value
  140459. */
  140460. getBodyStiffness(impostor: PhysicsImpostor): number;
  140461. /**
  140462. * Sets stiffness of the impostor
  140463. * @param impostor impostor to set stiffness on
  140464. * @param stiffness stiffness value from 0 to 1
  140465. */
  140466. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  140467. /**
  140468. * Gets velocityIterations of the impostor
  140469. * @param impostor impostor to get velocity iterations from
  140470. * @returns velocityIterations value
  140471. */
  140472. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  140473. /**
  140474. * Sets velocityIterations of the impostor
  140475. * @param impostor impostor to set velocity iterations on
  140476. * @param velocityIterations velocityIterations value
  140477. */
  140478. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  140479. /**
  140480. * Gets positionIterations of the impostor
  140481. * @param impostor impostor to get position iterations from
  140482. * @returns positionIterations value
  140483. */
  140484. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  140485. /**
  140486. * Sets positionIterations of the impostor
  140487. * @param impostor impostor to set position on
  140488. * @param positionIterations positionIterations value
  140489. */
  140490. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  140491. /**
  140492. * Append an anchor to a cloth object
  140493. * @param impostor is the cloth impostor to add anchor to
  140494. * @param otherImpostor is the rigid impostor to anchor to
  140495. * @param width ratio across width from 0 to 1
  140496. * @param height ratio up height from 0 to 1
  140497. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  140498. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  140499. */
  140500. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  140501. /**
  140502. * Append an hook to a rope object
  140503. * @param impostor is the rope impostor to add hook to
  140504. * @param otherImpostor is the rigid impostor to hook to
  140505. * @param length ratio along the rope from 0 to 1
  140506. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  140507. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  140508. */
  140509. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  140510. /**
  140511. * Sleeps the physics body and stops it from being active
  140512. * @param impostor impostor to sleep
  140513. */
  140514. sleepBody(impostor: PhysicsImpostor): void;
  140515. /**
  140516. * Activates the physics body
  140517. * @param impostor impostor to activate
  140518. */
  140519. wakeUpBody(impostor: PhysicsImpostor): void;
  140520. /**
  140521. * Updates the distance parameters of the joint
  140522. * @param joint joint to update
  140523. * @param maxDistance maximum distance of the joint
  140524. * @param minDistance minimum distance of the joint
  140525. */
  140526. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  140527. /**
  140528. * Sets a motor on the joint
  140529. * @param joint joint to set motor on
  140530. * @param speed speed of the motor
  140531. * @param maxForce maximum force of the motor
  140532. * @param motorIndex index of the motor
  140533. */
  140534. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  140535. /**
  140536. * Sets the motors limit
  140537. * @param joint joint to set limit on
  140538. * @param upperLimit upper limit
  140539. * @param lowerLimit lower limit
  140540. */
  140541. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  140542. /**
  140543. * Syncs the position and rotation of a mesh with the impostor
  140544. * @param mesh mesh to sync
  140545. * @param impostor impostor to update the mesh with
  140546. */
  140547. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  140548. /**
  140549. * Gets the radius of the impostor
  140550. * @param impostor impostor to get radius from
  140551. * @returns the radius
  140552. */
  140553. getRadius(impostor: PhysicsImpostor): number;
  140554. /**
  140555. * Gets the box size of the impostor
  140556. * @param impostor impostor to get box size from
  140557. * @param result the resulting box size
  140558. */
  140559. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  140560. /**
  140561. * Disposes of the impostor
  140562. */
  140563. dispose(): void;
  140564. /**
  140565. * Does a raycast in the physics world
  140566. * @param from when should the ray start?
  140567. * @param to when should the ray end?
  140568. * @returns PhysicsRaycastResult
  140569. */
  140570. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140571. }
  140572. }
  140573. declare module BABYLON {
  140574. interface AbstractScene {
  140575. /**
  140576. * The list of reflection probes added to the scene
  140577. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  140578. */
  140579. reflectionProbes: Array<ReflectionProbe>;
  140580. /**
  140581. * Removes the given reflection probe from this scene.
  140582. * @param toRemove The reflection probe to remove
  140583. * @returns The index of the removed reflection probe
  140584. */
  140585. removeReflectionProbe(toRemove: ReflectionProbe): number;
  140586. /**
  140587. * Adds the given reflection probe to this scene.
  140588. * @param newReflectionProbe The reflection probe to add
  140589. */
  140590. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  140591. }
  140592. /**
  140593. * Class used to generate realtime reflection / refraction cube textures
  140594. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  140595. */
  140596. export class ReflectionProbe {
  140597. /** defines the name of the probe */
  140598. name: string;
  140599. private _scene;
  140600. private _renderTargetTexture;
  140601. private _projectionMatrix;
  140602. private _viewMatrix;
  140603. private _target;
  140604. private _add;
  140605. private _attachedMesh;
  140606. private _invertYAxis;
  140607. /** Gets or sets probe position (center of the cube map) */
  140608. position: Vector3;
  140609. /**
  140610. * Creates a new reflection probe
  140611. * @param name defines the name of the probe
  140612. * @param size defines the texture resolution (for each face)
  140613. * @param scene defines the hosting scene
  140614. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  140615. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  140616. */
  140617. constructor(
  140618. /** defines the name of the probe */
  140619. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  140620. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  140621. get samples(): number;
  140622. set samples(value: number);
  140623. /** Gets or sets the refresh rate to use (on every frame by default) */
  140624. get refreshRate(): number;
  140625. set refreshRate(value: number);
  140626. /**
  140627. * Gets the hosting scene
  140628. * @returns a Scene
  140629. */
  140630. getScene(): Scene;
  140631. /** Gets the internal CubeTexture used to render to */
  140632. get cubeTexture(): RenderTargetTexture;
  140633. /** Gets the list of meshes to render */
  140634. get renderList(): Nullable<AbstractMesh[]>;
  140635. /**
  140636. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  140637. * @param mesh defines the mesh to attach to
  140638. */
  140639. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  140640. /**
  140641. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  140642. * @param renderingGroupId The rendering group id corresponding to its index
  140643. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  140644. */
  140645. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  140646. /**
  140647. * Clean all associated resources
  140648. */
  140649. dispose(): void;
  140650. /**
  140651. * Converts the reflection probe information to a readable string for debug purpose.
  140652. * @param fullDetails Supports for multiple levels of logging within scene loading
  140653. * @returns the human readable reflection probe info
  140654. */
  140655. toString(fullDetails?: boolean): string;
  140656. /**
  140657. * Get the class name of the relfection probe.
  140658. * @returns "ReflectionProbe"
  140659. */
  140660. getClassName(): string;
  140661. /**
  140662. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  140663. * @returns The JSON representation of the texture
  140664. */
  140665. serialize(): any;
  140666. /**
  140667. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  140668. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  140669. * @param scene Define the scene the parsed reflection probe should be instantiated in
  140670. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  140671. * @returns The parsed reflection probe if successful
  140672. */
  140673. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  140674. }
  140675. }
  140676. declare module BABYLON {
  140677. /** @hidden */
  140678. export var _BabylonLoaderRegistered: boolean;
  140679. /**
  140680. * Helps setting up some configuration for the babylon file loader.
  140681. */
  140682. export class BabylonFileLoaderConfiguration {
  140683. /**
  140684. * The loader does not allow injecting custom physix engine into the plugins.
  140685. * Unfortunately in ES6, we need to manually inject them into the plugin.
  140686. * So you could set this variable to your engine import to make it work.
  140687. */
  140688. static LoaderInjectedPhysicsEngine: any;
  140689. }
  140690. }
  140691. declare module BABYLON {
  140692. /**
  140693. * The Physically based simple base material of BJS.
  140694. *
  140695. * This enables better naming and convention enforcements on top of the pbrMaterial.
  140696. * It is used as the base class for both the specGloss and metalRough conventions.
  140697. */
  140698. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  140699. /**
  140700. * Number of Simultaneous lights allowed on the material.
  140701. */
  140702. maxSimultaneousLights: number;
  140703. /**
  140704. * If sets to true, disables all the lights affecting the material.
  140705. */
  140706. disableLighting: boolean;
  140707. /**
  140708. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  140709. */
  140710. environmentTexture: BaseTexture;
  140711. /**
  140712. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  140713. */
  140714. invertNormalMapX: boolean;
  140715. /**
  140716. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  140717. */
  140718. invertNormalMapY: boolean;
  140719. /**
  140720. * Normal map used in the model.
  140721. */
  140722. normalTexture: BaseTexture;
  140723. /**
  140724. * Emissivie color used to self-illuminate the model.
  140725. */
  140726. emissiveColor: Color3;
  140727. /**
  140728. * Emissivie texture used to self-illuminate the model.
  140729. */
  140730. emissiveTexture: BaseTexture;
  140731. /**
  140732. * Occlusion Channel Strenght.
  140733. */
  140734. occlusionStrength: number;
  140735. /**
  140736. * Occlusion Texture of the material (adding extra occlusion effects).
  140737. */
  140738. occlusionTexture: BaseTexture;
  140739. /**
  140740. * Defines the alpha limits in alpha test mode.
  140741. */
  140742. alphaCutOff: number;
  140743. /**
  140744. * Gets the current double sided mode.
  140745. */
  140746. get doubleSided(): boolean;
  140747. /**
  140748. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  140749. */
  140750. set doubleSided(value: boolean);
  140751. /**
  140752. * Stores the pre-calculated light information of a mesh in a texture.
  140753. */
  140754. lightmapTexture: BaseTexture;
  140755. /**
  140756. * If true, the light map contains occlusion information instead of lighting info.
  140757. */
  140758. useLightmapAsShadowmap: boolean;
  140759. /**
  140760. * Instantiates a new PBRMaterial instance.
  140761. *
  140762. * @param name The material name
  140763. * @param scene The scene the material will be use in.
  140764. */
  140765. constructor(name: string, scene: Scene);
  140766. getClassName(): string;
  140767. }
  140768. }
  140769. declare module BABYLON {
  140770. /**
  140771. * The PBR material of BJS following the metal roughness convention.
  140772. *
  140773. * This fits to the PBR convention in the GLTF definition:
  140774. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  140775. */
  140776. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  140777. /**
  140778. * The base color has two different interpretations depending on the value of metalness.
  140779. * When the material is a metal, the base color is the specific measured reflectance value
  140780. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  140781. * of the material.
  140782. */
  140783. baseColor: Color3;
  140784. /**
  140785. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  140786. * well as opacity information in the alpha channel.
  140787. */
  140788. baseTexture: BaseTexture;
  140789. /**
  140790. * Specifies the metallic scalar value of the material.
  140791. * Can also be used to scale the metalness values of the metallic texture.
  140792. */
  140793. metallic: number;
  140794. /**
  140795. * Specifies the roughness scalar value of the material.
  140796. * Can also be used to scale the roughness values of the metallic texture.
  140797. */
  140798. roughness: number;
  140799. /**
  140800. * Texture containing both the metallic value in the B channel and the
  140801. * roughness value in the G channel to keep better precision.
  140802. */
  140803. metallicRoughnessTexture: BaseTexture;
  140804. /**
  140805. * Instantiates a new PBRMetalRoughnessMaterial instance.
  140806. *
  140807. * @param name The material name
  140808. * @param scene The scene the material will be use in.
  140809. */
  140810. constructor(name: string, scene: Scene);
  140811. /**
  140812. * Return the currrent class name of the material.
  140813. */
  140814. getClassName(): string;
  140815. /**
  140816. * Makes a duplicate of the current material.
  140817. * @param name - name to use for the new material.
  140818. */
  140819. clone(name: string): PBRMetallicRoughnessMaterial;
  140820. /**
  140821. * Serialize the material to a parsable JSON object.
  140822. */
  140823. serialize(): any;
  140824. /**
  140825. * Parses a JSON object correponding to the serialize function.
  140826. */
  140827. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  140828. }
  140829. }
  140830. declare module BABYLON {
  140831. /**
  140832. * The PBR material of BJS following the specular glossiness convention.
  140833. *
  140834. * This fits to the PBR convention in the GLTF definition:
  140835. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  140836. */
  140837. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  140838. /**
  140839. * Specifies the diffuse color of the material.
  140840. */
  140841. diffuseColor: Color3;
  140842. /**
  140843. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  140844. * channel.
  140845. */
  140846. diffuseTexture: BaseTexture;
  140847. /**
  140848. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  140849. */
  140850. specularColor: Color3;
  140851. /**
  140852. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  140853. */
  140854. glossiness: number;
  140855. /**
  140856. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  140857. */
  140858. specularGlossinessTexture: BaseTexture;
  140859. /**
  140860. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  140861. *
  140862. * @param name The material name
  140863. * @param scene The scene the material will be use in.
  140864. */
  140865. constructor(name: string, scene: Scene);
  140866. /**
  140867. * Return the currrent class name of the material.
  140868. */
  140869. getClassName(): string;
  140870. /**
  140871. * Makes a duplicate of the current material.
  140872. * @param name - name to use for the new material.
  140873. */
  140874. clone(name: string): PBRSpecularGlossinessMaterial;
  140875. /**
  140876. * Serialize the material to a parsable JSON object.
  140877. */
  140878. serialize(): any;
  140879. /**
  140880. * Parses a JSON object correponding to the serialize function.
  140881. */
  140882. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  140883. }
  140884. }
  140885. declare module BABYLON {
  140886. /**
  140887. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  140888. * It can help converting any input color in a desired output one. This can then be used to create effects
  140889. * from sepia, black and white to sixties or futuristic rendering...
  140890. *
  140891. * The only supported format is currently 3dl.
  140892. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  140893. */
  140894. export class ColorGradingTexture extends BaseTexture {
  140895. /**
  140896. * The texture URL.
  140897. */
  140898. url: string;
  140899. /**
  140900. * Empty line regex stored for GC.
  140901. */
  140902. private static _noneEmptyLineRegex;
  140903. private _textureMatrix;
  140904. private _onLoad;
  140905. /**
  140906. * Instantiates a ColorGradingTexture from the following parameters.
  140907. *
  140908. * @param url The location of the color gradind data (currently only supporting 3dl)
  140909. * @param sceneOrEngine The scene or engine the texture will be used in
  140910. * @param onLoad defines a callback triggered when the texture has been loaded
  140911. */
  140912. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  140913. /**
  140914. * Fires the onload event from the constructor if requested.
  140915. */
  140916. private _triggerOnLoad;
  140917. /**
  140918. * Returns the texture matrix used in most of the material.
  140919. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  140920. */
  140921. getTextureMatrix(): Matrix;
  140922. /**
  140923. * Occurs when the file being loaded is a .3dl LUT file.
  140924. */
  140925. private load3dlTexture;
  140926. /**
  140927. * Starts the loading process of the texture.
  140928. */
  140929. private loadTexture;
  140930. /**
  140931. * Clones the color gradind texture.
  140932. */
  140933. clone(): ColorGradingTexture;
  140934. /**
  140935. * Called during delayed load for textures.
  140936. */
  140937. delayLoad(): void;
  140938. /**
  140939. * Parses a color grading texture serialized by Babylon.
  140940. * @param parsedTexture The texture information being parsedTexture
  140941. * @param scene The scene to load the texture in
  140942. * @param rootUrl The root url of the data assets to load
  140943. * @return A color gradind texture
  140944. */
  140945. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  140946. /**
  140947. * Serializes the LUT texture to json format.
  140948. */
  140949. serialize(): any;
  140950. }
  140951. }
  140952. declare module BABYLON {
  140953. /**
  140954. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  140955. */
  140956. export class EquiRectangularCubeTexture extends BaseTexture {
  140957. /** The six faces of the cube. */
  140958. private static _FacesMapping;
  140959. private _noMipmap;
  140960. private _onLoad;
  140961. private _onError;
  140962. /** The size of the cubemap. */
  140963. private _size;
  140964. /** The buffer of the image. */
  140965. private _buffer;
  140966. /** The width of the input image. */
  140967. private _width;
  140968. /** The height of the input image. */
  140969. private _height;
  140970. /** The URL to the image. */
  140971. url: string;
  140972. /**
  140973. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  140974. * @param url The location of the image
  140975. * @param scene The scene the texture will be used in
  140976. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  140977. * @param noMipmap Forces to not generate the mipmap if true
  140978. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  140979. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  140980. * @param onLoad — defines a callback called when texture is loaded
  140981. * @param onError — defines a callback called if there is an error
  140982. */
  140983. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  140984. /**
  140985. * Load the image data, by putting the image on a canvas and extracting its buffer.
  140986. */
  140987. private loadImage;
  140988. /**
  140989. * Convert the image buffer into a cubemap and create a CubeTexture.
  140990. */
  140991. private loadTexture;
  140992. /**
  140993. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  140994. * @param buffer The ArrayBuffer that should be converted.
  140995. * @returns The buffer as Float32Array.
  140996. */
  140997. private getFloat32ArrayFromArrayBuffer;
  140998. /**
  140999. * Get the current class name of the texture useful for serialization or dynamic coding.
  141000. * @returns "EquiRectangularCubeTexture"
  141001. */
  141002. getClassName(): string;
  141003. /**
  141004. * Create a clone of the current EquiRectangularCubeTexture and return it.
  141005. * @returns A clone of the current EquiRectangularCubeTexture.
  141006. */
  141007. clone(): EquiRectangularCubeTexture;
  141008. }
  141009. }
  141010. declare module BABYLON {
  141011. /**
  141012. * Defines the options related to the creation of an HtmlElementTexture
  141013. */
  141014. export interface IHtmlElementTextureOptions {
  141015. /**
  141016. * Defines wether mip maps should be created or not.
  141017. */
  141018. generateMipMaps?: boolean;
  141019. /**
  141020. * Defines the sampling mode of the texture.
  141021. */
  141022. samplingMode?: number;
  141023. /**
  141024. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  141025. */
  141026. engine: Nullable<ThinEngine>;
  141027. /**
  141028. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  141029. */
  141030. scene: Nullable<Scene>;
  141031. }
  141032. /**
  141033. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  141034. * To be as efficient as possible depending on your constraints nothing aside the first upload
  141035. * is automatically managed.
  141036. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  141037. * in your application.
  141038. *
  141039. * As the update is not automatic, you need to call them manually.
  141040. */
  141041. export class HtmlElementTexture extends BaseTexture {
  141042. /**
  141043. * The texture URL.
  141044. */
  141045. element: HTMLVideoElement | HTMLCanvasElement;
  141046. private static readonly DefaultOptions;
  141047. private _textureMatrix;
  141048. private _isVideo;
  141049. private _generateMipMaps;
  141050. private _samplingMode;
  141051. /**
  141052. * Instantiates a HtmlElementTexture from the following parameters.
  141053. *
  141054. * @param name Defines the name of the texture
  141055. * @param element Defines the video or canvas the texture is filled with
  141056. * @param options Defines the other none mandatory texture creation options
  141057. */
  141058. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  141059. private _createInternalTexture;
  141060. /**
  141061. * Returns the texture matrix used in most of the material.
  141062. */
  141063. getTextureMatrix(): Matrix;
  141064. /**
  141065. * Updates the content of the texture.
  141066. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  141067. */
  141068. update(invertY?: Nullable<boolean>): void;
  141069. }
  141070. }
  141071. declare module BABYLON {
  141072. /**
  141073. * Based on jsTGALoader - Javascript loader for TGA file
  141074. * By Vincent Thibault
  141075. * @see http://blog.robrowser.com/javascript-tga-loader.html
  141076. */
  141077. export class TGATools {
  141078. private static _TYPE_INDEXED;
  141079. private static _TYPE_RGB;
  141080. private static _TYPE_GREY;
  141081. private static _TYPE_RLE_INDEXED;
  141082. private static _TYPE_RLE_RGB;
  141083. private static _TYPE_RLE_GREY;
  141084. private static _ORIGIN_MASK;
  141085. private static _ORIGIN_SHIFT;
  141086. private static _ORIGIN_BL;
  141087. private static _ORIGIN_BR;
  141088. private static _ORIGIN_UL;
  141089. private static _ORIGIN_UR;
  141090. /**
  141091. * Gets the header of a TGA file
  141092. * @param data defines the TGA data
  141093. * @returns the header
  141094. */
  141095. static GetTGAHeader(data: Uint8Array): any;
  141096. /**
  141097. * Uploads TGA content to a Babylon Texture
  141098. * @hidden
  141099. */
  141100. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  141101. /** @hidden */
  141102. 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;
  141103. /** @hidden */
  141104. 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;
  141105. /** @hidden */
  141106. 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;
  141107. /** @hidden */
  141108. 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;
  141109. /** @hidden */
  141110. 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;
  141111. /** @hidden */
  141112. 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;
  141113. }
  141114. }
  141115. declare module BABYLON {
  141116. /**
  141117. * Implementation of the TGA Texture Loader.
  141118. * @hidden
  141119. */
  141120. export class _TGATextureLoader implements IInternalTextureLoader {
  141121. /**
  141122. * Defines wether the loader supports cascade loading the different faces.
  141123. */
  141124. readonly supportCascades: boolean;
  141125. /**
  141126. * This returns if the loader support the current file information.
  141127. * @param extension defines the file extension of the file being loaded
  141128. * @returns true if the loader can load the specified file
  141129. */
  141130. canLoad(extension: string): boolean;
  141131. /**
  141132. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  141133. * @param data contains the texture data
  141134. * @param texture defines the BabylonJS internal texture
  141135. * @param createPolynomials will be true if polynomials have been requested
  141136. * @param onLoad defines the callback to trigger once the texture is ready
  141137. * @param onError defines the callback to trigger in case of error
  141138. */
  141139. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  141140. /**
  141141. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  141142. * @param data contains the texture data
  141143. * @param texture defines the BabylonJS internal texture
  141144. * @param callback defines the method to call once ready to upload
  141145. */
  141146. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  141147. }
  141148. }
  141149. declare module BABYLON {
  141150. /**
  141151. * Info about the .basis files
  141152. */
  141153. class BasisFileInfo {
  141154. /**
  141155. * If the file has alpha
  141156. */
  141157. hasAlpha: boolean;
  141158. /**
  141159. * Info about each image of the basis file
  141160. */
  141161. images: Array<{
  141162. levels: Array<{
  141163. width: number;
  141164. height: number;
  141165. transcodedPixels: ArrayBufferView;
  141166. }>;
  141167. }>;
  141168. }
  141169. /**
  141170. * Result of transcoding a basis file
  141171. */
  141172. class TranscodeResult {
  141173. /**
  141174. * Info about the .basis file
  141175. */
  141176. fileInfo: BasisFileInfo;
  141177. /**
  141178. * Format to use when loading the file
  141179. */
  141180. format: number;
  141181. }
  141182. /**
  141183. * Configuration options for the Basis transcoder
  141184. */
  141185. export class BasisTranscodeConfiguration {
  141186. /**
  141187. * Supported compression formats used to determine the supported output format of the transcoder
  141188. */
  141189. supportedCompressionFormats?: {
  141190. /**
  141191. * etc1 compression format
  141192. */
  141193. etc1?: boolean;
  141194. /**
  141195. * s3tc compression format
  141196. */
  141197. s3tc?: boolean;
  141198. /**
  141199. * pvrtc compression format
  141200. */
  141201. pvrtc?: boolean;
  141202. /**
  141203. * etc2 compression format
  141204. */
  141205. etc2?: boolean;
  141206. };
  141207. /**
  141208. * If mipmap levels should be loaded for transcoded images (Default: true)
  141209. */
  141210. loadMipmapLevels?: boolean;
  141211. /**
  141212. * Index of a single image to load (Default: all images)
  141213. */
  141214. loadSingleImage?: number;
  141215. }
  141216. /**
  141217. * Used to load .Basis files
  141218. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  141219. */
  141220. export class BasisTools {
  141221. private static _IgnoreSupportedFormats;
  141222. /**
  141223. * URL to use when loading the basis transcoder
  141224. */
  141225. static JSModuleURL: string;
  141226. /**
  141227. * URL to use when loading the wasm module for the transcoder
  141228. */
  141229. static WasmModuleURL: string;
  141230. /**
  141231. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  141232. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  141233. * @returns internal format corresponding to the Basis format
  141234. */
  141235. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  141236. private static _WorkerPromise;
  141237. private static _Worker;
  141238. private static _actionId;
  141239. private static _CreateWorkerAsync;
  141240. /**
  141241. * Transcodes a loaded image file to compressed pixel data
  141242. * @param data image data to transcode
  141243. * @param config configuration options for the transcoding
  141244. * @returns a promise resulting in the transcoded image
  141245. */
  141246. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  141247. /**
  141248. * Loads a texture from the transcode result
  141249. * @param texture texture load to
  141250. * @param transcodeResult the result of transcoding the basis file to load from
  141251. */
  141252. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  141253. }
  141254. }
  141255. declare module BABYLON {
  141256. /**
  141257. * Loader for .basis file format
  141258. */
  141259. export class _BasisTextureLoader implements IInternalTextureLoader {
  141260. /**
  141261. * Defines whether the loader supports cascade loading the different faces.
  141262. */
  141263. readonly supportCascades: boolean;
  141264. /**
  141265. * This returns if the loader support the current file information.
  141266. * @param extension defines the file extension of the file being loaded
  141267. * @returns true if the loader can load the specified file
  141268. */
  141269. canLoad(extension: string): boolean;
  141270. /**
  141271. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  141272. * @param data contains the texture data
  141273. * @param texture defines the BabylonJS internal texture
  141274. * @param createPolynomials will be true if polynomials have been requested
  141275. * @param onLoad defines the callback to trigger once the texture is ready
  141276. * @param onError defines the callback to trigger in case of error
  141277. */
  141278. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  141279. /**
  141280. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  141281. * @param data contains the texture data
  141282. * @param texture defines the BabylonJS internal texture
  141283. * @param callback defines the method to call once ready to upload
  141284. */
  141285. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  141286. }
  141287. }
  141288. declare module BABYLON {
  141289. /**
  141290. * Defines the basic options interface of a TexturePacker Frame
  141291. */
  141292. export interface ITexturePackerFrame {
  141293. /**
  141294. * The frame ID
  141295. */
  141296. id: number;
  141297. /**
  141298. * The frames Scale
  141299. */
  141300. scale: Vector2;
  141301. /**
  141302. * The Frames offset
  141303. */
  141304. offset: Vector2;
  141305. }
  141306. /**
  141307. * This is a support class for frame Data on texture packer sets.
  141308. */
  141309. export class TexturePackerFrame implements ITexturePackerFrame {
  141310. /**
  141311. * The frame ID
  141312. */
  141313. id: number;
  141314. /**
  141315. * The frames Scale
  141316. */
  141317. scale: Vector2;
  141318. /**
  141319. * The Frames offset
  141320. */
  141321. offset: Vector2;
  141322. /**
  141323. * Initializes a texture package frame.
  141324. * @param id The numerical frame identifier
  141325. * @param scale Scalar Vector2 for UV frame
  141326. * @param offset Vector2 for the frame position in UV units.
  141327. * @returns TexturePackerFrame
  141328. */
  141329. constructor(id: number, scale: Vector2, offset: Vector2);
  141330. }
  141331. }
  141332. declare module BABYLON {
  141333. /**
  141334. * Defines the basic options interface of a TexturePacker
  141335. */
  141336. export interface ITexturePackerOptions {
  141337. /**
  141338. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  141339. */
  141340. map?: string[];
  141341. /**
  141342. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  141343. */
  141344. uvsIn?: string;
  141345. /**
  141346. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  141347. */
  141348. uvsOut?: string;
  141349. /**
  141350. * number representing the layout style. Defaults to LAYOUT_STRIP
  141351. */
  141352. layout?: number;
  141353. /**
  141354. * number of columns if using custom column count layout(2). This defaults to 4.
  141355. */
  141356. colnum?: number;
  141357. /**
  141358. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  141359. */
  141360. updateInputMeshes?: boolean;
  141361. /**
  141362. * boolean flag to dispose all the source textures. Defaults to true.
  141363. */
  141364. disposeSources?: boolean;
  141365. /**
  141366. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  141367. */
  141368. fillBlanks?: boolean;
  141369. /**
  141370. * string value representing the context fill style color. Defaults to 'black'.
  141371. */
  141372. customFillColor?: string;
  141373. /**
  141374. * Width and Height Value of each Frame in the TexturePacker Sets
  141375. */
  141376. frameSize?: number;
  141377. /**
  141378. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  141379. */
  141380. paddingRatio?: number;
  141381. /**
  141382. * Number that declares the fill method for the padding gutter.
  141383. */
  141384. paddingMode?: number;
  141385. /**
  141386. * If in SUBUV_COLOR padding mode what color to use.
  141387. */
  141388. paddingColor?: Color3 | Color4;
  141389. }
  141390. /**
  141391. * Defines the basic interface of a TexturePacker JSON File
  141392. */
  141393. export interface ITexturePackerJSON {
  141394. /**
  141395. * The frame ID
  141396. */
  141397. name: string;
  141398. /**
  141399. * The base64 channel data
  141400. */
  141401. sets: any;
  141402. /**
  141403. * The options of the Packer
  141404. */
  141405. options: ITexturePackerOptions;
  141406. /**
  141407. * The frame data of the Packer
  141408. */
  141409. frames: Array<number>;
  141410. }
  141411. /**
  141412. * This is a support class that generates a series of packed texture sets.
  141413. * @see https://doc.babylonjs.com/babylon101/materials
  141414. */
  141415. export class TexturePacker {
  141416. /** Packer Layout Constant 0 */
  141417. static readonly LAYOUT_STRIP: number;
  141418. /** Packer Layout Constant 1 */
  141419. static readonly LAYOUT_POWER2: number;
  141420. /** Packer Layout Constant 2 */
  141421. static readonly LAYOUT_COLNUM: number;
  141422. /** Packer Layout Constant 0 */
  141423. static readonly SUBUV_WRAP: number;
  141424. /** Packer Layout Constant 1 */
  141425. static readonly SUBUV_EXTEND: number;
  141426. /** Packer Layout Constant 2 */
  141427. static readonly SUBUV_COLOR: number;
  141428. /** The Name of the Texture Package */
  141429. name: string;
  141430. /** The scene scope of the TexturePacker */
  141431. scene: Scene;
  141432. /** The Meshes to target */
  141433. meshes: AbstractMesh[];
  141434. /** Arguments passed with the Constructor */
  141435. options: ITexturePackerOptions;
  141436. /** The promise that is started upon initialization */
  141437. promise: Nullable<Promise<TexturePacker | string>>;
  141438. /** The Container object for the channel sets that are generated */
  141439. sets: object;
  141440. /** The Container array for the frames that are generated */
  141441. frames: TexturePackerFrame[];
  141442. /** The expected number of textures the system is parsing. */
  141443. private _expecting;
  141444. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  141445. private _paddingValue;
  141446. /**
  141447. * Initializes a texture package series from an array of meshes or a single mesh.
  141448. * @param name The name of the package
  141449. * @param meshes The target meshes to compose the package from
  141450. * @param options The arguments that texture packer should follow while building.
  141451. * @param scene The scene which the textures are scoped to.
  141452. * @returns TexturePacker
  141453. */
  141454. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  141455. /**
  141456. * Starts the package process
  141457. * @param resolve The promises resolution function
  141458. * @returns TexturePacker
  141459. */
  141460. private _createFrames;
  141461. /**
  141462. * Calculates the Size of the Channel Sets
  141463. * @returns Vector2
  141464. */
  141465. private _calculateSize;
  141466. /**
  141467. * Calculates the UV data for the frames.
  141468. * @param baseSize the base frameSize
  141469. * @param padding the base frame padding
  141470. * @param dtSize size of the Dynamic Texture for that channel
  141471. * @param dtUnits is 1/dtSize
  141472. * @param update flag to update the input meshes
  141473. */
  141474. private _calculateMeshUVFrames;
  141475. /**
  141476. * Calculates the frames Offset.
  141477. * @param index of the frame
  141478. * @returns Vector2
  141479. */
  141480. private _getFrameOffset;
  141481. /**
  141482. * Updates a Mesh to the frame data
  141483. * @param mesh that is the target
  141484. * @param frameID or the frame index
  141485. */
  141486. private _updateMeshUV;
  141487. /**
  141488. * Updates a Meshes materials to use the texture packer channels
  141489. * @param m is the mesh to target
  141490. * @param force all channels on the packer to be set.
  141491. */
  141492. private _updateTextureReferences;
  141493. /**
  141494. * Public method to set a Mesh to a frame
  141495. * @param m that is the target
  141496. * @param frameID or the frame index
  141497. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  141498. */
  141499. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  141500. /**
  141501. * Starts the async promise to compile the texture packer.
  141502. * @returns Promise<void>
  141503. */
  141504. processAsync(): Promise<void>;
  141505. /**
  141506. * Disposes all textures associated with this packer
  141507. */
  141508. dispose(): void;
  141509. /**
  141510. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  141511. * @param imageType is the image type to use.
  141512. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  141513. */
  141514. download(imageType?: string, quality?: number): void;
  141515. /**
  141516. * Public method to load a texturePacker JSON file.
  141517. * @param data of the JSON file in string format.
  141518. */
  141519. updateFromJSON(data: string): void;
  141520. }
  141521. }
  141522. declare module BABYLON {
  141523. /**
  141524. * 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.
  141525. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  141526. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  141527. */
  141528. export class CustomProceduralTexture extends ProceduralTexture {
  141529. private _animate;
  141530. private _time;
  141531. private _config;
  141532. private _texturePath;
  141533. /**
  141534. * Instantiates a new Custom Procedural Texture.
  141535. * 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.
  141536. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  141537. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  141538. * @param name Define the name of the texture
  141539. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  141540. * @param size Define the size of the texture to create
  141541. * @param scene Define the scene the texture belongs to
  141542. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  141543. * @param generateMipMaps Define if the texture should creates mip maps or not
  141544. */
  141545. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  141546. private _loadJson;
  141547. /**
  141548. * Is the texture ready to be used ? (rendered at least once)
  141549. * @returns true if ready, otherwise, false.
  141550. */
  141551. isReady(): boolean;
  141552. /**
  141553. * Render the texture to its associated render target.
  141554. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  141555. */
  141556. render(useCameraPostProcess?: boolean): void;
  141557. /**
  141558. * Update the list of dependant textures samplers in the shader.
  141559. */
  141560. updateTextures(): void;
  141561. /**
  141562. * Update the uniform values of the procedural texture in the shader.
  141563. */
  141564. updateShaderUniforms(): void;
  141565. /**
  141566. * Define if the texture animates or not.
  141567. */
  141568. get animate(): boolean;
  141569. set animate(value: boolean);
  141570. }
  141571. }
  141572. declare module BABYLON {
  141573. /** @hidden */
  141574. export var noisePixelShader: {
  141575. name: string;
  141576. shader: string;
  141577. };
  141578. }
  141579. declare module BABYLON {
  141580. /**
  141581. * Class used to generate noise procedural textures
  141582. */
  141583. export class NoiseProceduralTexture extends ProceduralTexture {
  141584. private _time;
  141585. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  141586. brightness: number;
  141587. /** Defines the number of octaves to process */
  141588. octaves: number;
  141589. /** Defines the level of persistence (0.8 by default) */
  141590. persistence: number;
  141591. /** Gets or sets animation speed factor (default is 1) */
  141592. animationSpeedFactor: number;
  141593. /**
  141594. * Creates a new NoiseProceduralTexture
  141595. * @param name defines the name fo the texture
  141596. * @param size defines the size of the texture (default is 256)
  141597. * @param scene defines the hosting scene
  141598. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  141599. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  141600. */
  141601. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  141602. private _updateShaderUniforms;
  141603. protected _getDefines(): string;
  141604. /** Generate the current state of the procedural texture */
  141605. render(useCameraPostProcess?: boolean): void;
  141606. /**
  141607. * Serializes this noise procedural texture
  141608. * @returns a serialized noise procedural texture object
  141609. */
  141610. serialize(): any;
  141611. /**
  141612. * Clone the texture.
  141613. * @returns the cloned texture
  141614. */
  141615. clone(): NoiseProceduralTexture;
  141616. /**
  141617. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  141618. * @param parsedTexture defines parsed texture data
  141619. * @param scene defines the current scene
  141620. * @param rootUrl defines the root URL containing noise procedural texture information
  141621. * @returns a parsed NoiseProceduralTexture
  141622. */
  141623. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  141624. }
  141625. }
  141626. declare module BABYLON {
  141627. /**
  141628. * Raw cube texture where the raw buffers are passed in
  141629. */
  141630. export class RawCubeTexture extends CubeTexture {
  141631. /**
  141632. * Creates a cube texture where the raw buffers are passed in.
  141633. * @param scene defines the scene the texture is attached to
  141634. * @param data defines the array of data to use to create each face
  141635. * @param size defines the size of the textures
  141636. * @param format defines the format of the data
  141637. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  141638. * @param generateMipMaps defines if the engine should generate the mip levels
  141639. * @param invertY defines if data must be stored with Y axis inverted
  141640. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  141641. * @param compression defines the compression used (null by default)
  141642. */
  141643. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  141644. /**
  141645. * Updates the raw cube texture.
  141646. * @param data defines the data to store
  141647. * @param format defines the data format
  141648. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  141649. * @param invertY defines if data must be stored with Y axis inverted
  141650. * @param compression defines the compression used (null by default)
  141651. * @param level defines which level of the texture to update
  141652. */
  141653. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  141654. /**
  141655. * Updates a raw cube texture with RGBD encoded data.
  141656. * @param data defines the array of data [mipmap][face] to use to create each face
  141657. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  141658. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  141659. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  141660. * @returns a promsie that resolves when the operation is complete
  141661. */
  141662. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  141663. /**
  141664. * Clones the raw cube texture.
  141665. * @return a new cube texture
  141666. */
  141667. clone(): CubeTexture;
  141668. /** @hidden */
  141669. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  141670. }
  141671. }
  141672. declare module BABYLON {
  141673. /**
  141674. * Class used to store 2D array textures containing user data
  141675. */
  141676. export class RawTexture2DArray extends Texture {
  141677. /** Gets or sets the texture format to use */
  141678. format: number;
  141679. /**
  141680. * Create a new RawTexture2DArray
  141681. * @param data defines the data of the texture
  141682. * @param width defines the width of the texture
  141683. * @param height defines the height of the texture
  141684. * @param depth defines the number of layers of the texture
  141685. * @param format defines the texture format to use
  141686. * @param scene defines the hosting scene
  141687. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  141688. * @param invertY defines if texture must be stored with Y axis inverted
  141689. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  141690. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  141691. */
  141692. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  141693. /** Gets or sets the texture format to use */
  141694. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  141695. /**
  141696. * Update the texture with new data
  141697. * @param data defines the data to store in the texture
  141698. */
  141699. update(data: ArrayBufferView): void;
  141700. }
  141701. }
  141702. declare module BABYLON {
  141703. /**
  141704. * Class used to store 3D textures containing user data
  141705. */
  141706. export class RawTexture3D extends Texture {
  141707. /** Gets or sets the texture format to use */
  141708. format: number;
  141709. /**
  141710. * Create a new RawTexture3D
  141711. * @param data defines the data of the texture
  141712. * @param width defines the width of the texture
  141713. * @param height defines the height of the texture
  141714. * @param depth defines the depth of the texture
  141715. * @param format defines the texture format to use
  141716. * @param scene defines the hosting scene
  141717. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  141718. * @param invertY defines if texture must be stored with Y axis inverted
  141719. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  141720. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  141721. */
  141722. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  141723. /** Gets or sets the texture format to use */
  141724. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  141725. /**
  141726. * Update the texture with new data
  141727. * @param data defines the data to store in the texture
  141728. */
  141729. update(data: ArrayBufferView): void;
  141730. }
  141731. }
  141732. declare module BABYLON {
  141733. /**
  141734. * Creates a refraction texture used by refraction channel of the standard material.
  141735. * It is like a mirror but to see through a material.
  141736. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  141737. */
  141738. export class RefractionTexture extends RenderTargetTexture {
  141739. /**
  141740. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  141741. * 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.
  141742. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  141743. */
  141744. refractionPlane: Plane;
  141745. /**
  141746. * Define how deep under the surface we should see.
  141747. */
  141748. depth: number;
  141749. /**
  141750. * Creates a refraction texture used by refraction channel of the standard material.
  141751. * It is like a mirror but to see through a material.
  141752. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  141753. * @param name Define the texture name
  141754. * @param size Define the size of the underlying texture
  141755. * @param scene Define the scene the refraction belongs to
  141756. * @param generateMipMaps Define if we need to generate mips level for the refraction
  141757. */
  141758. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  141759. /**
  141760. * Clone the refraction texture.
  141761. * @returns the cloned texture
  141762. */
  141763. clone(): RefractionTexture;
  141764. /**
  141765. * Serialize the texture to a JSON representation you could use in Parse later on
  141766. * @returns the serialized JSON representation
  141767. */
  141768. serialize(): any;
  141769. }
  141770. }
  141771. declare module BABYLON {
  141772. /**
  141773. * Block used to add support for vertex skinning (bones)
  141774. */
  141775. export class BonesBlock extends NodeMaterialBlock {
  141776. /**
  141777. * Creates a new BonesBlock
  141778. * @param name defines the block name
  141779. */
  141780. constructor(name: string);
  141781. /**
  141782. * Initialize the block and prepare the context for build
  141783. * @param state defines the state that will be used for the build
  141784. */
  141785. initialize(state: NodeMaterialBuildState): void;
  141786. /**
  141787. * Gets the current class name
  141788. * @returns the class name
  141789. */
  141790. getClassName(): string;
  141791. /**
  141792. * Gets the matrix indices input component
  141793. */
  141794. get matricesIndices(): NodeMaterialConnectionPoint;
  141795. /**
  141796. * Gets the matrix weights input component
  141797. */
  141798. get matricesWeights(): NodeMaterialConnectionPoint;
  141799. /**
  141800. * Gets the extra matrix indices input component
  141801. */
  141802. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  141803. /**
  141804. * Gets the extra matrix weights input component
  141805. */
  141806. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  141807. /**
  141808. * Gets the world input component
  141809. */
  141810. get world(): NodeMaterialConnectionPoint;
  141811. /**
  141812. * Gets the output component
  141813. */
  141814. get output(): NodeMaterialConnectionPoint;
  141815. autoConfigure(material: NodeMaterial): void;
  141816. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  141817. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141818. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141819. protected _buildBlock(state: NodeMaterialBuildState): this;
  141820. }
  141821. }
  141822. declare module BABYLON {
  141823. /**
  141824. * Block used to add support for instances
  141825. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  141826. */
  141827. export class InstancesBlock extends NodeMaterialBlock {
  141828. /**
  141829. * Creates a new InstancesBlock
  141830. * @param name defines the block name
  141831. */
  141832. constructor(name: string);
  141833. /**
  141834. * Gets the current class name
  141835. * @returns the class name
  141836. */
  141837. getClassName(): string;
  141838. /**
  141839. * Gets the first world row input component
  141840. */
  141841. get world0(): NodeMaterialConnectionPoint;
  141842. /**
  141843. * Gets the second world row input component
  141844. */
  141845. get world1(): NodeMaterialConnectionPoint;
  141846. /**
  141847. * Gets the third world row input component
  141848. */
  141849. get world2(): NodeMaterialConnectionPoint;
  141850. /**
  141851. * Gets the forth world row input component
  141852. */
  141853. get world3(): NodeMaterialConnectionPoint;
  141854. /**
  141855. * Gets the world input component
  141856. */
  141857. get world(): NodeMaterialConnectionPoint;
  141858. /**
  141859. * Gets the output component
  141860. */
  141861. get output(): NodeMaterialConnectionPoint;
  141862. /**
  141863. * Gets the isntanceID component
  141864. */
  141865. get instanceID(): NodeMaterialConnectionPoint;
  141866. autoConfigure(material: NodeMaterial): void;
  141867. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  141868. protected _buildBlock(state: NodeMaterialBuildState): this;
  141869. }
  141870. }
  141871. declare module BABYLON {
  141872. /**
  141873. * Block used to add morph targets support to vertex shader
  141874. */
  141875. export class MorphTargetsBlock extends NodeMaterialBlock {
  141876. private _repeatableContentAnchor;
  141877. /**
  141878. * Create a new MorphTargetsBlock
  141879. * @param name defines the block name
  141880. */
  141881. constructor(name: string);
  141882. /**
  141883. * Gets the current class name
  141884. * @returns the class name
  141885. */
  141886. getClassName(): string;
  141887. /**
  141888. * Gets the position input component
  141889. */
  141890. get position(): NodeMaterialConnectionPoint;
  141891. /**
  141892. * Gets the normal input component
  141893. */
  141894. get normal(): NodeMaterialConnectionPoint;
  141895. /**
  141896. * Gets the tangent input component
  141897. */
  141898. get tangent(): NodeMaterialConnectionPoint;
  141899. /**
  141900. * Gets the tangent input component
  141901. */
  141902. get uv(): NodeMaterialConnectionPoint;
  141903. /**
  141904. * Gets the position output component
  141905. */
  141906. get positionOutput(): NodeMaterialConnectionPoint;
  141907. /**
  141908. * Gets the normal output component
  141909. */
  141910. get normalOutput(): NodeMaterialConnectionPoint;
  141911. /**
  141912. * Gets the tangent output component
  141913. */
  141914. get tangentOutput(): NodeMaterialConnectionPoint;
  141915. /**
  141916. * Gets the tangent output component
  141917. */
  141918. get uvOutput(): NodeMaterialConnectionPoint;
  141919. initialize(state: NodeMaterialBuildState): void;
  141920. autoConfigure(material: NodeMaterial): void;
  141921. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141922. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141923. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  141924. protected _buildBlock(state: NodeMaterialBuildState): this;
  141925. }
  141926. }
  141927. declare module BABYLON {
  141928. /**
  141929. * Block used to get data information from a light
  141930. */
  141931. export class LightInformationBlock extends NodeMaterialBlock {
  141932. private _lightDataUniformName;
  141933. private _lightColorUniformName;
  141934. private _lightTypeDefineName;
  141935. /**
  141936. * Gets or sets the light associated with this block
  141937. */
  141938. light: Nullable<Light>;
  141939. /**
  141940. * Creates a new LightInformationBlock
  141941. * @param name defines the block name
  141942. */
  141943. constructor(name: string);
  141944. /**
  141945. * Gets the current class name
  141946. * @returns the class name
  141947. */
  141948. getClassName(): string;
  141949. /**
  141950. * Gets the world position input component
  141951. */
  141952. get worldPosition(): NodeMaterialConnectionPoint;
  141953. /**
  141954. * Gets the direction output component
  141955. */
  141956. get direction(): NodeMaterialConnectionPoint;
  141957. /**
  141958. * Gets the direction output component
  141959. */
  141960. get color(): NodeMaterialConnectionPoint;
  141961. /**
  141962. * Gets the direction output component
  141963. */
  141964. get intensity(): NodeMaterialConnectionPoint;
  141965. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141966. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141967. protected _buildBlock(state: NodeMaterialBuildState): this;
  141968. serialize(): any;
  141969. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  141970. }
  141971. }
  141972. declare module BABYLON {
  141973. /**
  141974. * Block used to add image processing support to fragment shader
  141975. */
  141976. export class ImageProcessingBlock extends NodeMaterialBlock {
  141977. /**
  141978. * Create a new ImageProcessingBlock
  141979. * @param name defines the block name
  141980. */
  141981. constructor(name: string);
  141982. /**
  141983. * Gets the current class name
  141984. * @returns the class name
  141985. */
  141986. getClassName(): string;
  141987. /**
  141988. * Gets the color input component
  141989. */
  141990. get color(): NodeMaterialConnectionPoint;
  141991. /**
  141992. * Gets the output component
  141993. */
  141994. get output(): NodeMaterialConnectionPoint;
  141995. /**
  141996. * Initialize the block and prepare the context for build
  141997. * @param state defines the state that will be used for the build
  141998. */
  141999. initialize(state: NodeMaterialBuildState): void;
  142000. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  142001. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142002. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142003. protected _buildBlock(state: NodeMaterialBuildState): this;
  142004. }
  142005. }
  142006. declare module BABYLON {
  142007. /**
  142008. * Block used to pertub normals based on a normal map
  142009. */
  142010. export class PerturbNormalBlock extends NodeMaterialBlock {
  142011. private _tangentSpaceParameterName;
  142012. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  142013. invertX: boolean;
  142014. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  142015. invertY: boolean;
  142016. /**
  142017. * Create a new PerturbNormalBlock
  142018. * @param name defines the block name
  142019. */
  142020. constructor(name: string);
  142021. /**
  142022. * Gets the current class name
  142023. * @returns the class name
  142024. */
  142025. getClassName(): string;
  142026. /**
  142027. * Gets the world position input component
  142028. */
  142029. get worldPosition(): NodeMaterialConnectionPoint;
  142030. /**
  142031. * Gets the world normal input component
  142032. */
  142033. get worldNormal(): NodeMaterialConnectionPoint;
  142034. /**
  142035. * Gets the world tangent input component
  142036. */
  142037. get worldTangent(): NodeMaterialConnectionPoint;
  142038. /**
  142039. * Gets the uv input component
  142040. */
  142041. get uv(): NodeMaterialConnectionPoint;
  142042. /**
  142043. * Gets the normal map color input component
  142044. */
  142045. get normalMapColor(): NodeMaterialConnectionPoint;
  142046. /**
  142047. * Gets the strength input component
  142048. */
  142049. get strength(): NodeMaterialConnectionPoint;
  142050. /**
  142051. * Gets the output component
  142052. */
  142053. get output(): NodeMaterialConnectionPoint;
  142054. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142055. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142056. autoConfigure(material: NodeMaterial): void;
  142057. protected _buildBlock(state: NodeMaterialBuildState): this;
  142058. protected _dumpPropertiesCode(): string;
  142059. serialize(): any;
  142060. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142061. }
  142062. }
  142063. declare module BABYLON {
  142064. /**
  142065. * Block used to discard a pixel if a value is smaller than a cutoff
  142066. */
  142067. export class DiscardBlock extends NodeMaterialBlock {
  142068. /**
  142069. * Create a new DiscardBlock
  142070. * @param name defines the block name
  142071. */
  142072. constructor(name: string);
  142073. /**
  142074. * Gets the current class name
  142075. * @returns the class name
  142076. */
  142077. getClassName(): string;
  142078. /**
  142079. * Gets the color input component
  142080. */
  142081. get value(): NodeMaterialConnectionPoint;
  142082. /**
  142083. * Gets the cutoff input component
  142084. */
  142085. get cutoff(): NodeMaterialConnectionPoint;
  142086. protected _buildBlock(state: NodeMaterialBuildState): this;
  142087. }
  142088. }
  142089. declare module BABYLON {
  142090. /**
  142091. * Block used to test if the fragment shader is front facing
  142092. */
  142093. export class FrontFacingBlock extends NodeMaterialBlock {
  142094. /**
  142095. * Creates a new FrontFacingBlock
  142096. * @param name defines the block name
  142097. */
  142098. constructor(name: string);
  142099. /**
  142100. * Gets the current class name
  142101. * @returns the class name
  142102. */
  142103. getClassName(): string;
  142104. /**
  142105. * Gets the output component
  142106. */
  142107. get output(): NodeMaterialConnectionPoint;
  142108. protected _buildBlock(state: NodeMaterialBuildState): this;
  142109. }
  142110. }
  142111. declare module BABYLON {
  142112. /**
  142113. * Block used to get the derivative value on x and y of a given input
  142114. */
  142115. export class DerivativeBlock extends NodeMaterialBlock {
  142116. /**
  142117. * Create a new DerivativeBlock
  142118. * @param name defines the block name
  142119. */
  142120. constructor(name: string);
  142121. /**
  142122. * Gets the current class name
  142123. * @returns the class name
  142124. */
  142125. getClassName(): string;
  142126. /**
  142127. * Gets the input component
  142128. */
  142129. get input(): NodeMaterialConnectionPoint;
  142130. /**
  142131. * Gets the derivative output on x
  142132. */
  142133. get dx(): NodeMaterialConnectionPoint;
  142134. /**
  142135. * Gets the derivative output on y
  142136. */
  142137. get dy(): NodeMaterialConnectionPoint;
  142138. protected _buildBlock(state: NodeMaterialBuildState): this;
  142139. }
  142140. }
  142141. declare module BABYLON {
  142142. /**
  142143. * Block used to make gl_FragCoord available
  142144. */
  142145. export class FragCoordBlock extends NodeMaterialBlock {
  142146. /**
  142147. * Creates a new FragCoordBlock
  142148. * @param name defines the block name
  142149. */
  142150. constructor(name: string);
  142151. /**
  142152. * Gets the current class name
  142153. * @returns the class name
  142154. */
  142155. getClassName(): string;
  142156. /**
  142157. * Gets the xy component
  142158. */
  142159. get xy(): NodeMaterialConnectionPoint;
  142160. /**
  142161. * Gets the xyz component
  142162. */
  142163. get xyz(): NodeMaterialConnectionPoint;
  142164. /**
  142165. * Gets the xyzw component
  142166. */
  142167. get xyzw(): NodeMaterialConnectionPoint;
  142168. /**
  142169. * Gets the x component
  142170. */
  142171. get x(): NodeMaterialConnectionPoint;
  142172. /**
  142173. * Gets the y component
  142174. */
  142175. get y(): NodeMaterialConnectionPoint;
  142176. /**
  142177. * Gets the z component
  142178. */
  142179. get z(): NodeMaterialConnectionPoint;
  142180. /**
  142181. * Gets the w component
  142182. */
  142183. get output(): NodeMaterialConnectionPoint;
  142184. protected writeOutputs(state: NodeMaterialBuildState): string;
  142185. protected _buildBlock(state: NodeMaterialBuildState): this;
  142186. }
  142187. }
  142188. declare module BABYLON {
  142189. /**
  142190. * Block used to get the screen sizes
  142191. */
  142192. export class ScreenSizeBlock extends NodeMaterialBlock {
  142193. private _varName;
  142194. private _scene;
  142195. /**
  142196. * Creates a new ScreenSizeBlock
  142197. * @param name defines the block name
  142198. */
  142199. constructor(name: string);
  142200. /**
  142201. * Gets the current class name
  142202. * @returns the class name
  142203. */
  142204. getClassName(): string;
  142205. /**
  142206. * Gets the xy component
  142207. */
  142208. get xy(): NodeMaterialConnectionPoint;
  142209. /**
  142210. * Gets the x component
  142211. */
  142212. get x(): NodeMaterialConnectionPoint;
  142213. /**
  142214. * Gets the y component
  142215. */
  142216. get y(): NodeMaterialConnectionPoint;
  142217. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142218. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  142219. protected _buildBlock(state: NodeMaterialBuildState): this;
  142220. }
  142221. }
  142222. declare module BABYLON {
  142223. /**
  142224. * Block used to add support for scene fog
  142225. */
  142226. export class FogBlock extends NodeMaterialBlock {
  142227. private _fogDistanceName;
  142228. private _fogParameters;
  142229. /**
  142230. * Create a new FogBlock
  142231. * @param name defines the block name
  142232. */
  142233. constructor(name: string);
  142234. /**
  142235. * Gets the current class name
  142236. * @returns the class name
  142237. */
  142238. getClassName(): string;
  142239. /**
  142240. * Gets the world position input component
  142241. */
  142242. get worldPosition(): NodeMaterialConnectionPoint;
  142243. /**
  142244. * Gets the view input component
  142245. */
  142246. get view(): NodeMaterialConnectionPoint;
  142247. /**
  142248. * Gets the color input component
  142249. */
  142250. get input(): NodeMaterialConnectionPoint;
  142251. /**
  142252. * Gets the fog color input component
  142253. */
  142254. get fogColor(): NodeMaterialConnectionPoint;
  142255. /**
  142256. * Gets the output component
  142257. */
  142258. get output(): NodeMaterialConnectionPoint;
  142259. autoConfigure(material: NodeMaterial): void;
  142260. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142261. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142262. protected _buildBlock(state: NodeMaterialBuildState): this;
  142263. }
  142264. }
  142265. declare module BABYLON {
  142266. /**
  142267. * Block used to add light in the fragment shader
  142268. */
  142269. export class LightBlock extends NodeMaterialBlock {
  142270. private _lightId;
  142271. /**
  142272. * Gets or sets the light associated with this block
  142273. */
  142274. light: Nullable<Light>;
  142275. /**
  142276. * Create a new LightBlock
  142277. * @param name defines the block name
  142278. */
  142279. constructor(name: string);
  142280. /**
  142281. * Gets the current class name
  142282. * @returns the class name
  142283. */
  142284. getClassName(): string;
  142285. /**
  142286. * Gets the world position input component
  142287. */
  142288. get worldPosition(): NodeMaterialConnectionPoint;
  142289. /**
  142290. * Gets the world normal input component
  142291. */
  142292. get worldNormal(): NodeMaterialConnectionPoint;
  142293. /**
  142294. * Gets the camera (or eye) position component
  142295. */
  142296. get cameraPosition(): NodeMaterialConnectionPoint;
  142297. /**
  142298. * Gets the glossiness component
  142299. */
  142300. get glossiness(): NodeMaterialConnectionPoint;
  142301. /**
  142302. * Gets the glossinness power component
  142303. */
  142304. get glossPower(): NodeMaterialConnectionPoint;
  142305. /**
  142306. * Gets the diffuse color component
  142307. */
  142308. get diffuseColor(): NodeMaterialConnectionPoint;
  142309. /**
  142310. * Gets the specular color component
  142311. */
  142312. get specularColor(): NodeMaterialConnectionPoint;
  142313. /**
  142314. * Gets the diffuse output component
  142315. */
  142316. get diffuseOutput(): NodeMaterialConnectionPoint;
  142317. /**
  142318. * Gets the specular output component
  142319. */
  142320. get specularOutput(): NodeMaterialConnectionPoint;
  142321. /**
  142322. * Gets the shadow output component
  142323. */
  142324. get shadow(): NodeMaterialConnectionPoint;
  142325. autoConfigure(material: NodeMaterial): void;
  142326. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142327. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  142328. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142329. private _injectVertexCode;
  142330. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  142331. serialize(): any;
  142332. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142333. }
  142334. }
  142335. declare module BABYLON {
  142336. /**
  142337. * Block used to read a reflection texture from a sampler
  142338. */
  142339. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  142340. /**
  142341. * Create a new ReflectionTextureBlock
  142342. * @param name defines the block name
  142343. */
  142344. constructor(name: string);
  142345. /**
  142346. * Gets the current class name
  142347. * @returns the class name
  142348. */
  142349. getClassName(): string;
  142350. /**
  142351. * Gets the world position input component
  142352. */
  142353. get position(): NodeMaterialConnectionPoint;
  142354. /**
  142355. * Gets the world position input component
  142356. */
  142357. get worldPosition(): NodeMaterialConnectionPoint;
  142358. /**
  142359. * Gets the world normal input component
  142360. */
  142361. get worldNormal(): NodeMaterialConnectionPoint;
  142362. /**
  142363. * Gets the world input component
  142364. */
  142365. get world(): NodeMaterialConnectionPoint;
  142366. /**
  142367. * Gets the camera (or eye) position component
  142368. */
  142369. get cameraPosition(): NodeMaterialConnectionPoint;
  142370. /**
  142371. * Gets the view input component
  142372. */
  142373. get view(): NodeMaterialConnectionPoint;
  142374. /**
  142375. * Gets the rgb output component
  142376. */
  142377. get rgb(): NodeMaterialConnectionPoint;
  142378. /**
  142379. * Gets the rgba output component
  142380. */
  142381. get rgba(): NodeMaterialConnectionPoint;
  142382. /**
  142383. * Gets the r output component
  142384. */
  142385. get r(): NodeMaterialConnectionPoint;
  142386. /**
  142387. * Gets the g output component
  142388. */
  142389. get g(): NodeMaterialConnectionPoint;
  142390. /**
  142391. * Gets the b output component
  142392. */
  142393. get b(): NodeMaterialConnectionPoint;
  142394. /**
  142395. * Gets the a output component
  142396. */
  142397. get a(): NodeMaterialConnectionPoint;
  142398. autoConfigure(material: NodeMaterial): void;
  142399. protected _buildBlock(state: NodeMaterialBuildState): this;
  142400. }
  142401. }
  142402. declare module BABYLON {
  142403. /**
  142404. * Block used to add 2 vectors
  142405. */
  142406. export class AddBlock extends NodeMaterialBlock {
  142407. /**
  142408. * Creates a new AddBlock
  142409. * @param name defines the block name
  142410. */
  142411. constructor(name: string);
  142412. /**
  142413. * Gets the current class name
  142414. * @returns the class name
  142415. */
  142416. getClassName(): string;
  142417. /**
  142418. * Gets the left operand input component
  142419. */
  142420. get left(): NodeMaterialConnectionPoint;
  142421. /**
  142422. * Gets the right operand input component
  142423. */
  142424. get right(): NodeMaterialConnectionPoint;
  142425. /**
  142426. * Gets the output component
  142427. */
  142428. get output(): NodeMaterialConnectionPoint;
  142429. protected _buildBlock(state: NodeMaterialBuildState): this;
  142430. }
  142431. }
  142432. declare module BABYLON {
  142433. /**
  142434. * Block used to scale a vector by a float
  142435. */
  142436. export class ScaleBlock extends NodeMaterialBlock {
  142437. /**
  142438. * Creates a new ScaleBlock
  142439. * @param name defines the block name
  142440. */
  142441. constructor(name: string);
  142442. /**
  142443. * Gets the current class name
  142444. * @returns the class name
  142445. */
  142446. getClassName(): string;
  142447. /**
  142448. * Gets the input component
  142449. */
  142450. get input(): NodeMaterialConnectionPoint;
  142451. /**
  142452. * Gets the factor input component
  142453. */
  142454. get factor(): NodeMaterialConnectionPoint;
  142455. /**
  142456. * Gets the output component
  142457. */
  142458. get output(): NodeMaterialConnectionPoint;
  142459. protected _buildBlock(state: NodeMaterialBuildState): this;
  142460. }
  142461. }
  142462. declare module BABYLON {
  142463. /**
  142464. * Block used to clamp a float
  142465. */
  142466. export class ClampBlock extends NodeMaterialBlock {
  142467. /** Gets or sets the minimum range */
  142468. minimum: number;
  142469. /** Gets or sets the maximum range */
  142470. maximum: number;
  142471. /**
  142472. * Creates a new ClampBlock
  142473. * @param name defines the block name
  142474. */
  142475. constructor(name: string);
  142476. /**
  142477. * Gets the current class name
  142478. * @returns the class name
  142479. */
  142480. getClassName(): string;
  142481. /**
  142482. * Gets the value input component
  142483. */
  142484. get value(): NodeMaterialConnectionPoint;
  142485. /**
  142486. * Gets the output component
  142487. */
  142488. get output(): NodeMaterialConnectionPoint;
  142489. protected _buildBlock(state: NodeMaterialBuildState): this;
  142490. protected _dumpPropertiesCode(): string;
  142491. serialize(): any;
  142492. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142493. }
  142494. }
  142495. declare module BABYLON {
  142496. /**
  142497. * Block used to apply a cross product between 2 vectors
  142498. */
  142499. export class CrossBlock extends NodeMaterialBlock {
  142500. /**
  142501. * Creates a new CrossBlock
  142502. * @param name defines the block name
  142503. */
  142504. constructor(name: string);
  142505. /**
  142506. * Gets the current class name
  142507. * @returns the class name
  142508. */
  142509. getClassName(): string;
  142510. /**
  142511. * Gets the left operand input component
  142512. */
  142513. get left(): NodeMaterialConnectionPoint;
  142514. /**
  142515. * Gets the right operand input component
  142516. */
  142517. get right(): NodeMaterialConnectionPoint;
  142518. /**
  142519. * Gets the output component
  142520. */
  142521. get output(): NodeMaterialConnectionPoint;
  142522. protected _buildBlock(state: NodeMaterialBuildState): this;
  142523. }
  142524. }
  142525. declare module BABYLON {
  142526. /**
  142527. * Block used to apply a dot product between 2 vectors
  142528. */
  142529. export class DotBlock extends NodeMaterialBlock {
  142530. /**
  142531. * Creates a new DotBlock
  142532. * @param name defines the block name
  142533. */
  142534. constructor(name: string);
  142535. /**
  142536. * Gets the current class name
  142537. * @returns the class name
  142538. */
  142539. getClassName(): string;
  142540. /**
  142541. * Gets the left operand input component
  142542. */
  142543. get left(): NodeMaterialConnectionPoint;
  142544. /**
  142545. * Gets the right operand input component
  142546. */
  142547. get right(): NodeMaterialConnectionPoint;
  142548. /**
  142549. * Gets the output component
  142550. */
  142551. get output(): NodeMaterialConnectionPoint;
  142552. protected _buildBlock(state: NodeMaterialBuildState): this;
  142553. }
  142554. }
  142555. declare module BABYLON {
  142556. /**
  142557. * Block used to normalize a vector
  142558. */
  142559. export class NormalizeBlock extends NodeMaterialBlock {
  142560. /**
  142561. * Creates a new NormalizeBlock
  142562. * @param name defines the block name
  142563. */
  142564. constructor(name: string);
  142565. /**
  142566. * Gets the current class name
  142567. * @returns the class name
  142568. */
  142569. getClassName(): string;
  142570. /**
  142571. * Gets the input component
  142572. */
  142573. get input(): NodeMaterialConnectionPoint;
  142574. /**
  142575. * Gets the output component
  142576. */
  142577. get output(): NodeMaterialConnectionPoint;
  142578. protected _buildBlock(state: NodeMaterialBuildState): this;
  142579. }
  142580. }
  142581. declare module BABYLON {
  142582. /**
  142583. * Operations supported by the Trigonometry block
  142584. */
  142585. export enum TrigonometryBlockOperations {
  142586. /** Cos */
  142587. Cos = 0,
  142588. /** Sin */
  142589. Sin = 1,
  142590. /** Abs */
  142591. Abs = 2,
  142592. /** Exp */
  142593. Exp = 3,
  142594. /** Exp2 */
  142595. Exp2 = 4,
  142596. /** Round */
  142597. Round = 5,
  142598. /** Floor */
  142599. Floor = 6,
  142600. /** Ceiling */
  142601. Ceiling = 7,
  142602. /** Square root */
  142603. Sqrt = 8,
  142604. /** Log */
  142605. Log = 9,
  142606. /** Tangent */
  142607. Tan = 10,
  142608. /** Arc tangent */
  142609. ArcTan = 11,
  142610. /** Arc cosinus */
  142611. ArcCos = 12,
  142612. /** Arc sinus */
  142613. ArcSin = 13,
  142614. /** Fraction */
  142615. Fract = 14,
  142616. /** Sign */
  142617. Sign = 15,
  142618. /** To radians (from degrees) */
  142619. Radians = 16,
  142620. /** To degrees (from radians) */
  142621. Degrees = 17
  142622. }
  142623. /**
  142624. * Block used to apply trigonometry operation to floats
  142625. */
  142626. export class TrigonometryBlock extends NodeMaterialBlock {
  142627. /**
  142628. * Gets or sets the operation applied by the block
  142629. */
  142630. operation: TrigonometryBlockOperations;
  142631. /**
  142632. * Creates a new TrigonometryBlock
  142633. * @param name defines the block name
  142634. */
  142635. constructor(name: string);
  142636. /**
  142637. * Gets the current class name
  142638. * @returns the class name
  142639. */
  142640. getClassName(): string;
  142641. /**
  142642. * Gets the input component
  142643. */
  142644. get input(): NodeMaterialConnectionPoint;
  142645. /**
  142646. * Gets the output component
  142647. */
  142648. get output(): NodeMaterialConnectionPoint;
  142649. protected _buildBlock(state: NodeMaterialBuildState): this;
  142650. serialize(): any;
  142651. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142652. protected _dumpPropertiesCode(): string;
  142653. }
  142654. }
  142655. declare module BABYLON {
  142656. /**
  142657. * Block used to create a Color3/4 out of individual inputs (one for each component)
  142658. */
  142659. export class ColorMergerBlock extends NodeMaterialBlock {
  142660. /**
  142661. * Create a new ColorMergerBlock
  142662. * @param name defines the block name
  142663. */
  142664. constructor(name: string);
  142665. /**
  142666. * Gets the current class name
  142667. * @returns the class name
  142668. */
  142669. getClassName(): string;
  142670. /**
  142671. * Gets the rgb component (input)
  142672. */
  142673. get rgbIn(): NodeMaterialConnectionPoint;
  142674. /**
  142675. * Gets the r component (input)
  142676. */
  142677. get r(): NodeMaterialConnectionPoint;
  142678. /**
  142679. * Gets the g component (input)
  142680. */
  142681. get g(): NodeMaterialConnectionPoint;
  142682. /**
  142683. * Gets the b component (input)
  142684. */
  142685. get b(): NodeMaterialConnectionPoint;
  142686. /**
  142687. * Gets the a component (input)
  142688. */
  142689. get a(): NodeMaterialConnectionPoint;
  142690. /**
  142691. * Gets the rgba component (output)
  142692. */
  142693. get rgba(): NodeMaterialConnectionPoint;
  142694. /**
  142695. * Gets the rgb component (output)
  142696. */
  142697. get rgbOut(): NodeMaterialConnectionPoint;
  142698. /**
  142699. * Gets the rgb component (output)
  142700. * @deprecated Please use rgbOut instead.
  142701. */
  142702. get rgb(): NodeMaterialConnectionPoint;
  142703. protected _buildBlock(state: NodeMaterialBuildState): this;
  142704. }
  142705. }
  142706. declare module BABYLON {
  142707. /**
  142708. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  142709. */
  142710. export class VectorSplitterBlock extends NodeMaterialBlock {
  142711. /**
  142712. * Create a new VectorSplitterBlock
  142713. * @param name defines the block name
  142714. */
  142715. constructor(name: string);
  142716. /**
  142717. * Gets the current class name
  142718. * @returns the class name
  142719. */
  142720. getClassName(): string;
  142721. /**
  142722. * Gets the xyzw component (input)
  142723. */
  142724. get xyzw(): NodeMaterialConnectionPoint;
  142725. /**
  142726. * Gets the xyz component (input)
  142727. */
  142728. get xyzIn(): NodeMaterialConnectionPoint;
  142729. /**
  142730. * Gets the xy component (input)
  142731. */
  142732. get xyIn(): NodeMaterialConnectionPoint;
  142733. /**
  142734. * Gets the xyz component (output)
  142735. */
  142736. get xyzOut(): NodeMaterialConnectionPoint;
  142737. /**
  142738. * Gets the xy component (output)
  142739. */
  142740. get xyOut(): NodeMaterialConnectionPoint;
  142741. /**
  142742. * Gets the x component (output)
  142743. */
  142744. get x(): NodeMaterialConnectionPoint;
  142745. /**
  142746. * Gets the y component (output)
  142747. */
  142748. get y(): NodeMaterialConnectionPoint;
  142749. /**
  142750. * Gets the z component (output)
  142751. */
  142752. get z(): NodeMaterialConnectionPoint;
  142753. /**
  142754. * Gets the w component (output)
  142755. */
  142756. get w(): NodeMaterialConnectionPoint;
  142757. protected _inputRename(name: string): string;
  142758. protected _outputRename(name: string): string;
  142759. protected _buildBlock(state: NodeMaterialBuildState): this;
  142760. }
  142761. }
  142762. declare module BABYLON {
  142763. /**
  142764. * Block used to lerp between 2 values
  142765. */
  142766. export class LerpBlock extends NodeMaterialBlock {
  142767. /**
  142768. * Creates a new LerpBlock
  142769. * @param name defines the block name
  142770. */
  142771. constructor(name: string);
  142772. /**
  142773. * Gets the current class name
  142774. * @returns the class name
  142775. */
  142776. getClassName(): string;
  142777. /**
  142778. * Gets the left operand input component
  142779. */
  142780. get left(): NodeMaterialConnectionPoint;
  142781. /**
  142782. * Gets the right operand input component
  142783. */
  142784. get right(): NodeMaterialConnectionPoint;
  142785. /**
  142786. * Gets the gradient operand input component
  142787. */
  142788. get gradient(): NodeMaterialConnectionPoint;
  142789. /**
  142790. * Gets the output component
  142791. */
  142792. get output(): NodeMaterialConnectionPoint;
  142793. protected _buildBlock(state: NodeMaterialBuildState): this;
  142794. }
  142795. }
  142796. declare module BABYLON {
  142797. /**
  142798. * Block used to divide 2 vectors
  142799. */
  142800. export class DivideBlock extends NodeMaterialBlock {
  142801. /**
  142802. * Creates a new DivideBlock
  142803. * @param name defines the block name
  142804. */
  142805. constructor(name: string);
  142806. /**
  142807. * Gets the current class name
  142808. * @returns the class name
  142809. */
  142810. getClassName(): string;
  142811. /**
  142812. * Gets the left operand input component
  142813. */
  142814. get left(): NodeMaterialConnectionPoint;
  142815. /**
  142816. * Gets the right operand input component
  142817. */
  142818. get right(): NodeMaterialConnectionPoint;
  142819. /**
  142820. * Gets the output component
  142821. */
  142822. get output(): NodeMaterialConnectionPoint;
  142823. protected _buildBlock(state: NodeMaterialBuildState): this;
  142824. }
  142825. }
  142826. declare module BABYLON {
  142827. /**
  142828. * Block used to subtract 2 vectors
  142829. */
  142830. export class SubtractBlock extends NodeMaterialBlock {
  142831. /**
  142832. * Creates a new SubtractBlock
  142833. * @param name defines the block name
  142834. */
  142835. constructor(name: string);
  142836. /**
  142837. * Gets the current class name
  142838. * @returns the class name
  142839. */
  142840. getClassName(): string;
  142841. /**
  142842. * Gets the left operand input component
  142843. */
  142844. get left(): NodeMaterialConnectionPoint;
  142845. /**
  142846. * Gets the right operand input component
  142847. */
  142848. get right(): NodeMaterialConnectionPoint;
  142849. /**
  142850. * Gets the output component
  142851. */
  142852. get output(): NodeMaterialConnectionPoint;
  142853. protected _buildBlock(state: NodeMaterialBuildState): this;
  142854. }
  142855. }
  142856. declare module BABYLON {
  142857. /**
  142858. * Block used to step a value
  142859. */
  142860. export class StepBlock extends NodeMaterialBlock {
  142861. /**
  142862. * Creates a new StepBlock
  142863. * @param name defines the block name
  142864. */
  142865. constructor(name: string);
  142866. /**
  142867. * Gets the current class name
  142868. * @returns the class name
  142869. */
  142870. getClassName(): string;
  142871. /**
  142872. * Gets the value operand input component
  142873. */
  142874. get value(): NodeMaterialConnectionPoint;
  142875. /**
  142876. * Gets the edge operand input component
  142877. */
  142878. get edge(): NodeMaterialConnectionPoint;
  142879. /**
  142880. * Gets the output component
  142881. */
  142882. get output(): NodeMaterialConnectionPoint;
  142883. protected _buildBlock(state: NodeMaterialBuildState): this;
  142884. }
  142885. }
  142886. declare module BABYLON {
  142887. /**
  142888. * Block used to get the opposite (1 - x) of a value
  142889. */
  142890. export class OneMinusBlock extends NodeMaterialBlock {
  142891. /**
  142892. * Creates a new OneMinusBlock
  142893. * @param name defines the block name
  142894. */
  142895. constructor(name: string);
  142896. /**
  142897. * Gets the current class name
  142898. * @returns the class name
  142899. */
  142900. getClassName(): string;
  142901. /**
  142902. * Gets the input component
  142903. */
  142904. get input(): NodeMaterialConnectionPoint;
  142905. /**
  142906. * Gets the output component
  142907. */
  142908. get output(): NodeMaterialConnectionPoint;
  142909. protected _buildBlock(state: NodeMaterialBuildState): this;
  142910. }
  142911. }
  142912. declare module BABYLON {
  142913. /**
  142914. * Block used to get the view direction
  142915. */
  142916. export class ViewDirectionBlock extends NodeMaterialBlock {
  142917. /**
  142918. * Creates a new ViewDirectionBlock
  142919. * @param name defines the block name
  142920. */
  142921. constructor(name: string);
  142922. /**
  142923. * Gets the current class name
  142924. * @returns the class name
  142925. */
  142926. getClassName(): string;
  142927. /**
  142928. * Gets the world position component
  142929. */
  142930. get worldPosition(): NodeMaterialConnectionPoint;
  142931. /**
  142932. * Gets the camera position component
  142933. */
  142934. get cameraPosition(): NodeMaterialConnectionPoint;
  142935. /**
  142936. * Gets the output component
  142937. */
  142938. get output(): NodeMaterialConnectionPoint;
  142939. autoConfigure(material: NodeMaterial): void;
  142940. protected _buildBlock(state: NodeMaterialBuildState): this;
  142941. }
  142942. }
  142943. declare module BABYLON {
  142944. /**
  142945. * Block used to compute fresnel value
  142946. */
  142947. export class FresnelBlock extends NodeMaterialBlock {
  142948. /**
  142949. * Create a new FresnelBlock
  142950. * @param name defines the block name
  142951. */
  142952. constructor(name: string);
  142953. /**
  142954. * Gets the current class name
  142955. * @returns the class name
  142956. */
  142957. getClassName(): string;
  142958. /**
  142959. * Gets the world normal input component
  142960. */
  142961. get worldNormal(): NodeMaterialConnectionPoint;
  142962. /**
  142963. * Gets the view direction input component
  142964. */
  142965. get viewDirection(): NodeMaterialConnectionPoint;
  142966. /**
  142967. * Gets the bias input component
  142968. */
  142969. get bias(): NodeMaterialConnectionPoint;
  142970. /**
  142971. * Gets the camera (or eye) position component
  142972. */
  142973. get power(): NodeMaterialConnectionPoint;
  142974. /**
  142975. * Gets the fresnel output component
  142976. */
  142977. get fresnel(): NodeMaterialConnectionPoint;
  142978. autoConfigure(material: NodeMaterial): void;
  142979. protected _buildBlock(state: NodeMaterialBuildState): this;
  142980. }
  142981. }
  142982. declare module BABYLON {
  142983. /**
  142984. * Block used to get the max of 2 values
  142985. */
  142986. export class MaxBlock extends NodeMaterialBlock {
  142987. /**
  142988. * Creates a new MaxBlock
  142989. * @param name defines the block name
  142990. */
  142991. constructor(name: string);
  142992. /**
  142993. * Gets the current class name
  142994. * @returns the class name
  142995. */
  142996. getClassName(): string;
  142997. /**
  142998. * Gets the left operand input component
  142999. */
  143000. get left(): NodeMaterialConnectionPoint;
  143001. /**
  143002. * Gets the right operand input component
  143003. */
  143004. get right(): NodeMaterialConnectionPoint;
  143005. /**
  143006. * Gets the output component
  143007. */
  143008. get output(): NodeMaterialConnectionPoint;
  143009. protected _buildBlock(state: NodeMaterialBuildState): this;
  143010. }
  143011. }
  143012. declare module BABYLON {
  143013. /**
  143014. * Block used to get the min of 2 values
  143015. */
  143016. export class MinBlock extends NodeMaterialBlock {
  143017. /**
  143018. * Creates a new MinBlock
  143019. * @param name defines the block name
  143020. */
  143021. constructor(name: string);
  143022. /**
  143023. * Gets the current class name
  143024. * @returns the class name
  143025. */
  143026. getClassName(): string;
  143027. /**
  143028. * Gets the left operand input component
  143029. */
  143030. get left(): NodeMaterialConnectionPoint;
  143031. /**
  143032. * Gets the right operand input component
  143033. */
  143034. get right(): NodeMaterialConnectionPoint;
  143035. /**
  143036. * Gets the output component
  143037. */
  143038. get output(): NodeMaterialConnectionPoint;
  143039. protected _buildBlock(state: NodeMaterialBuildState): this;
  143040. }
  143041. }
  143042. declare module BABYLON {
  143043. /**
  143044. * Block used to get the distance between 2 values
  143045. */
  143046. export class DistanceBlock extends NodeMaterialBlock {
  143047. /**
  143048. * Creates a new DistanceBlock
  143049. * @param name defines the block name
  143050. */
  143051. constructor(name: string);
  143052. /**
  143053. * Gets the current class name
  143054. * @returns the class name
  143055. */
  143056. getClassName(): string;
  143057. /**
  143058. * Gets the left operand input component
  143059. */
  143060. get left(): NodeMaterialConnectionPoint;
  143061. /**
  143062. * Gets the right operand input component
  143063. */
  143064. get right(): NodeMaterialConnectionPoint;
  143065. /**
  143066. * Gets the output component
  143067. */
  143068. get output(): NodeMaterialConnectionPoint;
  143069. protected _buildBlock(state: NodeMaterialBuildState): this;
  143070. }
  143071. }
  143072. declare module BABYLON {
  143073. /**
  143074. * Block used to get the length of a vector
  143075. */
  143076. export class LengthBlock extends NodeMaterialBlock {
  143077. /**
  143078. * Creates a new LengthBlock
  143079. * @param name defines the block name
  143080. */
  143081. constructor(name: string);
  143082. /**
  143083. * Gets the current class name
  143084. * @returns the class name
  143085. */
  143086. getClassName(): string;
  143087. /**
  143088. * Gets the value input component
  143089. */
  143090. get value(): NodeMaterialConnectionPoint;
  143091. /**
  143092. * Gets the output component
  143093. */
  143094. get output(): NodeMaterialConnectionPoint;
  143095. protected _buildBlock(state: NodeMaterialBuildState): this;
  143096. }
  143097. }
  143098. declare module BABYLON {
  143099. /**
  143100. * Block used to get negative version of a value (i.e. x * -1)
  143101. */
  143102. export class NegateBlock extends NodeMaterialBlock {
  143103. /**
  143104. * Creates a new NegateBlock
  143105. * @param name defines the block name
  143106. */
  143107. constructor(name: string);
  143108. /**
  143109. * Gets the current class name
  143110. * @returns the class name
  143111. */
  143112. getClassName(): string;
  143113. /**
  143114. * Gets the value input component
  143115. */
  143116. get value(): NodeMaterialConnectionPoint;
  143117. /**
  143118. * Gets the output component
  143119. */
  143120. get output(): NodeMaterialConnectionPoint;
  143121. protected _buildBlock(state: NodeMaterialBuildState): this;
  143122. }
  143123. }
  143124. declare module BABYLON {
  143125. /**
  143126. * Block used to get the value of the first parameter raised to the power of the second
  143127. */
  143128. export class PowBlock extends NodeMaterialBlock {
  143129. /**
  143130. * Creates a new PowBlock
  143131. * @param name defines the block name
  143132. */
  143133. constructor(name: string);
  143134. /**
  143135. * Gets the current class name
  143136. * @returns the class name
  143137. */
  143138. getClassName(): string;
  143139. /**
  143140. * Gets the value operand input component
  143141. */
  143142. get value(): NodeMaterialConnectionPoint;
  143143. /**
  143144. * Gets the power operand input component
  143145. */
  143146. get power(): NodeMaterialConnectionPoint;
  143147. /**
  143148. * Gets the output component
  143149. */
  143150. get output(): NodeMaterialConnectionPoint;
  143151. protected _buildBlock(state: NodeMaterialBuildState): this;
  143152. }
  143153. }
  143154. declare module BABYLON {
  143155. /**
  143156. * Block used to get a random number
  143157. */
  143158. export class RandomNumberBlock extends NodeMaterialBlock {
  143159. /**
  143160. * Creates a new RandomNumberBlock
  143161. * @param name defines the block name
  143162. */
  143163. constructor(name: string);
  143164. /**
  143165. * Gets the current class name
  143166. * @returns the class name
  143167. */
  143168. getClassName(): string;
  143169. /**
  143170. * Gets the seed input component
  143171. */
  143172. get seed(): NodeMaterialConnectionPoint;
  143173. /**
  143174. * Gets the output component
  143175. */
  143176. get output(): NodeMaterialConnectionPoint;
  143177. protected _buildBlock(state: NodeMaterialBuildState): this;
  143178. }
  143179. }
  143180. declare module BABYLON {
  143181. /**
  143182. * Block used to compute arc tangent of 2 values
  143183. */
  143184. export class ArcTan2Block extends NodeMaterialBlock {
  143185. /**
  143186. * Creates a new ArcTan2Block
  143187. * @param name defines the block name
  143188. */
  143189. constructor(name: string);
  143190. /**
  143191. * Gets the current class name
  143192. * @returns the class name
  143193. */
  143194. getClassName(): string;
  143195. /**
  143196. * Gets the x operand input component
  143197. */
  143198. get x(): NodeMaterialConnectionPoint;
  143199. /**
  143200. * Gets the y operand input component
  143201. */
  143202. get y(): NodeMaterialConnectionPoint;
  143203. /**
  143204. * Gets the output component
  143205. */
  143206. get output(): NodeMaterialConnectionPoint;
  143207. protected _buildBlock(state: NodeMaterialBuildState): this;
  143208. }
  143209. }
  143210. declare module BABYLON {
  143211. /**
  143212. * Block used to smooth step a value
  143213. */
  143214. export class SmoothStepBlock extends NodeMaterialBlock {
  143215. /**
  143216. * Creates a new SmoothStepBlock
  143217. * @param name defines the block name
  143218. */
  143219. constructor(name: string);
  143220. /**
  143221. * Gets the current class name
  143222. * @returns the class name
  143223. */
  143224. getClassName(): string;
  143225. /**
  143226. * Gets the value operand input component
  143227. */
  143228. get value(): NodeMaterialConnectionPoint;
  143229. /**
  143230. * Gets the first edge operand input component
  143231. */
  143232. get edge0(): NodeMaterialConnectionPoint;
  143233. /**
  143234. * Gets the second edge operand input component
  143235. */
  143236. get edge1(): NodeMaterialConnectionPoint;
  143237. /**
  143238. * Gets the output component
  143239. */
  143240. get output(): NodeMaterialConnectionPoint;
  143241. protected _buildBlock(state: NodeMaterialBuildState): this;
  143242. }
  143243. }
  143244. declare module BABYLON {
  143245. /**
  143246. * Block used to get the reciprocal (1 / x) of a value
  143247. */
  143248. export class ReciprocalBlock extends NodeMaterialBlock {
  143249. /**
  143250. * Creates a new ReciprocalBlock
  143251. * @param name defines the block name
  143252. */
  143253. constructor(name: string);
  143254. /**
  143255. * Gets the current class name
  143256. * @returns the class name
  143257. */
  143258. getClassName(): string;
  143259. /**
  143260. * Gets the input component
  143261. */
  143262. get input(): NodeMaterialConnectionPoint;
  143263. /**
  143264. * Gets the output component
  143265. */
  143266. get output(): NodeMaterialConnectionPoint;
  143267. protected _buildBlock(state: NodeMaterialBuildState): this;
  143268. }
  143269. }
  143270. declare module BABYLON {
  143271. /**
  143272. * Block used to replace a color by another one
  143273. */
  143274. export class ReplaceColorBlock extends NodeMaterialBlock {
  143275. /**
  143276. * Creates a new ReplaceColorBlock
  143277. * @param name defines the block name
  143278. */
  143279. constructor(name: string);
  143280. /**
  143281. * Gets the current class name
  143282. * @returns the class name
  143283. */
  143284. getClassName(): string;
  143285. /**
  143286. * Gets the value input component
  143287. */
  143288. get value(): NodeMaterialConnectionPoint;
  143289. /**
  143290. * Gets the reference input component
  143291. */
  143292. get reference(): NodeMaterialConnectionPoint;
  143293. /**
  143294. * Gets the distance input component
  143295. */
  143296. get distance(): NodeMaterialConnectionPoint;
  143297. /**
  143298. * Gets the replacement input component
  143299. */
  143300. get replacement(): NodeMaterialConnectionPoint;
  143301. /**
  143302. * Gets the output component
  143303. */
  143304. get output(): NodeMaterialConnectionPoint;
  143305. protected _buildBlock(state: NodeMaterialBuildState): this;
  143306. }
  143307. }
  143308. declare module BABYLON {
  143309. /**
  143310. * Block used to posterize a value
  143311. * @see https://en.wikipedia.org/wiki/Posterization
  143312. */
  143313. export class PosterizeBlock extends NodeMaterialBlock {
  143314. /**
  143315. * Creates a new PosterizeBlock
  143316. * @param name defines the block name
  143317. */
  143318. constructor(name: string);
  143319. /**
  143320. * Gets the current class name
  143321. * @returns the class name
  143322. */
  143323. getClassName(): string;
  143324. /**
  143325. * Gets the value input component
  143326. */
  143327. get value(): NodeMaterialConnectionPoint;
  143328. /**
  143329. * Gets the steps input component
  143330. */
  143331. get steps(): NodeMaterialConnectionPoint;
  143332. /**
  143333. * Gets the output component
  143334. */
  143335. get output(): NodeMaterialConnectionPoint;
  143336. protected _buildBlock(state: NodeMaterialBuildState): this;
  143337. }
  143338. }
  143339. declare module BABYLON {
  143340. /**
  143341. * Operations supported by the Wave block
  143342. */
  143343. export enum WaveBlockKind {
  143344. /** SawTooth */
  143345. SawTooth = 0,
  143346. /** Square */
  143347. Square = 1,
  143348. /** Triangle */
  143349. Triangle = 2
  143350. }
  143351. /**
  143352. * Block used to apply wave operation to floats
  143353. */
  143354. export class WaveBlock extends NodeMaterialBlock {
  143355. /**
  143356. * Gets or sets the kibnd of wave to be applied by the block
  143357. */
  143358. kind: WaveBlockKind;
  143359. /**
  143360. * Creates a new WaveBlock
  143361. * @param name defines the block name
  143362. */
  143363. constructor(name: string);
  143364. /**
  143365. * Gets the current class name
  143366. * @returns the class name
  143367. */
  143368. getClassName(): string;
  143369. /**
  143370. * Gets the input component
  143371. */
  143372. get input(): NodeMaterialConnectionPoint;
  143373. /**
  143374. * Gets the output component
  143375. */
  143376. get output(): NodeMaterialConnectionPoint;
  143377. protected _buildBlock(state: NodeMaterialBuildState): this;
  143378. serialize(): any;
  143379. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143380. }
  143381. }
  143382. declare module BABYLON {
  143383. /**
  143384. * Class used to store a color step for the GradientBlock
  143385. */
  143386. export class GradientBlockColorStep {
  143387. /**
  143388. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  143389. */
  143390. step: number;
  143391. /**
  143392. * Gets or sets the color associated with this step
  143393. */
  143394. color: Color3;
  143395. /**
  143396. * Creates a new GradientBlockColorStep
  143397. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  143398. * @param color defines the color associated with this step
  143399. */
  143400. constructor(
  143401. /**
  143402. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  143403. */
  143404. step: number,
  143405. /**
  143406. * Gets or sets the color associated with this step
  143407. */
  143408. color: Color3);
  143409. }
  143410. /**
  143411. * Block used to return a color from a gradient based on an input value between 0 and 1
  143412. */
  143413. export class GradientBlock extends NodeMaterialBlock {
  143414. /**
  143415. * Gets or sets the list of color steps
  143416. */
  143417. colorSteps: GradientBlockColorStep[];
  143418. /**
  143419. * Creates a new GradientBlock
  143420. * @param name defines the block name
  143421. */
  143422. constructor(name: string);
  143423. /**
  143424. * Gets the current class name
  143425. * @returns the class name
  143426. */
  143427. getClassName(): string;
  143428. /**
  143429. * Gets the gradient input component
  143430. */
  143431. get gradient(): NodeMaterialConnectionPoint;
  143432. /**
  143433. * Gets the output component
  143434. */
  143435. get output(): NodeMaterialConnectionPoint;
  143436. private _writeColorConstant;
  143437. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143438. serialize(): any;
  143439. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143440. protected _dumpPropertiesCode(): string;
  143441. }
  143442. }
  143443. declare module BABYLON {
  143444. /**
  143445. * Block used to normalize lerp between 2 values
  143446. */
  143447. export class NLerpBlock extends NodeMaterialBlock {
  143448. /**
  143449. * Creates a new NLerpBlock
  143450. * @param name defines the block name
  143451. */
  143452. constructor(name: string);
  143453. /**
  143454. * Gets the current class name
  143455. * @returns the class name
  143456. */
  143457. getClassName(): string;
  143458. /**
  143459. * Gets the left operand input component
  143460. */
  143461. get left(): NodeMaterialConnectionPoint;
  143462. /**
  143463. * Gets the right operand input component
  143464. */
  143465. get right(): NodeMaterialConnectionPoint;
  143466. /**
  143467. * Gets the gradient operand input component
  143468. */
  143469. get gradient(): NodeMaterialConnectionPoint;
  143470. /**
  143471. * Gets the output component
  143472. */
  143473. get output(): NodeMaterialConnectionPoint;
  143474. protected _buildBlock(state: NodeMaterialBuildState): this;
  143475. }
  143476. }
  143477. declare module BABYLON {
  143478. /**
  143479. * block used to Generate a Worley Noise 3D Noise Pattern
  143480. */
  143481. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  143482. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  143483. manhattanDistance: boolean;
  143484. /**
  143485. * Creates a new WorleyNoise3DBlock
  143486. * @param name defines the block name
  143487. */
  143488. constructor(name: string);
  143489. /**
  143490. * Gets the current class name
  143491. * @returns the class name
  143492. */
  143493. getClassName(): string;
  143494. /**
  143495. * Gets the seed input component
  143496. */
  143497. get seed(): NodeMaterialConnectionPoint;
  143498. /**
  143499. * Gets the jitter input component
  143500. */
  143501. get jitter(): NodeMaterialConnectionPoint;
  143502. /**
  143503. * Gets the output component
  143504. */
  143505. get output(): NodeMaterialConnectionPoint;
  143506. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143507. /**
  143508. * Exposes the properties to the UI?
  143509. */
  143510. protected _dumpPropertiesCode(): string;
  143511. /**
  143512. * Exposes the properties to the Seralize?
  143513. */
  143514. serialize(): any;
  143515. /**
  143516. * Exposes the properties to the deseralize?
  143517. */
  143518. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143519. }
  143520. }
  143521. declare module BABYLON {
  143522. /**
  143523. * block used to Generate a Simplex Perlin 3d Noise Pattern
  143524. */
  143525. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  143526. /**
  143527. * Creates a new SimplexPerlin3DBlock
  143528. * @param name defines the block name
  143529. */
  143530. constructor(name: string);
  143531. /**
  143532. * Gets the current class name
  143533. * @returns the class name
  143534. */
  143535. getClassName(): string;
  143536. /**
  143537. * Gets the seed operand input component
  143538. */
  143539. get seed(): NodeMaterialConnectionPoint;
  143540. /**
  143541. * Gets the output component
  143542. */
  143543. get output(): NodeMaterialConnectionPoint;
  143544. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143545. }
  143546. }
  143547. declare module BABYLON {
  143548. /**
  143549. * Block used to blend normals
  143550. */
  143551. export class NormalBlendBlock extends NodeMaterialBlock {
  143552. /**
  143553. * Creates a new NormalBlendBlock
  143554. * @param name defines the block name
  143555. */
  143556. constructor(name: string);
  143557. /**
  143558. * Gets the current class name
  143559. * @returns the class name
  143560. */
  143561. getClassName(): string;
  143562. /**
  143563. * Gets the first input component
  143564. */
  143565. get normalMap0(): NodeMaterialConnectionPoint;
  143566. /**
  143567. * Gets the second input component
  143568. */
  143569. get normalMap1(): NodeMaterialConnectionPoint;
  143570. /**
  143571. * Gets the output component
  143572. */
  143573. get output(): NodeMaterialConnectionPoint;
  143574. protected _buildBlock(state: NodeMaterialBuildState): this;
  143575. }
  143576. }
  143577. declare module BABYLON {
  143578. /**
  143579. * Block used to rotate a 2d vector by a given angle
  143580. */
  143581. export class Rotate2dBlock extends NodeMaterialBlock {
  143582. /**
  143583. * Creates a new Rotate2dBlock
  143584. * @param name defines the block name
  143585. */
  143586. constructor(name: string);
  143587. /**
  143588. * Gets the current class name
  143589. * @returns the class name
  143590. */
  143591. getClassName(): string;
  143592. /**
  143593. * Gets the input vector
  143594. */
  143595. get input(): NodeMaterialConnectionPoint;
  143596. /**
  143597. * Gets the input angle
  143598. */
  143599. get angle(): NodeMaterialConnectionPoint;
  143600. /**
  143601. * Gets the output component
  143602. */
  143603. get output(): NodeMaterialConnectionPoint;
  143604. autoConfigure(material: NodeMaterial): void;
  143605. protected _buildBlock(state: NodeMaterialBuildState): this;
  143606. }
  143607. }
  143608. declare module BABYLON {
  143609. /**
  143610. * Block used to get the reflected vector from a direction and a normal
  143611. */
  143612. export class ReflectBlock extends NodeMaterialBlock {
  143613. /**
  143614. * Creates a new ReflectBlock
  143615. * @param name defines the block name
  143616. */
  143617. constructor(name: string);
  143618. /**
  143619. * Gets the current class name
  143620. * @returns the class name
  143621. */
  143622. getClassName(): string;
  143623. /**
  143624. * Gets the incident component
  143625. */
  143626. get incident(): NodeMaterialConnectionPoint;
  143627. /**
  143628. * Gets the normal component
  143629. */
  143630. get normal(): NodeMaterialConnectionPoint;
  143631. /**
  143632. * Gets the output component
  143633. */
  143634. get output(): NodeMaterialConnectionPoint;
  143635. protected _buildBlock(state: NodeMaterialBuildState): this;
  143636. }
  143637. }
  143638. declare module BABYLON {
  143639. /**
  143640. * Block used to get the refracted vector from a direction and a normal
  143641. */
  143642. export class RefractBlock extends NodeMaterialBlock {
  143643. /**
  143644. * Creates a new RefractBlock
  143645. * @param name defines the block name
  143646. */
  143647. constructor(name: string);
  143648. /**
  143649. * Gets the current class name
  143650. * @returns the class name
  143651. */
  143652. getClassName(): string;
  143653. /**
  143654. * Gets the incident component
  143655. */
  143656. get incident(): NodeMaterialConnectionPoint;
  143657. /**
  143658. * Gets the normal component
  143659. */
  143660. get normal(): NodeMaterialConnectionPoint;
  143661. /**
  143662. * Gets the index of refraction component
  143663. */
  143664. get ior(): NodeMaterialConnectionPoint;
  143665. /**
  143666. * Gets the output component
  143667. */
  143668. get output(): NodeMaterialConnectionPoint;
  143669. protected _buildBlock(state: NodeMaterialBuildState): this;
  143670. }
  143671. }
  143672. declare module BABYLON {
  143673. /**
  143674. * Block used to desaturate a color
  143675. */
  143676. export class DesaturateBlock extends NodeMaterialBlock {
  143677. /**
  143678. * Creates a new DesaturateBlock
  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 color operand input component
  143689. */
  143690. get color(): NodeMaterialConnectionPoint;
  143691. /**
  143692. * Gets the level operand input component
  143693. */
  143694. get level(): NodeMaterialConnectionPoint;
  143695. /**
  143696. * Gets the output component
  143697. */
  143698. get output(): NodeMaterialConnectionPoint;
  143699. protected _buildBlock(state: NodeMaterialBuildState): this;
  143700. }
  143701. }
  143702. declare module BABYLON {
  143703. /**
  143704. * Block used to implement the ambient occlusion module of the PBR material
  143705. */
  143706. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  143707. /**
  143708. * Create a new AmbientOcclusionBlock
  143709. * @param name defines the block name
  143710. */
  143711. constructor(name: string);
  143712. /**
  143713. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  143714. */
  143715. useAmbientInGrayScale: boolean;
  143716. /**
  143717. * Initialize the block and prepare the context for build
  143718. * @param state defines the state that will be used for the build
  143719. */
  143720. initialize(state: NodeMaterialBuildState): void;
  143721. /**
  143722. * Gets the current class name
  143723. * @returns the class name
  143724. */
  143725. getClassName(): string;
  143726. /**
  143727. * Gets the texture input component
  143728. */
  143729. get texture(): NodeMaterialConnectionPoint;
  143730. /**
  143731. * Gets the texture intensity component
  143732. */
  143733. get intensity(): NodeMaterialConnectionPoint;
  143734. /**
  143735. * Gets the direct light intensity input component
  143736. */
  143737. get directLightIntensity(): NodeMaterialConnectionPoint;
  143738. /**
  143739. * Gets the ambient occlusion object output component
  143740. */
  143741. get ambientOcclusion(): NodeMaterialConnectionPoint;
  143742. /**
  143743. * Gets the main code of the block (fragment side)
  143744. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  143745. * @returns the shader code
  143746. */
  143747. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  143748. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143749. protected _buildBlock(state: NodeMaterialBuildState): this;
  143750. protected _dumpPropertiesCode(): string;
  143751. serialize(): any;
  143752. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143753. }
  143754. }
  143755. declare module BABYLON {
  143756. /**
  143757. * Block used to implement the reflection module of the PBR material
  143758. */
  143759. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  143760. /** @hidden */
  143761. _defineLODReflectionAlpha: string;
  143762. /** @hidden */
  143763. _defineLinearSpecularReflection: string;
  143764. private _vEnvironmentIrradianceName;
  143765. /** @hidden */
  143766. _vReflectionMicrosurfaceInfosName: string;
  143767. /** @hidden */
  143768. _vReflectionInfosName: string;
  143769. /** @hidden */
  143770. _vReflectionFilteringInfoName: string;
  143771. private _scene;
  143772. /**
  143773. * The three properties below are set by the main PBR block prior to calling methods of this class.
  143774. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  143775. * It's less burden on the user side in the editor part.
  143776. */
  143777. /** @hidden */
  143778. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  143779. /** @hidden */
  143780. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  143781. /** @hidden */
  143782. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  143783. /**
  143784. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  143785. * diffuse part of the IBL.
  143786. */
  143787. useSphericalHarmonics: boolean;
  143788. /**
  143789. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  143790. */
  143791. forceIrradianceInFragment: boolean;
  143792. /**
  143793. * Create a new ReflectionBlock
  143794. * @param name defines the block name
  143795. */
  143796. constructor(name: string);
  143797. /**
  143798. * Gets the current class name
  143799. * @returns the class name
  143800. */
  143801. getClassName(): string;
  143802. /**
  143803. * Gets the position input component
  143804. */
  143805. get position(): NodeMaterialConnectionPoint;
  143806. /**
  143807. * Gets the world position input component
  143808. */
  143809. get worldPosition(): NodeMaterialConnectionPoint;
  143810. /**
  143811. * Gets the world normal input component
  143812. */
  143813. get worldNormal(): NodeMaterialConnectionPoint;
  143814. /**
  143815. * Gets the world input component
  143816. */
  143817. get world(): NodeMaterialConnectionPoint;
  143818. /**
  143819. * Gets the camera (or eye) position component
  143820. */
  143821. get cameraPosition(): NodeMaterialConnectionPoint;
  143822. /**
  143823. * Gets the view input component
  143824. */
  143825. get view(): NodeMaterialConnectionPoint;
  143826. /**
  143827. * Gets the color input component
  143828. */
  143829. get color(): NodeMaterialConnectionPoint;
  143830. /**
  143831. * Gets the reflection object output component
  143832. */
  143833. get reflection(): NodeMaterialConnectionPoint;
  143834. /**
  143835. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  143836. */
  143837. get hasTexture(): boolean;
  143838. /**
  143839. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  143840. */
  143841. get reflectionColor(): string;
  143842. protected _getTexture(): Nullable<BaseTexture>;
  143843. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143844. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  143845. /**
  143846. * Gets the code to inject in the vertex shader
  143847. * @param state current state of the node material building
  143848. * @returns the shader code
  143849. */
  143850. handleVertexSide(state: NodeMaterialBuildState): string;
  143851. /**
  143852. * Gets the main code of the block (fragment side)
  143853. * @param state current state of the node material building
  143854. * @param normalVarName name of the existing variable corresponding to the normal
  143855. * @returns the shader code
  143856. */
  143857. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  143858. protected _buildBlock(state: NodeMaterialBuildState): this;
  143859. protected _dumpPropertiesCode(): string;
  143860. serialize(): any;
  143861. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143862. }
  143863. }
  143864. declare module BABYLON {
  143865. /**
  143866. * Block used to implement the sheen module of the PBR material
  143867. */
  143868. export class SheenBlock extends NodeMaterialBlock {
  143869. /**
  143870. * Create a new SheenBlock
  143871. * @param name defines the block name
  143872. */
  143873. constructor(name: string);
  143874. /**
  143875. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  143876. * It allows the strength of the sheen effect to not depend on the base color of the material,
  143877. * making it easier to setup and tweak the effect
  143878. */
  143879. albedoScaling: boolean;
  143880. /**
  143881. * Defines if the sheen is linked to the sheen color.
  143882. */
  143883. linkSheenWithAlbedo: boolean;
  143884. /**
  143885. * Initialize the block and prepare the context for build
  143886. * @param state defines the state that will be used for the build
  143887. */
  143888. initialize(state: NodeMaterialBuildState): void;
  143889. /**
  143890. * Gets the current class name
  143891. * @returns the class name
  143892. */
  143893. getClassName(): string;
  143894. /**
  143895. * Gets the intensity input component
  143896. */
  143897. get intensity(): NodeMaterialConnectionPoint;
  143898. /**
  143899. * Gets the color input component
  143900. */
  143901. get color(): NodeMaterialConnectionPoint;
  143902. /**
  143903. * Gets the roughness input component
  143904. */
  143905. get roughness(): NodeMaterialConnectionPoint;
  143906. /**
  143907. * Gets the sheen object output component
  143908. */
  143909. get sheen(): NodeMaterialConnectionPoint;
  143910. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143911. /**
  143912. * Gets the main code of the block (fragment side)
  143913. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  143914. * @returns the shader code
  143915. */
  143916. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  143917. protected _buildBlock(state: NodeMaterialBuildState): this;
  143918. protected _dumpPropertiesCode(): string;
  143919. serialize(): any;
  143920. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143921. }
  143922. }
  143923. declare module BABYLON {
  143924. /**
  143925. * Block used to implement the reflectivity module of the PBR material
  143926. */
  143927. export class ReflectivityBlock extends NodeMaterialBlock {
  143928. private _metallicReflectanceColor;
  143929. private _metallicF0Factor;
  143930. /** @hidden */
  143931. _vMetallicReflectanceFactorsName: string;
  143932. /**
  143933. * The property below is set by the main PBR block prior to calling methods of this class.
  143934. */
  143935. /** @hidden */
  143936. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  143937. /**
  143938. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  143939. */
  143940. useAmbientOcclusionFromMetallicTextureRed: boolean;
  143941. /**
  143942. * Specifies if the metallic texture contains the metallness information in its blue channel.
  143943. */
  143944. useMetallnessFromMetallicTextureBlue: boolean;
  143945. /**
  143946. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  143947. */
  143948. useRoughnessFromMetallicTextureAlpha: boolean;
  143949. /**
  143950. * Specifies if the metallic texture contains the roughness information in its green channel.
  143951. */
  143952. useRoughnessFromMetallicTextureGreen: boolean;
  143953. /**
  143954. * Create a new ReflectivityBlock
  143955. * @param name defines the block name
  143956. */
  143957. constructor(name: string);
  143958. /**
  143959. * Initialize the block and prepare the context for build
  143960. * @param state defines the state that will be used for the build
  143961. */
  143962. initialize(state: NodeMaterialBuildState): void;
  143963. /**
  143964. * Gets the current class name
  143965. * @returns the class name
  143966. */
  143967. getClassName(): string;
  143968. /**
  143969. * Gets the metallic input component
  143970. */
  143971. get metallic(): NodeMaterialConnectionPoint;
  143972. /**
  143973. * Gets the roughness input component
  143974. */
  143975. get roughness(): NodeMaterialConnectionPoint;
  143976. /**
  143977. * Gets the texture input component
  143978. */
  143979. get texture(): NodeMaterialConnectionPoint;
  143980. /**
  143981. * Gets the reflectivity object output component
  143982. */
  143983. get reflectivity(): NodeMaterialConnectionPoint;
  143984. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  143985. /**
  143986. * Gets the main code of the block (fragment side)
  143987. * @param state current state of the node material building
  143988. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  143989. * @returns the shader code
  143990. */
  143991. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  143992. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143993. protected _buildBlock(state: NodeMaterialBuildState): this;
  143994. protected _dumpPropertiesCode(): string;
  143995. serialize(): any;
  143996. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143997. }
  143998. }
  143999. declare module BABYLON {
  144000. /**
  144001. * Block used to implement the anisotropy module of the PBR material
  144002. */
  144003. export class AnisotropyBlock extends NodeMaterialBlock {
  144004. /**
  144005. * The two properties below are set by the main PBR block prior to calling methods of this class.
  144006. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  144007. * It's less burden on the user side in the editor part.
  144008. */
  144009. /** @hidden */
  144010. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  144011. /** @hidden */
  144012. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  144013. /**
  144014. * Create a new AnisotropyBlock
  144015. * @param name defines the block name
  144016. */
  144017. constructor(name: string);
  144018. /**
  144019. * Initialize the block and prepare the context for build
  144020. * @param state defines the state that will be used for the build
  144021. */
  144022. initialize(state: NodeMaterialBuildState): void;
  144023. /**
  144024. * Gets the current class name
  144025. * @returns the class name
  144026. */
  144027. getClassName(): string;
  144028. /**
  144029. * Gets the intensity input component
  144030. */
  144031. get intensity(): NodeMaterialConnectionPoint;
  144032. /**
  144033. * Gets the direction input component
  144034. */
  144035. get direction(): NodeMaterialConnectionPoint;
  144036. /**
  144037. * Gets the texture input component
  144038. */
  144039. get texture(): NodeMaterialConnectionPoint;
  144040. /**
  144041. * Gets the uv input component
  144042. */
  144043. get uv(): NodeMaterialConnectionPoint;
  144044. /**
  144045. * Gets the worldTangent input component
  144046. */
  144047. get worldTangent(): NodeMaterialConnectionPoint;
  144048. /**
  144049. * Gets the anisotropy object output component
  144050. */
  144051. get anisotropy(): NodeMaterialConnectionPoint;
  144052. private _generateTBNSpace;
  144053. /**
  144054. * Gets the main code of the block (fragment side)
  144055. * @param state current state of the node material building
  144056. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  144057. * @returns the shader code
  144058. */
  144059. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  144060. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144061. protected _buildBlock(state: NodeMaterialBuildState): this;
  144062. }
  144063. }
  144064. declare module BABYLON {
  144065. /**
  144066. * Block used to implement the clear coat module of the PBR material
  144067. */
  144068. export class ClearCoatBlock extends NodeMaterialBlock {
  144069. private _scene;
  144070. /**
  144071. * Create a new ClearCoatBlock
  144072. * @param name defines the block name
  144073. */
  144074. constructor(name: string);
  144075. /**
  144076. * Initialize the block and prepare the context for build
  144077. * @param state defines the state that will be used for the build
  144078. */
  144079. initialize(state: NodeMaterialBuildState): void;
  144080. /**
  144081. * Gets the current class name
  144082. * @returns the class name
  144083. */
  144084. getClassName(): string;
  144085. /**
  144086. * Gets the intensity input component
  144087. */
  144088. get intensity(): NodeMaterialConnectionPoint;
  144089. /**
  144090. * Gets the roughness input component
  144091. */
  144092. get roughness(): NodeMaterialConnectionPoint;
  144093. /**
  144094. * Gets the ior input component
  144095. */
  144096. get ior(): NodeMaterialConnectionPoint;
  144097. /**
  144098. * Gets the texture input component
  144099. */
  144100. get texture(): NodeMaterialConnectionPoint;
  144101. /**
  144102. * Gets the bump texture input component
  144103. */
  144104. get bumpTexture(): NodeMaterialConnectionPoint;
  144105. /**
  144106. * Gets the uv input component
  144107. */
  144108. get uv(): NodeMaterialConnectionPoint;
  144109. /**
  144110. * Gets the tint color input component
  144111. */
  144112. get tintColor(): NodeMaterialConnectionPoint;
  144113. /**
  144114. * Gets the tint "at distance" input component
  144115. */
  144116. get tintAtDistance(): NodeMaterialConnectionPoint;
  144117. /**
  144118. * Gets the tint thickness input component
  144119. */
  144120. get tintThickness(): NodeMaterialConnectionPoint;
  144121. /**
  144122. * Gets the world tangent input component
  144123. */
  144124. get worldTangent(): NodeMaterialConnectionPoint;
  144125. /**
  144126. * Gets the clear coat object output component
  144127. */
  144128. get clearcoat(): NodeMaterialConnectionPoint;
  144129. autoConfigure(material: NodeMaterial): void;
  144130. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144131. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  144132. private _generateTBNSpace;
  144133. /**
  144134. * Gets the main code of the block (fragment side)
  144135. * @param state current state of the node material building
  144136. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  144137. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  144138. * @param worldPosVarName name of the variable holding the world position
  144139. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  144140. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  144141. * @param worldNormalVarName name of the variable holding the world normal
  144142. * @returns the shader code
  144143. */
  144144. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  144145. protected _buildBlock(state: NodeMaterialBuildState): this;
  144146. }
  144147. }
  144148. declare module BABYLON {
  144149. /**
  144150. * Block used to implement the sub surface module of the PBR material
  144151. */
  144152. export class SubSurfaceBlock extends NodeMaterialBlock {
  144153. /**
  144154. * Create a new SubSurfaceBlock
  144155. * @param name defines the block name
  144156. */
  144157. constructor(name: string);
  144158. /**
  144159. * Stores the intensity of the different subsurface effects in the thickness texture.
  144160. * * the green channel is the translucency intensity.
  144161. * * the blue channel is the scattering intensity.
  144162. * * the alpha channel is the refraction intensity.
  144163. */
  144164. useMaskFromThicknessTexture: boolean;
  144165. /**
  144166. * Initialize the block and prepare the context for build
  144167. * @param state defines the state that will be used for the build
  144168. */
  144169. initialize(state: NodeMaterialBuildState): void;
  144170. /**
  144171. * Gets the current class name
  144172. * @returns the class name
  144173. */
  144174. getClassName(): string;
  144175. /**
  144176. * Gets the min thickness input component
  144177. */
  144178. get minThickness(): NodeMaterialConnectionPoint;
  144179. /**
  144180. * Gets the max thickness input component
  144181. */
  144182. get maxThickness(): NodeMaterialConnectionPoint;
  144183. /**
  144184. * Gets the thickness texture component
  144185. */
  144186. get thicknessTexture(): NodeMaterialConnectionPoint;
  144187. /**
  144188. * Gets the tint color input component
  144189. */
  144190. get tintColor(): NodeMaterialConnectionPoint;
  144191. /**
  144192. * Gets the translucency intensity input component
  144193. */
  144194. get translucencyIntensity(): NodeMaterialConnectionPoint;
  144195. /**
  144196. * Gets the translucency diffusion distance input component
  144197. */
  144198. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  144199. /**
  144200. * Gets the refraction object parameters
  144201. */
  144202. get refraction(): NodeMaterialConnectionPoint;
  144203. /**
  144204. * Gets the sub surface object output component
  144205. */
  144206. get subsurface(): NodeMaterialConnectionPoint;
  144207. autoConfigure(material: NodeMaterial): void;
  144208. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144209. /**
  144210. * Gets the main code of the block (fragment side)
  144211. * @param state current state of the node material building
  144212. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  144213. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  144214. * @param worldPosVarName name of the variable holding the world position
  144215. * @returns the shader code
  144216. */
  144217. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  144218. protected _buildBlock(state: NodeMaterialBuildState): this;
  144219. }
  144220. }
  144221. declare module BABYLON {
  144222. /**
  144223. * Block used to implement the PBR metallic/roughness model
  144224. */
  144225. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  144226. /**
  144227. * Gets or sets the light associated with this block
  144228. */
  144229. light: Nullable<Light>;
  144230. private _lightId;
  144231. private _scene;
  144232. private _environmentBRDFTexture;
  144233. private _environmentBrdfSamplerName;
  144234. private _vNormalWName;
  144235. private _invertNormalName;
  144236. /**
  144237. * Create a new ReflectionBlock
  144238. * @param name defines the block name
  144239. */
  144240. constructor(name: string);
  144241. /**
  144242. * Intensity of the direct lights e.g. the four lights available in your scene.
  144243. * This impacts both the direct diffuse and specular highlights.
  144244. */
  144245. directIntensity: number;
  144246. /**
  144247. * Intensity of the environment e.g. how much the environment will light the object
  144248. * either through harmonics for rough material or through the refelction for shiny ones.
  144249. */
  144250. environmentIntensity: number;
  144251. /**
  144252. * This is a special control allowing the reduction of the specular highlights coming from the
  144253. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  144254. */
  144255. specularIntensity: number;
  144256. /**
  144257. * Defines the falloff type used in this material.
  144258. * It by default is Physical.
  144259. */
  144260. lightFalloff: number;
  144261. /**
  144262. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  144263. */
  144264. useAlphaFromAlbedoTexture: boolean;
  144265. /**
  144266. * Specifies that alpha test should be used
  144267. */
  144268. useAlphaTest: boolean;
  144269. /**
  144270. * Defines the alpha limits in alpha test mode.
  144271. */
  144272. alphaTestCutoff: number;
  144273. /**
  144274. * Specifies that alpha blending should be used
  144275. */
  144276. useAlphaBlending: boolean;
  144277. /**
  144278. * Defines if the alpha value should be determined via the rgb values.
  144279. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  144280. */
  144281. opacityRGB: boolean;
  144282. /**
  144283. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  144284. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  144285. */
  144286. useRadianceOverAlpha: boolean;
  144287. /**
  144288. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  144289. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  144290. */
  144291. useSpecularOverAlpha: boolean;
  144292. /**
  144293. * Enables specular anti aliasing in the PBR shader.
  144294. * It will both interacts on the Geometry for analytical and IBL lighting.
  144295. * It also prefilter the roughness map based on the bump values.
  144296. */
  144297. enableSpecularAntiAliasing: boolean;
  144298. /**
  144299. * Enables realtime filtering on the texture.
  144300. */
  144301. realTimeFiltering: boolean;
  144302. /**
  144303. * Quality switch for realtime filtering
  144304. */
  144305. realTimeFilteringQuality: number;
  144306. /**
  144307. * Defines if the material uses energy conservation.
  144308. */
  144309. useEnergyConservation: boolean;
  144310. /**
  144311. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  144312. * too much the area relying on ambient texture to define their ambient occlusion.
  144313. */
  144314. useRadianceOcclusion: boolean;
  144315. /**
  144316. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  144317. * makes the reflect vector face the model (under horizon).
  144318. */
  144319. useHorizonOcclusion: boolean;
  144320. /**
  144321. * If set to true, no lighting calculations will be applied.
  144322. */
  144323. unlit: boolean;
  144324. /**
  144325. * Force normal to face away from face.
  144326. */
  144327. forceNormalForward: boolean;
  144328. /**
  144329. * Defines the material debug mode.
  144330. * It helps seeing only some components of the material while troubleshooting.
  144331. */
  144332. debugMode: number;
  144333. /**
  144334. * Specify from where on screen the debug mode should start.
  144335. * The value goes from -1 (full screen) to 1 (not visible)
  144336. * It helps with side by side comparison against the final render
  144337. * This defaults to 0
  144338. */
  144339. debugLimit: number;
  144340. /**
  144341. * As the default viewing range might not be enough (if the ambient is really small for instance)
  144342. * You can use the factor to better multiply the final value.
  144343. */
  144344. debugFactor: number;
  144345. /**
  144346. * Initialize the block and prepare the context for build
  144347. * @param state defines the state that will be used for the build
  144348. */
  144349. initialize(state: NodeMaterialBuildState): void;
  144350. /**
  144351. * Gets the current class name
  144352. * @returns the class name
  144353. */
  144354. getClassName(): string;
  144355. /**
  144356. * Gets the world position input component
  144357. */
  144358. get worldPosition(): NodeMaterialConnectionPoint;
  144359. /**
  144360. * Gets the world normal input component
  144361. */
  144362. get worldNormal(): NodeMaterialConnectionPoint;
  144363. /**
  144364. * Gets the perturbed normal input component
  144365. */
  144366. get perturbedNormal(): NodeMaterialConnectionPoint;
  144367. /**
  144368. * Gets the camera position input component
  144369. */
  144370. get cameraPosition(): NodeMaterialConnectionPoint;
  144371. /**
  144372. * Gets the base color input component
  144373. */
  144374. get baseColor(): NodeMaterialConnectionPoint;
  144375. /**
  144376. * Gets the opacity texture input component
  144377. */
  144378. get opacityTexture(): NodeMaterialConnectionPoint;
  144379. /**
  144380. * Gets the ambient color input component
  144381. */
  144382. get ambientColor(): NodeMaterialConnectionPoint;
  144383. /**
  144384. * Gets the reflectivity object parameters
  144385. */
  144386. get reflectivity(): NodeMaterialConnectionPoint;
  144387. /**
  144388. * Gets the ambient occlusion object parameters
  144389. */
  144390. get ambientOcclusion(): NodeMaterialConnectionPoint;
  144391. /**
  144392. * Gets the reflection object parameters
  144393. */
  144394. get reflection(): NodeMaterialConnectionPoint;
  144395. /**
  144396. * Gets the sheen object parameters
  144397. */
  144398. get sheen(): NodeMaterialConnectionPoint;
  144399. /**
  144400. * Gets the clear coat object parameters
  144401. */
  144402. get clearcoat(): NodeMaterialConnectionPoint;
  144403. /**
  144404. * Gets the sub surface object parameters
  144405. */
  144406. get subsurface(): NodeMaterialConnectionPoint;
  144407. /**
  144408. * Gets the anisotropy object parameters
  144409. */
  144410. get anisotropy(): NodeMaterialConnectionPoint;
  144411. /**
  144412. * Gets the ambient output component
  144413. */
  144414. get ambient(): NodeMaterialConnectionPoint;
  144415. /**
  144416. * Gets the diffuse output component
  144417. */
  144418. get diffuse(): NodeMaterialConnectionPoint;
  144419. /**
  144420. * Gets the specular output component
  144421. */
  144422. get specular(): NodeMaterialConnectionPoint;
  144423. /**
  144424. * Gets the sheen output component
  144425. */
  144426. get sheenDir(): NodeMaterialConnectionPoint;
  144427. /**
  144428. * Gets the clear coat output component
  144429. */
  144430. get clearcoatDir(): NodeMaterialConnectionPoint;
  144431. /**
  144432. * Gets the indirect diffuse output component
  144433. */
  144434. get diffuseIndirect(): NodeMaterialConnectionPoint;
  144435. /**
  144436. * Gets the indirect specular output component
  144437. */
  144438. get specularIndirect(): NodeMaterialConnectionPoint;
  144439. /**
  144440. * Gets the indirect sheen output component
  144441. */
  144442. get sheenIndirect(): NodeMaterialConnectionPoint;
  144443. /**
  144444. * Gets the indirect clear coat output component
  144445. */
  144446. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  144447. /**
  144448. * Gets the refraction output component
  144449. */
  144450. get refraction(): NodeMaterialConnectionPoint;
  144451. /**
  144452. * Gets the global lighting output component
  144453. */
  144454. get lighting(): NodeMaterialConnectionPoint;
  144455. /**
  144456. * Gets the shadow output component
  144457. */
  144458. get shadow(): NodeMaterialConnectionPoint;
  144459. /**
  144460. * Gets the alpha output component
  144461. */
  144462. get alpha(): NodeMaterialConnectionPoint;
  144463. autoConfigure(material: NodeMaterial): void;
  144464. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144465. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  144466. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  144467. private _injectVertexCode;
  144468. /**
  144469. * Gets the code corresponding to the albedo/opacity module
  144470. * @returns the shader code
  144471. */
  144472. getAlbedoOpacityCode(): string;
  144473. protected _buildBlock(state: NodeMaterialBuildState): this;
  144474. protected _dumpPropertiesCode(): string;
  144475. serialize(): any;
  144476. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144477. }
  144478. }
  144479. declare module BABYLON {
  144480. /**
  144481. * Block used to compute value of one parameter modulo another
  144482. */
  144483. export class ModBlock extends NodeMaterialBlock {
  144484. /**
  144485. * Creates a new ModBlock
  144486. * @param name defines the block name
  144487. */
  144488. constructor(name: string);
  144489. /**
  144490. * Gets the current class name
  144491. * @returns the class name
  144492. */
  144493. getClassName(): string;
  144494. /**
  144495. * Gets the left operand input component
  144496. */
  144497. get left(): NodeMaterialConnectionPoint;
  144498. /**
  144499. * Gets the right operand input component
  144500. */
  144501. get right(): NodeMaterialConnectionPoint;
  144502. /**
  144503. * Gets the output component
  144504. */
  144505. get output(): NodeMaterialConnectionPoint;
  144506. protected _buildBlock(state: NodeMaterialBuildState): this;
  144507. }
  144508. }
  144509. declare module BABYLON {
  144510. /**
  144511. * Helper class to push actions to a pool of workers.
  144512. */
  144513. export class WorkerPool implements IDisposable {
  144514. private _workerInfos;
  144515. private _pendingActions;
  144516. /**
  144517. * Constructor
  144518. * @param workers Array of workers to use for actions
  144519. */
  144520. constructor(workers: Array<Worker>);
  144521. /**
  144522. * Terminates all workers and clears any pending actions.
  144523. */
  144524. dispose(): void;
  144525. /**
  144526. * Pushes an action to the worker pool. If all the workers are active, the action will be
  144527. * pended until a worker has completed its action.
  144528. * @param action The action to perform. Call onComplete when the action is complete.
  144529. */
  144530. push(action: (worker: Worker, onComplete: () => void) => void): void;
  144531. private _execute;
  144532. }
  144533. }
  144534. declare module BABYLON {
  144535. /**
  144536. * Configuration for Draco compression
  144537. */
  144538. export interface IDracoCompressionConfiguration {
  144539. /**
  144540. * Configuration for the decoder.
  144541. */
  144542. decoder: {
  144543. /**
  144544. * The url to the WebAssembly module.
  144545. */
  144546. wasmUrl?: string;
  144547. /**
  144548. * The url to the WebAssembly binary.
  144549. */
  144550. wasmBinaryUrl?: string;
  144551. /**
  144552. * The url to the fallback JavaScript module.
  144553. */
  144554. fallbackUrl?: string;
  144555. };
  144556. }
  144557. /**
  144558. * Draco compression (https://google.github.io/draco/)
  144559. *
  144560. * This class wraps the Draco module.
  144561. *
  144562. * **Encoder**
  144563. *
  144564. * The encoder is not currently implemented.
  144565. *
  144566. * **Decoder**
  144567. *
  144568. * 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.
  144569. *
  144570. * To update the configuration, use the following code:
  144571. * ```javascript
  144572. * DracoCompression.Configuration = {
  144573. * decoder: {
  144574. * wasmUrl: "<url to the WebAssembly library>",
  144575. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  144576. * fallbackUrl: "<url to the fallback JavaScript library>",
  144577. * }
  144578. * };
  144579. * ```
  144580. *
  144581. * 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.
  144582. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  144583. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  144584. *
  144585. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  144586. * ```javascript
  144587. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  144588. * ```
  144589. *
  144590. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  144591. */
  144592. export class DracoCompression implements IDisposable {
  144593. private _workerPoolPromise?;
  144594. private _decoderModulePromise?;
  144595. /**
  144596. * The configuration. Defaults to the following urls:
  144597. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  144598. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  144599. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  144600. */
  144601. static Configuration: IDracoCompressionConfiguration;
  144602. /**
  144603. * Returns true if the decoder configuration is available.
  144604. */
  144605. static get DecoderAvailable(): boolean;
  144606. /**
  144607. * Default number of workers to create when creating the draco compression object.
  144608. */
  144609. static DefaultNumWorkers: number;
  144610. private static GetDefaultNumWorkers;
  144611. private static _Default;
  144612. /**
  144613. * Default instance for the draco compression object.
  144614. */
  144615. static get Default(): DracoCompression;
  144616. /**
  144617. * Constructor
  144618. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  144619. */
  144620. constructor(numWorkers?: number);
  144621. /**
  144622. * Stop all async operations and release resources.
  144623. */
  144624. dispose(): void;
  144625. /**
  144626. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  144627. * @returns a promise that resolves when ready
  144628. */
  144629. whenReadyAsync(): Promise<void>;
  144630. /**
  144631. * Decode Draco compressed mesh data to vertex data.
  144632. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  144633. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  144634. * @returns A promise that resolves with the decoded vertex data
  144635. */
  144636. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  144637. [kind: string]: number;
  144638. }): Promise<VertexData>;
  144639. }
  144640. }
  144641. declare module BABYLON {
  144642. /**
  144643. * Class for building Constructive Solid Geometry
  144644. */
  144645. export class CSG {
  144646. private polygons;
  144647. /**
  144648. * The world matrix
  144649. */
  144650. matrix: Matrix;
  144651. /**
  144652. * Stores the position
  144653. */
  144654. position: Vector3;
  144655. /**
  144656. * Stores the rotation
  144657. */
  144658. rotation: Vector3;
  144659. /**
  144660. * Stores the rotation quaternion
  144661. */
  144662. rotationQuaternion: Nullable<Quaternion>;
  144663. /**
  144664. * Stores the scaling vector
  144665. */
  144666. scaling: Vector3;
  144667. /**
  144668. * Convert the Mesh to CSG
  144669. * @param mesh The Mesh to convert to CSG
  144670. * @returns A new CSG from the Mesh
  144671. */
  144672. static FromMesh(mesh: Mesh): CSG;
  144673. /**
  144674. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  144675. * @param polygons Polygons used to construct a CSG solid
  144676. */
  144677. private static FromPolygons;
  144678. /**
  144679. * Clones, or makes a deep copy, of the CSG
  144680. * @returns A new CSG
  144681. */
  144682. clone(): CSG;
  144683. /**
  144684. * Unions this CSG with another CSG
  144685. * @param csg The CSG to union against this CSG
  144686. * @returns The unioned CSG
  144687. */
  144688. union(csg: CSG): CSG;
  144689. /**
  144690. * Unions this CSG with another CSG in place
  144691. * @param csg The CSG to union against this CSG
  144692. */
  144693. unionInPlace(csg: CSG): void;
  144694. /**
  144695. * Subtracts this CSG with another CSG
  144696. * @param csg The CSG to subtract against this CSG
  144697. * @returns A new CSG
  144698. */
  144699. subtract(csg: CSG): CSG;
  144700. /**
  144701. * Subtracts this CSG with another CSG in place
  144702. * @param csg The CSG to subtact against this CSG
  144703. */
  144704. subtractInPlace(csg: CSG): void;
  144705. /**
  144706. * Intersect this CSG with another CSG
  144707. * @param csg The CSG to intersect against this CSG
  144708. * @returns A new CSG
  144709. */
  144710. intersect(csg: CSG): CSG;
  144711. /**
  144712. * Intersects this CSG with another CSG in place
  144713. * @param csg The CSG to intersect against this CSG
  144714. */
  144715. intersectInPlace(csg: CSG): void;
  144716. /**
  144717. * Return a new CSG solid with solid and empty space switched. This solid is
  144718. * not modified.
  144719. * @returns A new CSG solid with solid and empty space switched
  144720. */
  144721. inverse(): CSG;
  144722. /**
  144723. * Inverses the CSG in place
  144724. */
  144725. inverseInPlace(): void;
  144726. /**
  144727. * This is used to keep meshes transformations so they can be restored
  144728. * when we build back a Babylon Mesh
  144729. * NB : All CSG operations are performed in world coordinates
  144730. * @param csg The CSG to copy the transform attributes from
  144731. * @returns This CSG
  144732. */
  144733. copyTransformAttributes(csg: CSG): CSG;
  144734. /**
  144735. * Build Raw mesh from CSG
  144736. * Coordinates here are in world space
  144737. * @param name The name of the mesh geometry
  144738. * @param scene The Scene
  144739. * @param keepSubMeshes Specifies if the submeshes should be kept
  144740. * @returns A new Mesh
  144741. */
  144742. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  144743. /**
  144744. * Build Mesh from CSG taking material and transforms into account
  144745. * @param name The name of the Mesh
  144746. * @param material The material of the Mesh
  144747. * @param scene The Scene
  144748. * @param keepSubMeshes Specifies if submeshes should be kept
  144749. * @returns The new Mesh
  144750. */
  144751. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  144752. }
  144753. }
  144754. declare module BABYLON {
  144755. /**
  144756. * Class used to create a trail following a mesh
  144757. */
  144758. export class TrailMesh extends Mesh {
  144759. private _generator;
  144760. private _autoStart;
  144761. private _running;
  144762. private _diameter;
  144763. private _length;
  144764. private _sectionPolygonPointsCount;
  144765. private _sectionVectors;
  144766. private _sectionNormalVectors;
  144767. private _beforeRenderObserver;
  144768. /**
  144769. * @constructor
  144770. * @param name The value used by scene.getMeshByName() to do a lookup.
  144771. * @param generator The mesh or transform node to generate a trail.
  144772. * @param scene The scene to add this mesh to.
  144773. * @param diameter Diameter of trailing mesh. Default is 1.
  144774. * @param length Length of trailing mesh. Default is 60.
  144775. * @param autoStart Automatically start trailing mesh. Default true.
  144776. */
  144777. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  144778. /**
  144779. * "TrailMesh"
  144780. * @returns "TrailMesh"
  144781. */
  144782. getClassName(): string;
  144783. private _createMesh;
  144784. /**
  144785. * Start trailing mesh.
  144786. */
  144787. start(): void;
  144788. /**
  144789. * Stop trailing mesh.
  144790. */
  144791. stop(): void;
  144792. /**
  144793. * Update trailing mesh geometry.
  144794. */
  144795. update(): void;
  144796. /**
  144797. * Returns a new TrailMesh object.
  144798. * @param name is a string, the name given to the new mesh
  144799. * @param newGenerator use new generator object for cloned trail mesh
  144800. * @returns a new mesh
  144801. */
  144802. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  144803. /**
  144804. * Serializes this trail mesh
  144805. * @param serializationObject object to write serialization to
  144806. */
  144807. serialize(serializationObject: any): void;
  144808. /**
  144809. * Parses a serialized trail mesh
  144810. * @param parsedMesh the serialized mesh
  144811. * @param scene the scene to create the trail mesh in
  144812. * @returns the created trail mesh
  144813. */
  144814. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  144815. }
  144816. }
  144817. declare module BABYLON {
  144818. /**
  144819. * Class containing static functions to help procedurally build meshes
  144820. */
  144821. export class TiledBoxBuilder {
  144822. /**
  144823. * Creates a box mesh
  144824. * 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)
  144825. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  144826. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144827. * * 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
  144828. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144829. * @param name defines the name of the mesh
  144830. * @param options defines the options used to create the mesh
  144831. * @param scene defines the hosting scene
  144832. * @returns the box mesh
  144833. */
  144834. static CreateTiledBox(name: string, options: {
  144835. pattern?: number;
  144836. width?: number;
  144837. height?: number;
  144838. depth?: number;
  144839. tileSize?: number;
  144840. tileWidth?: number;
  144841. tileHeight?: number;
  144842. alignHorizontal?: number;
  144843. alignVertical?: number;
  144844. faceUV?: Vector4[];
  144845. faceColors?: Color4[];
  144846. sideOrientation?: number;
  144847. updatable?: boolean;
  144848. }, scene?: Nullable<Scene>): Mesh;
  144849. }
  144850. }
  144851. declare module BABYLON {
  144852. /**
  144853. * Class containing static functions to help procedurally build meshes
  144854. */
  144855. export class TorusKnotBuilder {
  144856. /**
  144857. * Creates a torus knot mesh
  144858. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  144859. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  144860. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  144861. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  144862. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144863. * * 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
  144864. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  144865. * @param name defines the name of the mesh
  144866. * @param options defines the options used to create the mesh
  144867. * @param scene defines the hosting scene
  144868. * @returns the torus knot mesh
  144869. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  144870. */
  144871. static CreateTorusKnot(name: string, options: {
  144872. radius?: number;
  144873. tube?: number;
  144874. radialSegments?: number;
  144875. tubularSegments?: number;
  144876. p?: number;
  144877. q?: number;
  144878. updatable?: boolean;
  144879. sideOrientation?: number;
  144880. frontUVs?: Vector4;
  144881. backUVs?: Vector4;
  144882. }, scene: any): Mesh;
  144883. }
  144884. }
  144885. declare module BABYLON {
  144886. /**
  144887. * Polygon
  144888. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  144889. */
  144890. export class Polygon {
  144891. /**
  144892. * Creates a rectangle
  144893. * @param xmin bottom X coord
  144894. * @param ymin bottom Y coord
  144895. * @param xmax top X coord
  144896. * @param ymax top Y coord
  144897. * @returns points that make the resulting rectation
  144898. */
  144899. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  144900. /**
  144901. * Creates a circle
  144902. * @param radius radius of circle
  144903. * @param cx scale in x
  144904. * @param cy scale in y
  144905. * @param numberOfSides number of sides that make up the circle
  144906. * @returns points that make the resulting circle
  144907. */
  144908. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  144909. /**
  144910. * Creates a polygon from input string
  144911. * @param input Input polygon data
  144912. * @returns the parsed points
  144913. */
  144914. static Parse(input: string): Vector2[];
  144915. /**
  144916. * Starts building a polygon from x and y coordinates
  144917. * @param x x coordinate
  144918. * @param y y coordinate
  144919. * @returns the started path2
  144920. */
  144921. static StartingAt(x: number, y: number): Path2;
  144922. }
  144923. /**
  144924. * Builds a polygon
  144925. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  144926. */
  144927. export class PolygonMeshBuilder {
  144928. private _points;
  144929. private _outlinepoints;
  144930. private _holes;
  144931. private _name;
  144932. private _scene;
  144933. private _epoints;
  144934. private _eholes;
  144935. private _addToepoint;
  144936. /**
  144937. * Babylon reference to the earcut plugin.
  144938. */
  144939. bjsEarcut: any;
  144940. /**
  144941. * Creates a PolygonMeshBuilder
  144942. * @param name name of the builder
  144943. * @param contours Path of the polygon
  144944. * @param scene scene to add to when creating the mesh
  144945. * @param earcutInjection can be used to inject your own earcut reference
  144946. */
  144947. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  144948. /**
  144949. * Adds a whole within the polygon
  144950. * @param hole Array of points defining the hole
  144951. * @returns this
  144952. */
  144953. addHole(hole: Vector2[]): PolygonMeshBuilder;
  144954. /**
  144955. * Creates the polygon
  144956. * @param updatable If the mesh should be updatable
  144957. * @param depth The depth of the mesh created
  144958. * @returns the created mesh
  144959. */
  144960. build(updatable?: boolean, depth?: number): Mesh;
  144961. /**
  144962. * Creates the polygon
  144963. * @param depth The depth of the mesh created
  144964. * @returns the created VertexData
  144965. */
  144966. buildVertexData(depth?: number): VertexData;
  144967. /**
  144968. * Adds a side to the polygon
  144969. * @param positions points that make the polygon
  144970. * @param normals normals of the polygon
  144971. * @param uvs uvs of the polygon
  144972. * @param indices indices of the polygon
  144973. * @param bounds bounds of the polygon
  144974. * @param points points of the polygon
  144975. * @param depth depth of the polygon
  144976. * @param flip flip of the polygon
  144977. */
  144978. private addSide;
  144979. }
  144980. }
  144981. declare module BABYLON {
  144982. /**
  144983. * Class containing static functions to help procedurally build meshes
  144984. */
  144985. export class PolygonBuilder {
  144986. /**
  144987. * Creates a polygon mesh
  144988. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  144989. * * 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
  144990. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  144991. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144992. * * 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)
  144993. * * Remember you can only change the shape positions, not their number when updating a polygon
  144994. * @param name defines the name of the mesh
  144995. * @param options defines the options used to create the mesh
  144996. * @param scene defines the hosting scene
  144997. * @param earcutInjection can be used to inject your own earcut reference
  144998. * @returns the polygon mesh
  144999. */
  145000. static CreatePolygon(name: string, options: {
  145001. shape: Vector3[];
  145002. holes?: Vector3[][];
  145003. depth?: number;
  145004. faceUV?: Vector4[];
  145005. faceColors?: Color4[];
  145006. updatable?: boolean;
  145007. sideOrientation?: number;
  145008. frontUVs?: Vector4;
  145009. backUVs?: Vector4;
  145010. wrap?: boolean;
  145011. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145012. /**
  145013. * Creates an extruded polygon mesh, with depth in the Y direction.
  145014. * * 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)
  145015. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145016. * @param name defines the name of the mesh
  145017. * @param options defines the options used to create the mesh
  145018. * @param scene defines the hosting scene
  145019. * @param earcutInjection can be used to inject your own earcut reference
  145020. * @returns the polygon mesh
  145021. */
  145022. static ExtrudePolygon(name: string, options: {
  145023. shape: Vector3[];
  145024. holes?: Vector3[][];
  145025. depth?: number;
  145026. faceUV?: Vector4[];
  145027. faceColors?: Color4[];
  145028. updatable?: boolean;
  145029. sideOrientation?: number;
  145030. frontUVs?: Vector4;
  145031. backUVs?: Vector4;
  145032. wrap?: boolean;
  145033. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145034. }
  145035. }
  145036. declare module BABYLON {
  145037. /**
  145038. * Class containing static functions to help procedurally build meshes
  145039. */
  145040. export class LatheBuilder {
  145041. /**
  145042. * Creates lathe mesh.
  145043. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  145044. * * 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
  145045. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  145046. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  145047. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  145048. * * 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
  145049. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  145050. * * 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
  145051. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145052. * * 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
  145053. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145054. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145055. * @param name defines the name of the mesh
  145056. * @param options defines the options used to create the mesh
  145057. * @param scene defines the hosting scene
  145058. * @returns the lathe mesh
  145059. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  145060. */
  145061. static CreateLathe(name: string, options: {
  145062. shape: Vector3[];
  145063. radius?: number;
  145064. tessellation?: number;
  145065. clip?: number;
  145066. arc?: number;
  145067. closed?: boolean;
  145068. updatable?: boolean;
  145069. sideOrientation?: number;
  145070. frontUVs?: Vector4;
  145071. backUVs?: Vector4;
  145072. cap?: number;
  145073. invertUV?: boolean;
  145074. }, scene?: Nullable<Scene>): Mesh;
  145075. }
  145076. }
  145077. declare module BABYLON {
  145078. /**
  145079. * Class containing static functions to help procedurally build meshes
  145080. */
  145081. export class TiledPlaneBuilder {
  145082. /**
  145083. * Creates a tiled plane mesh
  145084. * * The parameter `pattern` will, depending on value, do nothing or
  145085. * * * flip (reflect about central vertical) alternate tiles across and up
  145086. * * * flip every tile on alternate rows
  145087. * * * rotate (180 degs) alternate tiles across and up
  145088. * * * rotate every tile on alternate rows
  145089. * * * flip and rotate alternate tiles across and up
  145090. * * * flip and rotate every tile on alternate rows
  145091. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  145092. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  145093. * * 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
  145094. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  145095. * * 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)
  145096. * * 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)
  145097. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  145098. * @param name defines the name of the mesh
  145099. * @param options defines the options used to create the mesh
  145100. * @param scene defines the hosting scene
  145101. * @returns the box mesh
  145102. */
  145103. static CreateTiledPlane(name: string, options: {
  145104. pattern?: number;
  145105. tileSize?: number;
  145106. tileWidth?: number;
  145107. tileHeight?: number;
  145108. size?: number;
  145109. width?: number;
  145110. height?: number;
  145111. alignHorizontal?: number;
  145112. alignVertical?: number;
  145113. sideOrientation?: number;
  145114. frontUVs?: Vector4;
  145115. backUVs?: Vector4;
  145116. updatable?: boolean;
  145117. }, scene?: Nullable<Scene>): Mesh;
  145118. }
  145119. }
  145120. declare module BABYLON {
  145121. /**
  145122. * Class containing static functions to help procedurally build meshes
  145123. */
  145124. export class TubeBuilder {
  145125. /**
  145126. * Creates a tube mesh.
  145127. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  145128. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  145129. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  145130. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  145131. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  145132. * * 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)
  145133. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  145134. * * 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
  145135. * * 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
  145136. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145137. * * 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
  145138. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145139. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145140. * @param name defines the name of the mesh
  145141. * @param options defines the options used to create the mesh
  145142. * @param scene defines the hosting scene
  145143. * @returns the tube mesh
  145144. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145145. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  145146. */
  145147. static CreateTube(name: string, options: {
  145148. path: Vector3[];
  145149. radius?: number;
  145150. tessellation?: number;
  145151. radiusFunction?: {
  145152. (i: number, distance: number): number;
  145153. };
  145154. cap?: number;
  145155. arc?: number;
  145156. updatable?: boolean;
  145157. sideOrientation?: number;
  145158. frontUVs?: Vector4;
  145159. backUVs?: Vector4;
  145160. instance?: Mesh;
  145161. invertUV?: boolean;
  145162. }, scene?: Nullable<Scene>): Mesh;
  145163. }
  145164. }
  145165. declare module BABYLON {
  145166. /**
  145167. * Class containing static functions to help procedurally build meshes
  145168. */
  145169. export class IcoSphereBuilder {
  145170. /**
  145171. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  145172. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  145173. * * 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`)
  145174. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  145175. * * 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
  145176. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145177. * * 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
  145178. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145179. * @param name defines the name of the mesh
  145180. * @param options defines the options used to create the mesh
  145181. * @param scene defines the hosting scene
  145182. * @returns the icosahedron mesh
  145183. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  145184. */
  145185. static CreateIcoSphere(name: string, options: {
  145186. radius?: number;
  145187. radiusX?: number;
  145188. radiusY?: number;
  145189. radiusZ?: number;
  145190. flat?: boolean;
  145191. subdivisions?: number;
  145192. sideOrientation?: number;
  145193. frontUVs?: Vector4;
  145194. backUVs?: Vector4;
  145195. updatable?: boolean;
  145196. }, scene?: Nullable<Scene>): Mesh;
  145197. }
  145198. }
  145199. declare module BABYLON {
  145200. /**
  145201. * Class containing static functions to help procedurally build meshes
  145202. */
  145203. export class DecalBuilder {
  145204. /**
  145205. * Creates a decal mesh.
  145206. * 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
  145207. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  145208. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  145209. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  145210. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  145211. * @param name defines the name of the mesh
  145212. * @param sourceMesh defines the mesh where the decal must be applied
  145213. * @param options defines the options used to create the mesh
  145214. * @param scene defines the hosting scene
  145215. * @returns the decal mesh
  145216. * @see https://doc.babylonjs.com/how_to/decals
  145217. */
  145218. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  145219. position?: Vector3;
  145220. normal?: Vector3;
  145221. size?: Vector3;
  145222. angle?: number;
  145223. }): Mesh;
  145224. }
  145225. }
  145226. declare module BABYLON {
  145227. /**
  145228. * Class containing static functions to help procedurally build meshes
  145229. */
  145230. export class MeshBuilder {
  145231. /**
  145232. * Creates a box mesh
  145233. * * The parameter `size` sets the size (float) of each box side (default 1)
  145234. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  145235. * * 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)
  145236. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145237. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145238. * * 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
  145239. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145240. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  145241. * @param name defines the name of the mesh
  145242. * @param options defines the options used to create the mesh
  145243. * @param scene defines the hosting scene
  145244. * @returns the box mesh
  145245. */
  145246. static CreateBox(name: string, options: {
  145247. size?: number;
  145248. width?: number;
  145249. height?: number;
  145250. depth?: number;
  145251. faceUV?: Vector4[];
  145252. faceColors?: Color4[];
  145253. sideOrientation?: number;
  145254. frontUVs?: Vector4;
  145255. backUVs?: Vector4;
  145256. wrap?: boolean;
  145257. topBaseAt?: number;
  145258. bottomBaseAt?: number;
  145259. updatable?: boolean;
  145260. }, scene?: Nullable<Scene>): Mesh;
  145261. /**
  145262. * Creates a tiled box mesh
  145263. * * faceTiles sets the pattern, tile size and number of tiles for a face
  145264. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145265. * @param name defines the name of the mesh
  145266. * @param options defines the options used to create the mesh
  145267. * @param scene defines the hosting scene
  145268. * @returns the tiled box mesh
  145269. */
  145270. static CreateTiledBox(name: string, options: {
  145271. pattern?: number;
  145272. size?: number;
  145273. width?: number;
  145274. height?: number;
  145275. depth: number;
  145276. tileSize?: number;
  145277. tileWidth?: number;
  145278. tileHeight?: number;
  145279. faceUV?: Vector4[];
  145280. faceColors?: Color4[];
  145281. alignHorizontal?: number;
  145282. alignVertical?: number;
  145283. sideOrientation?: number;
  145284. updatable?: boolean;
  145285. }, scene?: Nullable<Scene>): Mesh;
  145286. /**
  145287. * Creates a sphere mesh
  145288. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  145289. * * 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`)
  145290. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  145291. * * 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
  145292. * * 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)
  145293. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145294. * * 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
  145295. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145296. * @param name defines the name of the mesh
  145297. * @param options defines the options used to create the mesh
  145298. * @param scene defines the hosting scene
  145299. * @returns the sphere mesh
  145300. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  145301. */
  145302. static CreateSphere(name: string, options: {
  145303. segments?: number;
  145304. diameter?: number;
  145305. diameterX?: number;
  145306. diameterY?: number;
  145307. diameterZ?: number;
  145308. arc?: number;
  145309. slice?: number;
  145310. sideOrientation?: number;
  145311. frontUVs?: Vector4;
  145312. backUVs?: Vector4;
  145313. updatable?: boolean;
  145314. }, scene?: Nullable<Scene>): Mesh;
  145315. /**
  145316. * Creates a plane polygonal mesh. By default, this is a disc
  145317. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  145318. * * 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
  145319. * * 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
  145320. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145321. * * 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
  145322. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145323. * @param name defines the name of the mesh
  145324. * @param options defines the options used to create the mesh
  145325. * @param scene defines the hosting scene
  145326. * @returns the plane polygonal mesh
  145327. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  145328. */
  145329. static CreateDisc(name: string, options: {
  145330. radius?: number;
  145331. tessellation?: number;
  145332. arc?: number;
  145333. updatable?: boolean;
  145334. sideOrientation?: number;
  145335. frontUVs?: Vector4;
  145336. backUVs?: Vector4;
  145337. }, scene?: Nullable<Scene>): Mesh;
  145338. /**
  145339. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  145340. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  145341. * * 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`)
  145342. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  145343. * * 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
  145344. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145345. * * 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
  145346. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145347. * @param name defines the name of the mesh
  145348. * @param options defines the options used to create the mesh
  145349. * @param scene defines the hosting scene
  145350. * @returns the icosahedron mesh
  145351. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  145352. */
  145353. static CreateIcoSphere(name: string, options: {
  145354. radius?: number;
  145355. radiusX?: number;
  145356. radiusY?: number;
  145357. radiusZ?: number;
  145358. flat?: boolean;
  145359. subdivisions?: number;
  145360. sideOrientation?: number;
  145361. frontUVs?: Vector4;
  145362. backUVs?: Vector4;
  145363. updatable?: boolean;
  145364. }, scene?: Nullable<Scene>): Mesh;
  145365. /**
  145366. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  145367. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  145368. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  145369. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  145370. * * 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
  145371. * * 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
  145372. * * 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
  145373. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145374. * * 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
  145375. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145376. * * 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
  145377. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  145378. * * 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
  145379. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  145380. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145381. * @param name defines the name of the mesh
  145382. * @param options defines the options used to create the mesh
  145383. * @param scene defines the hosting scene
  145384. * @returns the ribbon mesh
  145385. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  145386. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145387. */
  145388. static CreateRibbon(name: string, options: {
  145389. pathArray: Vector3[][];
  145390. closeArray?: boolean;
  145391. closePath?: boolean;
  145392. offset?: number;
  145393. updatable?: boolean;
  145394. sideOrientation?: number;
  145395. frontUVs?: Vector4;
  145396. backUVs?: Vector4;
  145397. instance?: Mesh;
  145398. invertUV?: boolean;
  145399. uvs?: Vector2[];
  145400. colors?: Color4[];
  145401. }, scene?: Nullable<Scene>): Mesh;
  145402. /**
  145403. * Creates a cylinder or a cone mesh
  145404. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  145405. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  145406. * * 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.
  145407. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  145408. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  145409. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  145410. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  145411. * * 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).
  145412. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  145413. * * 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).
  145414. * * 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
  145415. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  145416. * * 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
  145417. * * 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.
  145418. * * If `enclose` is false, a ring surface is one element.
  145419. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  145420. * * 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
  145421. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145422. * * 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
  145423. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145424. * @param name defines the name of the mesh
  145425. * @param options defines the options used to create the mesh
  145426. * @param scene defines the hosting scene
  145427. * @returns the cylinder mesh
  145428. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  145429. */
  145430. static CreateCylinder(name: string, options: {
  145431. height?: number;
  145432. diameterTop?: number;
  145433. diameterBottom?: number;
  145434. diameter?: number;
  145435. tessellation?: number;
  145436. subdivisions?: number;
  145437. arc?: number;
  145438. faceColors?: Color4[];
  145439. faceUV?: Vector4[];
  145440. updatable?: boolean;
  145441. hasRings?: boolean;
  145442. enclose?: boolean;
  145443. cap?: number;
  145444. sideOrientation?: number;
  145445. frontUVs?: Vector4;
  145446. backUVs?: Vector4;
  145447. }, scene?: Nullable<Scene>): Mesh;
  145448. /**
  145449. * Creates a torus mesh
  145450. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  145451. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  145452. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  145453. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145454. * * 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
  145455. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145456. * @param name defines the name of the mesh
  145457. * @param options defines the options used to create the mesh
  145458. * @param scene defines the hosting scene
  145459. * @returns the torus mesh
  145460. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  145461. */
  145462. static CreateTorus(name: string, options: {
  145463. diameter?: number;
  145464. thickness?: number;
  145465. tessellation?: number;
  145466. updatable?: boolean;
  145467. sideOrientation?: number;
  145468. frontUVs?: Vector4;
  145469. backUVs?: Vector4;
  145470. }, scene?: Nullable<Scene>): Mesh;
  145471. /**
  145472. * Creates a torus knot mesh
  145473. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  145474. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  145475. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  145476. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  145477. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145478. * * 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
  145479. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145480. * @param name defines the name of the mesh
  145481. * @param options defines the options used to create the mesh
  145482. * @param scene defines the hosting scene
  145483. * @returns the torus knot mesh
  145484. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  145485. */
  145486. static CreateTorusKnot(name: string, options: {
  145487. radius?: number;
  145488. tube?: number;
  145489. radialSegments?: number;
  145490. tubularSegments?: number;
  145491. p?: number;
  145492. q?: number;
  145493. updatable?: boolean;
  145494. sideOrientation?: number;
  145495. frontUVs?: Vector4;
  145496. backUVs?: Vector4;
  145497. }, scene?: Nullable<Scene>): Mesh;
  145498. /**
  145499. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  145500. * * 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
  145501. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  145502. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  145503. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  145504. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  145505. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  145506. * * 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
  145507. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  145508. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145509. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  145510. * @param name defines the name of the new line system
  145511. * @param options defines the options used to create the line system
  145512. * @param scene defines the hosting scene
  145513. * @returns a new line system mesh
  145514. */
  145515. static CreateLineSystem(name: string, options: {
  145516. lines: Vector3[][];
  145517. updatable?: boolean;
  145518. instance?: Nullable<LinesMesh>;
  145519. colors?: Nullable<Color4[][]>;
  145520. useVertexAlpha?: boolean;
  145521. }, scene: Nullable<Scene>): LinesMesh;
  145522. /**
  145523. * Creates a line mesh
  145524. * 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
  145525. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  145526. * * The parameter `points` is an array successive Vector3
  145527. * * 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
  145528. * * The optional parameter `colors` is an array of successive Color4, one per line point
  145529. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  145530. * * When updating an instance, remember that only point positions can change, not the number of points
  145531. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145532. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  145533. * @param name defines the name of the new line system
  145534. * @param options defines the options used to create the line system
  145535. * @param scene defines the hosting scene
  145536. * @returns a new line mesh
  145537. */
  145538. static CreateLines(name: string, options: {
  145539. points: Vector3[];
  145540. updatable?: boolean;
  145541. instance?: Nullable<LinesMesh>;
  145542. colors?: Color4[];
  145543. useVertexAlpha?: boolean;
  145544. }, scene?: Nullable<Scene>): LinesMesh;
  145545. /**
  145546. * Creates a dashed line mesh
  145547. * * 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
  145548. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  145549. * * The parameter `points` is an array successive Vector3
  145550. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  145551. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  145552. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  145553. * * 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
  145554. * * When updating an instance, remember that only point positions can change, not the number of points
  145555. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145556. * @param name defines the name of the mesh
  145557. * @param options defines the options used to create the mesh
  145558. * @param scene defines the hosting scene
  145559. * @returns the dashed line mesh
  145560. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  145561. */
  145562. static CreateDashedLines(name: string, options: {
  145563. points: Vector3[];
  145564. dashSize?: number;
  145565. gapSize?: number;
  145566. dashNb?: number;
  145567. updatable?: boolean;
  145568. instance?: LinesMesh;
  145569. }, scene?: Nullable<Scene>): LinesMesh;
  145570. /**
  145571. * 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.
  145572. * * 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.
  145573. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  145574. * * 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.
  145575. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  145576. * * 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
  145577. * * 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
  145578. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  145579. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145580. * * 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
  145581. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  145582. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145583. * @param name defines the name of the mesh
  145584. * @param options defines the options used to create the mesh
  145585. * @param scene defines the hosting scene
  145586. * @returns the extruded shape mesh
  145587. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145588. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  145589. */
  145590. static ExtrudeShape(name: string, options: {
  145591. shape: Vector3[];
  145592. path: Vector3[];
  145593. scale?: number;
  145594. rotation?: number;
  145595. cap?: number;
  145596. updatable?: boolean;
  145597. sideOrientation?: number;
  145598. frontUVs?: Vector4;
  145599. backUVs?: Vector4;
  145600. instance?: Mesh;
  145601. invertUV?: boolean;
  145602. }, scene?: Nullable<Scene>): Mesh;
  145603. /**
  145604. * Creates an custom extruded shape mesh.
  145605. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  145606. * * 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.
  145607. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  145608. * * 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
  145609. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  145610. * * 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
  145611. * * It must returns a float value that will be the scale value applied to the shape on each path point
  145612. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  145613. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  145614. * * 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
  145615. * * 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
  145616. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  145617. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145618. * * 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
  145619. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145620. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145621. * @param name defines the name of the mesh
  145622. * @param options defines the options used to create the mesh
  145623. * @param scene defines the hosting scene
  145624. * @returns the custom extruded shape mesh
  145625. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  145626. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145627. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  145628. */
  145629. static ExtrudeShapeCustom(name: string, options: {
  145630. shape: Vector3[];
  145631. path: Vector3[];
  145632. scaleFunction?: any;
  145633. rotationFunction?: any;
  145634. ribbonCloseArray?: boolean;
  145635. ribbonClosePath?: boolean;
  145636. cap?: number;
  145637. updatable?: boolean;
  145638. sideOrientation?: number;
  145639. frontUVs?: Vector4;
  145640. backUVs?: Vector4;
  145641. instance?: Mesh;
  145642. invertUV?: boolean;
  145643. }, scene?: Nullable<Scene>): Mesh;
  145644. /**
  145645. * Creates lathe mesh.
  145646. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  145647. * * 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
  145648. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  145649. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  145650. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  145651. * * 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
  145652. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  145653. * * 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
  145654. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145655. * * 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
  145656. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145657. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145658. * @param name defines the name of the mesh
  145659. * @param options defines the options used to create the mesh
  145660. * @param scene defines the hosting scene
  145661. * @returns the lathe mesh
  145662. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  145663. */
  145664. static CreateLathe(name: string, options: {
  145665. shape: Vector3[];
  145666. radius?: number;
  145667. tessellation?: number;
  145668. clip?: number;
  145669. arc?: number;
  145670. closed?: boolean;
  145671. updatable?: boolean;
  145672. sideOrientation?: number;
  145673. frontUVs?: Vector4;
  145674. backUVs?: Vector4;
  145675. cap?: number;
  145676. invertUV?: boolean;
  145677. }, scene?: Nullable<Scene>): Mesh;
  145678. /**
  145679. * Creates a tiled plane mesh
  145680. * * You can set a limited pattern arrangement with the tiles
  145681. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145682. * * 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
  145683. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145684. * @param name defines the name of the mesh
  145685. * @param options defines the options used to create the mesh
  145686. * @param scene defines the hosting scene
  145687. * @returns the plane mesh
  145688. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  145689. */
  145690. static CreateTiledPlane(name: string, options: {
  145691. pattern?: number;
  145692. tileSize?: number;
  145693. tileWidth?: number;
  145694. tileHeight?: number;
  145695. size?: number;
  145696. width?: number;
  145697. height?: number;
  145698. alignHorizontal?: number;
  145699. alignVertical?: number;
  145700. sideOrientation?: number;
  145701. frontUVs?: Vector4;
  145702. backUVs?: Vector4;
  145703. updatable?: boolean;
  145704. }, scene?: Nullable<Scene>): Mesh;
  145705. /**
  145706. * Creates a plane mesh
  145707. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  145708. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  145709. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  145710. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145711. * * 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
  145712. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145713. * @param name defines the name of the mesh
  145714. * @param options defines the options used to create the mesh
  145715. * @param scene defines the hosting scene
  145716. * @returns the plane mesh
  145717. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  145718. */
  145719. static CreatePlane(name: string, options: {
  145720. size?: number;
  145721. width?: number;
  145722. height?: number;
  145723. sideOrientation?: number;
  145724. frontUVs?: Vector4;
  145725. backUVs?: Vector4;
  145726. updatable?: boolean;
  145727. sourcePlane?: Plane;
  145728. }, scene?: Nullable<Scene>): Mesh;
  145729. /**
  145730. * Creates a ground mesh
  145731. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  145732. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  145733. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145734. * @param name defines the name of the mesh
  145735. * @param options defines the options used to create the mesh
  145736. * @param scene defines the hosting scene
  145737. * @returns the ground mesh
  145738. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  145739. */
  145740. static CreateGround(name: string, options: {
  145741. width?: number;
  145742. height?: number;
  145743. subdivisions?: number;
  145744. subdivisionsX?: number;
  145745. subdivisionsY?: number;
  145746. updatable?: boolean;
  145747. }, scene?: Nullable<Scene>): Mesh;
  145748. /**
  145749. * Creates a tiled ground mesh
  145750. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  145751. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  145752. * * 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
  145753. * * 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
  145754. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145755. * @param name defines the name of the mesh
  145756. * @param options defines the options used to create the mesh
  145757. * @param scene defines the hosting scene
  145758. * @returns the tiled ground mesh
  145759. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  145760. */
  145761. static CreateTiledGround(name: string, options: {
  145762. xmin: number;
  145763. zmin: number;
  145764. xmax: number;
  145765. zmax: number;
  145766. subdivisions?: {
  145767. w: number;
  145768. h: number;
  145769. };
  145770. precision?: {
  145771. w: number;
  145772. h: number;
  145773. };
  145774. updatable?: boolean;
  145775. }, scene?: Nullable<Scene>): Mesh;
  145776. /**
  145777. * Creates a ground mesh from a height map
  145778. * * The parameter `url` sets the URL of the height map image resource.
  145779. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  145780. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  145781. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  145782. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  145783. * * 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.
  145784. * * 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).
  145785. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  145786. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145787. * @param name defines the name of the mesh
  145788. * @param url defines the url to the height map
  145789. * @param options defines the options used to create the mesh
  145790. * @param scene defines the hosting scene
  145791. * @returns the ground mesh
  145792. * @see https://doc.babylonjs.com/babylon101/height_map
  145793. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  145794. */
  145795. static CreateGroundFromHeightMap(name: string, url: string, options: {
  145796. width?: number;
  145797. height?: number;
  145798. subdivisions?: number;
  145799. minHeight?: number;
  145800. maxHeight?: number;
  145801. colorFilter?: Color3;
  145802. alphaFilter?: number;
  145803. updatable?: boolean;
  145804. onReady?: (mesh: GroundMesh) => void;
  145805. }, scene?: Nullable<Scene>): GroundMesh;
  145806. /**
  145807. * Creates a polygon mesh
  145808. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  145809. * * 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
  145810. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  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. * * 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)
  145813. * * Remember you can only change the shape positions, not their number when updating a polygon
  145814. * @param name defines the name of the mesh
  145815. * @param options defines the options used to create the mesh
  145816. * @param scene defines the hosting scene
  145817. * @param earcutInjection can be used to inject your own earcut reference
  145818. * @returns the polygon mesh
  145819. */
  145820. static CreatePolygon(name: string, options: {
  145821. shape: Vector3[];
  145822. holes?: Vector3[][];
  145823. depth?: number;
  145824. faceUV?: Vector4[];
  145825. faceColors?: Color4[];
  145826. updatable?: boolean;
  145827. sideOrientation?: number;
  145828. frontUVs?: Vector4;
  145829. backUVs?: Vector4;
  145830. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145831. /**
  145832. * Creates an extruded polygon mesh, with depth in the Y direction.
  145833. * * 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)
  145834. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145835. * @param name defines the name of the mesh
  145836. * @param options defines the options used to create the mesh
  145837. * @param scene defines the hosting scene
  145838. * @param earcutInjection can be used to inject your own earcut reference
  145839. * @returns the polygon mesh
  145840. */
  145841. static ExtrudePolygon(name: string, options: {
  145842. shape: Vector3[];
  145843. holes?: Vector3[][];
  145844. depth?: number;
  145845. faceUV?: Vector4[];
  145846. faceColors?: Color4[];
  145847. updatable?: boolean;
  145848. sideOrientation?: number;
  145849. frontUVs?: Vector4;
  145850. backUVs?: Vector4;
  145851. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145852. /**
  145853. * Creates a tube mesh.
  145854. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  145855. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  145856. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  145857. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  145858. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  145859. * * 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)
  145860. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  145861. * * 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
  145862. * * 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
  145863. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145864. * * 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
  145865. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145866. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145867. * @param name defines the name of the mesh
  145868. * @param options defines the options used to create the mesh
  145869. * @param scene defines the hosting scene
  145870. * @returns the tube mesh
  145871. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145872. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  145873. */
  145874. static CreateTube(name: string, options: {
  145875. path: Vector3[];
  145876. radius?: number;
  145877. tessellation?: number;
  145878. radiusFunction?: {
  145879. (i: number, distance: number): number;
  145880. };
  145881. cap?: number;
  145882. arc?: number;
  145883. updatable?: boolean;
  145884. sideOrientation?: number;
  145885. frontUVs?: Vector4;
  145886. backUVs?: Vector4;
  145887. instance?: Mesh;
  145888. invertUV?: boolean;
  145889. }, scene?: Nullable<Scene>): Mesh;
  145890. /**
  145891. * Creates a polyhedron mesh
  145892. * * 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
  145893. * * The parameter `size` (positive float, default 1) sets the polygon size
  145894. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  145895. * * 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`
  145896. * * 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
  145897. * * 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)`)
  145898. * * 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
  145899. * * 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
  145900. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145901. * * 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
  145902. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145903. * @param name defines the name of the mesh
  145904. * @param options defines the options used to create the mesh
  145905. * @param scene defines the hosting scene
  145906. * @returns the polyhedron mesh
  145907. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  145908. */
  145909. static CreatePolyhedron(name: string, options: {
  145910. type?: number;
  145911. size?: number;
  145912. sizeX?: number;
  145913. sizeY?: number;
  145914. sizeZ?: number;
  145915. custom?: any;
  145916. faceUV?: Vector4[];
  145917. faceColors?: Color4[];
  145918. flat?: boolean;
  145919. updatable?: boolean;
  145920. sideOrientation?: number;
  145921. frontUVs?: Vector4;
  145922. backUVs?: Vector4;
  145923. }, scene?: Nullable<Scene>): Mesh;
  145924. /**
  145925. * Creates a decal mesh.
  145926. * 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
  145927. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  145928. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  145929. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  145930. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  145931. * @param name defines the name of the mesh
  145932. * @param sourceMesh defines the mesh where the decal must be applied
  145933. * @param options defines the options used to create the mesh
  145934. * @param scene defines the hosting scene
  145935. * @returns the decal mesh
  145936. * @see https://doc.babylonjs.com/how_to/decals
  145937. */
  145938. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  145939. position?: Vector3;
  145940. normal?: Vector3;
  145941. size?: Vector3;
  145942. angle?: number;
  145943. }): Mesh;
  145944. }
  145945. }
  145946. declare module BABYLON {
  145947. /**
  145948. * A simplifier interface for future simplification implementations
  145949. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  145950. */
  145951. export interface ISimplifier {
  145952. /**
  145953. * Simplification of a given mesh according to the given settings.
  145954. * Since this requires computation, it is assumed that the function runs async.
  145955. * @param settings The settings of the simplification, including quality and distance
  145956. * @param successCallback A callback that will be called after the mesh was simplified.
  145957. * @param errorCallback in case of an error, this callback will be called. optional.
  145958. */
  145959. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  145960. }
  145961. /**
  145962. * Expected simplification settings.
  145963. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  145964. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  145965. */
  145966. export interface ISimplificationSettings {
  145967. /**
  145968. * Gets or sets the expected quality
  145969. */
  145970. quality: number;
  145971. /**
  145972. * Gets or sets the distance when this optimized version should be used
  145973. */
  145974. distance: number;
  145975. /**
  145976. * Gets an already optimized mesh
  145977. */
  145978. optimizeMesh?: boolean;
  145979. }
  145980. /**
  145981. * Class used to specify simplification options
  145982. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  145983. */
  145984. export class SimplificationSettings implements ISimplificationSettings {
  145985. /** expected quality */
  145986. quality: number;
  145987. /** distance when this optimized version should be used */
  145988. distance: number;
  145989. /** already optimized mesh */
  145990. optimizeMesh?: boolean | undefined;
  145991. /**
  145992. * Creates a SimplificationSettings
  145993. * @param quality expected quality
  145994. * @param distance distance when this optimized version should be used
  145995. * @param optimizeMesh already optimized mesh
  145996. */
  145997. constructor(
  145998. /** expected quality */
  145999. quality: number,
  146000. /** distance when this optimized version should be used */
  146001. distance: number,
  146002. /** already optimized mesh */
  146003. optimizeMesh?: boolean | undefined);
  146004. }
  146005. /**
  146006. * Interface used to define a simplification task
  146007. */
  146008. export interface ISimplificationTask {
  146009. /**
  146010. * Array of settings
  146011. */
  146012. settings: Array<ISimplificationSettings>;
  146013. /**
  146014. * Simplification type
  146015. */
  146016. simplificationType: SimplificationType;
  146017. /**
  146018. * Mesh to simplify
  146019. */
  146020. mesh: Mesh;
  146021. /**
  146022. * Callback called on success
  146023. */
  146024. successCallback?: () => void;
  146025. /**
  146026. * Defines if parallel processing can be used
  146027. */
  146028. parallelProcessing: boolean;
  146029. }
  146030. /**
  146031. * Queue used to order the simplification tasks
  146032. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146033. */
  146034. export class SimplificationQueue {
  146035. private _simplificationArray;
  146036. /**
  146037. * Gets a boolean indicating that the process is still running
  146038. */
  146039. running: boolean;
  146040. /**
  146041. * Creates a new queue
  146042. */
  146043. constructor();
  146044. /**
  146045. * Adds a new simplification task
  146046. * @param task defines a task to add
  146047. */
  146048. addTask(task: ISimplificationTask): void;
  146049. /**
  146050. * Execute next task
  146051. */
  146052. executeNext(): void;
  146053. /**
  146054. * Execute a simplification task
  146055. * @param task defines the task to run
  146056. */
  146057. runSimplification(task: ISimplificationTask): void;
  146058. private getSimplifier;
  146059. }
  146060. /**
  146061. * The implemented types of simplification
  146062. * At the moment only Quadratic Error Decimation is implemented
  146063. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146064. */
  146065. export enum SimplificationType {
  146066. /** Quadratic error decimation */
  146067. QUADRATIC = 0
  146068. }
  146069. /**
  146070. * An implementation of the Quadratic Error simplification algorithm.
  146071. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  146072. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  146073. * @author RaananW
  146074. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146075. */
  146076. export class QuadraticErrorSimplification implements ISimplifier {
  146077. private _mesh;
  146078. private triangles;
  146079. private vertices;
  146080. private references;
  146081. private _reconstructedMesh;
  146082. /** Gets or sets the number pf sync interations */
  146083. syncIterations: number;
  146084. /** Gets or sets the aggressiveness of the simplifier */
  146085. aggressiveness: number;
  146086. /** Gets or sets the number of allowed iterations for decimation */
  146087. decimationIterations: number;
  146088. /** Gets or sets the espilon to use for bounding box computation */
  146089. boundingBoxEpsilon: number;
  146090. /**
  146091. * Creates a new QuadraticErrorSimplification
  146092. * @param _mesh defines the target mesh
  146093. */
  146094. constructor(_mesh: Mesh);
  146095. /**
  146096. * Simplification of a given mesh according to the given settings.
  146097. * Since this requires computation, it is assumed that the function runs async.
  146098. * @param settings The settings of the simplification, including quality and distance
  146099. * @param successCallback A callback that will be called after the mesh was simplified.
  146100. */
  146101. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  146102. private runDecimation;
  146103. private initWithMesh;
  146104. private init;
  146105. private reconstructMesh;
  146106. private initDecimatedMesh;
  146107. private isFlipped;
  146108. private updateTriangles;
  146109. private identifyBorder;
  146110. private updateMesh;
  146111. private vertexError;
  146112. private calculateError;
  146113. }
  146114. }
  146115. declare module BABYLON {
  146116. interface Scene {
  146117. /** @hidden (Backing field) */
  146118. _simplificationQueue: SimplificationQueue;
  146119. /**
  146120. * Gets or sets the simplification queue attached to the scene
  146121. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146122. */
  146123. simplificationQueue: SimplificationQueue;
  146124. }
  146125. interface Mesh {
  146126. /**
  146127. * Simplify the mesh according to the given array of settings.
  146128. * Function will return immediately and will simplify async
  146129. * @param settings a collection of simplification settings
  146130. * @param parallelProcessing should all levels calculate parallel or one after the other
  146131. * @param simplificationType the type of simplification to run
  146132. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  146133. * @returns the current mesh
  146134. */
  146135. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  146136. }
  146137. /**
  146138. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  146139. * created in a scene
  146140. */
  146141. export class SimplicationQueueSceneComponent implements ISceneComponent {
  146142. /**
  146143. * The component name helpfull to identify the component in the list of scene components.
  146144. */
  146145. readonly name: string;
  146146. /**
  146147. * The scene the component belongs to.
  146148. */
  146149. scene: Scene;
  146150. /**
  146151. * Creates a new instance of the component for the given scene
  146152. * @param scene Defines the scene to register the component in
  146153. */
  146154. constructor(scene: Scene);
  146155. /**
  146156. * Registers the component in a given scene
  146157. */
  146158. register(): void;
  146159. /**
  146160. * Rebuilds the elements related to this component in case of
  146161. * context lost for instance.
  146162. */
  146163. rebuild(): void;
  146164. /**
  146165. * Disposes the component and the associated ressources
  146166. */
  146167. dispose(): void;
  146168. private _beforeCameraUpdate;
  146169. }
  146170. }
  146171. declare module BABYLON {
  146172. interface Mesh {
  146173. /**
  146174. * Gets or sets a boolean defining if we want picking to pick thin instances as well
  146175. */
  146176. thinInstanceEnablePicking: boolean;
  146177. /**
  146178. * Creates a new thin instance
  146179. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  146180. * @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
  146181. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  146182. */
  146183. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  146184. /**
  146185. * Adds the transformation (matrix) of the current mesh as a thin instance
  146186. * @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
  146187. * @returns the thin instance index number
  146188. */
  146189. thinInstanceAddSelf(refresh: boolean): number;
  146190. /**
  146191. * Registers a custom attribute to be used with thin instances
  146192. * @param kind name of the attribute
  146193. * @param stride size in floats of the attribute
  146194. */
  146195. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  146196. /**
  146197. * Sets the matrix of a thin instance
  146198. * @param index index of the thin instance
  146199. * @param matrix matrix to set
  146200. * @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
  146201. */
  146202. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  146203. /**
  146204. * Sets the value of a custom attribute for a thin instance
  146205. * @param kind name of the attribute
  146206. * @param index index of the thin instance
  146207. * @param value value to set
  146208. * @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
  146209. */
  146210. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  146211. /**
  146212. * 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.
  146213. */
  146214. thinInstanceCount: number;
  146215. /**
  146216. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  146217. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  146218. * @param buffer buffer to set
  146219. * @param stride size in floats of each value of the buffer
  146220. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  146221. */
  146222. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  146223. /**
  146224. * Gets the list of world matrices
  146225. * @return an array containing all the world matrices from the thin instances
  146226. */
  146227. thinInstanceGetWorldMatrices(): Matrix[];
  146228. /**
  146229. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  146230. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  146231. */
  146232. thinInstanceBufferUpdated(kind: string): void;
  146233. /**
  146234. * Refreshes the bounding info, taking into account all the thin instances defined
  146235. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  146236. */
  146237. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  146238. /** @hidden */
  146239. _thinInstanceInitializeUserStorage(): void;
  146240. /** @hidden */
  146241. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  146242. /** @hidden */
  146243. _userThinInstanceBuffersStorage: {
  146244. data: {
  146245. [key: string]: Float32Array;
  146246. };
  146247. sizes: {
  146248. [key: string]: number;
  146249. };
  146250. vertexBuffers: {
  146251. [key: string]: Nullable<VertexBuffer>;
  146252. };
  146253. strides: {
  146254. [key: string]: number;
  146255. };
  146256. };
  146257. }
  146258. }
  146259. declare module BABYLON {
  146260. /**
  146261. * Navigation plugin interface to add navigation constrained by a navigation mesh
  146262. */
  146263. export interface INavigationEnginePlugin {
  146264. /**
  146265. * plugin name
  146266. */
  146267. name: string;
  146268. /**
  146269. * Creates a navigation mesh
  146270. * @param meshes array of all the geometry used to compute the navigatio mesh
  146271. * @param parameters bunch of parameters used to filter geometry
  146272. */
  146273. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  146274. /**
  146275. * Create a navigation mesh debug mesh
  146276. * @param scene is where the mesh will be added
  146277. * @returns debug display mesh
  146278. */
  146279. createDebugNavMesh(scene: Scene): Mesh;
  146280. /**
  146281. * Get a navigation mesh constrained position, closest to the parameter position
  146282. * @param position world position
  146283. * @returns the closest point to position constrained by the navigation mesh
  146284. */
  146285. getClosestPoint(position: Vector3): Vector3;
  146286. /**
  146287. * Get a navigation mesh constrained position, closest to the parameter position
  146288. * @param position world position
  146289. * @param result output the closest point to position constrained by the navigation mesh
  146290. */
  146291. getClosestPointToRef(position: Vector3, result: Vector3): void;
  146292. /**
  146293. * Get a navigation mesh constrained position, within a particular radius
  146294. * @param position world position
  146295. * @param maxRadius the maximum distance to the constrained world position
  146296. * @returns the closest point to position constrained by the navigation mesh
  146297. */
  146298. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  146299. /**
  146300. * Get a navigation mesh constrained position, within a particular radius
  146301. * @param position world position
  146302. * @param maxRadius the maximum distance to the constrained world position
  146303. * @param result output the closest point to position constrained by the navigation mesh
  146304. */
  146305. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  146306. /**
  146307. * Compute the final position from a segment made of destination-position
  146308. * @param position world position
  146309. * @param destination world position
  146310. * @returns the resulting point along the navmesh
  146311. */
  146312. moveAlong(position: Vector3, destination: Vector3): Vector3;
  146313. /**
  146314. * Compute the final position from a segment made of destination-position
  146315. * @param position world position
  146316. * @param destination world position
  146317. * @param result output the resulting point along the navmesh
  146318. */
  146319. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  146320. /**
  146321. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  146322. * @param start world position
  146323. * @param end world position
  146324. * @returns array containing world position composing the path
  146325. */
  146326. computePath(start: Vector3, end: Vector3): Vector3[];
  146327. /**
  146328. * If this plugin is supported
  146329. * @returns true if plugin is supported
  146330. */
  146331. isSupported(): boolean;
  146332. /**
  146333. * Create a new Crowd so you can add agents
  146334. * @param maxAgents the maximum agent count in the crowd
  146335. * @param maxAgentRadius the maximum radius an agent can have
  146336. * @param scene to attach the crowd to
  146337. * @returns the crowd you can add agents to
  146338. */
  146339. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  146340. /**
  146341. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146342. * The queries will try to find a solution within those bounds
  146343. * default is (1,1,1)
  146344. * @param extent x,y,z value that define the extent around the queries point of reference
  146345. */
  146346. setDefaultQueryExtent(extent: Vector3): void;
  146347. /**
  146348. * Get the Bounding box extent specified by setDefaultQueryExtent
  146349. * @returns the box extent values
  146350. */
  146351. getDefaultQueryExtent(): Vector3;
  146352. /**
  146353. * build the navmesh from a previously saved state using getNavmeshData
  146354. * @param data the Uint8Array returned by getNavmeshData
  146355. */
  146356. buildFromNavmeshData(data: Uint8Array): void;
  146357. /**
  146358. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  146359. * @returns data the Uint8Array that can be saved and reused
  146360. */
  146361. getNavmeshData(): Uint8Array;
  146362. /**
  146363. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146364. * @param result output the box extent values
  146365. */
  146366. getDefaultQueryExtentToRef(result: Vector3): void;
  146367. /**
  146368. * Release all resources
  146369. */
  146370. dispose(): void;
  146371. }
  146372. /**
  146373. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  146374. */
  146375. export interface ICrowd {
  146376. /**
  146377. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  146378. * You can attach anything to that node. The node position is updated in the scene update tick.
  146379. * @param pos world position that will be constrained by the navigation mesh
  146380. * @param parameters agent parameters
  146381. * @param transform hooked to the agent that will be update by the scene
  146382. * @returns agent index
  146383. */
  146384. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  146385. /**
  146386. * Returns the agent position in world space
  146387. * @param index agent index returned by addAgent
  146388. * @returns world space position
  146389. */
  146390. getAgentPosition(index: number): Vector3;
  146391. /**
  146392. * Gets the agent position result in world space
  146393. * @param index agent index returned by addAgent
  146394. * @param result output world space position
  146395. */
  146396. getAgentPositionToRef(index: number, result: Vector3): void;
  146397. /**
  146398. * Gets the agent velocity in world space
  146399. * @param index agent index returned by addAgent
  146400. * @returns world space velocity
  146401. */
  146402. getAgentVelocity(index: number): Vector3;
  146403. /**
  146404. * Gets the agent velocity result in world space
  146405. * @param index agent index returned by addAgent
  146406. * @param result output world space velocity
  146407. */
  146408. getAgentVelocityToRef(index: number, result: Vector3): void;
  146409. /**
  146410. * remove a particular agent previously created
  146411. * @param index agent index returned by addAgent
  146412. */
  146413. removeAgent(index: number): void;
  146414. /**
  146415. * get the list of all agents attached to this crowd
  146416. * @returns list of agent indices
  146417. */
  146418. getAgents(): number[];
  146419. /**
  146420. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  146421. * @param deltaTime in seconds
  146422. */
  146423. update(deltaTime: number): void;
  146424. /**
  146425. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  146426. * @param index agent index returned by addAgent
  146427. * @param destination targeted world position
  146428. */
  146429. agentGoto(index: number, destination: Vector3): void;
  146430. /**
  146431. * Teleport the agent to a new position
  146432. * @param index agent index returned by addAgent
  146433. * @param destination targeted world position
  146434. */
  146435. agentTeleport(index: number, destination: Vector3): void;
  146436. /**
  146437. * Update agent parameters
  146438. * @param index agent index returned by addAgent
  146439. * @param parameters agent parameters
  146440. */
  146441. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  146442. /**
  146443. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146444. * The queries will try to find a solution within those bounds
  146445. * default is (1,1,1)
  146446. * @param extent x,y,z value that define the extent around the queries point of reference
  146447. */
  146448. setDefaultQueryExtent(extent: Vector3): void;
  146449. /**
  146450. * Get the Bounding box extent specified by setDefaultQueryExtent
  146451. * @returns the box extent values
  146452. */
  146453. getDefaultQueryExtent(): Vector3;
  146454. /**
  146455. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146456. * @param result output the box extent values
  146457. */
  146458. getDefaultQueryExtentToRef(result: Vector3): void;
  146459. /**
  146460. * Release all resources
  146461. */
  146462. dispose(): void;
  146463. }
  146464. /**
  146465. * Configures an agent
  146466. */
  146467. export interface IAgentParameters {
  146468. /**
  146469. * Agent radius. [Limit: >= 0]
  146470. */
  146471. radius: number;
  146472. /**
  146473. * Agent height. [Limit: > 0]
  146474. */
  146475. height: number;
  146476. /**
  146477. * Maximum allowed acceleration. [Limit: >= 0]
  146478. */
  146479. maxAcceleration: number;
  146480. /**
  146481. * Maximum allowed speed. [Limit: >= 0]
  146482. */
  146483. maxSpeed: number;
  146484. /**
  146485. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  146486. */
  146487. collisionQueryRange: number;
  146488. /**
  146489. * The path visibility optimization range. [Limit: > 0]
  146490. */
  146491. pathOptimizationRange: number;
  146492. /**
  146493. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  146494. */
  146495. separationWeight: number;
  146496. }
  146497. /**
  146498. * Configures the navigation mesh creation
  146499. */
  146500. export interface INavMeshParameters {
  146501. /**
  146502. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  146503. */
  146504. cs: number;
  146505. /**
  146506. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  146507. */
  146508. ch: number;
  146509. /**
  146510. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  146511. */
  146512. walkableSlopeAngle: number;
  146513. /**
  146514. * Minimum floor to 'ceiling' height that will still allow the floor area to
  146515. * be considered walkable. [Limit: >= 3] [Units: vx]
  146516. */
  146517. walkableHeight: number;
  146518. /**
  146519. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  146520. */
  146521. walkableClimb: number;
  146522. /**
  146523. * The distance to erode/shrink the walkable area of the heightfield away from
  146524. * obstructions. [Limit: >=0] [Units: vx]
  146525. */
  146526. walkableRadius: number;
  146527. /**
  146528. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  146529. */
  146530. maxEdgeLen: number;
  146531. /**
  146532. * The maximum distance a simplfied contour's border edges should deviate
  146533. * the original raw contour. [Limit: >=0] [Units: vx]
  146534. */
  146535. maxSimplificationError: number;
  146536. /**
  146537. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  146538. */
  146539. minRegionArea: number;
  146540. /**
  146541. * Any regions with a span count smaller than this value will, if possible,
  146542. * be merged with larger regions. [Limit: >=0] [Units: vx]
  146543. */
  146544. mergeRegionArea: number;
  146545. /**
  146546. * The maximum number of vertices allowed for polygons generated during the
  146547. * contour to polygon conversion process. [Limit: >= 3]
  146548. */
  146549. maxVertsPerPoly: number;
  146550. /**
  146551. * Sets the sampling distance to use when generating the detail mesh.
  146552. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  146553. */
  146554. detailSampleDist: number;
  146555. /**
  146556. * The maximum distance the detail mesh surface should deviate from heightfield
  146557. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  146558. */
  146559. detailSampleMaxError: number;
  146560. }
  146561. }
  146562. declare module BABYLON {
  146563. /**
  146564. * RecastJS navigation plugin
  146565. */
  146566. export class RecastJSPlugin implements INavigationEnginePlugin {
  146567. /**
  146568. * Reference to the Recast library
  146569. */
  146570. bjsRECAST: any;
  146571. /**
  146572. * plugin name
  146573. */
  146574. name: string;
  146575. /**
  146576. * the first navmesh created. We might extend this to support multiple navmeshes
  146577. */
  146578. navMesh: any;
  146579. /**
  146580. * Initializes the recastJS plugin
  146581. * @param recastInjection can be used to inject your own recast reference
  146582. */
  146583. constructor(recastInjection?: any);
  146584. /**
  146585. * Creates a navigation mesh
  146586. * @param meshes array of all the geometry used to compute the navigatio mesh
  146587. * @param parameters bunch of parameters used to filter geometry
  146588. */
  146589. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  146590. /**
  146591. * Create a navigation mesh debug mesh
  146592. * @param scene is where the mesh will be added
  146593. * @returns debug display mesh
  146594. */
  146595. createDebugNavMesh(scene: Scene): Mesh;
  146596. /**
  146597. * Get a navigation mesh constrained position, closest to the parameter position
  146598. * @param position world position
  146599. * @returns the closest point to position constrained by the navigation mesh
  146600. */
  146601. getClosestPoint(position: Vector3): Vector3;
  146602. /**
  146603. * Get a navigation mesh constrained position, closest to the parameter position
  146604. * @param position world position
  146605. * @param result output the closest point to position constrained by the navigation mesh
  146606. */
  146607. getClosestPointToRef(position: Vector3, result: Vector3): void;
  146608. /**
  146609. * Get a navigation mesh constrained position, within a particular radius
  146610. * @param position world position
  146611. * @param maxRadius the maximum distance to the constrained world position
  146612. * @returns the closest point to position constrained by the navigation mesh
  146613. */
  146614. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  146615. /**
  146616. * Get a navigation mesh constrained position, within a particular radius
  146617. * @param position world position
  146618. * @param maxRadius the maximum distance to the constrained world position
  146619. * @param result output the closest point to position constrained by the navigation mesh
  146620. */
  146621. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  146622. /**
  146623. * Compute the final position from a segment made of destination-position
  146624. * @param position world position
  146625. * @param destination world position
  146626. * @returns the resulting point along the navmesh
  146627. */
  146628. moveAlong(position: Vector3, destination: Vector3): Vector3;
  146629. /**
  146630. * Compute the final position from a segment made of destination-position
  146631. * @param position world position
  146632. * @param destination world position
  146633. * @param result output the resulting point along the navmesh
  146634. */
  146635. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  146636. /**
  146637. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  146638. * @param start world position
  146639. * @param end world position
  146640. * @returns array containing world position composing the path
  146641. */
  146642. computePath(start: Vector3, end: Vector3): Vector3[];
  146643. /**
  146644. * Create a new Crowd so you can add agents
  146645. * @param maxAgents the maximum agent count in the crowd
  146646. * @param maxAgentRadius the maximum radius an agent can have
  146647. * @param scene to attach the crowd to
  146648. * @returns the crowd you can add agents to
  146649. */
  146650. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  146651. /**
  146652. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146653. * The queries will try to find a solution within those bounds
  146654. * default is (1,1,1)
  146655. * @param extent x,y,z value that define the extent around the queries point of reference
  146656. */
  146657. setDefaultQueryExtent(extent: Vector3): void;
  146658. /**
  146659. * Get the Bounding box extent specified by setDefaultQueryExtent
  146660. * @returns the box extent values
  146661. */
  146662. getDefaultQueryExtent(): Vector3;
  146663. /**
  146664. * build the navmesh from a previously saved state using getNavmeshData
  146665. * @param data the Uint8Array returned by getNavmeshData
  146666. */
  146667. buildFromNavmeshData(data: Uint8Array): void;
  146668. /**
  146669. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  146670. * @returns data the Uint8Array that can be saved and reused
  146671. */
  146672. getNavmeshData(): Uint8Array;
  146673. /**
  146674. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146675. * @param result output the box extent values
  146676. */
  146677. getDefaultQueryExtentToRef(result: Vector3): void;
  146678. /**
  146679. * Disposes
  146680. */
  146681. dispose(): void;
  146682. /**
  146683. * If this plugin is supported
  146684. * @returns true if plugin is supported
  146685. */
  146686. isSupported(): boolean;
  146687. }
  146688. /**
  146689. * Recast detour crowd implementation
  146690. */
  146691. export class RecastJSCrowd implements ICrowd {
  146692. /**
  146693. * Recast/detour plugin
  146694. */
  146695. bjsRECASTPlugin: RecastJSPlugin;
  146696. /**
  146697. * Link to the detour crowd
  146698. */
  146699. recastCrowd: any;
  146700. /**
  146701. * One transform per agent
  146702. */
  146703. transforms: TransformNode[];
  146704. /**
  146705. * All agents created
  146706. */
  146707. agents: number[];
  146708. /**
  146709. * Link to the scene is kept to unregister the crowd from the scene
  146710. */
  146711. private _scene;
  146712. /**
  146713. * Observer for crowd updates
  146714. */
  146715. private _onBeforeAnimationsObserver;
  146716. /**
  146717. * Constructor
  146718. * @param plugin recastJS plugin
  146719. * @param maxAgents the maximum agent count in the crowd
  146720. * @param maxAgentRadius the maximum radius an agent can have
  146721. * @param scene to attach the crowd to
  146722. * @returns the crowd you can add agents to
  146723. */
  146724. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  146725. /**
  146726. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  146727. * You can attach anything to that node. The node position is updated in the scene update tick.
  146728. * @param pos world position that will be constrained by the navigation mesh
  146729. * @param parameters agent parameters
  146730. * @param transform hooked to the agent that will be update by the scene
  146731. * @returns agent index
  146732. */
  146733. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  146734. /**
  146735. * Returns the agent position in world space
  146736. * @param index agent index returned by addAgent
  146737. * @returns world space position
  146738. */
  146739. getAgentPosition(index: number): Vector3;
  146740. /**
  146741. * Returns the agent position result in world space
  146742. * @param index agent index returned by addAgent
  146743. * @param result output world space position
  146744. */
  146745. getAgentPositionToRef(index: number, result: Vector3): void;
  146746. /**
  146747. * Returns the agent velocity in world space
  146748. * @param index agent index returned by addAgent
  146749. * @returns world space velocity
  146750. */
  146751. getAgentVelocity(index: number): Vector3;
  146752. /**
  146753. * Returns the agent velocity result in world space
  146754. * @param index agent index returned by addAgent
  146755. * @param result output world space velocity
  146756. */
  146757. getAgentVelocityToRef(index: number, result: Vector3): void;
  146758. /**
  146759. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  146760. * @param index agent index returned by addAgent
  146761. * @param destination targeted world position
  146762. */
  146763. agentGoto(index: number, destination: Vector3): void;
  146764. /**
  146765. * Teleport the agent to a new position
  146766. * @param index agent index returned by addAgent
  146767. * @param destination targeted world position
  146768. */
  146769. agentTeleport(index: number, destination: Vector3): void;
  146770. /**
  146771. * Update agent parameters
  146772. * @param index agent index returned by addAgent
  146773. * @param parameters agent parameters
  146774. */
  146775. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  146776. /**
  146777. * remove a particular agent previously created
  146778. * @param index agent index returned by addAgent
  146779. */
  146780. removeAgent(index: number): void;
  146781. /**
  146782. * get the list of all agents attached to this crowd
  146783. * @returns list of agent indices
  146784. */
  146785. getAgents(): number[];
  146786. /**
  146787. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  146788. * @param deltaTime in seconds
  146789. */
  146790. update(deltaTime: number): void;
  146791. /**
  146792. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146793. * The queries will try to find a solution within those bounds
  146794. * default is (1,1,1)
  146795. * @param extent x,y,z value that define the extent around the queries point of reference
  146796. */
  146797. setDefaultQueryExtent(extent: Vector3): void;
  146798. /**
  146799. * Get the Bounding box extent specified by setDefaultQueryExtent
  146800. * @returns the box extent values
  146801. */
  146802. getDefaultQueryExtent(): Vector3;
  146803. /**
  146804. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146805. * @param result output the box extent values
  146806. */
  146807. getDefaultQueryExtentToRef(result: Vector3): void;
  146808. /**
  146809. * Release all resources
  146810. */
  146811. dispose(): void;
  146812. }
  146813. }
  146814. declare module BABYLON {
  146815. /**
  146816. * Class used to enable access to IndexedDB
  146817. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  146818. */
  146819. export class Database implements IOfflineProvider {
  146820. private _callbackManifestChecked;
  146821. private _currentSceneUrl;
  146822. private _db;
  146823. private _enableSceneOffline;
  146824. private _enableTexturesOffline;
  146825. private _manifestVersionFound;
  146826. private _mustUpdateRessources;
  146827. private _hasReachedQuota;
  146828. private _isSupported;
  146829. private _idbFactory;
  146830. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  146831. private static IsUASupportingBlobStorage;
  146832. /**
  146833. * Gets a boolean indicating if Database storate is enabled (off by default)
  146834. */
  146835. static IDBStorageEnabled: boolean;
  146836. /**
  146837. * Gets a boolean indicating if scene must be saved in the database
  146838. */
  146839. get enableSceneOffline(): boolean;
  146840. /**
  146841. * Gets a boolean indicating if textures must be saved in the database
  146842. */
  146843. get enableTexturesOffline(): boolean;
  146844. /**
  146845. * Creates a new Database
  146846. * @param urlToScene defines the url to load the scene
  146847. * @param callbackManifestChecked defines the callback to use when manifest is checked
  146848. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  146849. */
  146850. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  146851. private static _ParseURL;
  146852. private static _ReturnFullUrlLocation;
  146853. private _checkManifestFile;
  146854. /**
  146855. * Open the database and make it available
  146856. * @param successCallback defines the callback to call on success
  146857. * @param errorCallback defines the callback to call on error
  146858. */
  146859. open(successCallback: () => void, errorCallback: () => void): void;
  146860. /**
  146861. * Loads an image from the database
  146862. * @param url defines the url to load from
  146863. * @param image defines the target DOM image
  146864. */
  146865. loadImage(url: string, image: HTMLImageElement): void;
  146866. private _loadImageFromDBAsync;
  146867. private _saveImageIntoDBAsync;
  146868. private _checkVersionFromDB;
  146869. private _loadVersionFromDBAsync;
  146870. private _saveVersionIntoDBAsync;
  146871. /**
  146872. * Loads a file from database
  146873. * @param url defines the URL to load from
  146874. * @param sceneLoaded defines a callback to call on success
  146875. * @param progressCallBack defines a callback to call when progress changed
  146876. * @param errorCallback defines a callback to call on error
  146877. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  146878. */
  146879. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  146880. private _loadFileAsync;
  146881. private _saveFileAsync;
  146882. /**
  146883. * Validates if xhr data is correct
  146884. * @param xhr defines the request to validate
  146885. * @param dataType defines the expected data type
  146886. * @returns true if data is correct
  146887. */
  146888. private static _ValidateXHRData;
  146889. }
  146890. }
  146891. declare module BABYLON {
  146892. /** @hidden */
  146893. export var gpuUpdateParticlesPixelShader: {
  146894. name: string;
  146895. shader: string;
  146896. };
  146897. }
  146898. declare module BABYLON {
  146899. /** @hidden */
  146900. export var gpuUpdateParticlesVertexShader: {
  146901. name: string;
  146902. shader: string;
  146903. };
  146904. }
  146905. declare module BABYLON {
  146906. /** @hidden */
  146907. export var clipPlaneFragmentDeclaration2: {
  146908. name: string;
  146909. shader: string;
  146910. };
  146911. }
  146912. declare module BABYLON {
  146913. /** @hidden */
  146914. export var gpuRenderParticlesPixelShader: {
  146915. name: string;
  146916. shader: string;
  146917. };
  146918. }
  146919. declare module BABYLON {
  146920. /** @hidden */
  146921. export var clipPlaneVertexDeclaration2: {
  146922. name: string;
  146923. shader: string;
  146924. };
  146925. }
  146926. declare module BABYLON {
  146927. /** @hidden */
  146928. export var gpuRenderParticlesVertexShader: {
  146929. name: string;
  146930. shader: string;
  146931. };
  146932. }
  146933. declare module BABYLON {
  146934. /**
  146935. * This represents a GPU particle system in Babylon
  146936. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  146937. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  146938. */
  146939. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  146940. /**
  146941. * The layer mask we are rendering the particles through.
  146942. */
  146943. layerMask: number;
  146944. private _capacity;
  146945. private _activeCount;
  146946. private _currentActiveCount;
  146947. private _accumulatedCount;
  146948. private _renderEffect;
  146949. private _updateEffect;
  146950. private _buffer0;
  146951. private _buffer1;
  146952. private _spriteBuffer;
  146953. private _updateVAO;
  146954. private _renderVAO;
  146955. private _targetIndex;
  146956. private _sourceBuffer;
  146957. private _targetBuffer;
  146958. private _currentRenderId;
  146959. private _started;
  146960. private _stopped;
  146961. private _timeDelta;
  146962. private _randomTexture;
  146963. private _randomTexture2;
  146964. private _attributesStrideSize;
  146965. private _updateEffectOptions;
  146966. private _randomTextureSize;
  146967. private _actualFrame;
  146968. private _customEffect;
  146969. private readonly _rawTextureWidth;
  146970. /**
  146971. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  146972. */
  146973. static get IsSupported(): boolean;
  146974. /**
  146975. * An event triggered when the system is disposed.
  146976. */
  146977. onDisposeObservable: Observable<IParticleSystem>;
  146978. /**
  146979. * Gets the maximum number of particles active at the same time.
  146980. * @returns The max number of active particles.
  146981. */
  146982. getCapacity(): number;
  146983. /**
  146984. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  146985. * to override the particles.
  146986. */
  146987. forceDepthWrite: boolean;
  146988. /**
  146989. * Gets or set the number of active particles
  146990. */
  146991. get activeParticleCount(): number;
  146992. set activeParticleCount(value: number);
  146993. private _preWarmDone;
  146994. /**
  146995. * Specifies if the particles are updated in emitter local space or world space.
  146996. */
  146997. isLocal: boolean;
  146998. /** Gets or sets a matrix to use to compute projection */
  146999. defaultProjectionMatrix: Matrix;
  147000. /**
  147001. * Is this system ready to be used/rendered
  147002. * @return true if the system is ready
  147003. */
  147004. isReady(): boolean;
  147005. /**
  147006. * Gets if the system has been started. (Note: this will still be true after stop is called)
  147007. * @returns True if it has been started, otherwise false.
  147008. */
  147009. isStarted(): boolean;
  147010. /**
  147011. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  147012. * @returns True if it has been stopped, otherwise false.
  147013. */
  147014. isStopped(): boolean;
  147015. /**
  147016. * Gets a boolean indicating that the system is stopping
  147017. * @returns true if the system is currently stopping
  147018. */
  147019. isStopping(): boolean;
  147020. /**
  147021. * Gets the number of particles active at the same time.
  147022. * @returns The number of active particles.
  147023. */
  147024. getActiveCount(): number;
  147025. /**
  147026. * Starts the particle system and begins to emit
  147027. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  147028. */
  147029. start(delay?: number): void;
  147030. /**
  147031. * Stops the particle system.
  147032. */
  147033. stop(): void;
  147034. /**
  147035. * Remove all active particles
  147036. */
  147037. reset(): void;
  147038. /**
  147039. * Returns the string "GPUParticleSystem"
  147040. * @returns a string containing the class name
  147041. */
  147042. getClassName(): string;
  147043. /**
  147044. * Gets the custom effect used to render the particles
  147045. * @param blendMode Blend mode for which the effect should be retrieved
  147046. * @returns The effect
  147047. */
  147048. getCustomEffect(blendMode?: number): Nullable<Effect>;
  147049. /**
  147050. * Sets the custom effect used to render the particles
  147051. * @param effect The effect to set
  147052. * @param blendMode Blend mode for which the effect should be set
  147053. */
  147054. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  147055. /** @hidden */
  147056. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  147057. /**
  147058. * Observable that will be called just before the particles are drawn
  147059. */
  147060. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  147061. /**
  147062. * Gets the name of the particle vertex shader
  147063. */
  147064. get vertexShaderName(): string;
  147065. private _colorGradientsTexture;
  147066. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  147067. /**
  147068. * Adds a new color gradient
  147069. * @param gradient defines the gradient to use (between 0 and 1)
  147070. * @param color1 defines the color to affect to the specified gradient
  147071. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  147072. * @returns the current particle system
  147073. */
  147074. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  147075. private _refreshColorGradient;
  147076. /** Force the system to rebuild all gradients that need to be resync */
  147077. forceRefreshGradients(): void;
  147078. /**
  147079. * Remove a specific color gradient
  147080. * @param gradient defines the gradient to remove
  147081. * @returns the current particle system
  147082. */
  147083. removeColorGradient(gradient: number): GPUParticleSystem;
  147084. private _angularSpeedGradientsTexture;
  147085. private _sizeGradientsTexture;
  147086. private _velocityGradientsTexture;
  147087. private _limitVelocityGradientsTexture;
  147088. private _dragGradientsTexture;
  147089. private _addFactorGradient;
  147090. /**
  147091. * Adds a new size gradient
  147092. * @param gradient defines the gradient to use (between 0 and 1)
  147093. * @param factor defines the size factor to affect to the specified gradient
  147094. * @returns the current particle system
  147095. */
  147096. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  147097. /**
  147098. * Remove a specific size gradient
  147099. * @param gradient defines the gradient to remove
  147100. * @returns the current particle system
  147101. */
  147102. removeSizeGradient(gradient: number): GPUParticleSystem;
  147103. private _refreshFactorGradient;
  147104. /**
  147105. * Adds a new angular speed gradient
  147106. * @param gradient defines the gradient to use (between 0 and 1)
  147107. * @param factor defines the angular speed to affect to the specified gradient
  147108. * @returns the current particle system
  147109. */
  147110. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  147111. /**
  147112. * Remove a specific angular speed gradient
  147113. * @param gradient defines the gradient to remove
  147114. * @returns the current particle system
  147115. */
  147116. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  147117. /**
  147118. * Adds a new velocity gradient
  147119. * @param gradient defines the gradient to use (between 0 and 1)
  147120. * @param factor defines the velocity to affect to the specified gradient
  147121. * @returns the current particle system
  147122. */
  147123. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  147124. /**
  147125. * Remove a specific velocity gradient
  147126. * @param gradient defines the gradient to remove
  147127. * @returns the current particle system
  147128. */
  147129. removeVelocityGradient(gradient: number): GPUParticleSystem;
  147130. /**
  147131. * Adds a new limit velocity gradient
  147132. * @param gradient defines the gradient to use (between 0 and 1)
  147133. * @param factor defines the limit velocity value to affect to the specified gradient
  147134. * @returns the current particle system
  147135. */
  147136. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  147137. /**
  147138. * Remove a specific limit velocity gradient
  147139. * @param gradient defines the gradient to remove
  147140. * @returns the current particle system
  147141. */
  147142. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  147143. /**
  147144. * Adds a new drag gradient
  147145. * @param gradient defines the gradient to use (between 0 and 1)
  147146. * @param factor defines the drag value to affect to the specified gradient
  147147. * @returns the current particle system
  147148. */
  147149. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  147150. /**
  147151. * Remove a specific drag gradient
  147152. * @param gradient defines the gradient to remove
  147153. * @returns the current particle system
  147154. */
  147155. removeDragGradient(gradient: number): GPUParticleSystem;
  147156. /**
  147157. * Not supported by GPUParticleSystem
  147158. * @param gradient defines the gradient to use (between 0 and 1)
  147159. * @param factor defines the emit rate value to affect to the specified gradient
  147160. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  147161. * @returns the current particle system
  147162. */
  147163. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  147164. /**
  147165. * Not supported by GPUParticleSystem
  147166. * @param gradient defines the gradient to remove
  147167. * @returns the current particle system
  147168. */
  147169. removeEmitRateGradient(gradient: number): IParticleSystem;
  147170. /**
  147171. * Not supported by GPUParticleSystem
  147172. * @param gradient defines the gradient to use (between 0 and 1)
  147173. * @param factor defines the start size value to affect to the specified gradient
  147174. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  147175. * @returns the current particle system
  147176. */
  147177. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  147178. /**
  147179. * Not supported by GPUParticleSystem
  147180. * @param gradient defines the gradient to remove
  147181. * @returns the current particle system
  147182. */
  147183. removeStartSizeGradient(gradient: number): IParticleSystem;
  147184. /**
  147185. * Not supported by GPUParticleSystem
  147186. * @param gradient defines the gradient to use (between 0 and 1)
  147187. * @param min defines the color remap minimal range
  147188. * @param max defines the color remap maximal range
  147189. * @returns the current particle system
  147190. */
  147191. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  147192. /**
  147193. * Not supported by GPUParticleSystem
  147194. * @param gradient defines the gradient to remove
  147195. * @returns the current particle system
  147196. */
  147197. removeColorRemapGradient(): IParticleSystem;
  147198. /**
  147199. * Not supported by GPUParticleSystem
  147200. * @param gradient defines the gradient to use (between 0 and 1)
  147201. * @param min defines the alpha remap minimal range
  147202. * @param max defines the alpha remap maximal range
  147203. * @returns the current particle system
  147204. */
  147205. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  147206. /**
  147207. * Not supported by GPUParticleSystem
  147208. * @param gradient defines the gradient to remove
  147209. * @returns the current particle system
  147210. */
  147211. removeAlphaRemapGradient(): IParticleSystem;
  147212. /**
  147213. * Not supported by GPUParticleSystem
  147214. * @param gradient defines the gradient to use (between 0 and 1)
  147215. * @param color defines the color to affect to the specified gradient
  147216. * @returns the current particle system
  147217. */
  147218. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  147219. /**
  147220. * Not supported by GPUParticleSystem
  147221. * @param gradient defines the gradient to remove
  147222. * @returns the current particle system
  147223. */
  147224. removeRampGradient(): IParticleSystem;
  147225. /**
  147226. * Not supported by GPUParticleSystem
  147227. * @returns the list of ramp gradients
  147228. */
  147229. getRampGradients(): Nullable<Array<Color3Gradient>>;
  147230. /**
  147231. * Not supported by GPUParticleSystem
  147232. * Gets or sets a boolean indicating that ramp gradients must be used
  147233. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  147234. */
  147235. get useRampGradients(): boolean;
  147236. set useRampGradients(value: boolean);
  147237. /**
  147238. * Not supported by GPUParticleSystem
  147239. * @param gradient defines the gradient to use (between 0 and 1)
  147240. * @param factor defines the life time factor to affect to the specified gradient
  147241. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  147242. * @returns the current particle system
  147243. */
  147244. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  147245. /**
  147246. * Not supported by GPUParticleSystem
  147247. * @param gradient defines the gradient to remove
  147248. * @returns the current particle system
  147249. */
  147250. removeLifeTimeGradient(gradient: number): IParticleSystem;
  147251. /**
  147252. * Instantiates a GPU particle system.
  147253. * 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.
  147254. * @param name The name of the particle system
  147255. * @param options The options used to create the system
  147256. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  147257. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  147258. * @param customEffect a custom effect used to change the way particles are rendered by default
  147259. */
  147260. constructor(name: string, options: Partial<{
  147261. capacity: number;
  147262. randomTextureSize: number;
  147263. }>, sceneOrEngine: Scene | ThinEngine, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  147264. protected _reset(): void;
  147265. private _createUpdateVAO;
  147266. private _createRenderVAO;
  147267. private _initialize;
  147268. /** @hidden */
  147269. _recreateUpdateEffect(): void;
  147270. private _getEffect;
  147271. /**
  147272. * Fill the defines array according to the current settings of the particle system
  147273. * @param defines Array to be updated
  147274. * @param blendMode blend mode to take into account when updating the array
  147275. */
  147276. fillDefines(defines: Array<string>, blendMode?: number): void;
  147277. /**
  147278. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  147279. * @param uniforms Uniforms array to fill
  147280. * @param attributes Attributes array to fill
  147281. * @param samplers Samplers array to fill
  147282. */
  147283. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  147284. /** @hidden */
  147285. _recreateRenderEffect(): Effect;
  147286. /**
  147287. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  147288. * @param preWarm defines if we are in the pre-warmimg phase
  147289. */
  147290. animate(preWarm?: boolean): void;
  147291. private _createFactorGradientTexture;
  147292. private _createSizeGradientTexture;
  147293. private _createAngularSpeedGradientTexture;
  147294. private _createVelocityGradientTexture;
  147295. private _createLimitVelocityGradientTexture;
  147296. private _createDragGradientTexture;
  147297. private _createColorGradientTexture;
  147298. /**
  147299. * Renders the particle system in its current state
  147300. * @param preWarm defines if the system should only update the particles but not render them
  147301. * @returns the current number of particles
  147302. */
  147303. render(preWarm?: boolean): number;
  147304. /**
  147305. * Rebuilds the particle system
  147306. */
  147307. rebuild(): void;
  147308. private _releaseBuffers;
  147309. private _releaseVAOs;
  147310. /**
  147311. * Disposes the particle system and free the associated resources
  147312. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  147313. */
  147314. dispose(disposeTexture?: boolean): void;
  147315. /**
  147316. * Clones the particle system.
  147317. * @param name The name of the cloned object
  147318. * @param newEmitter The new emitter to use
  147319. * @returns the cloned particle system
  147320. */
  147321. clone(name: string, newEmitter: any): GPUParticleSystem;
  147322. /**
  147323. * Serializes the particle system to a JSON object
  147324. * @param serializeTexture defines if the texture must be serialized as well
  147325. * @returns the JSON object
  147326. */
  147327. serialize(serializeTexture?: boolean): any;
  147328. /**
  147329. * Parses a JSON object to create a GPU particle system.
  147330. * @param parsedParticleSystem The JSON object to parse
  147331. * @param sceneOrEngine The scene or the engine to create the particle system in
  147332. * @param rootUrl The root url to use to load external dependencies like texture
  147333. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  147334. * @returns the parsed GPU particle system
  147335. */
  147336. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  147337. }
  147338. }
  147339. declare module BABYLON {
  147340. /**
  147341. * Represents a set of particle systems working together to create a specific effect
  147342. */
  147343. export class ParticleSystemSet implements IDisposable {
  147344. /**
  147345. * Gets or sets base Assets URL
  147346. */
  147347. static BaseAssetsUrl: string;
  147348. private _emitterCreationOptions;
  147349. private _emitterNode;
  147350. /**
  147351. * Gets the particle system list
  147352. */
  147353. systems: IParticleSystem[];
  147354. /**
  147355. * Gets the emitter node used with this set
  147356. */
  147357. get emitterNode(): Nullable<TransformNode>;
  147358. /**
  147359. * Creates a new emitter mesh as a sphere
  147360. * @param options defines the options used to create the sphere
  147361. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  147362. * @param scene defines the hosting scene
  147363. */
  147364. setEmitterAsSphere(options: {
  147365. diameter: number;
  147366. segments: number;
  147367. color: Color3;
  147368. }, renderingGroupId: number, scene: Scene): void;
  147369. /**
  147370. * Starts all particle systems of the set
  147371. * @param emitter defines an optional mesh to use as emitter for the particle systems
  147372. */
  147373. start(emitter?: AbstractMesh): void;
  147374. /**
  147375. * Release all associated resources
  147376. */
  147377. dispose(): void;
  147378. /**
  147379. * Serialize the set into a JSON compatible object
  147380. * @param serializeTexture defines if the texture must be serialized as well
  147381. * @returns a JSON compatible representation of the set
  147382. */
  147383. serialize(serializeTexture?: boolean): any;
  147384. /**
  147385. * Parse a new ParticleSystemSet from a serialized source
  147386. * @param data defines a JSON compatible representation of the set
  147387. * @param scene defines the hosting scene
  147388. * @param gpu defines if we want GPU particles or CPU particles
  147389. * @returns a new ParticleSystemSet
  147390. */
  147391. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  147392. }
  147393. }
  147394. declare module BABYLON {
  147395. /**
  147396. * This class is made for on one-liner static method to help creating particle system set.
  147397. */
  147398. export class ParticleHelper {
  147399. /**
  147400. * Gets or sets base Assets URL
  147401. */
  147402. static BaseAssetsUrl: string;
  147403. /** Define the Url to load snippets */
  147404. static SnippetUrl: string;
  147405. /**
  147406. * Create a default particle system that you can tweak
  147407. * @param emitter defines the emitter to use
  147408. * @param capacity defines the system capacity (default is 500 particles)
  147409. * @param scene defines the hosting scene
  147410. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  147411. * @returns the new Particle system
  147412. */
  147413. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  147414. /**
  147415. * This is the main static method (one-liner) of this helper to create different particle systems
  147416. * @param type This string represents the type to the particle system to create
  147417. * @param scene The scene where the particle system should live
  147418. * @param gpu If the system will use gpu
  147419. * @returns the ParticleSystemSet created
  147420. */
  147421. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  147422. /**
  147423. * Static function used to export a particle system to a ParticleSystemSet variable.
  147424. * Please note that the emitter shape is not exported
  147425. * @param systems defines the particle systems to export
  147426. * @returns the created particle system set
  147427. */
  147428. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  147429. /**
  147430. * Creates a particle system from a snippet saved in a remote file
  147431. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  147432. * @param url defines the url to load from
  147433. * @param scene defines the hosting scene
  147434. * @param gpu If the system will use gpu
  147435. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  147436. * @returns a promise that will resolve to the new particle system
  147437. */
  147438. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  147439. /**
  147440. * Creates a particle system from a snippet saved by the particle system editor
  147441. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  147442. * @param scene defines the hosting scene
  147443. * @param gpu If the system will use gpu
  147444. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  147445. * @returns a promise that will resolve to the new particle system
  147446. */
  147447. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  147448. }
  147449. }
  147450. declare module BABYLON {
  147451. interface Engine {
  147452. /**
  147453. * Create an effect to use with particle systems.
  147454. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  147455. * the particle system for which you want to create a custom effect in the last parameter
  147456. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  147457. * @param uniformsNames defines a list of attribute names
  147458. * @param samplers defines an array of string used to represent textures
  147459. * @param defines defines the string containing the defines to use to compile the shaders
  147460. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  147461. * @param onCompiled defines a function to call when the effect creation is successful
  147462. * @param onError defines a function to call when the effect creation has failed
  147463. * @param particleSystem the particle system you want to create the effect for
  147464. * @returns the new Effect
  147465. */
  147466. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  147467. }
  147468. interface Mesh {
  147469. /**
  147470. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  147471. * @returns an array of IParticleSystem
  147472. */
  147473. getEmittedParticleSystems(): IParticleSystem[];
  147474. /**
  147475. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  147476. * @returns an array of IParticleSystem
  147477. */
  147478. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  147479. }
  147480. }
  147481. declare module BABYLON {
  147482. /** Defines the 4 color options */
  147483. export enum PointColor {
  147484. /** color value */
  147485. Color = 2,
  147486. /** uv value */
  147487. UV = 1,
  147488. /** random value */
  147489. Random = 0,
  147490. /** stated value */
  147491. Stated = 3
  147492. }
  147493. /**
  147494. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  147495. * 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.
  147496. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  147497. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  147498. *
  147499. * Full documentation here : TO BE ENTERED
  147500. */
  147501. export class PointsCloudSystem implements IDisposable {
  147502. /**
  147503. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  147504. * Example : var p = SPS.particles[i];
  147505. */
  147506. particles: CloudPoint[];
  147507. /**
  147508. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  147509. */
  147510. nbParticles: number;
  147511. /**
  147512. * This a counter for your own usage. It's not set by any SPS functions.
  147513. */
  147514. counter: number;
  147515. /**
  147516. * The PCS name. This name is also given to the underlying mesh.
  147517. */
  147518. name: string;
  147519. /**
  147520. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  147521. */
  147522. mesh: Mesh;
  147523. /**
  147524. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  147525. * Please read :
  147526. */
  147527. vars: any;
  147528. /**
  147529. * @hidden
  147530. */
  147531. _size: number;
  147532. private _scene;
  147533. private _promises;
  147534. private _positions;
  147535. private _indices;
  147536. private _normals;
  147537. private _colors;
  147538. private _uvs;
  147539. private _indices32;
  147540. private _positions32;
  147541. private _colors32;
  147542. private _uvs32;
  147543. private _updatable;
  147544. private _isVisibilityBoxLocked;
  147545. private _alwaysVisible;
  147546. private _groups;
  147547. private _groupCounter;
  147548. private _computeParticleColor;
  147549. private _computeParticleTexture;
  147550. private _computeParticleRotation;
  147551. private _computeBoundingBox;
  147552. private _isReady;
  147553. /**
  147554. * Creates a PCS (Points Cloud System) object
  147555. * @param name (String) is the PCS name, this will be the underlying mesh name
  147556. * @param pointSize (number) is the size for each point
  147557. * @param scene (Scene) is the scene in which the PCS is added
  147558. * @param options defines the options of the PCS e.g.
  147559. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  147560. */
  147561. constructor(name: string, pointSize: number, scene: Scene, options?: {
  147562. updatable?: boolean;
  147563. });
  147564. /**
  147565. * Builds the PCS underlying mesh. Returns a standard Mesh.
  147566. * If no points were added to the PCS, the returned mesh is just a single point.
  147567. * @returns a promise for the created mesh
  147568. */
  147569. buildMeshAsync(): Promise<Mesh>;
  147570. /**
  147571. * @hidden
  147572. */
  147573. private _buildMesh;
  147574. private _addParticle;
  147575. private _randomUnitVector;
  147576. private _getColorIndicesForCoord;
  147577. private _setPointsColorOrUV;
  147578. private _colorFromTexture;
  147579. private _calculateDensity;
  147580. /**
  147581. * Adds points to the PCS in random positions within a unit sphere
  147582. * @param nb (positive integer) the number of particles to be created from this model
  147583. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  147584. * @returns the number of groups in the system
  147585. */
  147586. addPoints(nb: number, pointFunction?: any): number;
  147587. /**
  147588. * Adds points to the PCS from the surface of the model shape
  147589. * @param mesh is any Mesh object that will be used as a surface model for the points
  147590. * @param nb (positive integer) the number of particles to be created from this model
  147591. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  147592. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  147593. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  147594. * @returns the number of groups in the system
  147595. */
  147596. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  147597. /**
  147598. * Adds points to the PCS inside the model shape
  147599. * @param mesh is any Mesh object that will be used as a surface model for the points
  147600. * @param nb (positive integer) the number of particles to be created from this model
  147601. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  147602. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  147603. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  147604. * @returns the number of groups in the system
  147605. */
  147606. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  147607. /**
  147608. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  147609. * This method calls `updateParticle()` for each particle of the SPS.
  147610. * For an animated SPS, it is usually called within the render loop.
  147611. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  147612. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  147613. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  147614. * @returns the PCS.
  147615. */
  147616. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  147617. /**
  147618. * Disposes the PCS.
  147619. */
  147620. dispose(): void;
  147621. /**
  147622. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  147623. * doc :
  147624. * @returns the PCS.
  147625. */
  147626. refreshVisibleSize(): PointsCloudSystem;
  147627. /**
  147628. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  147629. * @param size the size (float) of the visibility box
  147630. * note : this doesn't lock the PCS mesh bounding box.
  147631. * doc :
  147632. */
  147633. setVisibilityBox(size: number): void;
  147634. /**
  147635. * Gets whether the PCS is always visible or not
  147636. * doc :
  147637. */
  147638. get isAlwaysVisible(): boolean;
  147639. /**
  147640. * Sets the PCS as always visible or not
  147641. * doc :
  147642. */
  147643. set isAlwaysVisible(val: boolean);
  147644. /**
  147645. * Tells to `setParticles()` to compute the particle rotations or not
  147646. * Default value : false. The PCS is faster when it's set to false
  147647. * Note : particle rotations are only applied to parent particles
  147648. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  147649. */
  147650. set computeParticleRotation(val: boolean);
  147651. /**
  147652. * Tells to `setParticles()` to compute the particle colors or not.
  147653. * Default value : true. The PCS is faster when it's set to false.
  147654. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  147655. */
  147656. set computeParticleColor(val: boolean);
  147657. set computeParticleTexture(val: boolean);
  147658. /**
  147659. * Gets if `setParticles()` computes the particle colors or not.
  147660. * Default value : false. The PCS is faster when it's set to false.
  147661. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  147662. */
  147663. get computeParticleColor(): boolean;
  147664. /**
  147665. * Gets if `setParticles()` computes the particle textures or not.
  147666. * Default value : false. The PCS is faster when it's set to false.
  147667. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  147668. */
  147669. get computeParticleTexture(): boolean;
  147670. /**
  147671. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  147672. */
  147673. set computeBoundingBox(val: boolean);
  147674. /**
  147675. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  147676. */
  147677. get computeBoundingBox(): boolean;
  147678. /**
  147679. * This function does nothing. It may be overwritten to set all the particle first values.
  147680. * The PCS doesn't call this function, you may have to call it by your own.
  147681. * doc :
  147682. */
  147683. initParticles(): void;
  147684. /**
  147685. * This function does nothing. It may be overwritten to recycle a particle
  147686. * The PCS doesn't call this function, you can to call it
  147687. * doc :
  147688. * @param particle The particle to recycle
  147689. * @returns the recycled particle
  147690. */
  147691. recycleParticle(particle: CloudPoint): CloudPoint;
  147692. /**
  147693. * Updates a particle : this function should be overwritten by the user.
  147694. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  147695. * doc :
  147696. * @example : just set a particle position or velocity and recycle conditions
  147697. * @param particle The particle to update
  147698. * @returns the updated particle
  147699. */
  147700. updateParticle(particle: CloudPoint): CloudPoint;
  147701. /**
  147702. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  147703. * This does nothing and may be overwritten by the user.
  147704. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  147705. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  147706. * @param update the boolean update value actually passed to setParticles()
  147707. */
  147708. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  147709. /**
  147710. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  147711. * This will be passed three parameters.
  147712. * This does nothing and may be overwritten by the user.
  147713. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  147714. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  147715. * @param update the boolean update value actually passed to setParticles()
  147716. */
  147717. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  147718. }
  147719. }
  147720. declare module BABYLON {
  147721. /**
  147722. * Represents one particle of a points cloud system.
  147723. */
  147724. export class CloudPoint {
  147725. /**
  147726. * particle global index
  147727. */
  147728. idx: number;
  147729. /**
  147730. * The color of the particle
  147731. */
  147732. color: Nullable<Color4>;
  147733. /**
  147734. * The world space position of the particle.
  147735. */
  147736. position: Vector3;
  147737. /**
  147738. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  147739. */
  147740. rotation: Vector3;
  147741. /**
  147742. * The world space rotation quaternion of the particle.
  147743. */
  147744. rotationQuaternion: Nullable<Quaternion>;
  147745. /**
  147746. * The uv of the particle.
  147747. */
  147748. uv: Nullable<Vector2>;
  147749. /**
  147750. * The current speed of the particle.
  147751. */
  147752. velocity: Vector3;
  147753. /**
  147754. * The pivot point in the particle local space.
  147755. */
  147756. pivot: Vector3;
  147757. /**
  147758. * Must the particle be translated from its pivot point in its local space ?
  147759. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  147760. * Default : false
  147761. */
  147762. translateFromPivot: boolean;
  147763. /**
  147764. * Index of this particle in the global "positions" array (Internal use)
  147765. * @hidden
  147766. */
  147767. _pos: number;
  147768. /**
  147769. * @hidden Index of this particle in the global "indices" array (Internal use)
  147770. */
  147771. _ind: number;
  147772. /**
  147773. * Group this particle belongs to
  147774. */
  147775. _group: PointsGroup;
  147776. /**
  147777. * Group id of this particle
  147778. */
  147779. groupId: number;
  147780. /**
  147781. * Index of the particle in its group id (Internal use)
  147782. */
  147783. idxInGroup: number;
  147784. /**
  147785. * @hidden Particle BoundingInfo object (Internal use)
  147786. */
  147787. _boundingInfo: BoundingInfo;
  147788. /**
  147789. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  147790. */
  147791. _pcs: PointsCloudSystem;
  147792. /**
  147793. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  147794. */
  147795. _stillInvisible: boolean;
  147796. /**
  147797. * @hidden Last computed particle rotation matrix
  147798. */
  147799. _rotationMatrix: number[];
  147800. /**
  147801. * Parent particle Id, if any.
  147802. * Default null.
  147803. */
  147804. parentId: Nullable<number>;
  147805. /**
  147806. * @hidden Internal global position in the PCS.
  147807. */
  147808. _globalPosition: Vector3;
  147809. /**
  147810. * Creates a Point Cloud object.
  147811. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  147812. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  147813. * @param group (PointsGroup) is the group the particle belongs to
  147814. * @param groupId (integer) is the group identifier in the PCS.
  147815. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  147816. * @param pcs defines the PCS it is associated to
  147817. */
  147818. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  147819. /**
  147820. * get point size
  147821. */
  147822. get size(): Vector3;
  147823. /**
  147824. * Set point size
  147825. */
  147826. set size(scale: Vector3);
  147827. /**
  147828. * Legacy support, changed quaternion to rotationQuaternion
  147829. */
  147830. get quaternion(): Nullable<Quaternion>;
  147831. /**
  147832. * Legacy support, changed quaternion to rotationQuaternion
  147833. */
  147834. set quaternion(q: Nullable<Quaternion>);
  147835. /**
  147836. * Returns a boolean. True if the particle intersects a mesh, else false
  147837. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  147838. * @param target is the object (point or mesh) what the intersection is computed against
  147839. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  147840. * @returns true if it intersects
  147841. */
  147842. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  147843. /**
  147844. * get the rotation matrix of the particle
  147845. * @hidden
  147846. */
  147847. getRotationMatrix(m: Matrix): void;
  147848. }
  147849. /**
  147850. * Represents a group of points in a points cloud system
  147851. * * PCS internal tool, don't use it manually.
  147852. */
  147853. export class PointsGroup {
  147854. /**
  147855. * The group id
  147856. * @hidden
  147857. */
  147858. groupID: number;
  147859. /**
  147860. * image data for group (internal use)
  147861. * @hidden
  147862. */
  147863. _groupImageData: Nullable<ArrayBufferView>;
  147864. /**
  147865. * Image Width (internal use)
  147866. * @hidden
  147867. */
  147868. _groupImgWidth: number;
  147869. /**
  147870. * Image Height (internal use)
  147871. * @hidden
  147872. */
  147873. _groupImgHeight: number;
  147874. /**
  147875. * Custom position function (internal use)
  147876. * @hidden
  147877. */
  147878. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  147879. /**
  147880. * density per facet for surface points
  147881. * @hidden
  147882. */
  147883. _groupDensity: number[];
  147884. /**
  147885. * Only when points are colored by texture carries pointer to texture list array
  147886. * @hidden
  147887. */
  147888. _textureNb: number;
  147889. /**
  147890. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  147891. * PCS internal tool, don't use it manually.
  147892. * @hidden
  147893. */
  147894. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  147895. }
  147896. }
  147897. declare module BABYLON {
  147898. interface Scene {
  147899. /** @hidden (Backing field) */
  147900. _physicsEngine: Nullable<IPhysicsEngine>;
  147901. /** @hidden */
  147902. _physicsTimeAccumulator: number;
  147903. /**
  147904. * Gets the current physics engine
  147905. * @returns a IPhysicsEngine or null if none attached
  147906. */
  147907. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  147908. /**
  147909. * Enables physics to the current scene
  147910. * @param gravity defines the scene's gravity for the physics engine
  147911. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  147912. * @return a boolean indicating if the physics engine was initialized
  147913. */
  147914. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  147915. /**
  147916. * Disables and disposes the physics engine associated with the scene
  147917. */
  147918. disablePhysicsEngine(): void;
  147919. /**
  147920. * Gets a boolean indicating if there is an active physics engine
  147921. * @returns a boolean indicating if there is an active physics engine
  147922. */
  147923. isPhysicsEnabled(): boolean;
  147924. /**
  147925. * Deletes a physics compound impostor
  147926. * @param compound defines the compound to delete
  147927. */
  147928. deleteCompoundImpostor(compound: any): void;
  147929. /**
  147930. * An event triggered when physic simulation is about to be run
  147931. */
  147932. onBeforePhysicsObservable: Observable<Scene>;
  147933. /**
  147934. * An event triggered when physic simulation has been done
  147935. */
  147936. onAfterPhysicsObservable: Observable<Scene>;
  147937. }
  147938. interface AbstractMesh {
  147939. /** @hidden */
  147940. _physicsImpostor: Nullable<PhysicsImpostor>;
  147941. /**
  147942. * Gets or sets impostor used for physic simulation
  147943. * @see https://doc.babylonjs.com/features/physics_engine
  147944. */
  147945. physicsImpostor: Nullable<PhysicsImpostor>;
  147946. /**
  147947. * Gets the current physics impostor
  147948. * @see https://doc.babylonjs.com/features/physics_engine
  147949. * @returns a physics impostor or null
  147950. */
  147951. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  147952. /** Apply a physic impulse to the mesh
  147953. * @param force defines the force to apply
  147954. * @param contactPoint defines where to apply the force
  147955. * @returns the current mesh
  147956. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  147957. */
  147958. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  147959. /**
  147960. * Creates a physic joint between two meshes
  147961. * @param otherMesh defines the other mesh to use
  147962. * @param pivot1 defines the pivot to use on this mesh
  147963. * @param pivot2 defines the pivot to use on the other mesh
  147964. * @param options defines additional options (can be plugin dependent)
  147965. * @returns the current mesh
  147966. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  147967. */
  147968. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  147969. /** @hidden */
  147970. _disposePhysicsObserver: Nullable<Observer<Node>>;
  147971. }
  147972. /**
  147973. * Defines the physics engine scene component responsible to manage a physics engine
  147974. */
  147975. export class PhysicsEngineSceneComponent implements ISceneComponent {
  147976. /**
  147977. * The component name helpful to identify the component in the list of scene components.
  147978. */
  147979. readonly name: string;
  147980. /**
  147981. * The scene the component belongs to.
  147982. */
  147983. scene: Scene;
  147984. /**
  147985. * Creates a new instance of the component for the given scene
  147986. * @param scene Defines the scene to register the component in
  147987. */
  147988. constructor(scene: Scene);
  147989. /**
  147990. * Registers the component in a given scene
  147991. */
  147992. register(): void;
  147993. /**
  147994. * Rebuilds the elements related to this component in case of
  147995. * context lost for instance.
  147996. */
  147997. rebuild(): void;
  147998. /**
  147999. * Disposes the component and the associated ressources
  148000. */
  148001. dispose(): void;
  148002. }
  148003. }
  148004. declare module BABYLON {
  148005. /**
  148006. * A helper for physics simulations
  148007. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148008. */
  148009. export class PhysicsHelper {
  148010. private _scene;
  148011. private _physicsEngine;
  148012. /**
  148013. * Initializes the Physics helper
  148014. * @param scene Babylon.js scene
  148015. */
  148016. constructor(scene: Scene);
  148017. /**
  148018. * Applies a radial explosion impulse
  148019. * @param origin the origin of the explosion
  148020. * @param radiusOrEventOptions the radius or the options of radial explosion
  148021. * @param strength the explosion strength
  148022. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148023. * @returns A physics radial explosion event, or null
  148024. */
  148025. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  148026. /**
  148027. * Applies a radial explosion force
  148028. * @param origin the origin of the explosion
  148029. * @param radiusOrEventOptions the radius or the options of radial explosion
  148030. * @param strength the explosion strength
  148031. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148032. * @returns A physics radial explosion event, or null
  148033. */
  148034. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  148035. /**
  148036. * Creates a gravitational field
  148037. * @param origin the origin of the explosion
  148038. * @param radiusOrEventOptions the radius or the options of radial explosion
  148039. * @param strength the explosion strength
  148040. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148041. * @returns A physics gravitational field event, or null
  148042. */
  148043. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  148044. /**
  148045. * Creates a physics updraft event
  148046. * @param origin the origin of the updraft
  148047. * @param radiusOrEventOptions the radius or the options of the updraft
  148048. * @param strength the strength of the updraft
  148049. * @param height the height of the updraft
  148050. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  148051. * @returns A physics updraft event, or null
  148052. */
  148053. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  148054. /**
  148055. * Creates a physics vortex event
  148056. * @param origin the of the vortex
  148057. * @param radiusOrEventOptions the radius or the options of the vortex
  148058. * @param strength the strength of the vortex
  148059. * @param height the height of the vortex
  148060. * @returns a Physics vortex event, or null
  148061. * A physics vortex event or null
  148062. */
  148063. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  148064. }
  148065. /**
  148066. * Represents a physics radial explosion event
  148067. */
  148068. class PhysicsRadialExplosionEvent {
  148069. private _scene;
  148070. private _options;
  148071. private _sphere;
  148072. private _dataFetched;
  148073. /**
  148074. * Initializes a radial explosioin event
  148075. * @param _scene BabylonJS scene
  148076. * @param _options The options for the vortex event
  148077. */
  148078. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  148079. /**
  148080. * Returns the data related to the radial explosion event (sphere).
  148081. * @returns The radial explosion event data
  148082. */
  148083. getData(): PhysicsRadialExplosionEventData;
  148084. /**
  148085. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  148086. * @param impostor A physics imposter
  148087. * @param origin the origin of the explosion
  148088. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  148089. */
  148090. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  148091. /**
  148092. * Triggers affecterd impostors callbacks
  148093. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  148094. */
  148095. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  148096. /**
  148097. * Disposes the sphere.
  148098. * @param force Specifies if the sphere should be disposed by force
  148099. */
  148100. dispose(force?: boolean): void;
  148101. /*** Helpers ***/
  148102. private _prepareSphere;
  148103. private _intersectsWithSphere;
  148104. }
  148105. /**
  148106. * Represents a gravitational field event
  148107. */
  148108. class PhysicsGravitationalFieldEvent {
  148109. private _physicsHelper;
  148110. private _scene;
  148111. private _origin;
  148112. private _options;
  148113. private _tickCallback;
  148114. private _sphere;
  148115. private _dataFetched;
  148116. /**
  148117. * Initializes the physics gravitational field event
  148118. * @param _physicsHelper A physics helper
  148119. * @param _scene BabylonJS scene
  148120. * @param _origin The origin position of the gravitational field event
  148121. * @param _options The options for the vortex event
  148122. */
  148123. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  148124. /**
  148125. * Returns the data related to the gravitational field event (sphere).
  148126. * @returns A gravitational field event
  148127. */
  148128. getData(): PhysicsGravitationalFieldEventData;
  148129. /**
  148130. * Enables the gravitational field.
  148131. */
  148132. enable(): void;
  148133. /**
  148134. * Disables the gravitational field.
  148135. */
  148136. disable(): void;
  148137. /**
  148138. * Disposes the sphere.
  148139. * @param force The force to dispose from the gravitational field event
  148140. */
  148141. dispose(force?: boolean): void;
  148142. private _tick;
  148143. }
  148144. /**
  148145. * Represents a physics updraft event
  148146. */
  148147. class PhysicsUpdraftEvent {
  148148. private _scene;
  148149. private _origin;
  148150. private _options;
  148151. private _physicsEngine;
  148152. private _originTop;
  148153. private _originDirection;
  148154. private _tickCallback;
  148155. private _cylinder;
  148156. private _cylinderPosition;
  148157. private _dataFetched;
  148158. /**
  148159. * Initializes the physics updraft event
  148160. * @param _scene BabylonJS scene
  148161. * @param _origin The origin position of the updraft
  148162. * @param _options The options for the updraft event
  148163. */
  148164. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  148165. /**
  148166. * Returns the data related to the updraft event (cylinder).
  148167. * @returns A physics updraft event
  148168. */
  148169. getData(): PhysicsUpdraftEventData;
  148170. /**
  148171. * Enables the updraft.
  148172. */
  148173. enable(): void;
  148174. /**
  148175. * Disables the updraft.
  148176. */
  148177. disable(): void;
  148178. /**
  148179. * Disposes the cylinder.
  148180. * @param force Specifies if the updraft should be disposed by force
  148181. */
  148182. dispose(force?: boolean): void;
  148183. private getImpostorHitData;
  148184. private _tick;
  148185. /*** Helpers ***/
  148186. private _prepareCylinder;
  148187. private _intersectsWithCylinder;
  148188. }
  148189. /**
  148190. * Represents a physics vortex event
  148191. */
  148192. class PhysicsVortexEvent {
  148193. private _scene;
  148194. private _origin;
  148195. private _options;
  148196. private _physicsEngine;
  148197. private _originTop;
  148198. private _tickCallback;
  148199. private _cylinder;
  148200. private _cylinderPosition;
  148201. private _dataFetched;
  148202. /**
  148203. * Initializes the physics vortex event
  148204. * @param _scene The BabylonJS scene
  148205. * @param _origin The origin position of the vortex
  148206. * @param _options The options for the vortex event
  148207. */
  148208. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  148209. /**
  148210. * Returns the data related to the vortex event (cylinder).
  148211. * @returns The physics vortex event data
  148212. */
  148213. getData(): PhysicsVortexEventData;
  148214. /**
  148215. * Enables the vortex.
  148216. */
  148217. enable(): void;
  148218. /**
  148219. * Disables the cortex.
  148220. */
  148221. disable(): void;
  148222. /**
  148223. * Disposes the sphere.
  148224. * @param force
  148225. */
  148226. dispose(force?: boolean): void;
  148227. private getImpostorHitData;
  148228. private _tick;
  148229. /*** Helpers ***/
  148230. private _prepareCylinder;
  148231. private _intersectsWithCylinder;
  148232. }
  148233. /**
  148234. * Options fot the radial explosion event
  148235. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148236. */
  148237. export class PhysicsRadialExplosionEventOptions {
  148238. /**
  148239. * The radius of the sphere for the radial explosion.
  148240. */
  148241. radius: number;
  148242. /**
  148243. * The strenth of the explosion.
  148244. */
  148245. strength: number;
  148246. /**
  148247. * The strenght of the force in correspondence to the distance of the affected object
  148248. */
  148249. falloff: PhysicsRadialImpulseFalloff;
  148250. /**
  148251. * Sphere options for the radial explosion.
  148252. */
  148253. sphere: {
  148254. segments: number;
  148255. diameter: number;
  148256. };
  148257. /**
  148258. * Sphere options for the radial explosion.
  148259. */
  148260. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  148261. }
  148262. /**
  148263. * Options fot the updraft event
  148264. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148265. */
  148266. export class PhysicsUpdraftEventOptions {
  148267. /**
  148268. * The radius of the cylinder for the vortex
  148269. */
  148270. radius: number;
  148271. /**
  148272. * The strenth of the updraft.
  148273. */
  148274. strength: number;
  148275. /**
  148276. * The height of the cylinder for the updraft.
  148277. */
  148278. height: number;
  148279. /**
  148280. * The mode for the the updraft.
  148281. */
  148282. updraftMode: PhysicsUpdraftMode;
  148283. }
  148284. /**
  148285. * Options fot the vortex event
  148286. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148287. */
  148288. export class PhysicsVortexEventOptions {
  148289. /**
  148290. * The radius of the cylinder for the vortex
  148291. */
  148292. radius: number;
  148293. /**
  148294. * The strenth of the vortex.
  148295. */
  148296. strength: number;
  148297. /**
  148298. * The height of the cylinder for the vortex.
  148299. */
  148300. height: number;
  148301. /**
  148302. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  148303. */
  148304. centripetalForceThreshold: number;
  148305. /**
  148306. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  148307. */
  148308. centripetalForceMultiplier: number;
  148309. /**
  148310. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  148311. */
  148312. centrifugalForceMultiplier: number;
  148313. /**
  148314. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  148315. */
  148316. updraftForceMultiplier: number;
  148317. }
  148318. /**
  148319. * The strenght of the force in correspondence to the distance of the affected object
  148320. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148321. */
  148322. export enum PhysicsRadialImpulseFalloff {
  148323. /** Defines that impulse is constant in strength across it's whole radius */
  148324. Constant = 0,
  148325. /** Defines that impulse gets weaker if it's further from the origin */
  148326. Linear = 1
  148327. }
  148328. /**
  148329. * The strength of the force in correspondence to the distance of the affected object
  148330. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148331. */
  148332. export enum PhysicsUpdraftMode {
  148333. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  148334. Center = 0,
  148335. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  148336. Perpendicular = 1
  148337. }
  148338. /**
  148339. * Interface for a physics hit data
  148340. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148341. */
  148342. export interface PhysicsHitData {
  148343. /**
  148344. * The force applied at the contact point
  148345. */
  148346. force: Vector3;
  148347. /**
  148348. * The contact point
  148349. */
  148350. contactPoint: Vector3;
  148351. /**
  148352. * The distance from the origin to the contact point
  148353. */
  148354. distanceFromOrigin: number;
  148355. }
  148356. /**
  148357. * Interface for radial explosion event data
  148358. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148359. */
  148360. export interface PhysicsRadialExplosionEventData {
  148361. /**
  148362. * A sphere used for the radial explosion event
  148363. */
  148364. sphere: Mesh;
  148365. }
  148366. /**
  148367. * Interface for gravitational field event data
  148368. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148369. */
  148370. export interface PhysicsGravitationalFieldEventData {
  148371. /**
  148372. * A sphere mesh used for the gravitational field event
  148373. */
  148374. sphere: Mesh;
  148375. }
  148376. /**
  148377. * Interface for updraft event data
  148378. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148379. */
  148380. export interface PhysicsUpdraftEventData {
  148381. /**
  148382. * A cylinder used for the updraft event
  148383. */
  148384. cylinder: Mesh;
  148385. }
  148386. /**
  148387. * Interface for vortex event data
  148388. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148389. */
  148390. export interface PhysicsVortexEventData {
  148391. /**
  148392. * A cylinder used for the vortex event
  148393. */
  148394. cylinder: Mesh;
  148395. }
  148396. /**
  148397. * Interface for an affected physics impostor
  148398. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148399. */
  148400. export interface PhysicsAffectedImpostorWithData {
  148401. /**
  148402. * The impostor affected by the effect
  148403. */
  148404. impostor: PhysicsImpostor;
  148405. /**
  148406. * The data about the hit/horce from the explosion
  148407. */
  148408. hitData: PhysicsHitData;
  148409. }
  148410. }
  148411. declare module BABYLON {
  148412. /** @hidden */
  148413. export var blackAndWhitePixelShader: {
  148414. name: string;
  148415. shader: string;
  148416. };
  148417. }
  148418. declare module BABYLON {
  148419. /**
  148420. * Post process used to render in black and white
  148421. */
  148422. export class BlackAndWhitePostProcess extends PostProcess {
  148423. /**
  148424. * Linear about to convert he result to black and white (default: 1)
  148425. */
  148426. degree: number;
  148427. /**
  148428. * Gets a string identifying the name of the class
  148429. * @returns "BlackAndWhitePostProcess" string
  148430. */
  148431. getClassName(): string;
  148432. /**
  148433. * Creates a black and white post process
  148434. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  148435. * @param name The name of the effect.
  148436. * @param options The required width/height ratio to downsize to before computing the render pass.
  148437. * @param camera The camera to apply the render pass to.
  148438. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148439. * @param engine The engine which the post process will be applied. (default: current engine)
  148440. * @param reusable If the post process can be reused on the same frame. (default: false)
  148441. */
  148442. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  148443. /** @hidden */
  148444. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlackAndWhitePostProcess>;
  148445. }
  148446. }
  148447. declare module BABYLON {
  148448. /**
  148449. * This represents a set of one or more post processes in Babylon.
  148450. * A post process can be used to apply a shader to a texture after it is rendered.
  148451. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  148452. */
  148453. export class PostProcessRenderEffect {
  148454. private _postProcesses;
  148455. private _getPostProcesses;
  148456. private _singleInstance;
  148457. private _cameras;
  148458. private _indicesForCamera;
  148459. /**
  148460. * Name of the effect
  148461. * @hidden
  148462. */
  148463. _name: string;
  148464. /**
  148465. * Instantiates a post process render effect.
  148466. * A post process can be used to apply a shader to a texture after it is rendered.
  148467. * @param engine The engine the effect is tied to
  148468. * @param name The name of the effect
  148469. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  148470. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  148471. */
  148472. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  148473. /**
  148474. * Checks if all the post processes in the effect are supported.
  148475. */
  148476. get isSupported(): boolean;
  148477. /**
  148478. * Updates the current state of the effect
  148479. * @hidden
  148480. */
  148481. _update(): void;
  148482. /**
  148483. * Attaches the effect on cameras
  148484. * @param cameras The camera to attach to.
  148485. * @hidden
  148486. */
  148487. _attachCameras(cameras: Camera): void;
  148488. /**
  148489. * Attaches the effect on cameras
  148490. * @param cameras The camera to attach to.
  148491. * @hidden
  148492. */
  148493. _attachCameras(cameras: Camera[]): void;
  148494. /**
  148495. * Detaches the effect on cameras
  148496. * @param cameras The camera to detatch from.
  148497. * @hidden
  148498. */
  148499. _detachCameras(cameras: Camera): void;
  148500. /**
  148501. * Detatches the effect on cameras
  148502. * @param cameras The camera to detatch from.
  148503. * @hidden
  148504. */
  148505. _detachCameras(cameras: Camera[]): void;
  148506. /**
  148507. * Enables the effect on given cameras
  148508. * @param cameras The camera to enable.
  148509. * @hidden
  148510. */
  148511. _enable(cameras: Camera): void;
  148512. /**
  148513. * Enables the effect on given cameras
  148514. * @param cameras The camera to enable.
  148515. * @hidden
  148516. */
  148517. _enable(cameras: Nullable<Camera[]>): void;
  148518. /**
  148519. * Disables the effect on the given cameras
  148520. * @param cameras The camera to disable.
  148521. * @hidden
  148522. */
  148523. _disable(cameras: Camera): void;
  148524. /**
  148525. * Disables the effect on the given cameras
  148526. * @param cameras The camera to disable.
  148527. * @hidden
  148528. */
  148529. _disable(cameras: Nullable<Camera[]>): void;
  148530. /**
  148531. * Gets a list of the post processes contained in the effect.
  148532. * @param camera The camera to get the post processes on.
  148533. * @returns The list of the post processes in the effect.
  148534. */
  148535. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  148536. }
  148537. }
  148538. declare module BABYLON {
  148539. /** @hidden */
  148540. export var extractHighlightsPixelShader: {
  148541. name: string;
  148542. shader: string;
  148543. };
  148544. }
  148545. declare module BABYLON {
  148546. /**
  148547. * 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.
  148548. */
  148549. export class ExtractHighlightsPostProcess extends PostProcess {
  148550. /**
  148551. * The luminance threshold, pixels below this value will be set to black.
  148552. */
  148553. threshold: number;
  148554. /** @hidden */
  148555. _exposure: number;
  148556. /**
  148557. * Post process which has the input texture to be used when performing highlight extraction
  148558. * @hidden
  148559. */
  148560. _inputPostProcess: Nullable<PostProcess>;
  148561. /**
  148562. * Gets a string identifying the name of the class
  148563. * @returns "ExtractHighlightsPostProcess" string
  148564. */
  148565. getClassName(): string;
  148566. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148567. }
  148568. }
  148569. declare module BABYLON {
  148570. /** @hidden */
  148571. export var bloomMergePixelShader: {
  148572. name: string;
  148573. shader: string;
  148574. };
  148575. }
  148576. declare module BABYLON {
  148577. /**
  148578. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  148579. */
  148580. export class BloomMergePostProcess extends PostProcess {
  148581. /** Weight of the bloom to be added to the original input. */
  148582. weight: number;
  148583. /**
  148584. * Gets a string identifying the name of the class
  148585. * @returns "BloomMergePostProcess" string
  148586. */
  148587. getClassName(): string;
  148588. /**
  148589. * Creates a new instance of @see BloomMergePostProcess
  148590. * @param name The name of the effect.
  148591. * @param originalFromInput Post process which's input will be used for the merge.
  148592. * @param blurred Blurred highlights post process which's output will be used.
  148593. * @param weight Weight of the bloom to be added to the original input.
  148594. * @param options The required width/height ratio to downsize to before computing the render pass.
  148595. * @param camera The camera to apply the render pass to.
  148596. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148597. * @param engine The engine which the post process will be applied. (default: current engine)
  148598. * @param reusable If the post process can be reused on the same frame. (default: false)
  148599. * @param textureType Type of textures used when performing the post process. (default: 0)
  148600. * @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)
  148601. */
  148602. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  148603. /** Weight of the bloom to be added to the original input. */
  148604. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148605. }
  148606. }
  148607. declare module BABYLON {
  148608. /**
  148609. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  148610. */
  148611. export class BloomEffect extends PostProcessRenderEffect {
  148612. private bloomScale;
  148613. /**
  148614. * @hidden Internal
  148615. */
  148616. _effects: Array<PostProcess>;
  148617. /**
  148618. * @hidden Internal
  148619. */
  148620. _downscale: ExtractHighlightsPostProcess;
  148621. private _blurX;
  148622. private _blurY;
  148623. private _merge;
  148624. /**
  148625. * The luminance threshold to find bright areas of the image to bloom.
  148626. */
  148627. get threshold(): number;
  148628. set threshold(value: number);
  148629. /**
  148630. * The strength of the bloom.
  148631. */
  148632. get weight(): number;
  148633. set weight(value: number);
  148634. /**
  148635. * Specifies the size of the bloom blur kernel, relative to the final output size
  148636. */
  148637. get kernel(): number;
  148638. set kernel(value: number);
  148639. /**
  148640. * Creates a new instance of @see BloomEffect
  148641. * @param scene The scene the effect belongs to.
  148642. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  148643. * @param bloomKernel The size of the kernel to be used when applying the blur.
  148644. * @param bloomWeight The the strength of bloom.
  148645. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  148646. * @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)
  148647. */
  148648. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  148649. /**
  148650. * Disposes each of the internal effects for a given camera.
  148651. * @param camera The camera to dispose the effect on.
  148652. */
  148653. disposeEffects(camera: Camera): void;
  148654. /**
  148655. * @hidden Internal
  148656. */
  148657. _updateEffects(): void;
  148658. /**
  148659. * Internal
  148660. * @returns if all the contained post processes are ready.
  148661. * @hidden
  148662. */
  148663. _isReady(): boolean;
  148664. }
  148665. }
  148666. declare module BABYLON {
  148667. /** @hidden */
  148668. export var chromaticAberrationPixelShader: {
  148669. name: string;
  148670. shader: string;
  148671. };
  148672. }
  148673. declare module BABYLON {
  148674. /**
  148675. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  148676. */
  148677. export class ChromaticAberrationPostProcess extends PostProcess {
  148678. /**
  148679. * The amount of seperation of rgb channels (default: 30)
  148680. */
  148681. aberrationAmount: number;
  148682. /**
  148683. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  148684. */
  148685. radialIntensity: number;
  148686. /**
  148687. * 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))
  148688. */
  148689. direction: Vector2;
  148690. /**
  148691. * 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))
  148692. */
  148693. centerPosition: Vector2;
  148694. /** The width of the screen to apply the effect on */
  148695. screenWidth: number;
  148696. /** The height of the screen to apply the effect on */
  148697. screenHeight: number;
  148698. /**
  148699. * Gets a string identifying the name of the class
  148700. * @returns "ChromaticAberrationPostProcess" string
  148701. */
  148702. getClassName(): string;
  148703. /**
  148704. * Creates a new instance ChromaticAberrationPostProcess
  148705. * @param name The name of the effect.
  148706. * @param screenWidth The width of the screen to apply the effect on.
  148707. * @param screenHeight The height of the screen to apply the effect on.
  148708. * @param options The required width/height ratio to downsize to before computing the render pass.
  148709. * @param camera The camera to apply the render pass to.
  148710. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148711. * @param engine The engine which the post process will be applied. (default: current engine)
  148712. * @param reusable If the post process can be reused on the same frame. (default: false)
  148713. * @param textureType Type of textures used when performing the post process. (default: 0)
  148714. * @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)
  148715. */
  148716. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148717. /** @hidden */
  148718. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ChromaticAberrationPostProcess>;
  148719. }
  148720. }
  148721. declare module BABYLON {
  148722. /** @hidden */
  148723. export var circleOfConfusionPixelShader: {
  148724. name: string;
  148725. shader: string;
  148726. };
  148727. }
  148728. declare module BABYLON {
  148729. /**
  148730. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  148731. */
  148732. export class CircleOfConfusionPostProcess extends PostProcess {
  148733. /**
  148734. * 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.
  148735. */
  148736. lensSize: number;
  148737. /**
  148738. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  148739. */
  148740. fStop: number;
  148741. /**
  148742. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  148743. */
  148744. focusDistance: number;
  148745. /**
  148746. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  148747. */
  148748. focalLength: number;
  148749. /**
  148750. * Gets a string identifying the name of the class
  148751. * @returns "CircleOfConfusionPostProcess" string
  148752. */
  148753. getClassName(): string;
  148754. private _depthTexture;
  148755. /**
  148756. * Creates a new instance CircleOfConfusionPostProcess
  148757. * @param name The name of the effect.
  148758. * @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.
  148759. * @param options The required width/height ratio to downsize to before computing the render pass.
  148760. * @param camera The camera to apply the render pass to.
  148761. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148762. * @param engine The engine which the post process will be applied. (default: current engine)
  148763. * @param reusable If the post process can be reused on the same frame. (default: false)
  148764. * @param textureType Type of textures used when performing the post process. (default: 0)
  148765. * @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)
  148766. */
  148767. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148768. /**
  148769. * 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.
  148770. */
  148771. set depthTexture(value: RenderTargetTexture);
  148772. }
  148773. }
  148774. declare module BABYLON {
  148775. /** @hidden */
  148776. export var colorCorrectionPixelShader: {
  148777. name: string;
  148778. shader: string;
  148779. };
  148780. }
  148781. declare module BABYLON {
  148782. /**
  148783. *
  148784. * This post-process allows the modification of rendered colors by using
  148785. * a 'look-up table' (LUT). This effect is also called Color Grading.
  148786. *
  148787. * The object needs to be provided an url to a texture containing the color
  148788. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  148789. * Use an image editing software to tweak the LUT to match your needs.
  148790. *
  148791. * For an example of a color LUT, see here:
  148792. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  148793. * For explanations on color grading, see here:
  148794. * @see http://udn.epicgames.com/Three/ColorGrading.html
  148795. *
  148796. */
  148797. export class ColorCorrectionPostProcess extends PostProcess {
  148798. private _colorTableTexture;
  148799. /**
  148800. * Gets the color table url used to create the LUT texture
  148801. */
  148802. colorTableUrl: string;
  148803. /**
  148804. * Gets a string identifying the name of the class
  148805. * @returns "ColorCorrectionPostProcess" string
  148806. */
  148807. getClassName(): string;
  148808. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  148809. /** @hidden */
  148810. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ColorCorrectionPostProcess>;
  148811. }
  148812. }
  148813. declare module BABYLON {
  148814. /** @hidden */
  148815. export var convolutionPixelShader: {
  148816. name: string;
  148817. shader: string;
  148818. };
  148819. }
  148820. declare module BABYLON {
  148821. /**
  148822. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  148823. * input texture to perform effects such as edge detection or sharpening
  148824. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  148825. */
  148826. export class ConvolutionPostProcess extends PostProcess {
  148827. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  148828. kernel: number[];
  148829. /**
  148830. * Gets a string identifying the name of the class
  148831. * @returns "ConvolutionPostProcess" string
  148832. */
  148833. getClassName(): string;
  148834. /**
  148835. * Creates a new instance ConvolutionPostProcess
  148836. * @param name The name of the effect.
  148837. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  148838. * @param options The required width/height ratio to downsize to before computing the render pass.
  148839. * @param camera The camera to apply the render pass to.
  148840. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148841. * @param engine The engine which the post process will be applied. (default: current engine)
  148842. * @param reusable If the post process can be reused on the same frame. (default: false)
  148843. * @param textureType Type of textures used when performing the post process. (default: 0)
  148844. */
  148845. constructor(name: string, kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  148846. /** @hidden */
  148847. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ConvolutionPostProcess>;
  148848. /**
  148849. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148850. */
  148851. static EdgeDetect0Kernel: number[];
  148852. /**
  148853. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148854. */
  148855. static EdgeDetect1Kernel: number[];
  148856. /**
  148857. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148858. */
  148859. static EdgeDetect2Kernel: number[];
  148860. /**
  148861. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148862. */
  148863. static SharpenKernel: number[];
  148864. /**
  148865. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148866. */
  148867. static EmbossKernel: number[];
  148868. /**
  148869. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148870. */
  148871. static GaussianKernel: number[];
  148872. }
  148873. }
  148874. declare module BABYLON {
  148875. /**
  148876. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  148877. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  148878. * based on samples that have a large difference in distance than the center pixel.
  148879. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  148880. */
  148881. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  148882. /**
  148883. * The direction the blur should be applied
  148884. */
  148885. direction: Vector2;
  148886. /**
  148887. * Gets a string identifying the name of the class
  148888. * @returns "DepthOfFieldBlurPostProcess" string
  148889. */
  148890. getClassName(): string;
  148891. /**
  148892. * Creates a new instance CircleOfConfusionPostProcess
  148893. * @param name The name of the effect.
  148894. * @param scene The scene the effect belongs to.
  148895. * @param direction The direction the blur should be applied.
  148896. * @param kernel The size of the kernel used to blur.
  148897. * @param options The required width/height ratio to downsize to before computing the render pass.
  148898. * @param camera The camera to apply the render pass to.
  148899. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  148900. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  148901. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148902. * @param engine The engine which the post process will be applied. (default: current engine)
  148903. * @param reusable If the post process can be reused on the same frame. (default: false)
  148904. * @param textureType Type of textures used when performing the post process. (default: 0)
  148905. * @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)
  148906. */
  148907. 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);
  148908. }
  148909. }
  148910. declare module BABYLON {
  148911. /** @hidden */
  148912. export var depthOfFieldMergePixelShader: {
  148913. name: string;
  148914. shader: string;
  148915. };
  148916. }
  148917. declare module BABYLON {
  148918. /**
  148919. * Options to be set when merging outputs from the default pipeline.
  148920. */
  148921. export class DepthOfFieldMergePostProcessOptions {
  148922. /**
  148923. * The original image to merge on top of
  148924. */
  148925. originalFromInput: PostProcess;
  148926. /**
  148927. * Parameters to perform the merge of the depth of field effect
  148928. */
  148929. depthOfField?: {
  148930. circleOfConfusion: PostProcess;
  148931. blurSteps: Array<PostProcess>;
  148932. };
  148933. /**
  148934. * Parameters to perform the merge of bloom effect
  148935. */
  148936. bloom?: {
  148937. blurred: PostProcess;
  148938. weight: number;
  148939. };
  148940. }
  148941. /**
  148942. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  148943. */
  148944. export class DepthOfFieldMergePostProcess extends PostProcess {
  148945. private blurSteps;
  148946. /**
  148947. * Gets a string identifying the name of the class
  148948. * @returns "DepthOfFieldMergePostProcess" string
  148949. */
  148950. getClassName(): string;
  148951. /**
  148952. * Creates a new instance of DepthOfFieldMergePostProcess
  148953. * @param name The name of the effect.
  148954. * @param originalFromInput Post process which's input will be used for the merge.
  148955. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  148956. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  148957. * @param options The required width/height ratio to downsize to before computing the render pass.
  148958. * @param camera The camera to apply the render pass to.
  148959. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148960. * @param engine The engine which the post process will be applied. (default: current engine)
  148961. * @param reusable If the post process can be reused on the same frame. (default: false)
  148962. * @param textureType Type of textures used when performing the post process. (default: 0)
  148963. * @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)
  148964. */
  148965. 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);
  148966. /**
  148967. * Updates the effect with the current post process compile time values and recompiles the shader.
  148968. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  148969. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  148970. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  148971. * @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
  148972. * @param onCompiled Called when the shader has been compiled.
  148973. * @param onError Called if there is an error when compiling a shader.
  148974. */
  148975. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  148976. }
  148977. }
  148978. declare module BABYLON {
  148979. /**
  148980. * Specifies the level of max blur that should be applied when using the depth of field effect
  148981. */
  148982. export enum DepthOfFieldEffectBlurLevel {
  148983. /**
  148984. * Subtle blur
  148985. */
  148986. Low = 0,
  148987. /**
  148988. * Medium blur
  148989. */
  148990. Medium = 1,
  148991. /**
  148992. * Large blur
  148993. */
  148994. High = 2
  148995. }
  148996. /**
  148997. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  148998. */
  148999. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  149000. private _circleOfConfusion;
  149001. /**
  149002. * @hidden Internal, blurs from high to low
  149003. */
  149004. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  149005. private _depthOfFieldBlurY;
  149006. private _dofMerge;
  149007. /**
  149008. * @hidden Internal post processes in depth of field effect
  149009. */
  149010. _effects: Array<PostProcess>;
  149011. /**
  149012. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  149013. */
  149014. set focalLength(value: number);
  149015. get focalLength(): number;
  149016. /**
  149017. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  149018. */
  149019. set fStop(value: number);
  149020. get fStop(): number;
  149021. /**
  149022. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  149023. */
  149024. set focusDistance(value: number);
  149025. get focusDistance(): number;
  149026. /**
  149027. * 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.
  149028. */
  149029. set lensSize(value: number);
  149030. get lensSize(): number;
  149031. /**
  149032. * Creates a new instance DepthOfFieldEffect
  149033. * @param scene The scene the effect belongs to.
  149034. * @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.
  149035. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  149036. * @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)
  149037. */
  149038. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  149039. /**
  149040. * Get the current class name of the current effet
  149041. * @returns "DepthOfFieldEffect"
  149042. */
  149043. getClassName(): string;
  149044. /**
  149045. * 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.
  149046. */
  149047. set depthTexture(value: RenderTargetTexture);
  149048. /**
  149049. * Disposes each of the internal effects for a given camera.
  149050. * @param camera The camera to dispose the effect on.
  149051. */
  149052. disposeEffects(camera: Camera): void;
  149053. /**
  149054. * @hidden Internal
  149055. */
  149056. _updateEffects(): void;
  149057. /**
  149058. * Internal
  149059. * @returns if all the contained post processes are ready.
  149060. * @hidden
  149061. */
  149062. _isReady(): boolean;
  149063. }
  149064. }
  149065. declare module BABYLON {
  149066. /** @hidden */
  149067. export var displayPassPixelShader: {
  149068. name: string;
  149069. shader: string;
  149070. };
  149071. }
  149072. declare module BABYLON {
  149073. /**
  149074. * DisplayPassPostProcess which produces an output the same as it's input
  149075. */
  149076. export class DisplayPassPostProcess extends PostProcess {
  149077. /**
  149078. * Gets a string identifying the name of the class
  149079. * @returns "DisplayPassPostProcess" string
  149080. */
  149081. getClassName(): string;
  149082. /**
  149083. * Creates the DisplayPassPostProcess
  149084. * @param name The name of the effect.
  149085. * @param options The required width/height ratio to downsize to before computing the render pass.
  149086. * @param camera The camera to apply the render pass to.
  149087. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149088. * @param engine The engine which the post process will be applied. (default: current engine)
  149089. * @param reusable If the post process can be reused on the same frame. (default: false)
  149090. */
  149091. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149092. /** @hidden */
  149093. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<DisplayPassPostProcess>;
  149094. }
  149095. }
  149096. declare module BABYLON {
  149097. /** @hidden */
  149098. export var filterPixelShader: {
  149099. name: string;
  149100. shader: string;
  149101. };
  149102. }
  149103. declare module BABYLON {
  149104. /**
  149105. * Applies a kernel filter to the image
  149106. */
  149107. export class FilterPostProcess extends PostProcess {
  149108. /** The matrix to be applied to the image */
  149109. kernelMatrix: Matrix;
  149110. /**
  149111. * Gets a string identifying the name of the class
  149112. * @returns "FilterPostProcess" string
  149113. */
  149114. getClassName(): string;
  149115. /**
  149116. *
  149117. * @param name The name of the effect.
  149118. * @param kernelMatrix The matrix to be applied to the image
  149119. * @param options The required width/height ratio to downsize to before computing the render pass.
  149120. * @param camera The camera to apply the render pass to.
  149121. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149122. * @param engine The engine which the post process will be applied. (default: current engine)
  149123. * @param reusable If the post process can be reused on the same frame. (default: false)
  149124. */
  149125. constructor(name: string, kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149126. /** @hidden */
  149127. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<FilterPostProcess>;
  149128. }
  149129. }
  149130. declare module BABYLON {
  149131. /** @hidden */
  149132. export var fxaaPixelShader: {
  149133. name: string;
  149134. shader: string;
  149135. };
  149136. }
  149137. declare module BABYLON {
  149138. /** @hidden */
  149139. export var fxaaVertexShader: {
  149140. name: string;
  149141. shader: string;
  149142. };
  149143. }
  149144. declare module BABYLON {
  149145. /**
  149146. * Fxaa post process
  149147. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  149148. */
  149149. export class FxaaPostProcess extends PostProcess {
  149150. /**
  149151. * Gets a string identifying the name of the class
  149152. * @returns "FxaaPostProcess" string
  149153. */
  149154. getClassName(): string;
  149155. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  149156. private _getDefines;
  149157. /** @hidden */
  149158. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): FxaaPostProcess;
  149159. }
  149160. }
  149161. declare module BABYLON {
  149162. /** @hidden */
  149163. export var grainPixelShader: {
  149164. name: string;
  149165. shader: string;
  149166. };
  149167. }
  149168. declare module BABYLON {
  149169. /**
  149170. * The GrainPostProcess adds noise to the image at mid luminance levels
  149171. */
  149172. export class GrainPostProcess extends PostProcess {
  149173. /**
  149174. * The intensity of the grain added (default: 30)
  149175. */
  149176. intensity: number;
  149177. /**
  149178. * If the grain should be randomized on every frame
  149179. */
  149180. animated: boolean;
  149181. /**
  149182. * Gets a string identifying the name of the class
  149183. * @returns "GrainPostProcess" string
  149184. */
  149185. getClassName(): string;
  149186. /**
  149187. * Creates a new instance of @see GrainPostProcess
  149188. * @param name The name of the effect.
  149189. * @param options The required width/height ratio to downsize to before computing the render pass.
  149190. * @param camera The camera to apply the render pass to.
  149191. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149192. * @param engine The engine which the post process will be applied. (default: current engine)
  149193. * @param reusable If the post process can be reused on the same frame. (default: false)
  149194. * @param textureType Type of textures used when performing the post process. (default: 0)
  149195. * @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)
  149196. */
  149197. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149198. /** @hidden */
  149199. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): GrainPostProcess;
  149200. }
  149201. }
  149202. declare module BABYLON {
  149203. /** @hidden */
  149204. export var highlightsPixelShader: {
  149205. name: string;
  149206. shader: string;
  149207. };
  149208. }
  149209. declare module BABYLON {
  149210. /**
  149211. * Extracts highlights from the image
  149212. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  149213. */
  149214. export class HighlightsPostProcess extends PostProcess {
  149215. /**
  149216. * Gets a string identifying the name of the class
  149217. * @returns "HighlightsPostProcess" string
  149218. */
  149219. getClassName(): string;
  149220. /**
  149221. * Extracts highlights from the image
  149222. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  149223. * @param name The name of the effect.
  149224. * @param options The required width/height ratio to downsize to before computing the render pass.
  149225. * @param camera The camera to apply the render pass to.
  149226. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149227. * @param engine The engine which the post process will be applied. (default: current engine)
  149228. * @param reusable If the post process can be reused on the same frame. (default: false)
  149229. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  149230. */
  149231. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  149232. }
  149233. }
  149234. declare module BABYLON {
  149235. /** @hidden */
  149236. export var mrtFragmentDeclaration: {
  149237. name: string;
  149238. shader: string;
  149239. };
  149240. }
  149241. declare module BABYLON {
  149242. /** @hidden */
  149243. export var geometryPixelShader: {
  149244. name: string;
  149245. shader: string;
  149246. };
  149247. }
  149248. declare module BABYLON {
  149249. /** @hidden */
  149250. export var geometryVertexShader: {
  149251. name: string;
  149252. shader: string;
  149253. };
  149254. }
  149255. declare module BABYLON {
  149256. /** @hidden */
  149257. interface ISavedTransformationMatrix {
  149258. world: Matrix;
  149259. viewProjection: Matrix;
  149260. }
  149261. /**
  149262. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  149263. */
  149264. export class GeometryBufferRenderer {
  149265. /**
  149266. * Constant used to retrieve the position texture index in the G-Buffer textures array
  149267. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  149268. */
  149269. static readonly POSITION_TEXTURE_TYPE: number;
  149270. /**
  149271. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  149272. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  149273. */
  149274. static readonly VELOCITY_TEXTURE_TYPE: number;
  149275. /**
  149276. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  149277. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  149278. */
  149279. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  149280. /**
  149281. * Dictionary used to store the previous transformation matrices of each rendered mesh
  149282. * in order to compute objects velocities when enableVelocity is set to "true"
  149283. * @hidden
  149284. */
  149285. _previousTransformationMatrices: {
  149286. [index: number]: ISavedTransformationMatrix;
  149287. };
  149288. /**
  149289. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  149290. * in order to compute objects velocities when enableVelocity is set to "true"
  149291. * @hidden
  149292. */
  149293. _previousBonesTransformationMatrices: {
  149294. [index: number]: Float32Array;
  149295. };
  149296. /**
  149297. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  149298. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  149299. */
  149300. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  149301. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  149302. renderTransparentMeshes: boolean;
  149303. private _scene;
  149304. private _resizeObserver;
  149305. private _multiRenderTarget;
  149306. private _ratio;
  149307. private _enablePosition;
  149308. private _enableVelocity;
  149309. private _enableReflectivity;
  149310. private _positionIndex;
  149311. private _velocityIndex;
  149312. private _reflectivityIndex;
  149313. protected _effect: Effect;
  149314. protected _cachedDefines: string;
  149315. /**
  149316. * Set the render list (meshes to be rendered) used in the G buffer.
  149317. */
  149318. set renderList(meshes: Mesh[]);
  149319. /**
  149320. * Gets wether or not G buffer are supported by the running hardware.
  149321. * This requires draw buffer supports
  149322. */
  149323. get isSupported(): boolean;
  149324. /**
  149325. * Returns the index of the given texture type in the G-Buffer textures array
  149326. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  149327. * @returns the index of the given texture type in the G-Buffer textures array
  149328. */
  149329. getTextureIndex(textureType: number): number;
  149330. /**
  149331. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  149332. */
  149333. get enablePosition(): boolean;
  149334. /**
  149335. * Sets whether or not objects positions are enabled for the G buffer.
  149336. */
  149337. set enablePosition(enable: boolean);
  149338. /**
  149339. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  149340. */
  149341. get enableVelocity(): boolean;
  149342. /**
  149343. * Sets wether or not objects velocities are enabled for the G buffer.
  149344. */
  149345. set enableVelocity(enable: boolean);
  149346. /**
  149347. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  149348. */
  149349. get enableReflectivity(): boolean;
  149350. /**
  149351. * Sets wether or not objects roughness are enabled for the G buffer.
  149352. */
  149353. set enableReflectivity(enable: boolean);
  149354. /**
  149355. * Gets the scene associated with the buffer.
  149356. */
  149357. get scene(): Scene;
  149358. /**
  149359. * Gets the ratio used by the buffer during its creation.
  149360. * How big is the buffer related to the main canvas.
  149361. */
  149362. get ratio(): number;
  149363. /** @hidden */
  149364. static _SceneComponentInitialization: (scene: Scene) => void;
  149365. /**
  149366. * Creates a new G Buffer for the scene
  149367. * @param scene The scene the buffer belongs to
  149368. * @param ratio How big is the buffer related to the main canvas.
  149369. */
  149370. constructor(scene: Scene, ratio?: number);
  149371. /**
  149372. * Checks wether everything is ready to render a submesh to the G buffer.
  149373. * @param subMesh the submesh to check readiness for
  149374. * @param useInstances is the mesh drawn using instance or not
  149375. * @returns true if ready otherwise false
  149376. */
  149377. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  149378. /**
  149379. * Gets the current underlying G Buffer.
  149380. * @returns the buffer
  149381. */
  149382. getGBuffer(): MultiRenderTarget;
  149383. /**
  149384. * Gets the number of samples used to render the buffer (anti aliasing).
  149385. */
  149386. get samples(): number;
  149387. /**
  149388. * Sets the number of samples used to render the buffer (anti aliasing).
  149389. */
  149390. set samples(value: number);
  149391. /**
  149392. * Disposes the renderer and frees up associated resources.
  149393. */
  149394. dispose(): void;
  149395. protected _createRenderTargets(): void;
  149396. private _copyBonesTransformationMatrices;
  149397. }
  149398. }
  149399. declare module BABYLON {
  149400. interface Scene {
  149401. /** @hidden (Backing field) */
  149402. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  149403. /**
  149404. * Gets or Sets the current geometry buffer associated to the scene.
  149405. */
  149406. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  149407. /**
  149408. * Enables a GeometryBufferRender and associates it with the scene
  149409. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  149410. * @returns the GeometryBufferRenderer
  149411. */
  149412. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  149413. /**
  149414. * Disables the GeometryBufferRender associated with the scene
  149415. */
  149416. disableGeometryBufferRenderer(): void;
  149417. }
  149418. /**
  149419. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  149420. * in several rendering techniques.
  149421. */
  149422. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  149423. /**
  149424. * The component name helpful to identify the component in the list of scene components.
  149425. */
  149426. readonly name: string;
  149427. /**
  149428. * The scene the component belongs to.
  149429. */
  149430. scene: Scene;
  149431. /**
  149432. * Creates a new instance of the component for the given scene
  149433. * @param scene Defines the scene to register the component in
  149434. */
  149435. constructor(scene: Scene);
  149436. /**
  149437. * Registers the component in a given scene
  149438. */
  149439. register(): void;
  149440. /**
  149441. * Rebuilds the elements related to this component in case of
  149442. * context lost for instance.
  149443. */
  149444. rebuild(): void;
  149445. /**
  149446. * Disposes the component and the associated ressources
  149447. */
  149448. dispose(): void;
  149449. private _gatherRenderTargets;
  149450. }
  149451. }
  149452. declare module BABYLON {
  149453. /** @hidden */
  149454. export var motionBlurPixelShader: {
  149455. name: string;
  149456. shader: string;
  149457. };
  149458. }
  149459. declare module BABYLON {
  149460. /**
  149461. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  149462. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  149463. * As an example, all you have to do is to create the post-process:
  149464. * var mb = new BABYLON.MotionBlurPostProcess(
  149465. * 'mb', // The name of the effect.
  149466. * scene, // The scene containing the objects to blur according to their velocity.
  149467. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  149468. * camera // The camera to apply the render pass to.
  149469. * );
  149470. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  149471. */
  149472. export class MotionBlurPostProcess extends PostProcess {
  149473. /**
  149474. * Defines how much the image is blurred by the movement. Default value is equal to 1
  149475. */
  149476. motionStrength: number;
  149477. /**
  149478. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  149479. */
  149480. get motionBlurSamples(): number;
  149481. /**
  149482. * Sets the number of iterations to be used for motion blur quality
  149483. */
  149484. set motionBlurSamples(samples: number);
  149485. private _motionBlurSamples;
  149486. private _geometryBufferRenderer;
  149487. /**
  149488. * Gets a string identifying the name of the class
  149489. * @returns "MotionBlurPostProcess" string
  149490. */
  149491. getClassName(): string;
  149492. /**
  149493. * Creates a new instance MotionBlurPostProcess
  149494. * @param name The name of the effect.
  149495. * @param scene The scene containing the objects to blur according to their velocity.
  149496. * @param options The required width/height ratio to downsize to before computing the render pass.
  149497. * @param camera The camera to apply the render pass to.
  149498. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149499. * @param engine The engine which the post process will be applied. (default: current engine)
  149500. * @param reusable If the post process can be reused on the same frame. (default: false)
  149501. * @param textureType Type of textures used when performing the post process. (default: 0)
  149502. * @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)
  149503. */
  149504. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149505. /**
  149506. * Excludes the given skinned mesh from computing bones velocities.
  149507. * 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.
  149508. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  149509. */
  149510. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  149511. /**
  149512. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  149513. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  149514. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  149515. */
  149516. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  149517. /**
  149518. * Disposes the post process.
  149519. * @param camera The camera to dispose the post process on.
  149520. */
  149521. dispose(camera?: Camera): void;
  149522. /** @hidden */
  149523. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<MotionBlurPostProcess>;
  149524. }
  149525. }
  149526. declare module BABYLON {
  149527. /** @hidden */
  149528. export var refractionPixelShader: {
  149529. name: string;
  149530. shader: string;
  149531. };
  149532. }
  149533. declare module BABYLON {
  149534. /**
  149535. * Post process which applies a refractin texture
  149536. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  149537. */
  149538. export class RefractionPostProcess extends PostProcess {
  149539. private _refTexture;
  149540. private _ownRefractionTexture;
  149541. /** the base color of the refraction (used to taint the rendering) */
  149542. color: Color3;
  149543. /** simulated refraction depth */
  149544. depth: number;
  149545. /** the coefficient of the base color (0 to remove base color tainting) */
  149546. colorLevel: number;
  149547. /** Gets the url used to load the refraction texture */
  149548. refractionTextureUrl: string;
  149549. /**
  149550. * Gets or sets the refraction texture
  149551. * Please note that you are responsible for disposing the texture if you set it manually
  149552. */
  149553. get refractionTexture(): Texture;
  149554. set refractionTexture(value: Texture);
  149555. /**
  149556. * Gets a string identifying the name of the class
  149557. * @returns "RefractionPostProcess" string
  149558. */
  149559. getClassName(): string;
  149560. /**
  149561. * Initializes the RefractionPostProcess
  149562. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  149563. * @param name The name of the effect.
  149564. * @param refractionTextureUrl Url of the refraction texture to use
  149565. * @param color the base color of the refraction (used to taint the rendering)
  149566. * @param depth simulated refraction depth
  149567. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  149568. * @param camera The camera to apply the render pass to.
  149569. * @param options The required width/height ratio to downsize to before computing the render pass.
  149570. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149571. * @param engine The engine which the post process will be applied. (default: current engine)
  149572. * @param reusable If the post process can be reused on the same frame. (default: false)
  149573. */
  149574. constructor(name: string, refractionTextureUrl: string, color: Color3, depth: number, colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149575. /**
  149576. * Disposes of the post process
  149577. * @param camera Camera to dispose post process on
  149578. */
  149579. dispose(camera: Camera): void;
  149580. /** @hidden */
  149581. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): RefractionPostProcess;
  149582. }
  149583. }
  149584. declare module BABYLON {
  149585. /** @hidden */
  149586. export var sharpenPixelShader: {
  149587. name: string;
  149588. shader: string;
  149589. };
  149590. }
  149591. declare module BABYLON {
  149592. /**
  149593. * The SharpenPostProcess applies a sharpen kernel to every pixel
  149594. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  149595. */
  149596. export class SharpenPostProcess extends PostProcess {
  149597. /**
  149598. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  149599. */
  149600. colorAmount: number;
  149601. /**
  149602. * How much sharpness should be applied (default: 0.3)
  149603. */
  149604. edgeAmount: number;
  149605. /**
  149606. * Gets a string identifying the name of the class
  149607. * @returns "SharpenPostProcess" string
  149608. */
  149609. getClassName(): string;
  149610. /**
  149611. * Creates a new instance ConvolutionPostProcess
  149612. * @param name The name of the effect.
  149613. * @param options The required width/height ratio to downsize to before computing the render pass.
  149614. * @param camera The camera to apply the render pass to.
  149615. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149616. * @param engine The engine which the post process will be applied. (default: current engine)
  149617. * @param reusable If the post process can be reused on the same frame. (default: false)
  149618. * @param textureType Type of textures used when performing the post process. (default: 0)
  149619. * @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)
  149620. */
  149621. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149622. /** @hidden */
  149623. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): SharpenPostProcess;
  149624. }
  149625. }
  149626. declare module BABYLON {
  149627. /**
  149628. * PostProcessRenderPipeline
  149629. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149630. */
  149631. export class PostProcessRenderPipeline {
  149632. private engine;
  149633. private _renderEffects;
  149634. private _renderEffectsForIsolatedPass;
  149635. /**
  149636. * List of inspectable custom properties (used by the Inspector)
  149637. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  149638. */
  149639. inspectableCustomProperties: IInspectable[];
  149640. /**
  149641. * @hidden
  149642. */
  149643. protected _cameras: Camera[];
  149644. /** @hidden */
  149645. _name: string;
  149646. /**
  149647. * Gets pipeline name
  149648. */
  149649. get name(): string;
  149650. /** Gets the list of attached cameras */
  149651. get cameras(): Camera[];
  149652. /**
  149653. * Initializes a PostProcessRenderPipeline
  149654. * @param engine engine to add the pipeline to
  149655. * @param name name of the pipeline
  149656. */
  149657. constructor(engine: Engine, name: string);
  149658. /**
  149659. * Gets the class name
  149660. * @returns "PostProcessRenderPipeline"
  149661. */
  149662. getClassName(): string;
  149663. /**
  149664. * If all the render effects in the pipeline are supported
  149665. */
  149666. get isSupported(): boolean;
  149667. /**
  149668. * Adds an effect to the pipeline
  149669. * @param renderEffect the effect to add
  149670. */
  149671. addEffect(renderEffect: PostProcessRenderEffect): void;
  149672. /** @hidden */
  149673. _rebuild(): void;
  149674. /** @hidden */
  149675. _enableEffect(renderEffectName: string, cameras: Camera): void;
  149676. /** @hidden */
  149677. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  149678. /** @hidden */
  149679. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  149680. /** @hidden */
  149681. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  149682. /** @hidden */
  149683. _attachCameras(cameras: Camera, unique: boolean): void;
  149684. /** @hidden */
  149685. _attachCameras(cameras: Camera[], unique: boolean): void;
  149686. /** @hidden */
  149687. _detachCameras(cameras: Camera): void;
  149688. /** @hidden */
  149689. _detachCameras(cameras: Nullable<Camera[]>): void;
  149690. /** @hidden */
  149691. _update(): void;
  149692. /** @hidden */
  149693. _reset(): void;
  149694. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  149695. /**
  149696. * Sets the required values to the prepass renderer.
  149697. * @param prePassRenderer defines the prepass renderer to setup.
  149698. * @returns true if the pre pass is needed.
  149699. */
  149700. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  149701. /**
  149702. * Disposes of the pipeline
  149703. */
  149704. dispose(): void;
  149705. }
  149706. }
  149707. declare module BABYLON {
  149708. /**
  149709. * PostProcessRenderPipelineManager class
  149710. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149711. */
  149712. export class PostProcessRenderPipelineManager {
  149713. private _renderPipelines;
  149714. /**
  149715. * Initializes a PostProcessRenderPipelineManager
  149716. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149717. */
  149718. constructor();
  149719. /**
  149720. * Gets the list of supported render pipelines
  149721. */
  149722. get supportedPipelines(): PostProcessRenderPipeline[];
  149723. /**
  149724. * Adds a pipeline to the manager
  149725. * @param renderPipeline The pipeline to add
  149726. */
  149727. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  149728. /**
  149729. * Attaches a camera to the pipeline
  149730. * @param renderPipelineName The name of the pipeline to attach to
  149731. * @param cameras the camera to attach
  149732. * @param unique if the camera can be attached multiple times to the pipeline
  149733. */
  149734. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  149735. /**
  149736. * Detaches a camera from the pipeline
  149737. * @param renderPipelineName The name of the pipeline to detach from
  149738. * @param cameras the camera to detach
  149739. */
  149740. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  149741. /**
  149742. * Enables an effect by name on a pipeline
  149743. * @param renderPipelineName the name of the pipeline to enable the effect in
  149744. * @param renderEffectName the name of the effect to enable
  149745. * @param cameras the cameras that the effect should be enabled on
  149746. */
  149747. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  149748. /**
  149749. * Disables an effect by name on a pipeline
  149750. * @param renderPipelineName the name of the pipeline to disable the effect in
  149751. * @param renderEffectName the name of the effect to disable
  149752. * @param cameras the cameras that the effect should be disabled on
  149753. */
  149754. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  149755. /**
  149756. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  149757. */
  149758. update(): void;
  149759. /** @hidden */
  149760. _rebuild(): void;
  149761. /**
  149762. * Disposes of the manager and pipelines
  149763. */
  149764. dispose(): void;
  149765. }
  149766. }
  149767. declare module BABYLON {
  149768. interface Scene {
  149769. /** @hidden (Backing field) */
  149770. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  149771. /**
  149772. * Gets the postprocess render pipeline manager
  149773. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149774. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  149775. */
  149776. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  149777. }
  149778. /**
  149779. * Defines the Render Pipeline scene component responsible to rendering pipelines
  149780. */
  149781. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  149782. /**
  149783. * The component name helpfull to identify the component in the list of scene components.
  149784. */
  149785. readonly name: string;
  149786. /**
  149787. * The scene the component belongs to.
  149788. */
  149789. scene: Scene;
  149790. /**
  149791. * Creates a new instance of the component for the given scene
  149792. * @param scene Defines the scene to register the component in
  149793. */
  149794. constructor(scene: Scene);
  149795. /**
  149796. * Registers the component in a given scene
  149797. */
  149798. register(): void;
  149799. /**
  149800. * Rebuilds the elements related to this component in case of
  149801. * context lost for instance.
  149802. */
  149803. rebuild(): void;
  149804. /**
  149805. * Disposes the component and the associated ressources
  149806. */
  149807. dispose(): void;
  149808. private _gatherRenderTargets;
  149809. }
  149810. }
  149811. declare module BABYLON {
  149812. /**
  149813. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  149814. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  149815. */
  149816. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  149817. private _scene;
  149818. private _camerasToBeAttached;
  149819. /**
  149820. * ID of the sharpen post process,
  149821. */
  149822. private readonly SharpenPostProcessId;
  149823. /**
  149824. * @ignore
  149825. * ID of the image processing post process;
  149826. */
  149827. readonly ImageProcessingPostProcessId: string;
  149828. /**
  149829. * @ignore
  149830. * ID of the Fast Approximate Anti-Aliasing post process;
  149831. */
  149832. readonly FxaaPostProcessId: string;
  149833. /**
  149834. * ID of the chromatic aberration post process,
  149835. */
  149836. private readonly ChromaticAberrationPostProcessId;
  149837. /**
  149838. * ID of the grain post process
  149839. */
  149840. private readonly GrainPostProcessId;
  149841. /**
  149842. * Sharpen post process which will apply a sharpen convolution to enhance edges
  149843. */
  149844. sharpen: SharpenPostProcess;
  149845. private _sharpenEffect;
  149846. private bloom;
  149847. /**
  149848. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  149849. */
  149850. depthOfField: DepthOfFieldEffect;
  149851. /**
  149852. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  149853. */
  149854. fxaa: FxaaPostProcess;
  149855. /**
  149856. * Image post processing pass used to perform operations such as tone mapping or color grading.
  149857. */
  149858. imageProcessing: ImageProcessingPostProcess;
  149859. /**
  149860. * Chromatic aberration post process which will shift rgb colors in the image
  149861. */
  149862. chromaticAberration: ChromaticAberrationPostProcess;
  149863. private _chromaticAberrationEffect;
  149864. /**
  149865. * Grain post process which add noise to the image
  149866. */
  149867. grain: GrainPostProcess;
  149868. private _grainEffect;
  149869. /**
  149870. * Glow post process which adds a glow to emissive areas of the image
  149871. */
  149872. private _glowLayer;
  149873. /**
  149874. * Animations which can be used to tweak settings over a period of time
  149875. */
  149876. animations: Animation[];
  149877. private _imageProcessingConfigurationObserver;
  149878. private _sharpenEnabled;
  149879. private _bloomEnabled;
  149880. private _depthOfFieldEnabled;
  149881. private _depthOfFieldBlurLevel;
  149882. private _fxaaEnabled;
  149883. private _imageProcessingEnabled;
  149884. private _defaultPipelineTextureType;
  149885. private _bloomScale;
  149886. private _chromaticAberrationEnabled;
  149887. private _grainEnabled;
  149888. private _buildAllowed;
  149889. /**
  149890. * Gets active scene
  149891. */
  149892. get scene(): Scene;
  149893. /**
  149894. * Enable or disable the sharpen process from the pipeline
  149895. */
  149896. set sharpenEnabled(enabled: boolean);
  149897. get sharpenEnabled(): boolean;
  149898. private _resizeObserver;
  149899. private _hardwareScaleLevel;
  149900. private _bloomKernel;
  149901. /**
  149902. * Specifies the size of the bloom blur kernel, relative to the final output size
  149903. */
  149904. get bloomKernel(): number;
  149905. set bloomKernel(value: number);
  149906. /**
  149907. * Specifies the weight of the bloom in the final rendering
  149908. */
  149909. private _bloomWeight;
  149910. /**
  149911. * Specifies the luma threshold for the area that will be blurred by the bloom
  149912. */
  149913. private _bloomThreshold;
  149914. private _hdr;
  149915. /**
  149916. * The strength of the bloom.
  149917. */
  149918. set bloomWeight(value: number);
  149919. get bloomWeight(): number;
  149920. /**
  149921. * The strength of the bloom.
  149922. */
  149923. set bloomThreshold(value: number);
  149924. get bloomThreshold(): number;
  149925. /**
  149926. * The scale of the bloom, lower value will provide better performance.
  149927. */
  149928. set bloomScale(value: number);
  149929. get bloomScale(): number;
  149930. /**
  149931. * Enable or disable the bloom from the pipeline
  149932. */
  149933. set bloomEnabled(enabled: boolean);
  149934. get bloomEnabled(): boolean;
  149935. private _rebuildBloom;
  149936. /**
  149937. * If the depth of field is enabled.
  149938. */
  149939. get depthOfFieldEnabled(): boolean;
  149940. set depthOfFieldEnabled(enabled: boolean);
  149941. /**
  149942. * Blur level of the depth of field effect. (Higher blur will effect performance)
  149943. */
  149944. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  149945. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  149946. /**
  149947. * If the anti aliasing is enabled.
  149948. */
  149949. set fxaaEnabled(enabled: boolean);
  149950. get fxaaEnabled(): boolean;
  149951. private _samples;
  149952. /**
  149953. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  149954. */
  149955. set samples(sampleCount: number);
  149956. get samples(): number;
  149957. /**
  149958. * If image processing is enabled.
  149959. */
  149960. set imageProcessingEnabled(enabled: boolean);
  149961. get imageProcessingEnabled(): boolean;
  149962. /**
  149963. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  149964. */
  149965. set glowLayerEnabled(enabled: boolean);
  149966. get glowLayerEnabled(): boolean;
  149967. /**
  149968. * Gets the glow layer (or null if not defined)
  149969. */
  149970. get glowLayer(): Nullable<GlowLayer>;
  149971. /**
  149972. * Enable or disable the chromaticAberration process from the pipeline
  149973. */
  149974. set chromaticAberrationEnabled(enabled: boolean);
  149975. get chromaticAberrationEnabled(): boolean;
  149976. /**
  149977. * Enable or disable the grain process from the pipeline
  149978. */
  149979. set grainEnabled(enabled: boolean);
  149980. get grainEnabled(): boolean;
  149981. /**
  149982. * @constructor
  149983. * @param name - The rendering pipeline name (default: "")
  149984. * @param hdr - If high dynamic range textures should be used (default: true)
  149985. * @param scene - The scene linked to this pipeline (default: the last created scene)
  149986. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  149987. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  149988. */
  149989. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  149990. /**
  149991. * Get the class name
  149992. * @returns "DefaultRenderingPipeline"
  149993. */
  149994. getClassName(): string;
  149995. /**
  149996. * Force the compilation of the entire pipeline.
  149997. */
  149998. prepare(): void;
  149999. private _hasCleared;
  150000. private _prevPostProcess;
  150001. private _prevPrevPostProcess;
  150002. private _setAutoClearAndTextureSharing;
  150003. private _depthOfFieldSceneObserver;
  150004. private _buildPipeline;
  150005. private _disposePostProcesses;
  150006. /**
  150007. * Adds a camera to the pipeline
  150008. * @param camera the camera to be added
  150009. */
  150010. addCamera(camera: Camera): void;
  150011. /**
  150012. * Removes a camera from the pipeline
  150013. * @param camera the camera to remove
  150014. */
  150015. removeCamera(camera: Camera): void;
  150016. /**
  150017. * Dispose of the pipeline and stop all post processes
  150018. */
  150019. dispose(): void;
  150020. /**
  150021. * Serialize the rendering pipeline (Used when exporting)
  150022. * @returns the serialized object
  150023. */
  150024. serialize(): any;
  150025. /**
  150026. * Parse the serialized pipeline
  150027. * @param source Source pipeline.
  150028. * @param scene The scene to load the pipeline to.
  150029. * @param rootUrl The URL of the serialized pipeline.
  150030. * @returns An instantiated pipeline from the serialized object.
  150031. */
  150032. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  150033. }
  150034. }
  150035. declare module BABYLON {
  150036. /** @hidden */
  150037. export var lensHighlightsPixelShader: {
  150038. name: string;
  150039. shader: string;
  150040. };
  150041. }
  150042. declare module BABYLON {
  150043. /** @hidden */
  150044. export var depthOfFieldPixelShader: {
  150045. name: string;
  150046. shader: string;
  150047. };
  150048. }
  150049. declare module BABYLON {
  150050. /**
  150051. * BABYLON.JS Chromatic Aberration GLSL Shader
  150052. * Author: Olivier Guyot
  150053. * Separates very slightly R, G and B colors on the edges of the screen
  150054. * Inspired by Francois Tarlier & Martins Upitis
  150055. */
  150056. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  150057. /**
  150058. * @ignore
  150059. * The chromatic aberration PostProcess id in the pipeline
  150060. */
  150061. LensChromaticAberrationEffect: string;
  150062. /**
  150063. * @ignore
  150064. * The highlights enhancing PostProcess id in the pipeline
  150065. */
  150066. HighlightsEnhancingEffect: string;
  150067. /**
  150068. * @ignore
  150069. * The depth-of-field PostProcess id in the pipeline
  150070. */
  150071. LensDepthOfFieldEffect: string;
  150072. private _scene;
  150073. private _depthTexture;
  150074. private _grainTexture;
  150075. private _chromaticAberrationPostProcess;
  150076. private _highlightsPostProcess;
  150077. private _depthOfFieldPostProcess;
  150078. private _edgeBlur;
  150079. private _grainAmount;
  150080. private _chromaticAberration;
  150081. private _distortion;
  150082. private _highlightsGain;
  150083. private _highlightsThreshold;
  150084. private _dofDistance;
  150085. private _dofAperture;
  150086. private _dofDarken;
  150087. private _dofPentagon;
  150088. private _blurNoise;
  150089. /**
  150090. * @constructor
  150091. *
  150092. * Effect parameters are as follow:
  150093. * {
  150094. * chromatic_aberration: number; // from 0 to x (1 for realism)
  150095. * edge_blur: number; // from 0 to x (1 for realism)
  150096. * distortion: number; // from 0 to x (1 for realism)
  150097. * grain_amount: number; // from 0 to 1
  150098. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  150099. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  150100. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  150101. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  150102. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  150103. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  150104. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  150105. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  150106. * }
  150107. * Note: if an effect parameter is unset, effect is disabled
  150108. *
  150109. * @param name The rendering pipeline name
  150110. * @param parameters - An object containing all parameters (see above)
  150111. * @param scene The scene linked to this pipeline
  150112. * @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)
  150113. * @param cameras The array of cameras that the rendering pipeline will be attached to
  150114. */
  150115. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  150116. /**
  150117. * Get the class name
  150118. * @returns "LensRenderingPipeline"
  150119. */
  150120. getClassName(): string;
  150121. /**
  150122. * Gets associated scene
  150123. */
  150124. get scene(): Scene;
  150125. /**
  150126. * Gets or sets the edge blur
  150127. */
  150128. get edgeBlur(): number;
  150129. set edgeBlur(value: number);
  150130. /**
  150131. * Gets or sets the grain amount
  150132. */
  150133. get grainAmount(): number;
  150134. set grainAmount(value: number);
  150135. /**
  150136. * Gets or sets the chromatic aberration amount
  150137. */
  150138. get chromaticAberration(): number;
  150139. set chromaticAberration(value: number);
  150140. /**
  150141. * Gets or sets the depth of field aperture
  150142. */
  150143. get dofAperture(): number;
  150144. set dofAperture(value: number);
  150145. /**
  150146. * Gets or sets the edge distortion
  150147. */
  150148. get edgeDistortion(): number;
  150149. set edgeDistortion(value: number);
  150150. /**
  150151. * Gets or sets the depth of field distortion
  150152. */
  150153. get dofDistortion(): number;
  150154. set dofDistortion(value: number);
  150155. /**
  150156. * Gets or sets the darken out of focus amount
  150157. */
  150158. get darkenOutOfFocus(): number;
  150159. set darkenOutOfFocus(value: number);
  150160. /**
  150161. * Gets or sets a boolean indicating if blur noise is enabled
  150162. */
  150163. get blurNoise(): boolean;
  150164. set blurNoise(value: boolean);
  150165. /**
  150166. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  150167. */
  150168. get pentagonBokeh(): boolean;
  150169. set pentagonBokeh(value: boolean);
  150170. /**
  150171. * Gets or sets the highlight grain amount
  150172. */
  150173. get highlightsGain(): number;
  150174. set highlightsGain(value: number);
  150175. /**
  150176. * Gets or sets the highlight threshold
  150177. */
  150178. get highlightsThreshold(): number;
  150179. set highlightsThreshold(value: number);
  150180. /**
  150181. * Sets the amount of blur at the edges
  150182. * @param amount blur amount
  150183. */
  150184. setEdgeBlur(amount: number): void;
  150185. /**
  150186. * Sets edge blur to 0
  150187. */
  150188. disableEdgeBlur(): void;
  150189. /**
  150190. * Sets the amout of grain
  150191. * @param amount Amount of grain
  150192. */
  150193. setGrainAmount(amount: number): void;
  150194. /**
  150195. * Set grain amount to 0
  150196. */
  150197. disableGrain(): void;
  150198. /**
  150199. * Sets the chromatic aberration amount
  150200. * @param amount amount of chromatic aberration
  150201. */
  150202. setChromaticAberration(amount: number): void;
  150203. /**
  150204. * Sets chromatic aberration amount to 0
  150205. */
  150206. disableChromaticAberration(): void;
  150207. /**
  150208. * Sets the EdgeDistortion amount
  150209. * @param amount amount of EdgeDistortion
  150210. */
  150211. setEdgeDistortion(amount: number): void;
  150212. /**
  150213. * Sets edge distortion to 0
  150214. */
  150215. disableEdgeDistortion(): void;
  150216. /**
  150217. * Sets the FocusDistance amount
  150218. * @param amount amount of FocusDistance
  150219. */
  150220. setFocusDistance(amount: number): void;
  150221. /**
  150222. * Disables depth of field
  150223. */
  150224. disableDepthOfField(): void;
  150225. /**
  150226. * Sets the Aperture amount
  150227. * @param amount amount of Aperture
  150228. */
  150229. setAperture(amount: number): void;
  150230. /**
  150231. * Sets the DarkenOutOfFocus amount
  150232. * @param amount amount of DarkenOutOfFocus
  150233. */
  150234. setDarkenOutOfFocus(amount: number): void;
  150235. private _pentagonBokehIsEnabled;
  150236. /**
  150237. * Creates a pentagon bokeh effect
  150238. */
  150239. enablePentagonBokeh(): void;
  150240. /**
  150241. * Disables the pentagon bokeh effect
  150242. */
  150243. disablePentagonBokeh(): void;
  150244. /**
  150245. * Enables noise blur
  150246. */
  150247. enableNoiseBlur(): void;
  150248. /**
  150249. * Disables noise blur
  150250. */
  150251. disableNoiseBlur(): void;
  150252. /**
  150253. * Sets the HighlightsGain amount
  150254. * @param amount amount of HighlightsGain
  150255. */
  150256. setHighlightsGain(amount: number): void;
  150257. /**
  150258. * Sets the HighlightsThreshold amount
  150259. * @param amount amount of HighlightsThreshold
  150260. */
  150261. setHighlightsThreshold(amount: number): void;
  150262. /**
  150263. * Disables highlights
  150264. */
  150265. disableHighlights(): void;
  150266. /**
  150267. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  150268. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  150269. */
  150270. dispose(disableDepthRender?: boolean): void;
  150271. private _createChromaticAberrationPostProcess;
  150272. private _createHighlightsPostProcess;
  150273. private _createDepthOfFieldPostProcess;
  150274. private _createGrainTexture;
  150275. }
  150276. }
  150277. declare module BABYLON {
  150278. /** @hidden */
  150279. export var ssao2PixelShader: {
  150280. name: string;
  150281. shader: string;
  150282. };
  150283. }
  150284. declare module BABYLON {
  150285. /** @hidden */
  150286. export var ssaoCombinePixelShader: {
  150287. name: string;
  150288. shader: string;
  150289. };
  150290. }
  150291. declare module BABYLON {
  150292. /**
  150293. * Render pipeline to produce ssao effect
  150294. */
  150295. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  150296. /**
  150297. * @ignore
  150298. * The PassPostProcess id in the pipeline that contains the original scene color
  150299. */
  150300. SSAOOriginalSceneColorEffect: string;
  150301. /**
  150302. * @ignore
  150303. * The SSAO PostProcess id in the pipeline
  150304. */
  150305. SSAORenderEffect: string;
  150306. /**
  150307. * @ignore
  150308. * The horizontal blur PostProcess id in the pipeline
  150309. */
  150310. SSAOBlurHRenderEffect: string;
  150311. /**
  150312. * @ignore
  150313. * The vertical blur PostProcess id in the pipeline
  150314. */
  150315. SSAOBlurVRenderEffect: string;
  150316. /**
  150317. * @ignore
  150318. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  150319. */
  150320. SSAOCombineRenderEffect: string;
  150321. /**
  150322. * The output strength of the SSAO post-process. Default value is 1.0.
  150323. */
  150324. totalStrength: number;
  150325. /**
  150326. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  150327. */
  150328. maxZ: number;
  150329. /**
  150330. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  150331. */
  150332. minZAspect: number;
  150333. private _samples;
  150334. /**
  150335. * Number of samples used for the SSAO calculations. Default value is 8
  150336. */
  150337. set samples(n: number);
  150338. get samples(): number;
  150339. private _textureSamples;
  150340. /**
  150341. * Number of samples to use for antialiasing
  150342. */
  150343. set textureSamples(n: number);
  150344. get textureSamples(): number;
  150345. /**
  150346. * Force rendering the geometry through geometry buffer
  150347. */
  150348. private _forceGeometryBuffer;
  150349. /**
  150350. * Ratio object used for SSAO ratio and blur ratio
  150351. */
  150352. private _ratio;
  150353. /**
  150354. * Dynamically generated sphere sampler.
  150355. */
  150356. private _sampleSphere;
  150357. /**
  150358. * Blur filter offsets
  150359. */
  150360. private _samplerOffsets;
  150361. private _expensiveBlur;
  150362. /**
  150363. * If bilateral blur should be used
  150364. */
  150365. set expensiveBlur(b: boolean);
  150366. get expensiveBlur(): boolean;
  150367. /**
  150368. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  150369. */
  150370. radius: number;
  150371. /**
  150372. * The base color of the SSAO post-process
  150373. * The final result is "base + ssao" between [0, 1]
  150374. */
  150375. base: number;
  150376. /**
  150377. * Support test.
  150378. */
  150379. static get IsSupported(): boolean;
  150380. private _scene;
  150381. private _randomTexture;
  150382. private _originalColorPostProcess;
  150383. private _ssaoPostProcess;
  150384. private _blurHPostProcess;
  150385. private _blurVPostProcess;
  150386. private _ssaoCombinePostProcess;
  150387. private _prePassRenderer;
  150388. /**
  150389. * Gets active scene
  150390. */
  150391. get scene(): Scene;
  150392. /**
  150393. * @constructor
  150394. * @param name The rendering pipeline name
  150395. * @param scene The scene linked to this pipeline
  150396. * @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 }
  150397. * @param cameras The array of cameras that the rendering pipeline will be attached to
  150398. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  150399. */
  150400. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  150401. /**
  150402. * Get the class name
  150403. * @returns "SSAO2RenderingPipeline"
  150404. */
  150405. getClassName(): string;
  150406. /**
  150407. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  150408. */
  150409. dispose(disableGeometryBufferRenderer?: boolean): void;
  150410. private _createBlurPostProcess;
  150411. /** @hidden */
  150412. _rebuild(): void;
  150413. private _bits;
  150414. private _radicalInverse_VdC;
  150415. private _hammersley;
  150416. private _hemisphereSample_uniform;
  150417. private _generateHemisphere;
  150418. private _getDefinesForSSAO;
  150419. private _createSSAOPostProcess;
  150420. private _createSSAOCombinePostProcess;
  150421. private _createRandomTexture;
  150422. /**
  150423. * Serialize the rendering pipeline (Used when exporting)
  150424. * @returns the serialized object
  150425. */
  150426. serialize(): any;
  150427. /**
  150428. * Parse the serialized pipeline
  150429. * @param source Source pipeline.
  150430. * @param scene The scene to load the pipeline to.
  150431. * @param rootUrl The URL of the serialized pipeline.
  150432. * @returns An instantiated pipeline from the serialized object.
  150433. */
  150434. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  150435. /**
  150436. * Sets the required values to the prepass renderer.
  150437. * @param prePassRenderer defines the prepass renderer to setup
  150438. * @returns true if the pre pass is needed.
  150439. */
  150440. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  150441. }
  150442. }
  150443. declare module BABYLON {
  150444. /** @hidden */
  150445. export var ssaoPixelShader: {
  150446. name: string;
  150447. shader: string;
  150448. };
  150449. }
  150450. declare module BABYLON {
  150451. /**
  150452. * Render pipeline to produce ssao effect
  150453. */
  150454. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  150455. /**
  150456. * @ignore
  150457. * The PassPostProcess id in the pipeline that contains the original scene color
  150458. */
  150459. SSAOOriginalSceneColorEffect: string;
  150460. /**
  150461. * @ignore
  150462. * The SSAO PostProcess id in the pipeline
  150463. */
  150464. SSAORenderEffect: string;
  150465. /**
  150466. * @ignore
  150467. * The horizontal blur PostProcess id in the pipeline
  150468. */
  150469. SSAOBlurHRenderEffect: string;
  150470. /**
  150471. * @ignore
  150472. * The vertical blur PostProcess id in the pipeline
  150473. */
  150474. SSAOBlurVRenderEffect: string;
  150475. /**
  150476. * @ignore
  150477. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  150478. */
  150479. SSAOCombineRenderEffect: string;
  150480. /**
  150481. * The output strength of the SSAO post-process. Default value is 1.0.
  150482. */
  150483. totalStrength: number;
  150484. /**
  150485. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  150486. */
  150487. radius: number;
  150488. /**
  150489. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  150490. * Must not be equal to fallOff and superior to fallOff.
  150491. * Default value is 0.0075
  150492. */
  150493. area: number;
  150494. /**
  150495. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  150496. * Must not be equal to area and inferior to area.
  150497. * Default value is 0.000001
  150498. */
  150499. fallOff: number;
  150500. /**
  150501. * The base color of the SSAO post-process
  150502. * The final result is "base + ssao" between [0, 1]
  150503. */
  150504. base: number;
  150505. private _scene;
  150506. private _depthTexture;
  150507. private _randomTexture;
  150508. private _originalColorPostProcess;
  150509. private _ssaoPostProcess;
  150510. private _blurHPostProcess;
  150511. private _blurVPostProcess;
  150512. private _ssaoCombinePostProcess;
  150513. private _firstUpdate;
  150514. /**
  150515. * Gets active scene
  150516. */
  150517. get scene(): Scene;
  150518. /**
  150519. * @constructor
  150520. * @param name - The rendering pipeline name
  150521. * @param scene - The scene linked to this pipeline
  150522. * @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 }
  150523. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  150524. */
  150525. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  150526. /**
  150527. * Get the class name
  150528. * @returns "SSAORenderingPipeline"
  150529. */
  150530. getClassName(): string;
  150531. /**
  150532. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  150533. */
  150534. dispose(disableDepthRender?: boolean): void;
  150535. private _createBlurPostProcess;
  150536. /** @hidden */
  150537. _rebuild(): void;
  150538. private _createSSAOPostProcess;
  150539. private _createSSAOCombinePostProcess;
  150540. private _createRandomTexture;
  150541. }
  150542. }
  150543. declare module BABYLON {
  150544. /** @hidden */
  150545. export var screenSpaceReflectionPixelShader: {
  150546. name: string;
  150547. shader: string;
  150548. };
  150549. }
  150550. declare module BABYLON {
  150551. /**
  150552. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  150553. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  150554. */
  150555. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  150556. /**
  150557. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  150558. */
  150559. threshold: number;
  150560. /**
  150561. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  150562. */
  150563. strength: number;
  150564. /**
  150565. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  150566. */
  150567. reflectionSpecularFalloffExponent: number;
  150568. /**
  150569. * 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]
  150570. */
  150571. step: number;
  150572. /**
  150573. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  150574. */
  150575. roughnessFactor: number;
  150576. private _geometryBufferRenderer;
  150577. private _enableSmoothReflections;
  150578. private _reflectionSamples;
  150579. private _smoothSteps;
  150580. /**
  150581. * Gets a string identifying the name of the class
  150582. * @returns "ScreenSpaceReflectionPostProcess" string
  150583. */
  150584. getClassName(): string;
  150585. /**
  150586. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  150587. * @param name The name of the effect.
  150588. * @param scene The scene containing the objects to calculate reflections.
  150589. * @param options The required width/height ratio to downsize to before computing the render pass.
  150590. * @param camera The camera to apply the render pass to.
  150591. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150592. * @param engine The engine which the post process will be applied. (default: current engine)
  150593. * @param reusable If the post process can be reused on the same frame. (default: false)
  150594. * @param textureType Type of textures used when performing the post process. (default: 0)
  150595. * @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)
  150596. */
  150597. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  150598. /**
  150599. * Gets wether or not smoothing reflections is enabled.
  150600. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  150601. */
  150602. get enableSmoothReflections(): boolean;
  150603. /**
  150604. * Sets wether or not smoothing reflections is enabled.
  150605. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  150606. */
  150607. set enableSmoothReflections(enabled: boolean);
  150608. /**
  150609. * Gets the number of samples taken while computing reflections. More samples count is high,
  150610. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  150611. */
  150612. get reflectionSamples(): number;
  150613. /**
  150614. * Sets the number of samples taken while computing reflections. More samples count is high,
  150615. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  150616. */
  150617. set reflectionSamples(samples: number);
  150618. /**
  150619. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  150620. * more the post-process will require GPU power and can generate a drop in FPS.
  150621. * Default value (5.0) work pretty well in all cases but can be adjusted.
  150622. */
  150623. get smoothSteps(): number;
  150624. set smoothSteps(steps: number);
  150625. private _updateEffectDefines;
  150626. /** @hidden */
  150627. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceReflectionPostProcess;
  150628. }
  150629. }
  150630. declare module BABYLON {
  150631. /** @hidden */
  150632. export var standardPixelShader: {
  150633. name: string;
  150634. shader: string;
  150635. };
  150636. }
  150637. declare module BABYLON {
  150638. /**
  150639. * Standard rendering pipeline
  150640. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  150641. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  150642. */
  150643. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  150644. /**
  150645. * Public members
  150646. */
  150647. /**
  150648. * Post-process which contains the original scene color before the pipeline applies all the effects
  150649. */
  150650. originalPostProcess: Nullable<PostProcess>;
  150651. /**
  150652. * Post-process used to down scale an image x4
  150653. */
  150654. downSampleX4PostProcess: Nullable<PostProcess>;
  150655. /**
  150656. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  150657. */
  150658. brightPassPostProcess: Nullable<PostProcess>;
  150659. /**
  150660. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  150661. */
  150662. blurHPostProcesses: PostProcess[];
  150663. /**
  150664. * Post-process array storing all the vertical blur post-processes used by the pipeline
  150665. */
  150666. blurVPostProcesses: PostProcess[];
  150667. /**
  150668. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  150669. */
  150670. textureAdderPostProcess: Nullable<PostProcess>;
  150671. /**
  150672. * Post-process used to create volumetric lighting effect
  150673. */
  150674. volumetricLightPostProcess: Nullable<PostProcess>;
  150675. /**
  150676. * Post-process used to smooth the previous volumetric light post-process on the X axis
  150677. */
  150678. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  150679. /**
  150680. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  150681. */
  150682. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  150683. /**
  150684. * Post-process used to merge the volumetric light effect and the real scene color
  150685. */
  150686. volumetricLightMergePostProces: Nullable<PostProcess>;
  150687. /**
  150688. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  150689. */
  150690. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  150691. /**
  150692. * Base post-process used to calculate the average luminance of the final image for HDR
  150693. */
  150694. luminancePostProcess: Nullable<PostProcess>;
  150695. /**
  150696. * Post-processes used to create down sample post-processes in order to get
  150697. * the average luminance of the final image for HDR
  150698. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  150699. */
  150700. luminanceDownSamplePostProcesses: PostProcess[];
  150701. /**
  150702. * Post-process used to create a HDR effect (light adaptation)
  150703. */
  150704. hdrPostProcess: Nullable<PostProcess>;
  150705. /**
  150706. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  150707. */
  150708. textureAdderFinalPostProcess: Nullable<PostProcess>;
  150709. /**
  150710. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  150711. */
  150712. lensFlareFinalPostProcess: Nullable<PostProcess>;
  150713. /**
  150714. * Post-process used to merge the final HDR post-process and the real scene color
  150715. */
  150716. hdrFinalPostProcess: Nullable<PostProcess>;
  150717. /**
  150718. * Post-process used to create a lens flare effect
  150719. */
  150720. lensFlarePostProcess: Nullable<PostProcess>;
  150721. /**
  150722. * Post-process that merges the result of the lens flare post-process and the real scene color
  150723. */
  150724. lensFlareComposePostProcess: Nullable<PostProcess>;
  150725. /**
  150726. * Post-process used to create a motion blur effect
  150727. */
  150728. motionBlurPostProcess: Nullable<PostProcess>;
  150729. /**
  150730. * Post-process used to create a depth of field effect
  150731. */
  150732. depthOfFieldPostProcess: Nullable<PostProcess>;
  150733. /**
  150734. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  150735. */
  150736. fxaaPostProcess: Nullable<FxaaPostProcess>;
  150737. /**
  150738. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  150739. */
  150740. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  150741. /**
  150742. * Represents the brightness threshold in order to configure the illuminated surfaces
  150743. */
  150744. brightThreshold: number;
  150745. /**
  150746. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  150747. */
  150748. blurWidth: number;
  150749. /**
  150750. * Sets if the blur for highlighted surfaces must be only horizontal
  150751. */
  150752. horizontalBlur: boolean;
  150753. /**
  150754. * Gets the overall exposure used by the pipeline
  150755. */
  150756. get exposure(): number;
  150757. /**
  150758. * Sets the overall exposure used by the pipeline
  150759. */
  150760. set exposure(value: number);
  150761. /**
  150762. * Texture used typically to simulate "dirty" on camera lens
  150763. */
  150764. lensTexture: Nullable<Texture>;
  150765. /**
  150766. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  150767. */
  150768. volumetricLightCoefficient: number;
  150769. /**
  150770. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  150771. */
  150772. volumetricLightPower: number;
  150773. /**
  150774. * Used the set the blur intensity to smooth the volumetric lights
  150775. */
  150776. volumetricLightBlurScale: number;
  150777. /**
  150778. * Light (spot or directional) used to generate the volumetric lights rays
  150779. * The source light must have a shadow generate so the pipeline can get its
  150780. * depth map
  150781. */
  150782. sourceLight: Nullable<SpotLight | DirectionalLight>;
  150783. /**
  150784. * For eye adaptation, represents the minimum luminance the eye can see
  150785. */
  150786. hdrMinimumLuminance: number;
  150787. /**
  150788. * For eye adaptation, represents the decrease luminance speed
  150789. */
  150790. hdrDecreaseRate: number;
  150791. /**
  150792. * For eye adaptation, represents the increase luminance speed
  150793. */
  150794. hdrIncreaseRate: number;
  150795. /**
  150796. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  150797. */
  150798. get hdrAutoExposure(): boolean;
  150799. /**
  150800. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  150801. */
  150802. set hdrAutoExposure(value: boolean);
  150803. /**
  150804. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  150805. */
  150806. lensColorTexture: Nullable<Texture>;
  150807. /**
  150808. * The overall strengh for the lens flare effect
  150809. */
  150810. lensFlareStrength: number;
  150811. /**
  150812. * Dispersion coefficient for lens flare ghosts
  150813. */
  150814. lensFlareGhostDispersal: number;
  150815. /**
  150816. * Main lens flare halo width
  150817. */
  150818. lensFlareHaloWidth: number;
  150819. /**
  150820. * Based on the lens distortion effect, defines how much the lens flare result
  150821. * is distorted
  150822. */
  150823. lensFlareDistortionStrength: number;
  150824. /**
  150825. * Configures the blur intensity used for for lens flare (halo)
  150826. */
  150827. lensFlareBlurWidth: number;
  150828. /**
  150829. * Lens star texture must be used to simulate rays on the flares and is available
  150830. * in the documentation
  150831. */
  150832. lensStarTexture: Nullable<Texture>;
  150833. /**
  150834. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  150835. * flare effect by taking account of the dirt texture
  150836. */
  150837. lensFlareDirtTexture: Nullable<Texture>;
  150838. /**
  150839. * Represents the focal length for the depth of field effect
  150840. */
  150841. depthOfFieldDistance: number;
  150842. /**
  150843. * Represents the blur intensity for the blurred part of the depth of field effect
  150844. */
  150845. depthOfFieldBlurWidth: number;
  150846. /**
  150847. * Gets how much the image is blurred by the movement while using the motion blur post-process
  150848. */
  150849. get motionStrength(): number;
  150850. /**
  150851. * Sets how much the image is blurred by the movement while using the motion blur post-process
  150852. */
  150853. set motionStrength(strength: number);
  150854. /**
  150855. * Gets wether or not the motion blur post-process is object based or screen based.
  150856. */
  150857. get objectBasedMotionBlur(): boolean;
  150858. /**
  150859. * Sets wether or not the motion blur post-process should be object based or screen based
  150860. */
  150861. set objectBasedMotionBlur(value: boolean);
  150862. /**
  150863. * List of animations for the pipeline (IAnimatable implementation)
  150864. */
  150865. animations: Animation[];
  150866. /**
  150867. * Private members
  150868. */
  150869. private _scene;
  150870. private _currentDepthOfFieldSource;
  150871. private _basePostProcess;
  150872. private _fixedExposure;
  150873. private _currentExposure;
  150874. private _hdrAutoExposure;
  150875. private _hdrCurrentLuminance;
  150876. private _motionStrength;
  150877. private _isObjectBasedMotionBlur;
  150878. private _floatTextureType;
  150879. private _camerasToBeAttached;
  150880. private _ratio;
  150881. private _bloomEnabled;
  150882. private _depthOfFieldEnabled;
  150883. private _vlsEnabled;
  150884. private _lensFlareEnabled;
  150885. private _hdrEnabled;
  150886. private _motionBlurEnabled;
  150887. private _fxaaEnabled;
  150888. private _screenSpaceReflectionsEnabled;
  150889. private _motionBlurSamples;
  150890. private _volumetricLightStepsCount;
  150891. private _samples;
  150892. /**
  150893. * @ignore
  150894. * Specifies if the bloom pipeline is enabled
  150895. */
  150896. get BloomEnabled(): boolean;
  150897. set BloomEnabled(enabled: boolean);
  150898. /**
  150899. * @ignore
  150900. * Specifies if the depth of field pipeline is enabed
  150901. */
  150902. get DepthOfFieldEnabled(): boolean;
  150903. set DepthOfFieldEnabled(enabled: boolean);
  150904. /**
  150905. * @ignore
  150906. * Specifies if the lens flare pipeline is enabed
  150907. */
  150908. get LensFlareEnabled(): boolean;
  150909. set LensFlareEnabled(enabled: boolean);
  150910. /**
  150911. * @ignore
  150912. * Specifies if the HDR pipeline is enabled
  150913. */
  150914. get HDREnabled(): boolean;
  150915. set HDREnabled(enabled: boolean);
  150916. /**
  150917. * @ignore
  150918. * Specifies if the volumetric lights scattering effect is enabled
  150919. */
  150920. get VLSEnabled(): boolean;
  150921. set VLSEnabled(enabled: boolean);
  150922. /**
  150923. * @ignore
  150924. * Specifies if the motion blur effect is enabled
  150925. */
  150926. get MotionBlurEnabled(): boolean;
  150927. set MotionBlurEnabled(enabled: boolean);
  150928. /**
  150929. * Specifies if anti-aliasing is enabled
  150930. */
  150931. get fxaaEnabled(): boolean;
  150932. set fxaaEnabled(enabled: boolean);
  150933. /**
  150934. * Specifies if screen space reflections are enabled.
  150935. */
  150936. get screenSpaceReflectionsEnabled(): boolean;
  150937. set screenSpaceReflectionsEnabled(enabled: boolean);
  150938. /**
  150939. * Specifies the number of steps used to calculate the volumetric lights
  150940. * Typically in interval [50, 200]
  150941. */
  150942. get volumetricLightStepsCount(): number;
  150943. set volumetricLightStepsCount(count: number);
  150944. /**
  150945. * Specifies the number of samples used for the motion blur effect
  150946. * Typically in interval [16, 64]
  150947. */
  150948. get motionBlurSamples(): number;
  150949. set motionBlurSamples(samples: number);
  150950. /**
  150951. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  150952. */
  150953. get samples(): number;
  150954. set samples(sampleCount: number);
  150955. /**
  150956. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  150957. * @constructor
  150958. * @param name The rendering pipeline name
  150959. * @param scene The scene linked to this pipeline
  150960. * @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)
  150961. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  150962. * @param cameras The array of cameras that the rendering pipeline will be attached to
  150963. */
  150964. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  150965. private _buildPipeline;
  150966. private _createDownSampleX4PostProcess;
  150967. private _createBrightPassPostProcess;
  150968. private _createBlurPostProcesses;
  150969. private _createTextureAdderPostProcess;
  150970. private _createVolumetricLightPostProcess;
  150971. private _createLuminancePostProcesses;
  150972. private _createHdrPostProcess;
  150973. private _createLensFlarePostProcess;
  150974. private _createDepthOfFieldPostProcess;
  150975. private _createMotionBlurPostProcess;
  150976. private _getDepthTexture;
  150977. private _disposePostProcesses;
  150978. /**
  150979. * Dispose of the pipeline and stop all post processes
  150980. */
  150981. dispose(): void;
  150982. /**
  150983. * Serialize the rendering pipeline (Used when exporting)
  150984. * @returns the serialized object
  150985. */
  150986. serialize(): any;
  150987. /**
  150988. * Parse the serialized pipeline
  150989. * @param source Source pipeline.
  150990. * @param scene The scene to load the pipeline to.
  150991. * @param rootUrl The URL of the serialized pipeline.
  150992. * @returns An instantiated pipeline from the serialized object.
  150993. */
  150994. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  150995. /**
  150996. * Luminance steps
  150997. */
  150998. static LuminanceSteps: number;
  150999. }
  151000. }
  151001. declare module BABYLON {
  151002. /** @hidden */
  151003. export var stereoscopicInterlacePixelShader: {
  151004. name: string;
  151005. shader: string;
  151006. };
  151007. }
  151008. declare module BABYLON {
  151009. /**
  151010. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  151011. */
  151012. export class StereoscopicInterlacePostProcessI extends PostProcess {
  151013. private _stepSize;
  151014. private _passedProcess;
  151015. /**
  151016. * Gets a string identifying the name of the class
  151017. * @returns "StereoscopicInterlacePostProcessI" string
  151018. */
  151019. getClassName(): string;
  151020. /**
  151021. * Initializes a StereoscopicInterlacePostProcessI
  151022. * @param name The name of the effect.
  151023. * @param rigCameras The rig cameras to be appled to the post process
  151024. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  151025. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  151026. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151027. * @param engine The engine which the post process will be applied. (default: current engine)
  151028. * @param reusable If the post process can be reused on the same frame. (default: false)
  151029. */
  151030. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  151031. }
  151032. /**
  151033. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  151034. */
  151035. export class StereoscopicInterlacePostProcess extends PostProcess {
  151036. private _stepSize;
  151037. private _passedProcess;
  151038. /**
  151039. * Gets a string identifying the name of the class
  151040. * @returns "StereoscopicInterlacePostProcess" string
  151041. */
  151042. getClassName(): string;
  151043. /**
  151044. * Initializes a StereoscopicInterlacePostProcess
  151045. * @param name The name of the effect.
  151046. * @param rigCameras The rig cameras to be appled to the post process
  151047. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  151048. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151049. * @param engine The engine which the post process will be applied. (default: current engine)
  151050. * @param reusable If the post process can be reused on the same frame. (default: false)
  151051. */
  151052. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  151053. }
  151054. }
  151055. declare module BABYLON {
  151056. /** @hidden */
  151057. export var tonemapPixelShader: {
  151058. name: string;
  151059. shader: string;
  151060. };
  151061. }
  151062. declare module BABYLON {
  151063. /** Defines operator used for tonemapping */
  151064. export enum TonemappingOperator {
  151065. /** Hable */
  151066. Hable = 0,
  151067. /** Reinhard */
  151068. Reinhard = 1,
  151069. /** HejiDawson */
  151070. HejiDawson = 2,
  151071. /** Photographic */
  151072. Photographic = 3
  151073. }
  151074. /**
  151075. * Defines a post process to apply tone mapping
  151076. */
  151077. export class TonemapPostProcess extends PostProcess {
  151078. private _operator;
  151079. /** Defines the required exposure adjustement */
  151080. exposureAdjustment: number;
  151081. /**
  151082. * Gets a string identifying the name of the class
  151083. * @returns "TonemapPostProcess" string
  151084. */
  151085. getClassName(): string;
  151086. /**
  151087. * Creates a new TonemapPostProcess
  151088. * @param name defines the name of the postprocess
  151089. * @param _operator defines the operator to use
  151090. * @param exposureAdjustment defines the required exposure adjustement
  151091. * @param camera defines the camera to use (can be null)
  151092. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  151093. * @param engine defines the hosting engine (can be ignore if camera is set)
  151094. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  151095. */
  151096. constructor(name: string, _operator: TonemappingOperator,
  151097. /** Defines the required exposure adjustement */
  151098. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  151099. }
  151100. }
  151101. declare module BABYLON {
  151102. /** @hidden */
  151103. export var volumetricLightScatteringPixelShader: {
  151104. name: string;
  151105. shader: string;
  151106. };
  151107. }
  151108. declare module BABYLON {
  151109. /** @hidden */
  151110. export var volumetricLightScatteringPassVertexShader: {
  151111. name: string;
  151112. shader: string;
  151113. };
  151114. }
  151115. declare module BABYLON {
  151116. /** @hidden */
  151117. export var volumetricLightScatteringPassPixelShader: {
  151118. name: string;
  151119. shader: string;
  151120. };
  151121. }
  151122. declare module BABYLON {
  151123. /**
  151124. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  151125. */
  151126. export class VolumetricLightScatteringPostProcess extends PostProcess {
  151127. private _volumetricLightScatteringPass;
  151128. private _volumetricLightScatteringRTT;
  151129. private _viewPort;
  151130. private _screenCoordinates;
  151131. private _cachedDefines;
  151132. /**
  151133. * If not undefined, the mesh position is computed from the attached node position
  151134. */
  151135. attachedNode: {
  151136. position: Vector3;
  151137. };
  151138. /**
  151139. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  151140. */
  151141. customMeshPosition: Vector3;
  151142. /**
  151143. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  151144. */
  151145. useCustomMeshPosition: boolean;
  151146. /**
  151147. * If the post-process should inverse the light scattering direction
  151148. */
  151149. invert: boolean;
  151150. /**
  151151. * The internal mesh used by the post-process
  151152. */
  151153. mesh: Mesh;
  151154. /**
  151155. * @hidden
  151156. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  151157. */
  151158. get useDiffuseColor(): boolean;
  151159. set useDiffuseColor(useDiffuseColor: boolean);
  151160. /**
  151161. * Array containing the excluded meshes not rendered in the internal pass
  151162. */
  151163. excludedMeshes: AbstractMesh[];
  151164. /**
  151165. * Controls the overall intensity of the post-process
  151166. */
  151167. exposure: number;
  151168. /**
  151169. * Dissipates each sample's contribution in range [0, 1]
  151170. */
  151171. decay: number;
  151172. /**
  151173. * Controls the overall intensity of each sample
  151174. */
  151175. weight: number;
  151176. /**
  151177. * Controls the density of each sample
  151178. */
  151179. density: number;
  151180. /**
  151181. * @constructor
  151182. * @param name The post-process name
  151183. * @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)
  151184. * @param camera The camera that the post-process will be attached to
  151185. * @param mesh The mesh used to create the light scattering
  151186. * @param samples The post-process quality, default 100
  151187. * @param samplingModeThe post-process filtering mode
  151188. * @param engine The babylon engine
  151189. * @param reusable If the post-process is reusable
  151190. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  151191. */
  151192. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  151193. /**
  151194. * Returns the string "VolumetricLightScatteringPostProcess"
  151195. * @returns "VolumetricLightScatteringPostProcess"
  151196. */
  151197. getClassName(): string;
  151198. private _isReady;
  151199. /**
  151200. * Sets the new light position for light scattering effect
  151201. * @param position The new custom light position
  151202. */
  151203. setCustomMeshPosition(position: Vector3): void;
  151204. /**
  151205. * Returns the light position for light scattering effect
  151206. * @return Vector3 The custom light position
  151207. */
  151208. getCustomMeshPosition(): Vector3;
  151209. /**
  151210. * Disposes the internal assets and detaches the post-process from the camera
  151211. */
  151212. dispose(camera: Camera): void;
  151213. /**
  151214. * Returns the render target texture used by the post-process
  151215. * @return the render target texture used by the post-process
  151216. */
  151217. getPass(): RenderTargetTexture;
  151218. private _meshExcluded;
  151219. private _createPass;
  151220. private _updateMeshScreenCoordinates;
  151221. /**
  151222. * Creates a default mesh for the Volumeric Light Scattering post-process
  151223. * @param name The mesh name
  151224. * @param scene The scene where to create the mesh
  151225. * @return the default mesh
  151226. */
  151227. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  151228. }
  151229. }
  151230. declare module BABYLON {
  151231. /** @hidden */
  151232. export var screenSpaceCurvaturePixelShader: {
  151233. name: string;
  151234. shader: string;
  151235. };
  151236. }
  151237. declare module BABYLON {
  151238. /**
  151239. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  151240. */
  151241. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  151242. /**
  151243. * Defines how much ridge the curvature effect displays.
  151244. */
  151245. ridge: number;
  151246. /**
  151247. * Defines how much valley the curvature effect displays.
  151248. */
  151249. valley: number;
  151250. private _geometryBufferRenderer;
  151251. /**
  151252. * Gets a string identifying the name of the class
  151253. * @returns "ScreenSpaceCurvaturePostProcess" string
  151254. */
  151255. getClassName(): string;
  151256. /**
  151257. * Creates a new instance ScreenSpaceCurvaturePostProcess
  151258. * @param name The name of the effect.
  151259. * @param scene The scene containing the objects to blur according to their velocity.
  151260. * @param options The required width/height ratio to downsize to before computing the render pass.
  151261. * @param camera The camera to apply the render pass to.
  151262. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151263. * @param engine The engine which the post process will be applied. (default: current engine)
  151264. * @param reusable If the post process can be reused on the same frame. (default: false)
  151265. * @param textureType Type of textures used when performing the post process. (default: 0)
  151266. * @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)
  151267. */
  151268. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  151269. /**
  151270. * Support test.
  151271. */
  151272. static get IsSupported(): boolean;
  151273. /** @hidden */
  151274. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  151275. }
  151276. }
  151277. declare module BABYLON {
  151278. interface Scene {
  151279. /** @hidden (Backing field) */
  151280. _boundingBoxRenderer: BoundingBoxRenderer;
  151281. /** @hidden (Backing field) */
  151282. _forceShowBoundingBoxes: boolean;
  151283. /**
  151284. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  151285. */
  151286. forceShowBoundingBoxes: boolean;
  151287. /**
  151288. * Gets the bounding box renderer associated with the scene
  151289. * @returns a BoundingBoxRenderer
  151290. */
  151291. getBoundingBoxRenderer(): BoundingBoxRenderer;
  151292. }
  151293. interface AbstractMesh {
  151294. /** @hidden (Backing field) */
  151295. _showBoundingBox: boolean;
  151296. /**
  151297. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  151298. */
  151299. showBoundingBox: boolean;
  151300. }
  151301. /**
  151302. * Component responsible of rendering the bounding box of the meshes in a scene.
  151303. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  151304. */
  151305. export class BoundingBoxRenderer implements ISceneComponent {
  151306. /**
  151307. * The component name helpfull to identify the component in the list of scene components.
  151308. */
  151309. readonly name: string;
  151310. /**
  151311. * The scene the component belongs to.
  151312. */
  151313. scene: Scene;
  151314. /**
  151315. * Color of the bounding box lines placed in front of an object
  151316. */
  151317. frontColor: Color3;
  151318. /**
  151319. * Color of the bounding box lines placed behind an object
  151320. */
  151321. backColor: Color3;
  151322. /**
  151323. * Defines if the renderer should show the back lines or not
  151324. */
  151325. showBackLines: boolean;
  151326. /**
  151327. * Observable raised before rendering a bounding box
  151328. */
  151329. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  151330. /**
  151331. * Observable raised after rendering a bounding box
  151332. */
  151333. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  151334. /**
  151335. * @hidden
  151336. */
  151337. renderList: SmartArray<BoundingBox>;
  151338. private _colorShader;
  151339. private _vertexBuffers;
  151340. private _indexBuffer;
  151341. private _fillIndexBuffer;
  151342. private _fillIndexData;
  151343. /**
  151344. * Instantiates a new bounding box renderer in a scene.
  151345. * @param scene the scene the renderer renders in
  151346. */
  151347. constructor(scene: Scene);
  151348. /**
  151349. * Registers the component in a given scene
  151350. */
  151351. register(): void;
  151352. private _evaluateSubMesh;
  151353. private _activeMesh;
  151354. private _prepareRessources;
  151355. private _createIndexBuffer;
  151356. /**
  151357. * Rebuilds the elements related to this component in case of
  151358. * context lost for instance.
  151359. */
  151360. rebuild(): void;
  151361. /**
  151362. * @hidden
  151363. */
  151364. reset(): void;
  151365. /**
  151366. * Render the bounding boxes of a specific rendering group
  151367. * @param renderingGroupId defines the rendering group to render
  151368. */
  151369. render(renderingGroupId: number): void;
  151370. /**
  151371. * In case of occlusion queries, we can render the occlusion bounding box through this method
  151372. * @param mesh Define the mesh to render the occlusion bounding box for
  151373. */
  151374. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  151375. /**
  151376. * Dispose and release the resources attached to this renderer.
  151377. */
  151378. dispose(): void;
  151379. }
  151380. }
  151381. declare module BABYLON {
  151382. interface Scene {
  151383. /** @hidden (Backing field) */
  151384. _depthRenderer: {
  151385. [id: string]: DepthRenderer;
  151386. };
  151387. /**
  151388. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  151389. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  151390. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  151391. * @returns the created depth renderer
  151392. */
  151393. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  151394. /**
  151395. * Disables a depth renderer for a given camera
  151396. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  151397. */
  151398. disableDepthRenderer(camera?: Nullable<Camera>): void;
  151399. }
  151400. /**
  151401. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  151402. * in several rendering techniques.
  151403. */
  151404. export class DepthRendererSceneComponent implements ISceneComponent {
  151405. /**
  151406. * The component name helpfull to identify the component in the list of scene components.
  151407. */
  151408. readonly name: string;
  151409. /**
  151410. * The scene the component belongs to.
  151411. */
  151412. scene: Scene;
  151413. /**
  151414. * Creates a new instance of the component for the given scene
  151415. * @param scene Defines the scene to register the component in
  151416. */
  151417. constructor(scene: Scene);
  151418. /**
  151419. * Registers the component in a given scene
  151420. */
  151421. register(): void;
  151422. /**
  151423. * Rebuilds the elements related to this component in case of
  151424. * context lost for instance.
  151425. */
  151426. rebuild(): void;
  151427. /**
  151428. * Disposes the component and the associated ressources
  151429. */
  151430. dispose(): void;
  151431. private _gatherRenderTargets;
  151432. private _gatherActiveCameraRenderTargets;
  151433. }
  151434. }
  151435. declare module BABYLON {
  151436. interface AbstractScene {
  151437. /** @hidden (Backing field) */
  151438. _prePassRenderer: Nullable<PrePassRenderer>;
  151439. /**
  151440. * Gets or Sets the current prepass renderer associated to the scene.
  151441. */
  151442. prePassRenderer: Nullable<PrePassRenderer>;
  151443. /**
  151444. * Enables the prepass and associates it with the scene
  151445. * @returns the PrePassRenderer
  151446. */
  151447. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  151448. /**
  151449. * Disables the prepass associated with the scene
  151450. */
  151451. disablePrePassRenderer(): void;
  151452. }
  151453. /**
  151454. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  151455. * in several rendering techniques.
  151456. */
  151457. export class PrePassRendererSceneComponent implements ISceneSerializableComponent {
  151458. /**
  151459. * The component name helpful to identify the component in the list of scene components.
  151460. */
  151461. readonly name: string;
  151462. /**
  151463. * The scene the component belongs to.
  151464. */
  151465. scene: Scene;
  151466. /**
  151467. * Creates a new instance of the component for the given scene
  151468. * @param scene Defines the scene to register the component in
  151469. */
  151470. constructor(scene: Scene);
  151471. /**
  151472. * Registers the component in a given scene
  151473. */
  151474. register(): void;
  151475. private _beforeCameraDraw;
  151476. private _afterCameraDraw;
  151477. private _beforeClearStage;
  151478. /**
  151479. * Serializes the component data to the specified json object
  151480. * @param serializationObject The object to serialize to
  151481. */
  151482. serialize(serializationObject: any): void;
  151483. /**
  151484. * Adds all the elements from the container to the scene
  151485. * @param container the container holding the elements
  151486. */
  151487. addFromContainer(container: AbstractScene): void;
  151488. /**
  151489. * Removes all the elements in the container from the scene
  151490. * @param container contains the elements to remove
  151491. * @param dispose if the removed element should be disposed (default: false)
  151492. */
  151493. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  151494. /**
  151495. * Rebuilds the elements related to this component in case of
  151496. * context lost for instance.
  151497. */
  151498. rebuild(): void;
  151499. /**
  151500. * Disposes the component and the associated ressources
  151501. */
  151502. dispose(): void;
  151503. }
  151504. }
  151505. declare module BABYLON {
  151506. /** @hidden */
  151507. export var outlinePixelShader: {
  151508. name: string;
  151509. shader: string;
  151510. };
  151511. }
  151512. declare module BABYLON {
  151513. /** @hidden */
  151514. export var outlineVertexShader: {
  151515. name: string;
  151516. shader: string;
  151517. };
  151518. }
  151519. declare module BABYLON {
  151520. interface Scene {
  151521. /** @hidden */
  151522. _outlineRenderer: OutlineRenderer;
  151523. /**
  151524. * Gets the outline renderer associated with the scene
  151525. * @returns a OutlineRenderer
  151526. */
  151527. getOutlineRenderer(): OutlineRenderer;
  151528. }
  151529. interface AbstractMesh {
  151530. /** @hidden (Backing field) */
  151531. _renderOutline: boolean;
  151532. /**
  151533. * Gets or sets a boolean indicating if the outline must be rendered as well
  151534. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  151535. */
  151536. renderOutline: boolean;
  151537. /** @hidden (Backing field) */
  151538. _renderOverlay: boolean;
  151539. /**
  151540. * Gets or sets a boolean indicating if the overlay must be rendered as well
  151541. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  151542. */
  151543. renderOverlay: boolean;
  151544. }
  151545. /**
  151546. * This class is responsible to draw bothe outline/overlay of meshes.
  151547. * It should not be used directly but through the available method on mesh.
  151548. */
  151549. export class OutlineRenderer implements ISceneComponent {
  151550. /**
  151551. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  151552. */
  151553. private static _StencilReference;
  151554. /**
  151555. * The name of the component. Each component must have a unique name.
  151556. */
  151557. name: string;
  151558. /**
  151559. * The scene the component belongs to.
  151560. */
  151561. scene: Scene;
  151562. /**
  151563. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  151564. */
  151565. zOffset: number;
  151566. private _engine;
  151567. private _effect;
  151568. private _cachedDefines;
  151569. private _savedDepthWrite;
  151570. /**
  151571. * Instantiates a new outline renderer. (There could be only one per scene).
  151572. * @param scene Defines the scene it belongs to
  151573. */
  151574. constructor(scene: Scene);
  151575. /**
  151576. * Register the component to one instance of a scene.
  151577. */
  151578. register(): void;
  151579. /**
  151580. * Rebuilds the elements related to this component in case of
  151581. * context lost for instance.
  151582. */
  151583. rebuild(): void;
  151584. /**
  151585. * Disposes the component and the associated ressources.
  151586. */
  151587. dispose(): void;
  151588. /**
  151589. * Renders the outline in the canvas.
  151590. * @param subMesh Defines the sumesh to render
  151591. * @param batch Defines the batch of meshes in case of instances
  151592. * @param useOverlay Defines if the rendering is for the overlay or the outline
  151593. */
  151594. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  151595. /**
  151596. * Returns whether or not the outline renderer is ready for a given submesh.
  151597. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  151598. * @param subMesh Defines the submesh to check readyness for
  151599. * @param useInstances Defines wheter wee are trying to render instances or not
  151600. * @returns true if ready otherwise false
  151601. */
  151602. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  151603. private _beforeRenderingMesh;
  151604. private _afterRenderingMesh;
  151605. }
  151606. }
  151607. declare module BABYLON {
  151608. /**
  151609. * Defines the basic options interface of a Sprite Frame Source Size.
  151610. */
  151611. export interface ISpriteJSONSpriteSourceSize {
  151612. /**
  151613. * number of the original width of the Frame
  151614. */
  151615. w: number;
  151616. /**
  151617. * number of the original height of the Frame
  151618. */
  151619. h: number;
  151620. }
  151621. /**
  151622. * Defines the basic options interface of a Sprite Frame Data.
  151623. */
  151624. export interface ISpriteJSONSpriteFrameData {
  151625. /**
  151626. * number of the x offset of the Frame
  151627. */
  151628. x: number;
  151629. /**
  151630. * number of the y offset of the Frame
  151631. */
  151632. y: number;
  151633. /**
  151634. * number of the width of the Frame
  151635. */
  151636. w: number;
  151637. /**
  151638. * number of the height of the Frame
  151639. */
  151640. h: number;
  151641. }
  151642. /**
  151643. * Defines the basic options interface of a JSON Sprite.
  151644. */
  151645. export interface ISpriteJSONSprite {
  151646. /**
  151647. * string name of the Frame
  151648. */
  151649. filename: string;
  151650. /**
  151651. * ISpriteJSONSpriteFrame basic object of the frame data
  151652. */
  151653. frame: ISpriteJSONSpriteFrameData;
  151654. /**
  151655. * boolean to flag is the frame was rotated.
  151656. */
  151657. rotated: boolean;
  151658. /**
  151659. * boolean to flag is the frame was trimmed.
  151660. */
  151661. trimmed: boolean;
  151662. /**
  151663. * ISpriteJSONSpriteFrame basic object of the source data
  151664. */
  151665. spriteSourceSize: ISpriteJSONSpriteFrameData;
  151666. /**
  151667. * ISpriteJSONSpriteFrame basic object of the source data
  151668. */
  151669. sourceSize: ISpriteJSONSpriteSourceSize;
  151670. }
  151671. /**
  151672. * Defines the basic options interface of a JSON atlas.
  151673. */
  151674. export interface ISpriteJSONAtlas {
  151675. /**
  151676. * Array of objects that contain the frame data.
  151677. */
  151678. frames: Array<ISpriteJSONSprite>;
  151679. /**
  151680. * object basic object containing the sprite meta data.
  151681. */
  151682. meta?: object;
  151683. }
  151684. }
  151685. declare module BABYLON {
  151686. /** @hidden */
  151687. export var spriteMapPixelShader: {
  151688. name: string;
  151689. shader: string;
  151690. };
  151691. }
  151692. declare module BABYLON {
  151693. /** @hidden */
  151694. export var spriteMapVertexShader: {
  151695. name: string;
  151696. shader: string;
  151697. };
  151698. }
  151699. declare module BABYLON {
  151700. /**
  151701. * Defines the basic options interface of a SpriteMap
  151702. */
  151703. export interface ISpriteMapOptions {
  151704. /**
  151705. * Vector2 of the number of cells in the grid.
  151706. */
  151707. stageSize?: Vector2;
  151708. /**
  151709. * Vector2 of the size of the output plane in World Units.
  151710. */
  151711. outputSize?: Vector2;
  151712. /**
  151713. * Vector3 of the position of the output plane in World Units.
  151714. */
  151715. outputPosition?: Vector3;
  151716. /**
  151717. * Vector3 of the rotation of the output plane.
  151718. */
  151719. outputRotation?: Vector3;
  151720. /**
  151721. * number of layers that the system will reserve in resources.
  151722. */
  151723. layerCount?: number;
  151724. /**
  151725. * number of max animation frames a single cell will reserve in resources.
  151726. */
  151727. maxAnimationFrames?: number;
  151728. /**
  151729. * number cell index of the base tile when the system compiles.
  151730. */
  151731. baseTile?: number;
  151732. /**
  151733. * boolean flip the sprite after its been repositioned by the framing data.
  151734. */
  151735. flipU?: boolean;
  151736. /**
  151737. * Vector3 scalar of the global RGB values of the SpriteMap.
  151738. */
  151739. colorMultiply?: Vector3;
  151740. }
  151741. /**
  151742. * Defines the IDisposable interface in order to be cleanable from resources.
  151743. */
  151744. export interface ISpriteMap extends IDisposable {
  151745. /**
  151746. * String name of the SpriteMap.
  151747. */
  151748. name: string;
  151749. /**
  151750. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  151751. */
  151752. atlasJSON: ISpriteJSONAtlas;
  151753. /**
  151754. * Texture of the SpriteMap.
  151755. */
  151756. spriteSheet: Texture;
  151757. /**
  151758. * The parameters to initialize the SpriteMap with.
  151759. */
  151760. options: ISpriteMapOptions;
  151761. }
  151762. /**
  151763. * Class used to manage a grid restricted sprite deployment on an Output plane.
  151764. */
  151765. export class SpriteMap implements ISpriteMap {
  151766. /** The Name of the spriteMap */
  151767. name: string;
  151768. /** The JSON file with the frame and meta data */
  151769. atlasJSON: ISpriteJSONAtlas;
  151770. /** The systems Sprite Sheet Texture */
  151771. spriteSheet: Texture;
  151772. /** Arguments passed with the Constructor */
  151773. options: ISpriteMapOptions;
  151774. /** Public Sprite Storage array, parsed from atlasJSON */
  151775. sprites: Array<ISpriteJSONSprite>;
  151776. /** Returns the Number of Sprites in the System */
  151777. get spriteCount(): number;
  151778. /** Returns the Position of Output Plane*/
  151779. get position(): Vector3;
  151780. /** Returns the Position of Output Plane*/
  151781. set position(v: Vector3);
  151782. /** Returns the Rotation of Output Plane*/
  151783. get rotation(): Vector3;
  151784. /** Returns the Rotation of Output Plane*/
  151785. set rotation(v: Vector3);
  151786. /** Sets the AnimationMap*/
  151787. get animationMap(): RawTexture;
  151788. /** Sets the AnimationMap*/
  151789. set animationMap(v: RawTexture);
  151790. /** Scene that the SpriteMap was created in */
  151791. private _scene;
  151792. /** Texture Buffer of Float32 that holds tile frame data*/
  151793. private _frameMap;
  151794. /** Texture Buffers of Float32 that holds tileMap data*/
  151795. private _tileMaps;
  151796. /** Texture Buffer of Float32 that holds Animation Data*/
  151797. private _animationMap;
  151798. /** Custom ShaderMaterial Central to the System*/
  151799. private _material;
  151800. /** Custom ShaderMaterial Central to the System*/
  151801. private _output;
  151802. /** Systems Time Ticker*/
  151803. private _time;
  151804. /**
  151805. * Creates a new SpriteMap
  151806. * @param name defines the SpriteMaps Name
  151807. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  151808. * @param spriteSheet is the Texture that the Sprites are on.
  151809. * @param options a basic deployment configuration
  151810. * @param scene The Scene that the map is deployed on
  151811. */
  151812. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  151813. /**
  151814. * Returns tileID location
  151815. * @returns Vector2 the cell position ID
  151816. */
  151817. getTileID(): Vector2;
  151818. /**
  151819. * Gets the UV location of the mouse over the SpriteMap.
  151820. * @returns Vector2 the UV position of the mouse interaction
  151821. */
  151822. getMousePosition(): Vector2;
  151823. /**
  151824. * Creates the "frame" texture Buffer
  151825. * -------------------------------------
  151826. * Structure of frames
  151827. * "filename": "Falling-Water-2.png",
  151828. * "frame": {"x":69,"y":103,"w":24,"h":32},
  151829. * "rotated": true,
  151830. * "trimmed": true,
  151831. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  151832. * "sourceSize": {"w":32,"h":32}
  151833. * @returns RawTexture of the frameMap
  151834. */
  151835. private _createFrameBuffer;
  151836. /**
  151837. * Creates the tileMap texture Buffer
  151838. * @param buffer normally and array of numbers, or a false to generate from scratch
  151839. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  151840. * @returns RawTexture of the tileMap
  151841. */
  151842. private _createTileBuffer;
  151843. /**
  151844. * Modifies the data of the tileMaps
  151845. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  151846. * @param pos is the iVector2 Coordinates of the Tile
  151847. * @param tile The SpriteIndex of the new Tile
  151848. */
  151849. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  151850. /**
  151851. * Creates the animationMap texture Buffer
  151852. * @param buffer normally and array of numbers, or a false to generate from scratch
  151853. * @returns RawTexture of the animationMap
  151854. */
  151855. private _createTileAnimationBuffer;
  151856. /**
  151857. * Modifies the data of the animationMap
  151858. * @param cellID is the Index of the Sprite
  151859. * @param _frame is the target Animation frame
  151860. * @param toCell is the Target Index of the next frame of the animation
  151861. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  151862. * @param speed is a global scalar of the time variable on the map.
  151863. */
  151864. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  151865. /**
  151866. * Exports the .tilemaps file
  151867. */
  151868. saveTileMaps(): void;
  151869. /**
  151870. * Imports the .tilemaps file
  151871. * @param url of the .tilemaps file
  151872. */
  151873. loadTileMaps(url: string): void;
  151874. /**
  151875. * Release associated resources
  151876. */
  151877. dispose(): void;
  151878. }
  151879. }
  151880. declare module BABYLON {
  151881. /**
  151882. * Class used to manage multiple sprites of different sizes on the same spritesheet
  151883. * @see https://doc.babylonjs.com/babylon101/sprites
  151884. */
  151885. export class SpritePackedManager extends SpriteManager {
  151886. /** defines the packed manager's name */
  151887. name: string;
  151888. /**
  151889. * Creates a new sprite manager from a packed sprite sheet
  151890. * @param name defines the manager's name
  151891. * @param imgUrl defines the sprite sheet url
  151892. * @param capacity defines the maximum allowed number of sprites
  151893. * @param scene defines the hosting scene
  151894. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  151895. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  151896. * @param samplingMode defines the smapling mode to use with spritesheet
  151897. * @param fromPacked set to true; do not alter
  151898. */
  151899. constructor(
  151900. /** defines the packed manager's name */
  151901. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  151902. }
  151903. }
  151904. declare module BABYLON {
  151905. /**
  151906. * Defines the list of states available for a task inside a AssetsManager
  151907. */
  151908. export enum AssetTaskState {
  151909. /**
  151910. * Initialization
  151911. */
  151912. INIT = 0,
  151913. /**
  151914. * Running
  151915. */
  151916. RUNNING = 1,
  151917. /**
  151918. * Done
  151919. */
  151920. DONE = 2,
  151921. /**
  151922. * Error
  151923. */
  151924. ERROR = 3
  151925. }
  151926. /**
  151927. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  151928. */
  151929. export abstract class AbstractAssetTask {
  151930. /**
  151931. * Task name
  151932. */ name: string;
  151933. /**
  151934. * Callback called when the task is successful
  151935. */
  151936. onSuccess: (task: any) => void;
  151937. /**
  151938. * Callback called when the task is not successful
  151939. */
  151940. onError: (task: any, message?: string, exception?: any) => void;
  151941. /**
  151942. * Creates a new AssetsManager
  151943. * @param name defines the name of the task
  151944. */
  151945. constructor(
  151946. /**
  151947. * Task name
  151948. */ name: string);
  151949. private _isCompleted;
  151950. private _taskState;
  151951. private _errorObject;
  151952. /**
  151953. * Get if the task is completed
  151954. */
  151955. get isCompleted(): boolean;
  151956. /**
  151957. * Gets the current state of the task
  151958. */
  151959. get taskState(): AssetTaskState;
  151960. /**
  151961. * Gets the current error object (if task is in error)
  151962. */
  151963. get errorObject(): {
  151964. message?: string;
  151965. exception?: any;
  151966. };
  151967. /**
  151968. * Internal only
  151969. * @hidden
  151970. */
  151971. _setErrorObject(message?: string, exception?: any): void;
  151972. /**
  151973. * Execute the current task
  151974. * @param scene defines the scene where you want your assets to be loaded
  151975. * @param onSuccess is a callback called when the task is successfully executed
  151976. * @param onError is a callback called if an error occurs
  151977. */
  151978. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  151979. /**
  151980. * Execute the current task
  151981. * @param scene defines the scene where you want your assets to be loaded
  151982. * @param onSuccess is a callback called when the task is successfully executed
  151983. * @param onError is a callback called if an error occurs
  151984. */
  151985. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  151986. /**
  151987. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  151988. * This can be used with failed tasks that have the reason for failure fixed.
  151989. */
  151990. reset(): void;
  151991. private onErrorCallback;
  151992. private onDoneCallback;
  151993. }
  151994. /**
  151995. * Define the interface used by progress events raised during assets loading
  151996. */
  151997. export interface IAssetsProgressEvent {
  151998. /**
  151999. * Defines the number of remaining tasks to process
  152000. */
  152001. remainingCount: number;
  152002. /**
  152003. * Defines the total number of tasks
  152004. */
  152005. totalCount: number;
  152006. /**
  152007. * Defines the task that was just processed
  152008. */
  152009. task: AbstractAssetTask;
  152010. }
  152011. /**
  152012. * Class used to share progress information about assets loading
  152013. */
  152014. export class AssetsProgressEvent implements IAssetsProgressEvent {
  152015. /**
  152016. * Defines the number of remaining tasks to process
  152017. */
  152018. remainingCount: number;
  152019. /**
  152020. * Defines the total number of tasks
  152021. */
  152022. totalCount: number;
  152023. /**
  152024. * Defines the task that was just processed
  152025. */
  152026. task: AbstractAssetTask;
  152027. /**
  152028. * Creates a AssetsProgressEvent
  152029. * @param remainingCount defines the number of remaining tasks to process
  152030. * @param totalCount defines the total number of tasks
  152031. * @param task defines the task that was just processed
  152032. */
  152033. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  152034. }
  152035. /**
  152036. * Define a task used by AssetsManager to load assets into a container
  152037. */
  152038. export class ContainerAssetTask extends AbstractAssetTask {
  152039. /**
  152040. * Defines the name of the task
  152041. */
  152042. name: string;
  152043. /**
  152044. * Defines the list of mesh's names you want to load
  152045. */
  152046. meshesNames: any;
  152047. /**
  152048. * Defines the root url to use as a base to load your meshes and associated resources
  152049. */
  152050. rootUrl: string;
  152051. /**
  152052. * Defines the filename or File of the scene to load from
  152053. */
  152054. sceneFilename: string | File;
  152055. /**
  152056. * Get the loaded asset container
  152057. */
  152058. loadedContainer: AssetContainer;
  152059. /**
  152060. * Gets the list of loaded meshes
  152061. */
  152062. loadedMeshes: Array<AbstractMesh>;
  152063. /**
  152064. * Gets the list of loaded particle systems
  152065. */
  152066. loadedParticleSystems: Array<IParticleSystem>;
  152067. /**
  152068. * Gets the list of loaded skeletons
  152069. */
  152070. loadedSkeletons: Array<Skeleton>;
  152071. /**
  152072. * Gets the list of loaded animation groups
  152073. */
  152074. loadedAnimationGroups: Array<AnimationGroup>;
  152075. /**
  152076. * Callback called when the task is successful
  152077. */
  152078. onSuccess: (task: ContainerAssetTask) => void;
  152079. /**
  152080. * Callback called when the task is successful
  152081. */
  152082. onError: (task: ContainerAssetTask, message?: string, exception?: any) => void;
  152083. /**
  152084. * Creates a new ContainerAssetTask
  152085. * @param name defines the name of the task
  152086. * @param meshesNames defines the list of mesh's names you want to load
  152087. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  152088. * @param sceneFilename defines the filename or File of the scene to load from
  152089. */
  152090. constructor(
  152091. /**
  152092. * Defines the name of the task
  152093. */
  152094. name: string,
  152095. /**
  152096. * Defines the list of mesh's names you want to load
  152097. */
  152098. meshesNames: any,
  152099. /**
  152100. * Defines the root url to use as a base to load your meshes and associated resources
  152101. */
  152102. rootUrl: string,
  152103. /**
  152104. * Defines the filename or File of the scene to load from
  152105. */
  152106. sceneFilename: string | File);
  152107. /**
  152108. * Execute the current task
  152109. * @param scene defines the scene where you want your assets to be loaded
  152110. * @param onSuccess is a callback called when the task is successfully executed
  152111. * @param onError is a callback called if an error occurs
  152112. */
  152113. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152114. }
  152115. /**
  152116. * Define a task used by AssetsManager to load meshes
  152117. */
  152118. export class MeshAssetTask extends AbstractAssetTask {
  152119. /**
  152120. * Defines the name of the task
  152121. */
  152122. name: string;
  152123. /**
  152124. * Defines the list of mesh's names you want to load
  152125. */
  152126. meshesNames: any;
  152127. /**
  152128. * Defines the root url to use as a base to load your meshes and associated resources
  152129. */
  152130. rootUrl: string;
  152131. /**
  152132. * Defines the filename or File of the scene to load from
  152133. */
  152134. sceneFilename: string | File;
  152135. /**
  152136. * Gets the list of loaded meshes
  152137. */
  152138. loadedMeshes: Array<AbstractMesh>;
  152139. /**
  152140. * Gets the list of loaded particle systems
  152141. */
  152142. loadedParticleSystems: Array<IParticleSystem>;
  152143. /**
  152144. * Gets the list of loaded skeletons
  152145. */
  152146. loadedSkeletons: Array<Skeleton>;
  152147. /**
  152148. * Gets the list of loaded animation groups
  152149. */
  152150. loadedAnimationGroups: Array<AnimationGroup>;
  152151. /**
  152152. * Callback called when the task is successful
  152153. */
  152154. onSuccess: (task: MeshAssetTask) => void;
  152155. /**
  152156. * Callback called when the task is successful
  152157. */
  152158. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  152159. /**
  152160. * Creates a new MeshAssetTask
  152161. * @param name defines the name of the task
  152162. * @param meshesNames defines the list of mesh's names you want to load
  152163. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  152164. * @param sceneFilename defines the filename or File of the scene to load from
  152165. */
  152166. constructor(
  152167. /**
  152168. * Defines the name of the task
  152169. */
  152170. name: string,
  152171. /**
  152172. * Defines the list of mesh's names you want to load
  152173. */
  152174. meshesNames: any,
  152175. /**
  152176. * Defines the root url to use as a base to load your meshes and associated resources
  152177. */
  152178. rootUrl: string,
  152179. /**
  152180. * Defines the filename or File of the scene to load from
  152181. */
  152182. sceneFilename: string | File);
  152183. /**
  152184. * Execute the current task
  152185. * @param scene defines the scene where you want your assets to be loaded
  152186. * @param onSuccess is a callback called when the task is successfully executed
  152187. * @param onError is a callback called if an error occurs
  152188. */
  152189. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152190. }
  152191. /**
  152192. * Define a task used by AssetsManager to load text content
  152193. */
  152194. export class TextFileAssetTask extends AbstractAssetTask {
  152195. /**
  152196. * Defines the name of the task
  152197. */
  152198. name: string;
  152199. /**
  152200. * Defines the location of the file to load
  152201. */
  152202. url: string;
  152203. /**
  152204. * Gets the loaded text string
  152205. */
  152206. text: string;
  152207. /**
  152208. * Callback called when the task is successful
  152209. */
  152210. onSuccess: (task: TextFileAssetTask) => void;
  152211. /**
  152212. * Callback called when the task is successful
  152213. */
  152214. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  152215. /**
  152216. * Creates a new TextFileAssetTask object
  152217. * @param name defines the name of the task
  152218. * @param url defines the location of the file to load
  152219. */
  152220. constructor(
  152221. /**
  152222. * Defines the name of the task
  152223. */
  152224. name: string,
  152225. /**
  152226. * Defines the location of the file to load
  152227. */
  152228. url: string);
  152229. /**
  152230. * Execute the current task
  152231. * @param scene defines the scene where you want your assets to be loaded
  152232. * @param onSuccess is a callback called when the task is successfully executed
  152233. * @param onError is a callback called if an error occurs
  152234. */
  152235. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152236. }
  152237. /**
  152238. * Define a task used by AssetsManager to load binary data
  152239. */
  152240. export class BinaryFileAssetTask extends AbstractAssetTask {
  152241. /**
  152242. * Defines the name of the task
  152243. */
  152244. name: string;
  152245. /**
  152246. * Defines the location of the file to load
  152247. */
  152248. url: string;
  152249. /**
  152250. * Gets the lodaded data (as an array buffer)
  152251. */
  152252. data: ArrayBuffer;
  152253. /**
  152254. * Callback called when the task is successful
  152255. */
  152256. onSuccess: (task: BinaryFileAssetTask) => void;
  152257. /**
  152258. * Callback called when the task is successful
  152259. */
  152260. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  152261. /**
  152262. * Creates a new BinaryFileAssetTask object
  152263. * @param name defines the name of the new task
  152264. * @param url defines the location of the file to load
  152265. */
  152266. constructor(
  152267. /**
  152268. * Defines the name of the task
  152269. */
  152270. name: string,
  152271. /**
  152272. * Defines the location of the file to load
  152273. */
  152274. url: string);
  152275. /**
  152276. * Execute the current task
  152277. * @param scene defines the scene where you want your assets to be loaded
  152278. * @param onSuccess is a callback called when the task is successfully executed
  152279. * @param onError is a callback called if an error occurs
  152280. */
  152281. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152282. }
  152283. /**
  152284. * Define a task used by AssetsManager to load images
  152285. */
  152286. export class ImageAssetTask extends AbstractAssetTask {
  152287. /**
  152288. * Defines the name of the task
  152289. */
  152290. name: string;
  152291. /**
  152292. * Defines the location of the image to load
  152293. */
  152294. url: string;
  152295. /**
  152296. * Gets the loaded images
  152297. */
  152298. image: HTMLImageElement;
  152299. /**
  152300. * Callback called when the task is successful
  152301. */
  152302. onSuccess: (task: ImageAssetTask) => void;
  152303. /**
  152304. * Callback called when the task is successful
  152305. */
  152306. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  152307. /**
  152308. * Creates a new ImageAssetTask
  152309. * @param name defines the name of the task
  152310. * @param url defines the location of the image to load
  152311. */
  152312. constructor(
  152313. /**
  152314. * Defines the name of the task
  152315. */
  152316. name: string,
  152317. /**
  152318. * Defines the location of the image to load
  152319. */
  152320. url: string);
  152321. /**
  152322. * Execute the current task
  152323. * @param scene defines the scene where you want your assets to be loaded
  152324. * @param onSuccess is a callback called when the task is successfully executed
  152325. * @param onError is a callback called if an error occurs
  152326. */
  152327. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152328. }
  152329. /**
  152330. * Defines the interface used by texture loading tasks
  152331. */
  152332. export interface ITextureAssetTask<TEX extends BaseTexture> {
  152333. /**
  152334. * Gets the loaded texture
  152335. */
  152336. texture: TEX;
  152337. }
  152338. /**
  152339. * Define a task used by AssetsManager to load 2D textures
  152340. */
  152341. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  152342. /**
  152343. * Defines the name of the task
  152344. */
  152345. name: string;
  152346. /**
  152347. * Defines the location of the file to load
  152348. */
  152349. url: string;
  152350. /**
  152351. * Defines if mipmap should not be generated (default is false)
  152352. */
  152353. noMipmap?: boolean | undefined;
  152354. /**
  152355. * Defines if texture must be inverted on Y axis (default is true)
  152356. */
  152357. invertY: boolean;
  152358. /**
  152359. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152360. */
  152361. samplingMode: number;
  152362. /**
  152363. * Gets the loaded texture
  152364. */
  152365. texture: Texture;
  152366. /**
  152367. * Callback called when the task is successful
  152368. */
  152369. onSuccess: (task: TextureAssetTask) => void;
  152370. /**
  152371. * Callback called when the task is successful
  152372. */
  152373. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  152374. /**
  152375. * Creates a new TextureAssetTask object
  152376. * @param name defines the name of the task
  152377. * @param url defines the location of the file to load
  152378. * @param noMipmap defines if mipmap should not be generated (default is false)
  152379. * @param invertY defines if texture must be inverted on Y axis (default is true)
  152380. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152381. */
  152382. constructor(
  152383. /**
  152384. * Defines the name of the task
  152385. */
  152386. name: string,
  152387. /**
  152388. * Defines the location of the file to load
  152389. */
  152390. url: string,
  152391. /**
  152392. * Defines if mipmap should not be generated (default is false)
  152393. */
  152394. noMipmap?: boolean | undefined,
  152395. /**
  152396. * Defines if texture must be inverted on Y axis (default is true)
  152397. */
  152398. invertY?: boolean,
  152399. /**
  152400. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152401. */
  152402. samplingMode?: number);
  152403. /**
  152404. * Execute the current task
  152405. * @param scene defines the scene where you want your assets to be loaded
  152406. * @param onSuccess is a callback called when the task is successfully executed
  152407. * @param onError is a callback called if an error occurs
  152408. */
  152409. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152410. }
  152411. /**
  152412. * Define a task used by AssetsManager to load cube textures
  152413. */
  152414. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  152415. /**
  152416. * Defines the name of the task
  152417. */
  152418. name: string;
  152419. /**
  152420. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152421. */
  152422. url: string;
  152423. /**
  152424. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152425. */
  152426. extensions?: string[] | undefined;
  152427. /**
  152428. * Defines if mipmaps should not be generated (default is false)
  152429. */
  152430. noMipmap?: boolean | undefined;
  152431. /**
  152432. * Defines the explicit list of files (undefined by default)
  152433. */
  152434. files?: string[] | undefined;
  152435. /**
  152436. * Gets the loaded texture
  152437. */
  152438. texture: CubeTexture;
  152439. /**
  152440. * Callback called when the task is successful
  152441. */
  152442. onSuccess: (task: CubeTextureAssetTask) => void;
  152443. /**
  152444. * Callback called when the task is successful
  152445. */
  152446. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  152447. /**
  152448. * Creates a new CubeTextureAssetTask
  152449. * @param name defines the name of the task
  152450. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152451. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152452. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152453. * @param files defines the explicit list of files (undefined by default)
  152454. */
  152455. constructor(
  152456. /**
  152457. * Defines the name of the task
  152458. */
  152459. name: string,
  152460. /**
  152461. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152462. */
  152463. url: string,
  152464. /**
  152465. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152466. */
  152467. extensions?: string[] | undefined,
  152468. /**
  152469. * Defines if mipmaps should not be generated (default is false)
  152470. */
  152471. noMipmap?: boolean | undefined,
  152472. /**
  152473. * Defines the explicit list of files (undefined by default)
  152474. */
  152475. files?: string[] | undefined);
  152476. /**
  152477. * Execute the current task
  152478. * @param scene defines the scene where you want your assets to be loaded
  152479. * @param onSuccess is a callback called when the task is successfully executed
  152480. * @param onError is a callback called if an error occurs
  152481. */
  152482. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152483. }
  152484. /**
  152485. * Define a task used by AssetsManager to load HDR cube textures
  152486. */
  152487. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  152488. /**
  152489. * Defines the name of the task
  152490. */
  152491. name: string;
  152492. /**
  152493. * Defines the location of the file to load
  152494. */
  152495. url: string;
  152496. /**
  152497. * Defines the desired size (the more it increases the longer the generation will be)
  152498. */
  152499. size: number;
  152500. /**
  152501. * Defines if mipmaps should not be generated (default is false)
  152502. */
  152503. noMipmap: boolean;
  152504. /**
  152505. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152506. */
  152507. generateHarmonics: boolean;
  152508. /**
  152509. * 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)
  152510. */
  152511. gammaSpace: boolean;
  152512. /**
  152513. * Internal Use Only
  152514. */
  152515. reserved: boolean;
  152516. /**
  152517. * Gets the loaded texture
  152518. */
  152519. texture: HDRCubeTexture;
  152520. /**
  152521. * Callback called when the task is successful
  152522. */
  152523. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  152524. /**
  152525. * Callback called when the task is successful
  152526. */
  152527. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  152528. /**
  152529. * Creates a new HDRCubeTextureAssetTask object
  152530. * @param name defines the name of the task
  152531. * @param url defines the location of the file to load
  152532. * @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.
  152533. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152534. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152535. * @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)
  152536. * @param reserved Internal use only
  152537. */
  152538. constructor(
  152539. /**
  152540. * Defines the name of the task
  152541. */
  152542. name: string,
  152543. /**
  152544. * Defines the location of the file to load
  152545. */
  152546. url: string,
  152547. /**
  152548. * Defines the desired size (the more it increases the longer the generation will be)
  152549. */
  152550. size: number,
  152551. /**
  152552. * Defines if mipmaps should not be generated (default is false)
  152553. */
  152554. noMipmap?: boolean,
  152555. /**
  152556. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152557. */
  152558. generateHarmonics?: boolean,
  152559. /**
  152560. * 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)
  152561. */
  152562. gammaSpace?: boolean,
  152563. /**
  152564. * Internal Use Only
  152565. */
  152566. reserved?: boolean);
  152567. /**
  152568. * Execute the current task
  152569. * @param scene defines the scene where you want your assets to be loaded
  152570. * @param onSuccess is a callback called when the task is successfully executed
  152571. * @param onError is a callback called if an error occurs
  152572. */
  152573. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152574. }
  152575. /**
  152576. * Define a task used by AssetsManager to load Equirectangular cube textures
  152577. */
  152578. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  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 the desired size (the more it increases the longer the generation will be)
  152589. */
  152590. size: number;
  152591. /**
  152592. * Defines if mipmaps should not be generated (default is false)
  152593. */
  152594. noMipmap: boolean;
  152595. /**
  152596. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  152597. * but the standard material would require them in Gamma space) (default is true)
  152598. */
  152599. gammaSpace: boolean;
  152600. /**
  152601. * Gets the loaded texture
  152602. */
  152603. texture: EquiRectangularCubeTexture;
  152604. /**
  152605. * Callback called when the task is successful
  152606. */
  152607. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  152608. /**
  152609. * Callback called when the task is successful
  152610. */
  152611. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  152612. /**
  152613. * Creates a new EquiRectangularCubeTextureAssetTask object
  152614. * @param name defines the name of the task
  152615. * @param url defines the location of the file to load
  152616. * @param size defines the desired size (the more it increases the longer the generation will be)
  152617. * If the size is omitted this implies you are using a preprocessed cubemap.
  152618. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152619. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  152620. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  152621. * (default is true)
  152622. */
  152623. constructor(
  152624. /**
  152625. * Defines the name of the task
  152626. */
  152627. name: string,
  152628. /**
  152629. * Defines the location of the file to load
  152630. */
  152631. url: string,
  152632. /**
  152633. * Defines the desired size (the more it increases the longer the generation will be)
  152634. */
  152635. size: number,
  152636. /**
  152637. * Defines if mipmaps should not be generated (default is false)
  152638. */
  152639. noMipmap?: boolean,
  152640. /**
  152641. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  152642. * but the standard material would require them in Gamma space) (default is true)
  152643. */
  152644. gammaSpace?: boolean);
  152645. /**
  152646. * Execute the current task
  152647. * @param scene defines the scene where you want your assets to be loaded
  152648. * @param onSuccess is a callback called when the task is successfully executed
  152649. * @param onError is a callback called if an error occurs
  152650. */
  152651. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152652. }
  152653. /**
  152654. * This class can be used to easily import assets into a scene
  152655. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  152656. */
  152657. export class AssetsManager {
  152658. private _scene;
  152659. private _isLoading;
  152660. protected _tasks: AbstractAssetTask[];
  152661. protected _waitingTasksCount: number;
  152662. protected _totalTasksCount: number;
  152663. /**
  152664. * Callback called when all tasks are processed
  152665. */
  152666. onFinish: (tasks: AbstractAssetTask[]) => void;
  152667. /**
  152668. * Callback called when a task is successful
  152669. */
  152670. onTaskSuccess: (task: AbstractAssetTask) => void;
  152671. /**
  152672. * Callback called when a task had an error
  152673. */
  152674. onTaskError: (task: AbstractAssetTask) => void;
  152675. /**
  152676. * Callback called when a task is done (whatever the result is)
  152677. */
  152678. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  152679. /**
  152680. * Observable called when all tasks are processed
  152681. */
  152682. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  152683. /**
  152684. * Observable called when a task had an error
  152685. */
  152686. onTaskErrorObservable: Observable<AbstractAssetTask>;
  152687. /**
  152688. * Observable called when all tasks were executed
  152689. */
  152690. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  152691. /**
  152692. * Observable called when a task is done (whatever the result is)
  152693. */
  152694. onProgressObservable: Observable<IAssetsProgressEvent>;
  152695. /**
  152696. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  152697. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  152698. */
  152699. useDefaultLoadingScreen: boolean;
  152700. /**
  152701. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  152702. * when all assets have been downloaded.
  152703. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  152704. */
  152705. autoHideLoadingUI: boolean;
  152706. /**
  152707. * Creates a new AssetsManager
  152708. * @param scene defines the scene to work on
  152709. */
  152710. constructor(scene: Scene);
  152711. /**
  152712. * Add a ContainerAssetTask to the list of active tasks
  152713. * @param taskName defines the name of the new task
  152714. * @param meshesNames defines the name of meshes to load
  152715. * @param rootUrl defines the root url to use to locate files
  152716. * @param sceneFilename defines the filename of the scene file
  152717. * @returns a new ContainerAssetTask object
  152718. */
  152719. addContainerTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): ContainerAssetTask;
  152720. /**
  152721. * Add a MeshAssetTask to the list of active tasks
  152722. * @param taskName defines the name of the new task
  152723. * @param meshesNames defines the name of meshes to load
  152724. * @param rootUrl defines the root url to use to locate files
  152725. * @param sceneFilename defines the filename of the scene file
  152726. * @returns a new MeshAssetTask object
  152727. */
  152728. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  152729. /**
  152730. * Add a TextFileAssetTask to the list of active tasks
  152731. * @param taskName defines the name of the new task
  152732. * @param url defines the url of the file to load
  152733. * @returns a new TextFileAssetTask object
  152734. */
  152735. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  152736. /**
  152737. * Add a BinaryFileAssetTask to the list of active tasks
  152738. * @param taskName defines the name of the new task
  152739. * @param url defines the url of the file to load
  152740. * @returns a new BinaryFileAssetTask object
  152741. */
  152742. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  152743. /**
  152744. * Add a ImageAssetTask to the list of active tasks
  152745. * @param taskName defines the name of the new task
  152746. * @param url defines the url of the file to load
  152747. * @returns a new ImageAssetTask object
  152748. */
  152749. addImageTask(taskName: string, url: string): ImageAssetTask;
  152750. /**
  152751. * Add a TextureAssetTask to the list of active tasks
  152752. * @param taskName defines the name of the new task
  152753. * @param url defines the url of the file to load
  152754. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152755. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  152756. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  152757. * @returns a new TextureAssetTask object
  152758. */
  152759. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  152760. /**
  152761. * Add a CubeTextureAssetTask to the list of active tasks
  152762. * @param taskName defines the name of the new task
  152763. * @param url defines the url of the file to load
  152764. * @param extensions defines the extension to use to load the cube map (can be null)
  152765. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152766. * @param files defines the list of files to load (can be null)
  152767. * @returns a new CubeTextureAssetTask object
  152768. */
  152769. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  152770. /**
  152771. *
  152772. * Add a HDRCubeTextureAssetTask to the list of active tasks
  152773. * @param taskName defines the name of the new task
  152774. * @param url defines the url of the file to load
  152775. * @param size defines the size you want for the cubemap (can be null)
  152776. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152777. * @param generateHarmonics defines if you want to automatically generate (true by default)
  152778. * @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)
  152779. * @param reserved Internal use only
  152780. * @returns a new HDRCubeTextureAssetTask object
  152781. */
  152782. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  152783. /**
  152784. *
  152785. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  152786. * @param taskName defines the name of the new task
  152787. * @param url defines the url of the file to load
  152788. * @param size defines the size you want for the cubemap (can be null)
  152789. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152790. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  152791. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  152792. * @returns a new EquiRectangularCubeTextureAssetTask object
  152793. */
  152794. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  152795. /**
  152796. * Remove a task from the assets manager.
  152797. * @param task the task to remove
  152798. */
  152799. removeTask(task: AbstractAssetTask): void;
  152800. private _decreaseWaitingTasksCount;
  152801. private _runTask;
  152802. /**
  152803. * Reset the AssetsManager and remove all tasks
  152804. * @return the current instance of the AssetsManager
  152805. */
  152806. reset(): AssetsManager;
  152807. /**
  152808. * Start the loading process
  152809. * @return the current instance of the AssetsManager
  152810. */
  152811. load(): AssetsManager;
  152812. /**
  152813. * Start the loading process as an async operation
  152814. * @return a promise returning the list of failed tasks
  152815. */
  152816. loadAsync(): Promise<void>;
  152817. }
  152818. }
  152819. declare module BABYLON {
  152820. /**
  152821. * Wrapper class for promise with external resolve and reject.
  152822. */
  152823. export class Deferred<T> {
  152824. /**
  152825. * The promise associated with this deferred object.
  152826. */
  152827. readonly promise: Promise<T>;
  152828. private _resolve;
  152829. private _reject;
  152830. /**
  152831. * The resolve method of the promise associated with this deferred object.
  152832. */
  152833. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  152834. /**
  152835. * The reject method of the promise associated with this deferred object.
  152836. */
  152837. get reject(): (reason?: any) => void;
  152838. /**
  152839. * Constructor for this deferred object.
  152840. */
  152841. constructor();
  152842. }
  152843. }
  152844. declare module BABYLON {
  152845. /**
  152846. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  152847. */
  152848. export class MeshExploder {
  152849. private _centerMesh;
  152850. private _meshes;
  152851. private _meshesOrigins;
  152852. private _toCenterVectors;
  152853. private _scaledDirection;
  152854. private _newPosition;
  152855. private _centerPosition;
  152856. /**
  152857. * Explodes meshes from a center mesh.
  152858. * @param meshes The meshes to explode.
  152859. * @param centerMesh The mesh to be center of explosion.
  152860. */
  152861. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  152862. private _setCenterMesh;
  152863. /**
  152864. * Get class name
  152865. * @returns "MeshExploder"
  152866. */
  152867. getClassName(): string;
  152868. /**
  152869. * "Exploded meshes"
  152870. * @returns Array of meshes with the centerMesh at index 0.
  152871. */
  152872. getMeshes(): Array<Mesh>;
  152873. /**
  152874. * Explodes meshes giving a specific direction
  152875. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  152876. */
  152877. explode(direction?: number): void;
  152878. }
  152879. }
  152880. declare module BABYLON {
  152881. /**
  152882. * Class used to help managing file picking and drag'n'drop
  152883. */
  152884. export class FilesInput {
  152885. /**
  152886. * List of files ready to be loaded
  152887. */
  152888. static get FilesToLoad(): {
  152889. [key: string]: File;
  152890. };
  152891. /**
  152892. * Callback called when a file is processed
  152893. */
  152894. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  152895. private _engine;
  152896. private _currentScene;
  152897. private _sceneLoadedCallback;
  152898. private _progressCallback;
  152899. private _additionalRenderLoopLogicCallback;
  152900. private _textureLoadingCallback;
  152901. private _startingProcessingFilesCallback;
  152902. private _onReloadCallback;
  152903. private _errorCallback;
  152904. private _elementToMonitor;
  152905. private _sceneFileToLoad;
  152906. private _filesToLoad;
  152907. /**
  152908. * Creates a new FilesInput
  152909. * @param engine defines the rendering engine
  152910. * @param scene defines the hosting scene
  152911. * @param sceneLoadedCallback callback called when scene is loaded
  152912. * @param progressCallback callback called to track progress
  152913. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  152914. * @param textureLoadingCallback callback called when a texture is loading
  152915. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  152916. * @param onReloadCallback callback called when a reload is requested
  152917. * @param errorCallback callback call if an error occurs
  152918. */
  152919. 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>);
  152920. private _dragEnterHandler;
  152921. private _dragOverHandler;
  152922. private _dropHandler;
  152923. /**
  152924. * Calls this function to listen to drag'n'drop events on a specific DOM element
  152925. * @param elementToMonitor defines the DOM element to track
  152926. */
  152927. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  152928. /** Gets the current list of files to load */
  152929. get filesToLoad(): File[];
  152930. /**
  152931. * Release all associated resources
  152932. */
  152933. dispose(): void;
  152934. private renderFunction;
  152935. private drag;
  152936. private drop;
  152937. private _traverseFolder;
  152938. private _processFiles;
  152939. /**
  152940. * Load files from a drop event
  152941. * @param event defines the drop event to use as source
  152942. */
  152943. loadFiles(event: any): void;
  152944. private _processReload;
  152945. /**
  152946. * Reload the current scene from the loaded files
  152947. */
  152948. reload(): void;
  152949. }
  152950. }
  152951. declare module BABYLON {
  152952. /**
  152953. * Defines the root class used to create scene optimization to use with SceneOptimizer
  152954. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  152955. */
  152956. export class SceneOptimization {
  152957. /**
  152958. * Defines the priority of this optimization (0 by default which means first in the list)
  152959. */
  152960. priority: number;
  152961. /**
  152962. * Gets a string describing the action executed by the current optimization
  152963. * @returns description string
  152964. */
  152965. getDescription(): string;
  152966. /**
  152967. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  152968. * @param scene defines the current scene where to apply this optimization
  152969. * @param optimizer defines the current optimizer
  152970. * @returns true if everything that can be done was applied
  152971. */
  152972. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  152973. /**
  152974. * Creates the SceneOptimization object
  152975. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  152976. * @param desc defines the description associated with the optimization
  152977. */
  152978. constructor(
  152979. /**
  152980. * Defines the priority of this optimization (0 by default which means first in the list)
  152981. */
  152982. priority?: number);
  152983. }
  152984. /**
  152985. * Defines an optimization used to reduce the size of render target textures
  152986. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  152987. */
  152988. export class TextureOptimization extends SceneOptimization {
  152989. /**
  152990. * Defines the priority of this optimization (0 by default which means first in the list)
  152991. */
  152992. priority: number;
  152993. /**
  152994. * 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
  152995. */
  152996. maximumSize: number;
  152997. /**
  152998. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  152999. */
  153000. step: number;
  153001. /**
  153002. * Gets a string describing the action executed by the current optimization
  153003. * @returns description string
  153004. */
  153005. getDescription(): string;
  153006. /**
  153007. * Creates the TextureOptimization object
  153008. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153009. * @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
  153010. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  153011. */
  153012. constructor(
  153013. /**
  153014. * Defines the priority of this optimization (0 by default which means first in the list)
  153015. */
  153016. priority?: number,
  153017. /**
  153018. * 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
  153019. */
  153020. maximumSize?: number,
  153021. /**
  153022. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  153023. */
  153024. step?: number);
  153025. /**
  153026. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153027. * @param scene defines the current scene where to apply this optimization
  153028. * @param optimizer defines the current optimizer
  153029. * @returns true if everything that can be done was applied
  153030. */
  153031. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153032. }
  153033. /**
  153034. * Defines an optimization used to increase or decrease the rendering resolution
  153035. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153036. */
  153037. export class HardwareScalingOptimization extends SceneOptimization {
  153038. /**
  153039. * Defines the priority of this optimization (0 by default which means first in the list)
  153040. */
  153041. priority: number;
  153042. /**
  153043. * Defines the maximum scale to use (2 by default)
  153044. */
  153045. maximumScale: number;
  153046. /**
  153047. * Defines the step to use between two passes (0.5 by default)
  153048. */
  153049. step: number;
  153050. private _currentScale;
  153051. private _directionOffset;
  153052. /**
  153053. * Gets a string describing the action executed by the current optimization
  153054. * @return description string
  153055. */
  153056. getDescription(): string;
  153057. /**
  153058. * Creates the HardwareScalingOptimization object
  153059. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153060. * @param maximumScale defines the maximum scale to use (2 by default)
  153061. * @param step defines the step to use between two passes (0.5 by default)
  153062. */
  153063. constructor(
  153064. /**
  153065. * Defines the priority of this optimization (0 by default which means first in the list)
  153066. */
  153067. priority?: number,
  153068. /**
  153069. * Defines the maximum scale to use (2 by default)
  153070. */
  153071. maximumScale?: number,
  153072. /**
  153073. * Defines the step to use between two passes (0.5 by default)
  153074. */
  153075. step?: number);
  153076. /**
  153077. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153078. * @param scene defines the current scene where to apply this optimization
  153079. * @param optimizer defines the current optimizer
  153080. * @returns true if everything that can be done was applied
  153081. */
  153082. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153083. }
  153084. /**
  153085. * Defines an optimization used to remove shadows
  153086. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153087. */
  153088. export class ShadowsOptimization extends SceneOptimization {
  153089. /**
  153090. * Gets a string describing the action executed by the current optimization
  153091. * @return description string
  153092. */
  153093. getDescription(): string;
  153094. /**
  153095. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153096. * @param scene defines the current scene where to apply this optimization
  153097. * @param optimizer defines the current optimizer
  153098. * @returns true if everything that can be done was applied
  153099. */
  153100. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153101. }
  153102. /**
  153103. * Defines an optimization used to turn post-processes off
  153104. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153105. */
  153106. export class PostProcessesOptimization extends SceneOptimization {
  153107. /**
  153108. * Gets a string describing the action executed by the current optimization
  153109. * @return description string
  153110. */
  153111. getDescription(): string;
  153112. /**
  153113. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153114. * @param scene defines the current scene where to apply this optimization
  153115. * @param optimizer defines the current optimizer
  153116. * @returns true if everything that can be done was applied
  153117. */
  153118. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153119. }
  153120. /**
  153121. * Defines an optimization used to turn lens flares off
  153122. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153123. */
  153124. export class LensFlaresOptimization extends SceneOptimization {
  153125. /**
  153126. * Gets a string describing the action executed by the current optimization
  153127. * @return description string
  153128. */
  153129. getDescription(): string;
  153130. /**
  153131. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153132. * @param scene defines the current scene where to apply this optimization
  153133. * @param optimizer defines the current optimizer
  153134. * @returns true if everything that can be done was applied
  153135. */
  153136. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153137. }
  153138. /**
  153139. * Defines an optimization based on user defined callback.
  153140. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153141. */
  153142. export class CustomOptimization extends SceneOptimization {
  153143. /**
  153144. * Callback called to apply the custom optimization.
  153145. */
  153146. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  153147. /**
  153148. * Callback called to get custom description
  153149. */
  153150. onGetDescription: () => string;
  153151. /**
  153152. * Gets a string describing the action executed by the current optimization
  153153. * @returns description string
  153154. */
  153155. getDescription(): string;
  153156. /**
  153157. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153158. * @param scene defines the current scene where to apply this optimization
  153159. * @param optimizer defines the current optimizer
  153160. * @returns true if everything that can be done was applied
  153161. */
  153162. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153163. }
  153164. /**
  153165. * Defines an optimization used to turn particles off
  153166. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153167. */
  153168. export class ParticlesOptimization extends SceneOptimization {
  153169. /**
  153170. * Gets a string describing the action executed by the current optimization
  153171. * @return description string
  153172. */
  153173. getDescription(): string;
  153174. /**
  153175. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153176. * @param scene defines the current scene where to apply this optimization
  153177. * @param optimizer defines the current optimizer
  153178. * @returns true if everything that can be done was applied
  153179. */
  153180. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153181. }
  153182. /**
  153183. * Defines an optimization used to turn render targets off
  153184. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153185. */
  153186. export class RenderTargetsOptimization extends SceneOptimization {
  153187. /**
  153188. * Gets a string describing the action executed by the current optimization
  153189. * @return description string
  153190. */
  153191. getDescription(): string;
  153192. /**
  153193. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153194. * @param scene defines the current scene where to apply this optimization
  153195. * @param optimizer defines the current optimizer
  153196. * @returns true if everything that can be done was applied
  153197. */
  153198. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153199. }
  153200. /**
  153201. * Defines an optimization used to merge meshes with compatible materials
  153202. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153203. */
  153204. export class MergeMeshesOptimization extends SceneOptimization {
  153205. private static _UpdateSelectionTree;
  153206. /**
  153207. * Gets or sets a boolean which defines if optimization octree has to be updated
  153208. */
  153209. static get UpdateSelectionTree(): boolean;
  153210. /**
  153211. * Gets or sets a boolean which defines if optimization octree has to be updated
  153212. */
  153213. static set UpdateSelectionTree(value: boolean);
  153214. /**
  153215. * Gets a string describing the action executed by the current optimization
  153216. * @return description string
  153217. */
  153218. getDescription(): string;
  153219. private _canBeMerged;
  153220. /**
  153221. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153222. * @param scene defines the current scene where to apply this optimization
  153223. * @param optimizer defines the current optimizer
  153224. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  153225. * @returns true if everything that can be done was applied
  153226. */
  153227. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  153228. }
  153229. /**
  153230. * Defines a list of options used by SceneOptimizer
  153231. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153232. */
  153233. export class SceneOptimizerOptions {
  153234. /**
  153235. * Defines the target frame rate to reach (60 by default)
  153236. */
  153237. targetFrameRate: number;
  153238. /**
  153239. * Defines the interval between two checkes (2000ms by default)
  153240. */
  153241. trackerDuration: number;
  153242. /**
  153243. * Gets the list of optimizations to apply
  153244. */
  153245. optimizations: SceneOptimization[];
  153246. /**
  153247. * Creates a new list of options used by SceneOptimizer
  153248. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  153249. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  153250. */
  153251. constructor(
  153252. /**
  153253. * Defines the target frame rate to reach (60 by default)
  153254. */
  153255. targetFrameRate?: number,
  153256. /**
  153257. * Defines the interval between two checkes (2000ms by default)
  153258. */
  153259. trackerDuration?: number);
  153260. /**
  153261. * Add a new optimization
  153262. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  153263. * @returns the current SceneOptimizerOptions
  153264. */
  153265. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  153266. /**
  153267. * Add a new custom optimization
  153268. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  153269. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  153270. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153271. * @returns the current SceneOptimizerOptions
  153272. */
  153273. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  153274. /**
  153275. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  153276. * @param targetFrameRate defines the target frame rate (60 by default)
  153277. * @returns a SceneOptimizerOptions object
  153278. */
  153279. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  153280. /**
  153281. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  153282. * @param targetFrameRate defines the target frame rate (60 by default)
  153283. * @returns a SceneOptimizerOptions object
  153284. */
  153285. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  153286. /**
  153287. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  153288. * @param targetFrameRate defines the target frame rate (60 by default)
  153289. * @returns a SceneOptimizerOptions object
  153290. */
  153291. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  153292. }
  153293. /**
  153294. * Class used to run optimizations in order to reach a target frame rate
  153295. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153296. */
  153297. export class SceneOptimizer implements IDisposable {
  153298. private _isRunning;
  153299. private _options;
  153300. private _scene;
  153301. private _currentPriorityLevel;
  153302. private _targetFrameRate;
  153303. private _trackerDuration;
  153304. private _currentFrameRate;
  153305. private _sceneDisposeObserver;
  153306. private _improvementMode;
  153307. /**
  153308. * Defines an observable called when the optimizer reaches the target frame rate
  153309. */
  153310. onSuccessObservable: Observable<SceneOptimizer>;
  153311. /**
  153312. * Defines an observable called when the optimizer enables an optimization
  153313. */
  153314. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  153315. /**
  153316. * Defines an observable called when the optimizer is not able to reach the target frame rate
  153317. */
  153318. onFailureObservable: Observable<SceneOptimizer>;
  153319. /**
  153320. * Gets a boolean indicating if the optimizer is in improvement mode
  153321. */
  153322. get isInImprovementMode(): boolean;
  153323. /**
  153324. * Gets the current priority level (0 at start)
  153325. */
  153326. get currentPriorityLevel(): number;
  153327. /**
  153328. * Gets the current frame rate checked by the SceneOptimizer
  153329. */
  153330. get currentFrameRate(): number;
  153331. /**
  153332. * Gets or sets the current target frame rate (60 by default)
  153333. */
  153334. get targetFrameRate(): number;
  153335. /**
  153336. * Gets or sets the current target frame rate (60 by default)
  153337. */
  153338. set targetFrameRate(value: number);
  153339. /**
  153340. * Gets or sets the current interval between two checks (every 2000ms by default)
  153341. */
  153342. get trackerDuration(): number;
  153343. /**
  153344. * Gets or sets the current interval between two checks (every 2000ms by default)
  153345. */
  153346. set trackerDuration(value: number);
  153347. /**
  153348. * Gets the list of active optimizations
  153349. */
  153350. get optimizations(): SceneOptimization[];
  153351. /**
  153352. * Creates a new SceneOptimizer
  153353. * @param scene defines the scene to work on
  153354. * @param options defines the options to use with the SceneOptimizer
  153355. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  153356. * @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)
  153357. */
  153358. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  153359. /**
  153360. * Stops the current optimizer
  153361. */
  153362. stop(): void;
  153363. /**
  153364. * Reset the optimizer to initial step (current priority level = 0)
  153365. */
  153366. reset(): void;
  153367. /**
  153368. * Start the optimizer. By default it will try to reach a specific framerate
  153369. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  153370. */
  153371. start(): void;
  153372. private _checkCurrentState;
  153373. /**
  153374. * Release all resources
  153375. */
  153376. dispose(): void;
  153377. /**
  153378. * Helper function to create a SceneOptimizer with one single line of code
  153379. * @param scene defines the scene to work on
  153380. * @param options defines the options to use with the SceneOptimizer
  153381. * @param onSuccess defines a callback to call on success
  153382. * @param onFailure defines a callback to call on failure
  153383. * @returns the new SceneOptimizer object
  153384. */
  153385. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  153386. }
  153387. }
  153388. declare module BABYLON {
  153389. /**
  153390. * Class used to serialize a scene into a string
  153391. */
  153392. export class SceneSerializer {
  153393. /**
  153394. * Clear cache used by a previous serialization
  153395. */
  153396. static ClearCache(): void;
  153397. /**
  153398. * Serialize a scene into a JSON compatible object
  153399. * @param scene defines the scene to serialize
  153400. * @returns a JSON compatible object
  153401. */
  153402. static Serialize(scene: Scene): any;
  153403. /**
  153404. * Serialize a mesh into a JSON compatible object
  153405. * @param toSerialize defines the mesh to serialize
  153406. * @param withParents defines if parents must be serialized as well
  153407. * @param withChildren defines if children must be serialized as well
  153408. * @returns a JSON compatible object
  153409. */
  153410. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  153411. }
  153412. }
  153413. declare module BABYLON {
  153414. /**
  153415. * Class used to host texture specific utilities
  153416. */
  153417. export class TextureTools {
  153418. /**
  153419. * Uses the GPU to create a copy texture rescaled at a given size
  153420. * @param texture Texture to copy from
  153421. * @param width defines the desired width
  153422. * @param height defines the desired height
  153423. * @param useBilinearMode defines if bilinear mode has to be used
  153424. * @return the generated texture
  153425. */
  153426. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  153427. }
  153428. }
  153429. declare module BABYLON {
  153430. /**
  153431. * This represents the different options available for the video capture.
  153432. */
  153433. export interface VideoRecorderOptions {
  153434. /** Defines the mime type of the video. */
  153435. mimeType: string;
  153436. /** Defines the FPS the video should be recorded at. */
  153437. fps: number;
  153438. /** Defines the chunk size for the recording data. */
  153439. recordChunckSize: number;
  153440. /** The audio tracks to attach to the recording. */
  153441. audioTracks?: MediaStreamTrack[];
  153442. }
  153443. /**
  153444. * This can help with recording videos from BabylonJS.
  153445. * This is based on the available WebRTC functionalities of the browser.
  153446. *
  153447. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  153448. */
  153449. export class VideoRecorder {
  153450. private static readonly _defaultOptions;
  153451. /**
  153452. * Returns whether or not the VideoRecorder is available in your browser.
  153453. * @param engine Defines the Babylon Engine.
  153454. * @returns true if supported otherwise false.
  153455. */
  153456. static IsSupported(engine: Engine): boolean;
  153457. private readonly _options;
  153458. private _canvas;
  153459. private _mediaRecorder;
  153460. private _recordedChunks;
  153461. private _fileName;
  153462. private _resolve;
  153463. private _reject;
  153464. /**
  153465. * True when a recording is already in progress.
  153466. */
  153467. get isRecording(): boolean;
  153468. /**
  153469. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  153470. * @param engine Defines the BabylonJS Engine you wish to record.
  153471. * @param options Defines options that can be used to customize the capture.
  153472. */
  153473. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  153474. /**
  153475. * Stops the current recording before the default capture timeout passed in the startRecording function.
  153476. */
  153477. stopRecording(): void;
  153478. /**
  153479. * Starts recording the canvas for a max duration specified in parameters.
  153480. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  153481. * If null no automatic download will start and you can rely on the promise to get the data back.
  153482. * @param maxDuration Defines the maximum recording time in seconds.
  153483. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  153484. * @return A promise callback at the end of the recording with the video data in Blob.
  153485. */
  153486. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  153487. /**
  153488. * Releases internal resources used during the recording.
  153489. */
  153490. dispose(): void;
  153491. private _handleDataAvailable;
  153492. private _handleError;
  153493. private _handleStop;
  153494. }
  153495. }
  153496. declare module BABYLON {
  153497. /**
  153498. * Class containing a set of static utilities functions for screenshots
  153499. */
  153500. export class ScreenshotTools {
  153501. /**
  153502. * Captures a screenshot of the current rendering
  153503. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153504. * @param engine defines the rendering engine
  153505. * @param camera defines the source camera
  153506. * @param size This parameter can be set to a single number or to an object with the
  153507. * following (optional) properties: precision, width, height. If a single number is passed,
  153508. * it will be used for both width and height. If an object is passed, the screenshot size
  153509. * will be derived from the parameters. The precision property is a multiplier allowing
  153510. * rendering at a higher or lower resolution
  153511. * @param successCallback defines the callback receives a single parameter which contains the
  153512. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  153513. * src parameter of an <img> to display it
  153514. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  153515. * Check your browser for supported MIME types
  153516. */
  153517. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  153518. /**
  153519. * Captures a screenshot of the current rendering
  153520. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153521. * @param engine defines the rendering engine
  153522. * @param camera defines the source camera
  153523. * @param size This parameter can be set to a single number or to an object with the
  153524. * following (optional) properties: precision, width, height. If a single number is passed,
  153525. * it will be used for both width and height. If an object is passed, the screenshot size
  153526. * will be derived from the parameters. The precision property is a multiplier allowing
  153527. * rendering at a higher or lower resolution
  153528. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  153529. * Check your browser for supported MIME types
  153530. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  153531. * to the src parameter of an <img> to display it
  153532. */
  153533. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  153534. /**
  153535. * Generates an image screenshot from the specified camera.
  153536. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153537. * @param engine The engine to use for rendering
  153538. * @param camera The camera to use for rendering
  153539. * @param size This parameter can be set to a single number or to an object with the
  153540. * following (optional) properties: precision, width, height. If a single number is passed,
  153541. * it will be used for both width and height. If an object is passed, the screenshot size
  153542. * will be derived from the parameters. The precision property is a multiplier allowing
  153543. * rendering at a higher or lower resolution
  153544. * @param successCallback The callback receives a single parameter which contains the
  153545. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  153546. * src parameter of an <img> to display it
  153547. * @param mimeType The MIME type of the screenshot image (default: image/png).
  153548. * Check your browser for supported MIME types
  153549. * @param samples Texture samples (default: 1)
  153550. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  153551. * @param fileName A name for for the downloaded file.
  153552. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  153553. * @param enableStencilBuffer Whether the stencil buffer should be enabled or not (default: false)
  153554. */
  153555. 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;
  153556. /**
  153557. * Generates an image screenshot from the specified camera.
  153558. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153559. * @param engine The engine to use for rendering
  153560. * @param camera The camera to use for rendering
  153561. * @param size This parameter can be set to a single number or to an object with the
  153562. * following (optional) properties: precision, width, height. If a single number is passed,
  153563. * it will be used for both width and height. If an object is passed, the screenshot size
  153564. * will be derived from the parameters. The precision property is a multiplier allowing
  153565. * rendering at a higher or lower resolution
  153566. * @param mimeType The MIME type of the screenshot image (default: image/png).
  153567. * Check your browser for supported MIME types
  153568. * @param samples Texture samples (default: 1)
  153569. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  153570. * @param fileName A name for for the downloaded file.
  153571. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  153572. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  153573. * to the src parameter of an <img> to display it
  153574. */
  153575. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  153576. /**
  153577. * Gets height and width for screenshot size
  153578. * @private
  153579. */
  153580. private static _getScreenshotSize;
  153581. }
  153582. }
  153583. declare module BABYLON {
  153584. /**
  153585. * Interface for a data buffer
  153586. */
  153587. export interface IDataBuffer {
  153588. /**
  153589. * Reads bytes from the data buffer.
  153590. * @param byteOffset The byte offset to read
  153591. * @param byteLength The byte length to read
  153592. * @returns A promise that resolves when the bytes are read
  153593. */
  153594. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  153595. /**
  153596. * The byte length of the buffer.
  153597. */
  153598. readonly byteLength: number;
  153599. }
  153600. /**
  153601. * Utility class for reading from a data buffer
  153602. */
  153603. export class DataReader {
  153604. /**
  153605. * The data buffer associated with this data reader.
  153606. */
  153607. readonly buffer: IDataBuffer;
  153608. /**
  153609. * The current byte offset from the beginning of the data buffer.
  153610. */
  153611. byteOffset: number;
  153612. private _dataView;
  153613. private _dataByteOffset;
  153614. /**
  153615. * Constructor
  153616. * @param buffer The buffer to read
  153617. */
  153618. constructor(buffer: IDataBuffer);
  153619. /**
  153620. * Loads the given byte length.
  153621. * @param byteLength The byte length to load
  153622. * @returns A promise that resolves when the load is complete
  153623. */
  153624. loadAsync(byteLength: number): Promise<void>;
  153625. /**
  153626. * Read a unsigned 32-bit integer from the currently loaded data range.
  153627. * @returns The 32-bit integer read
  153628. */
  153629. readUint32(): number;
  153630. /**
  153631. * Read a byte array from the currently loaded data range.
  153632. * @param byteLength The byte length to read
  153633. * @returns The byte array read
  153634. */
  153635. readUint8Array(byteLength: number): Uint8Array;
  153636. /**
  153637. * Read a string from the currently loaded data range.
  153638. * @param byteLength The byte length to read
  153639. * @returns The string read
  153640. */
  153641. readString(byteLength: number): string;
  153642. /**
  153643. * Skips the given byte length the currently loaded data range.
  153644. * @param byteLength The byte length to skip
  153645. */
  153646. skipBytes(byteLength: number): void;
  153647. }
  153648. }
  153649. declare module BABYLON {
  153650. /**
  153651. * Class for storing data to local storage if available or in-memory storage otherwise
  153652. */
  153653. export class DataStorage {
  153654. private static _Storage;
  153655. private static _GetStorage;
  153656. /**
  153657. * Reads a string from the data storage
  153658. * @param key The key to read
  153659. * @param defaultValue The value if the key doesn't exist
  153660. * @returns The string value
  153661. */
  153662. static ReadString(key: string, defaultValue: string): string;
  153663. /**
  153664. * Writes a string to the data storage
  153665. * @param key The key to write
  153666. * @param value The value to write
  153667. */
  153668. static WriteString(key: string, value: string): void;
  153669. /**
  153670. * Reads a boolean from the data storage
  153671. * @param key The key to read
  153672. * @param defaultValue The value if the key doesn't exist
  153673. * @returns The boolean value
  153674. */
  153675. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  153676. /**
  153677. * Writes a boolean to the data storage
  153678. * @param key The key to write
  153679. * @param value The value to write
  153680. */
  153681. static WriteBoolean(key: string, value: boolean): void;
  153682. /**
  153683. * Reads a number from the data storage
  153684. * @param key The key to read
  153685. * @param defaultValue The value if the key doesn't exist
  153686. * @returns The number value
  153687. */
  153688. static ReadNumber(key: string, defaultValue: number): number;
  153689. /**
  153690. * Writes a number to the data storage
  153691. * @param key The key to write
  153692. * @param value The value to write
  153693. */
  153694. static WriteNumber(key: string, value: number): void;
  153695. }
  153696. }
  153697. declare module BABYLON {
  153698. /**
  153699. * Class used to record delta files between 2 scene states
  153700. */
  153701. export class SceneRecorder {
  153702. private _trackedScene;
  153703. private _savedJSON;
  153704. /**
  153705. * Track a given scene. This means the current scene state will be considered the original state
  153706. * @param scene defines the scene to track
  153707. */
  153708. track(scene: Scene): void;
  153709. /**
  153710. * Get the delta between current state and original state
  153711. * @returns a string containing the delta
  153712. */
  153713. getDelta(): any;
  153714. private _compareArray;
  153715. private _compareObjects;
  153716. private _compareCollections;
  153717. private static GetShadowGeneratorById;
  153718. /**
  153719. * Apply a given delta to a given scene
  153720. * @param deltaJSON defines the JSON containing the delta
  153721. * @param scene defines the scene to apply the delta to
  153722. */
  153723. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  153724. private static _ApplyPropertiesToEntity;
  153725. private static _ApplyDeltaForEntity;
  153726. }
  153727. }
  153728. declare module BABYLON {
  153729. /**
  153730. * An interface for all Hit test features
  153731. */
  153732. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  153733. /**
  153734. * Triggered when new babylon (transformed) hit test results are available
  153735. */
  153736. onHitTestResultObservable: Observable<T[]>;
  153737. }
  153738. /**
  153739. * Options used for hit testing
  153740. */
  153741. export interface IWebXRLegacyHitTestOptions {
  153742. /**
  153743. * Only test when user interacted with the scene. Default - hit test every frame
  153744. */
  153745. testOnPointerDownOnly?: boolean;
  153746. /**
  153747. * The node to use to transform the local results to world coordinates
  153748. */
  153749. worldParentNode?: TransformNode;
  153750. }
  153751. /**
  153752. * Interface defining the babylon result of raycasting/hit-test
  153753. */
  153754. export interface IWebXRLegacyHitResult {
  153755. /**
  153756. * Transformation matrix that can be applied to a node that will put it in the hit point location
  153757. */
  153758. transformationMatrix: Matrix;
  153759. /**
  153760. * The native hit test result
  153761. */
  153762. xrHitResult: XRHitResult | XRHitTestResult;
  153763. }
  153764. /**
  153765. * The currently-working hit-test module.
  153766. * Hit test (or Ray-casting) is used to interact with the real world.
  153767. * For further information read here - https://github.com/immersive-web/hit-test
  153768. */
  153769. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  153770. /**
  153771. * options to use when constructing this feature
  153772. */
  153773. readonly options: IWebXRLegacyHitTestOptions;
  153774. private _direction;
  153775. private _mat;
  153776. private _onSelectEnabled;
  153777. private _origin;
  153778. /**
  153779. * The module's name
  153780. */
  153781. static readonly Name: string;
  153782. /**
  153783. * The (Babylon) version of this module.
  153784. * This is an integer representing the implementation version.
  153785. * This number does not correspond to the WebXR specs version
  153786. */
  153787. static readonly Version: number;
  153788. /**
  153789. * Populated with the last native XR Hit Results
  153790. */
  153791. lastNativeXRHitResults: XRHitResult[];
  153792. /**
  153793. * Triggered when new babylon (transformed) hit test results are available
  153794. */
  153795. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  153796. /**
  153797. * Creates a new instance of the (legacy version) hit test feature
  153798. * @param _xrSessionManager an instance of WebXRSessionManager
  153799. * @param options options to use when constructing this feature
  153800. */
  153801. constructor(_xrSessionManager: WebXRSessionManager,
  153802. /**
  153803. * options to use when constructing this feature
  153804. */
  153805. options?: IWebXRLegacyHitTestOptions);
  153806. /**
  153807. * execute a hit test with an XR Ray
  153808. *
  153809. * @param xrSession a native xrSession that will execute this hit test
  153810. * @param xrRay the ray (position and direction) to use for ray-casting
  153811. * @param referenceSpace native XR reference space to use for the hit-test
  153812. * @param filter filter function that will filter the results
  153813. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  153814. */
  153815. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  153816. /**
  153817. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  153818. * @param event the (select) event to use to select with
  153819. * @param referenceSpace the reference space to use for this hit test
  153820. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  153821. */
  153822. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  153823. /**
  153824. * attach this feature
  153825. * Will usually be called by the features manager
  153826. *
  153827. * @returns true if successful.
  153828. */
  153829. attach(): boolean;
  153830. /**
  153831. * detach this feature.
  153832. * Will usually be called by the features manager
  153833. *
  153834. * @returns true if successful.
  153835. */
  153836. detach(): boolean;
  153837. /**
  153838. * Dispose this feature and all of the resources attached
  153839. */
  153840. dispose(): void;
  153841. protected _onXRFrame(frame: XRFrame): void;
  153842. private _onHitTestResults;
  153843. private _onSelect;
  153844. }
  153845. }
  153846. declare module BABYLON {
  153847. /**
  153848. * Options used for hit testing (version 2)
  153849. */
  153850. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  153851. /**
  153852. * Do not create a permanent hit test. Will usually be used when only
  153853. * transient inputs are needed.
  153854. */
  153855. disablePermanentHitTest?: boolean;
  153856. /**
  153857. * Enable transient (for example touch-based) hit test inspections
  153858. */
  153859. enableTransientHitTest?: boolean;
  153860. /**
  153861. * Offset ray for the permanent hit test
  153862. */
  153863. offsetRay?: Vector3;
  153864. /**
  153865. * Offset ray for the transient hit test
  153866. */
  153867. transientOffsetRay?: Vector3;
  153868. /**
  153869. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  153870. */
  153871. useReferenceSpace?: boolean;
  153872. /**
  153873. * Override the default entity type(s) of the hit-test result
  153874. */
  153875. entityTypes?: XRHitTestTrackableType[];
  153876. }
  153877. /**
  153878. * Interface defining the babylon result of hit-test
  153879. */
  153880. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  153881. /**
  153882. * The input source that generated this hit test (if transient)
  153883. */
  153884. inputSource?: XRInputSource;
  153885. /**
  153886. * Is this a transient hit test
  153887. */
  153888. isTransient?: boolean;
  153889. /**
  153890. * Position of the hit test result
  153891. */
  153892. position: Vector3;
  153893. /**
  153894. * Rotation of the hit test result
  153895. */
  153896. rotationQuaternion: Quaternion;
  153897. /**
  153898. * The native hit test result
  153899. */
  153900. xrHitResult: XRHitTestResult;
  153901. }
  153902. /**
  153903. * The currently-working hit-test module.
  153904. * Hit test (or Ray-casting) is used to interact with the real world.
  153905. * For further information read here - https://github.com/immersive-web/hit-test
  153906. *
  153907. * Tested on chrome (mobile) 80.
  153908. */
  153909. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  153910. /**
  153911. * options to use when constructing this feature
  153912. */
  153913. readonly options: IWebXRHitTestOptions;
  153914. private _tmpMat;
  153915. private _tmpPos;
  153916. private _tmpQuat;
  153917. private _transientXrHitTestSource;
  153918. private _xrHitTestSource;
  153919. private initHitTestSource;
  153920. /**
  153921. * The module's name
  153922. */
  153923. static readonly Name: string;
  153924. /**
  153925. * The (Babylon) version of this module.
  153926. * This is an integer representing the implementation version.
  153927. * This number does not correspond to the WebXR specs version
  153928. */
  153929. static readonly Version: number;
  153930. /**
  153931. * When set to true, each hit test will have its own position/rotation objects
  153932. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  153933. * the developers will clone them or copy them as they see fit.
  153934. */
  153935. autoCloneTransformation: boolean;
  153936. /**
  153937. * Triggered when new babylon (transformed) hit test results are available
  153938. */
  153939. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  153940. /**
  153941. * Use this to temporarily pause hit test checks.
  153942. */
  153943. paused: boolean;
  153944. /**
  153945. * Creates a new instance of the hit test feature
  153946. * @param _xrSessionManager an instance of WebXRSessionManager
  153947. * @param options options to use when constructing this feature
  153948. */
  153949. constructor(_xrSessionManager: WebXRSessionManager,
  153950. /**
  153951. * options to use when constructing this feature
  153952. */
  153953. options?: IWebXRHitTestOptions);
  153954. /**
  153955. * attach this feature
  153956. * Will usually be called by the features manager
  153957. *
  153958. * @returns true if successful.
  153959. */
  153960. attach(): boolean;
  153961. /**
  153962. * detach this feature.
  153963. * Will usually be called by the features manager
  153964. *
  153965. * @returns true if successful.
  153966. */
  153967. detach(): boolean;
  153968. /**
  153969. * Dispose this feature and all of the resources attached
  153970. */
  153971. dispose(): void;
  153972. protected _onXRFrame(frame: XRFrame): void;
  153973. private _processWebXRHitTestResult;
  153974. }
  153975. }
  153976. declare module BABYLON {
  153977. /**
  153978. * Configuration options of the anchor system
  153979. */
  153980. export interface IWebXRAnchorSystemOptions {
  153981. /**
  153982. * a node that will be used to convert local to world coordinates
  153983. */
  153984. worldParentNode?: TransformNode;
  153985. /**
  153986. * If set to true a reference of the created anchors will be kept until the next session starts
  153987. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  153988. */
  153989. doNotRemoveAnchorsOnSessionEnded?: boolean;
  153990. }
  153991. /**
  153992. * A babylon container for an XR Anchor
  153993. */
  153994. export interface IWebXRAnchor {
  153995. /**
  153996. * A babylon-assigned ID for this anchor
  153997. */
  153998. id: number;
  153999. /**
  154000. * Transformation matrix to apply to an object attached to this anchor
  154001. */
  154002. transformationMatrix: Matrix;
  154003. /**
  154004. * The native anchor object
  154005. */
  154006. xrAnchor: XRAnchor;
  154007. /**
  154008. * if defined, this object will be constantly updated by the anchor's position and rotation
  154009. */
  154010. attachedNode?: TransformNode;
  154011. }
  154012. /**
  154013. * An implementation of the anchor system for WebXR.
  154014. * For further information see https://github.com/immersive-web/anchors/
  154015. */
  154016. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  154017. private _options;
  154018. private _lastFrameDetected;
  154019. private _trackedAnchors;
  154020. private _referenceSpaceForFrameAnchors;
  154021. private _futureAnchors;
  154022. /**
  154023. * The module's name
  154024. */
  154025. static readonly Name: string;
  154026. /**
  154027. * The (Babylon) version of this module.
  154028. * This is an integer representing the implementation version.
  154029. * This number does not correspond to the WebXR specs version
  154030. */
  154031. static readonly Version: number;
  154032. /**
  154033. * Observers registered here will be executed when a new anchor was added to the session
  154034. */
  154035. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  154036. /**
  154037. * Observers registered here will be executed when an anchor was removed from the session
  154038. */
  154039. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  154040. /**
  154041. * Observers registered here will be executed when an existing anchor updates
  154042. * This can execute N times every frame
  154043. */
  154044. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  154045. /**
  154046. * Set the reference space to use for anchor creation, when not using a hit test.
  154047. * Will default to the session's reference space if not defined
  154048. */
  154049. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  154050. /**
  154051. * constructs a new anchor system
  154052. * @param _xrSessionManager an instance of WebXRSessionManager
  154053. * @param _options configuration object for this feature
  154054. */
  154055. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  154056. private _tmpVector;
  154057. private _tmpQuaternion;
  154058. private _populateTmpTransformation;
  154059. /**
  154060. * Create a new anchor point using a hit test result at a specific point in the scene
  154061. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  154062. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  154063. *
  154064. * @param hitTestResult The hit test result to use for this anchor creation
  154065. * @param position an optional position offset for this anchor
  154066. * @param rotationQuaternion an optional rotation offset for this anchor
  154067. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  154068. */
  154069. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  154070. /**
  154071. * Add a new anchor at a specific position and rotation
  154072. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  154073. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  154074. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  154075. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  154076. *
  154077. * @param position the position in which to add an anchor
  154078. * @param rotationQuaternion an optional rotation for the anchor transformation
  154079. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  154080. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  154081. */
  154082. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  154083. /**
  154084. * detach this feature.
  154085. * Will usually be called by the features manager
  154086. *
  154087. * @returns true if successful.
  154088. */
  154089. detach(): boolean;
  154090. /**
  154091. * Dispose this feature and all of the resources attached
  154092. */
  154093. dispose(): void;
  154094. protected _onXRFrame(frame: XRFrame): void;
  154095. /**
  154096. * avoiding using Array.find for global support.
  154097. * @param xrAnchor the plane to find in the array
  154098. */
  154099. private _findIndexInAnchorArray;
  154100. private _updateAnchorWithXRFrame;
  154101. private _createAnchorAtTransformation;
  154102. }
  154103. }
  154104. declare module BABYLON {
  154105. /**
  154106. * Options used in the plane detector module
  154107. */
  154108. export interface IWebXRPlaneDetectorOptions {
  154109. /**
  154110. * The node to use to transform the local results to world coordinates
  154111. */
  154112. worldParentNode?: TransformNode;
  154113. /**
  154114. * If set to true a reference of the created planes will be kept until the next session starts
  154115. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  154116. */
  154117. doNotRemovePlanesOnSessionEnded?: boolean;
  154118. }
  154119. /**
  154120. * A babylon interface for a WebXR plane.
  154121. * A Plane is actually a polygon, built from N points in space
  154122. *
  154123. * Supported in chrome 79, not supported in canary 81 ATM
  154124. */
  154125. export interface IWebXRPlane {
  154126. /**
  154127. * a babylon-assigned ID for this polygon
  154128. */
  154129. id: number;
  154130. /**
  154131. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  154132. */
  154133. polygonDefinition: Array<Vector3>;
  154134. /**
  154135. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  154136. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  154137. */
  154138. transformationMatrix: Matrix;
  154139. /**
  154140. * the native xr-plane object
  154141. */
  154142. xrPlane: XRPlane;
  154143. }
  154144. /**
  154145. * The plane detector is used to detect planes in the real world when in AR
  154146. * For more information see https://github.com/immersive-web/real-world-geometry/
  154147. */
  154148. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  154149. private _options;
  154150. private _detectedPlanes;
  154151. private _enabled;
  154152. private _lastFrameDetected;
  154153. /**
  154154. * The module's name
  154155. */
  154156. static readonly Name: string;
  154157. /**
  154158. * The (Babylon) version of this module.
  154159. * This is an integer representing the implementation version.
  154160. * This number does not correspond to the WebXR specs version
  154161. */
  154162. static readonly Version: number;
  154163. /**
  154164. * Observers registered here will be executed when a new plane was added to the session
  154165. */
  154166. onPlaneAddedObservable: Observable<IWebXRPlane>;
  154167. /**
  154168. * Observers registered here will be executed when a plane is no longer detected in the session
  154169. */
  154170. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  154171. /**
  154172. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  154173. * This can execute N times every frame
  154174. */
  154175. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  154176. /**
  154177. * construct a new Plane Detector
  154178. * @param _xrSessionManager an instance of xr Session manager
  154179. * @param _options configuration to use when constructing this feature
  154180. */
  154181. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  154182. /**
  154183. * detach this feature.
  154184. * Will usually be called by the features manager
  154185. *
  154186. * @returns true if successful.
  154187. */
  154188. detach(): boolean;
  154189. /**
  154190. * Dispose this feature and all of the resources attached
  154191. */
  154192. dispose(): void;
  154193. protected _onXRFrame(frame: XRFrame): void;
  154194. private _init;
  154195. private _updatePlaneWithXRPlane;
  154196. /**
  154197. * avoiding using Array.find for global support.
  154198. * @param xrPlane the plane to find in the array
  154199. */
  154200. private findIndexInPlaneArray;
  154201. }
  154202. }
  154203. declare module BABYLON {
  154204. /**
  154205. * Options interface for the background remover plugin
  154206. */
  154207. export interface IWebXRBackgroundRemoverOptions {
  154208. /**
  154209. * Further background meshes to disable when entering AR
  154210. */
  154211. backgroundMeshes?: AbstractMesh[];
  154212. /**
  154213. * flags to configure the removal of the environment helper.
  154214. * If not set, the entire background will be removed. If set, flags should be set as well.
  154215. */
  154216. environmentHelperRemovalFlags?: {
  154217. /**
  154218. * Should the skybox be removed (default false)
  154219. */
  154220. skyBox?: boolean;
  154221. /**
  154222. * Should the ground be removed (default false)
  154223. */
  154224. ground?: boolean;
  154225. };
  154226. /**
  154227. * don't disable the environment helper
  154228. */
  154229. ignoreEnvironmentHelper?: boolean;
  154230. }
  154231. /**
  154232. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  154233. */
  154234. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  154235. /**
  154236. * read-only options to be used in this module
  154237. */
  154238. readonly options: IWebXRBackgroundRemoverOptions;
  154239. /**
  154240. * The module's name
  154241. */
  154242. static readonly Name: string;
  154243. /**
  154244. * The (Babylon) version of this module.
  154245. * This is an integer representing the implementation version.
  154246. * This number does not correspond to the WebXR specs version
  154247. */
  154248. static readonly Version: number;
  154249. /**
  154250. * registered observers will be triggered when the background state changes
  154251. */
  154252. onBackgroundStateChangedObservable: Observable<boolean>;
  154253. /**
  154254. * constructs a new background remover module
  154255. * @param _xrSessionManager the session manager for this module
  154256. * @param options read-only options to be used in this module
  154257. */
  154258. constructor(_xrSessionManager: WebXRSessionManager,
  154259. /**
  154260. * read-only options to be used in this module
  154261. */
  154262. options?: IWebXRBackgroundRemoverOptions);
  154263. /**
  154264. * attach this feature
  154265. * Will usually be called by the features manager
  154266. *
  154267. * @returns true if successful.
  154268. */
  154269. attach(): boolean;
  154270. /**
  154271. * detach this feature.
  154272. * Will usually be called by the features manager
  154273. *
  154274. * @returns true if successful.
  154275. */
  154276. detach(): boolean;
  154277. /**
  154278. * Dispose this feature and all of the resources attached
  154279. */
  154280. dispose(): void;
  154281. protected _onXRFrame(_xrFrame: XRFrame): void;
  154282. private _setBackgroundState;
  154283. }
  154284. }
  154285. declare module BABYLON {
  154286. /**
  154287. * Options for the controller physics feature
  154288. */
  154289. export class IWebXRControllerPhysicsOptions {
  154290. /**
  154291. * Should the headset get its own impostor
  154292. */
  154293. enableHeadsetImpostor?: boolean;
  154294. /**
  154295. * Optional parameters for the headset impostor
  154296. */
  154297. headsetImpostorParams?: {
  154298. /**
  154299. * The type of impostor to create. Default is sphere
  154300. */
  154301. impostorType: number;
  154302. /**
  154303. * the size of the impostor. Defaults to 10cm
  154304. */
  154305. impostorSize?: number | {
  154306. width: number;
  154307. height: number;
  154308. depth: number;
  154309. };
  154310. /**
  154311. * Friction definitions
  154312. */
  154313. friction?: number;
  154314. /**
  154315. * Restitution
  154316. */
  154317. restitution?: number;
  154318. };
  154319. /**
  154320. * The physics properties of the future impostors
  154321. */
  154322. physicsProperties?: {
  154323. /**
  154324. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  154325. * Note that this requires a physics engine that supports mesh impostors!
  154326. */
  154327. useControllerMesh?: boolean;
  154328. /**
  154329. * The type of impostor to create. Default is sphere
  154330. */
  154331. impostorType?: number;
  154332. /**
  154333. * the size of the impostor. Defaults to 10cm
  154334. */
  154335. impostorSize?: number | {
  154336. width: number;
  154337. height: number;
  154338. depth: number;
  154339. };
  154340. /**
  154341. * Friction definitions
  154342. */
  154343. friction?: number;
  154344. /**
  154345. * Restitution
  154346. */
  154347. restitution?: number;
  154348. };
  154349. /**
  154350. * the xr input to use with this pointer selection
  154351. */
  154352. xrInput: WebXRInput;
  154353. }
  154354. /**
  154355. * Add physics impostor to your webxr controllers,
  154356. * including naive calculation of their linear and angular velocity
  154357. */
  154358. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  154359. private readonly _options;
  154360. private _attachController;
  154361. private _controllers;
  154362. private _debugMode;
  154363. private _delta;
  154364. private _headsetImpostor?;
  154365. private _headsetMesh?;
  154366. private _lastTimestamp;
  154367. private _tmpQuaternion;
  154368. private _tmpVector;
  154369. /**
  154370. * The module's name
  154371. */
  154372. static readonly Name: string;
  154373. /**
  154374. * The (Babylon) version of this module.
  154375. * This is an integer representing the implementation version.
  154376. * This number does not correspond to the webxr specs version
  154377. */
  154378. static readonly Version: number;
  154379. /**
  154380. * Construct a new Controller Physics Feature
  154381. * @param _xrSessionManager the corresponding xr session manager
  154382. * @param _options options to create this feature with
  154383. */
  154384. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  154385. /**
  154386. * @hidden
  154387. * enable debugging - will show console outputs and the impostor mesh
  154388. */
  154389. _enablePhysicsDebug(): void;
  154390. /**
  154391. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  154392. * @param xrController the controller to add
  154393. */
  154394. addController(xrController: WebXRInputSource): void;
  154395. /**
  154396. * attach this feature
  154397. * Will usually be called by the features manager
  154398. *
  154399. * @returns true if successful.
  154400. */
  154401. attach(): boolean;
  154402. /**
  154403. * detach this feature.
  154404. * Will usually be called by the features manager
  154405. *
  154406. * @returns true if successful.
  154407. */
  154408. detach(): boolean;
  154409. /**
  154410. * Get the headset impostor, if enabled
  154411. * @returns the impostor
  154412. */
  154413. getHeadsetImpostor(): PhysicsImpostor | undefined;
  154414. /**
  154415. * Get the physics impostor of a specific controller.
  154416. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  154417. * @param controller the controller or the controller id of which to get the impostor
  154418. * @returns the impostor or null
  154419. */
  154420. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  154421. /**
  154422. * Update the physics properties provided in the constructor
  154423. * @param newProperties the new properties object
  154424. */
  154425. setPhysicsProperties(newProperties: {
  154426. impostorType?: number;
  154427. impostorSize?: number | {
  154428. width: number;
  154429. height: number;
  154430. depth: number;
  154431. };
  154432. friction?: number;
  154433. restitution?: number;
  154434. }): void;
  154435. protected _onXRFrame(_xrFrame: any): void;
  154436. private _detachController;
  154437. }
  154438. }
  154439. declare module BABYLON {
  154440. /**
  154441. * A babylon interface for a "WebXR" feature point.
  154442. * Represents the position and confidence value of a given feature point.
  154443. */
  154444. export interface IWebXRFeaturePoint {
  154445. /**
  154446. * Represents the position of the feature point in world space.
  154447. */
  154448. position: Vector3;
  154449. /**
  154450. * Represents the confidence value of the feature point in world space. 0 being least confident, and 1 being most confident.
  154451. */
  154452. confidenceValue: number;
  154453. }
  154454. /**
  154455. * The feature point system is used to detect feature points from real world geometry.
  154456. * This feature is currently experimental and only supported on BabylonNative, and should not be used in the browser.
  154457. * The newly introduced API can be seen in webxr.nativeextensions.d.ts and described in FeaturePoints.md.
  154458. */
  154459. export class WebXRFeaturePointSystem extends WebXRAbstractFeature {
  154460. private _enabled;
  154461. private _featurePointCloud;
  154462. /**
  154463. * The module's name
  154464. */
  154465. static readonly Name: string;
  154466. /**
  154467. * The (Babylon) version of this module.
  154468. * This is an integer representing the implementation version.
  154469. * This number does not correspond to the WebXR specs version
  154470. */
  154471. static readonly Version: number;
  154472. /**
  154473. * Observers registered here will be executed whenever new feature points are added (on XRFrame while the session is tracking).
  154474. * Will notify the observers about which feature points have been added.
  154475. */
  154476. readonly onFeaturePointsAddedObservable: Observable<number[]>;
  154477. /**
  154478. * Observers registered here will be executed whenever a feature point has been updated (on XRFrame while the session is tracking).
  154479. * Will notify the observers about which feature points have been updated.
  154480. */
  154481. readonly onFeaturePointsUpdatedObservable: Observable<number[]>;
  154482. /**
  154483. * The current feature point cloud maintained across frames.
  154484. */
  154485. get featurePointCloud(): Array<IWebXRFeaturePoint>;
  154486. /**
  154487. * construct the feature point system
  154488. * @param _xrSessionManager an instance of xr Session manager
  154489. */
  154490. constructor(_xrSessionManager: WebXRSessionManager);
  154491. /**
  154492. * Detach this feature.
  154493. * Will usually be called by the features manager
  154494. *
  154495. * @returns true if successful.
  154496. */
  154497. detach(): boolean;
  154498. /**
  154499. * Dispose this feature and all of the resources attached
  154500. */
  154501. dispose(): void;
  154502. /**
  154503. * On receiving a new XR frame if this feature is attached notify observers new feature point data is available.
  154504. */
  154505. protected _onXRFrame(frame: XRFrame): void;
  154506. /**
  154507. * Initializes the feature. If the feature point feature is not available for this environment do not mark the feature as enabled.
  154508. */
  154509. private _init;
  154510. }
  154511. }
  154512. declare module BABYLON {
  154513. /**
  154514. * Configuration interface for the hand tracking feature
  154515. */
  154516. export interface IWebXRHandTrackingOptions {
  154517. /**
  154518. * The xrInput that will be used as source for new hands
  154519. */
  154520. xrInput: WebXRInput;
  154521. /**
  154522. * Configuration object for the joint meshes
  154523. */
  154524. jointMeshes?: {
  154525. /**
  154526. * Should the meshes created be invisible (defaults to false)
  154527. */
  154528. invisible?: boolean;
  154529. /**
  154530. * A source mesh to be used to create instances. Defaults to a sphere.
  154531. * This mesh will be the source for all other (25) meshes.
  154532. * It should have the general size of a single unit, as the instances will be scaled according to the provided radius
  154533. */
  154534. sourceMesh?: Mesh;
  154535. /**
  154536. * Should the source mesh stay visible. Defaults to false
  154537. */
  154538. keepOriginalVisible?: boolean;
  154539. /**
  154540. * Scale factor for all instances (defaults to 2)
  154541. */
  154542. scaleFactor?: number;
  154543. /**
  154544. * Should each instance have its own physics impostor
  154545. */
  154546. enablePhysics?: boolean;
  154547. /**
  154548. * If enabled, override default physics properties
  154549. */
  154550. physicsProps?: {
  154551. friction?: number;
  154552. restitution?: number;
  154553. impostorType?: number;
  154554. };
  154555. /**
  154556. * For future use - a single hand-mesh that will be updated according to the XRHand data provided
  154557. */
  154558. handMesh?: AbstractMesh;
  154559. };
  154560. }
  154561. /**
  154562. * Parts of the hands divided to writs and finger names
  154563. */
  154564. export const enum HandPart {
  154565. /**
  154566. * HandPart - Wrist
  154567. */
  154568. WRIST = "wrist",
  154569. /**
  154570. * HandPart - The THumb
  154571. */
  154572. THUMB = "thumb",
  154573. /**
  154574. * HandPart - Index finger
  154575. */
  154576. INDEX = "index",
  154577. /**
  154578. * HandPart - Middle finger
  154579. */
  154580. MIDDLE = "middle",
  154581. /**
  154582. * HandPart - Ring finger
  154583. */
  154584. RING = "ring",
  154585. /**
  154586. * HandPart - Little finger
  154587. */
  154588. LITTLE = "little"
  154589. }
  154590. /**
  154591. * Representing a single hand (with its corresponding native XRHand object)
  154592. */
  154593. export class WebXRHand implements IDisposable {
  154594. /** the controller to which the hand correlates */
  154595. readonly xrController: WebXRInputSource;
  154596. /** the meshes to be used to track the hand joints */
  154597. readonly trackedMeshes: AbstractMesh[];
  154598. /**
  154599. * Hand-parts definition (key is HandPart)
  154600. */
  154601. static HandPartsDefinition: {
  154602. [key: string]: number[];
  154603. };
  154604. /**
  154605. * Populate the HandPartsDefinition object.
  154606. * This is called as a side effect since certain browsers don't have XRHand defined.
  154607. */
  154608. static _PopulateHandPartsDefinition(): void;
  154609. /**
  154610. * Construct a new hand object
  154611. * @param xrController the controller to which the hand correlates
  154612. * @param trackedMeshes the meshes to be used to track the hand joints
  154613. */
  154614. constructor(
  154615. /** the controller to which the hand correlates */
  154616. xrController: WebXRInputSource,
  154617. /** the meshes to be used to track the hand joints */
  154618. trackedMeshes: AbstractMesh[]);
  154619. /**
  154620. * Update this hand from the latest xr frame
  154621. * @param xrFrame xrFrame to update from
  154622. * @param referenceSpace The current viewer reference space
  154623. * @param scaleFactor optional scale factor for the meshes
  154624. */
  154625. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace, scaleFactor?: number): void;
  154626. /**
  154627. * Get meshes of part of the hand
  154628. * @param part the part of hand to get
  154629. * @returns An array of meshes that correlate to the hand part requested
  154630. */
  154631. getHandPartMeshes(part: HandPart): AbstractMesh[];
  154632. /**
  154633. * Dispose this Hand object
  154634. */
  154635. dispose(): void;
  154636. }
  154637. /**
  154638. * WebXR Hand Joint tracking feature, available for selected browsers and devices
  154639. */
  154640. export class WebXRHandTracking extends WebXRAbstractFeature {
  154641. /**
  154642. * options to use when constructing this feature
  154643. */
  154644. readonly options: IWebXRHandTrackingOptions;
  154645. private static _idCounter;
  154646. /**
  154647. * The module's name
  154648. */
  154649. static readonly Name: string;
  154650. /**
  154651. * The (Babylon) version of this module.
  154652. * This is an integer representing the implementation version.
  154653. * This number does not correspond to the WebXR specs version
  154654. */
  154655. static readonly Version: number;
  154656. /**
  154657. * This observable will notify registered observers when a new hand object was added and initialized
  154658. */
  154659. onHandAddedObservable: Observable<WebXRHand>;
  154660. /**
  154661. * This observable will notify its observers right before the hand object is disposed
  154662. */
  154663. onHandRemovedObservable: Observable<WebXRHand>;
  154664. private _hands;
  154665. /**
  154666. * Creates a new instance of the hit test feature
  154667. * @param _xrSessionManager an instance of WebXRSessionManager
  154668. * @param options options to use when constructing this feature
  154669. */
  154670. constructor(_xrSessionManager: WebXRSessionManager,
  154671. /**
  154672. * options to use when constructing this feature
  154673. */
  154674. options: IWebXRHandTrackingOptions);
  154675. /**
  154676. * Check if the needed objects are defined.
  154677. * This does not mean that the feature is enabled, but that the objects needed are well defined.
  154678. */
  154679. isCompatible(): boolean;
  154680. /**
  154681. * attach this feature
  154682. * Will usually be called by the features manager
  154683. *
  154684. * @returns true if successful.
  154685. */
  154686. attach(): boolean;
  154687. /**
  154688. * detach this feature.
  154689. * Will usually be called by the features manager
  154690. *
  154691. * @returns true if successful.
  154692. */
  154693. detach(): boolean;
  154694. /**
  154695. * Dispose this feature and all of the resources attached
  154696. */
  154697. dispose(): void;
  154698. /**
  154699. * Get the hand object according to the controller id
  154700. * @param controllerId the controller id to which we want to get the hand
  154701. * @returns null if not found or the WebXRHand object if found
  154702. */
  154703. getHandByControllerId(controllerId: string): Nullable<WebXRHand>;
  154704. /**
  154705. * Get a hand object according to the requested handedness
  154706. * @param handedness the handedness to request
  154707. * @returns null if not found or the WebXRHand object if found
  154708. */
  154709. getHandByHandedness(handedness: XRHandedness): Nullable<WebXRHand>;
  154710. protected _onXRFrame(_xrFrame: XRFrame): void;
  154711. private _attachHand;
  154712. private _detachHand;
  154713. }
  154714. }
  154715. declare module BABYLON {
  154716. /**
  154717. * The motion controller class for all microsoft mixed reality controllers
  154718. */
  154719. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  154720. protected readonly _mapping: {
  154721. defaultButton: {
  154722. valueNodeName: string;
  154723. unpressedNodeName: string;
  154724. pressedNodeName: string;
  154725. };
  154726. defaultAxis: {
  154727. valueNodeName: string;
  154728. minNodeName: string;
  154729. maxNodeName: string;
  154730. };
  154731. buttons: {
  154732. "xr-standard-trigger": {
  154733. rootNodeName: string;
  154734. componentProperty: string;
  154735. states: string[];
  154736. };
  154737. "xr-standard-squeeze": {
  154738. rootNodeName: string;
  154739. componentProperty: string;
  154740. states: string[];
  154741. };
  154742. "xr-standard-touchpad": {
  154743. rootNodeName: string;
  154744. labelAnchorNodeName: string;
  154745. touchPointNodeName: string;
  154746. };
  154747. "xr-standard-thumbstick": {
  154748. rootNodeName: string;
  154749. componentProperty: string;
  154750. states: string[];
  154751. };
  154752. };
  154753. axes: {
  154754. "xr-standard-touchpad": {
  154755. "x-axis": {
  154756. rootNodeName: string;
  154757. };
  154758. "y-axis": {
  154759. rootNodeName: string;
  154760. };
  154761. };
  154762. "xr-standard-thumbstick": {
  154763. "x-axis": {
  154764. rootNodeName: string;
  154765. };
  154766. "y-axis": {
  154767. rootNodeName: string;
  154768. };
  154769. };
  154770. };
  154771. };
  154772. /**
  154773. * The base url used to load the left and right controller models
  154774. */
  154775. static MODEL_BASE_URL: string;
  154776. /**
  154777. * The name of the left controller model file
  154778. */
  154779. static MODEL_LEFT_FILENAME: string;
  154780. /**
  154781. * The name of the right controller model file
  154782. */
  154783. static MODEL_RIGHT_FILENAME: string;
  154784. profileId: string;
  154785. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  154786. protected _getFilenameAndPath(): {
  154787. filename: string;
  154788. path: string;
  154789. };
  154790. protected _getModelLoadingConstraints(): boolean;
  154791. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  154792. protected _setRootMesh(meshes: AbstractMesh[]): void;
  154793. protected _updateModel(): void;
  154794. }
  154795. }
  154796. declare module BABYLON {
  154797. /**
  154798. * The motion controller class for oculus touch (quest, rift).
  154799. * This class supports legacy mapping as well the standard xr mapping
  154800. */
  154801. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  154802. private _forceLegacyControllers;
  154803. private _modelRootNode;
  154804. /**
  154805. * The base url used to load the left and right controller models
  154806. */
  154807. static MODEL_BASE_URL: string;
  154808. /**
  154809. * The name of the left controller model file
  154810. */
  154811. static MODEL_LEFT_FILENAME: string;
  154812. /**
  154813. * The name of the right controller model file
  154814. */
  154815. static MODEL_RIGHT_FILENAME: string;
  154816. /**
  154817. * Base Url for the Quest controller model.
  154818. */
  154819. static QUEST_MODEL_BASE_URL: string;
  154820. profileId: string;
  154821. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  154822. protected _getFilenameAndPath(): {
  154823. filename: string;
  154824. path: string;
  154825. };
  154826. protected _getModelLoadingConstraints(): boolean;
  154827. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  154828. protected _setRootMesh(meshes: AbstractMesh[]): void;
  154829. protected _updateModel(): void;
  154830. /**
  154831. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  154832. * between the touch and touch 2.
  154833. */
  154834. private _isQuest;
  154835. }
  154836. }
  154837. declare module BABYLON {
  154838. /**
  154839. * The motion controller class for the standard HTC-Vive controllers
  154840. */
  154841. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  154842. private _modelRootNode;
  154843. /**
  154844. * The base url used to load the left and right controller models
  154845. */
  154846. static MODEL_BASE_URL: string;
  154847. /**
  154848. * File name for the controller model.
  154849. */
  154850. static MODEL_FILENAME: string;
  154851. profileId: string;
  154852. /**
  154853. * Create a new Vive motion controller object
  154854. * @param scene the scene to use to create this controller
  154855. * @param gamepadObject the corresponding gamepad object
  154856. * @param handedness the handedness of the controller
  154857. */
  154858. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  154859. protected _getFilenameAndPath(): {
  154860. filename: string;
  154861. path: string;
  154862. };
  154863. protected _getModelLoadingConstraints(): boolean;
  154864. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  154865. protected _setRootMesh(meshes: AbstractMesh[]): void;
  154866. protected _updateModel(): void;
  154867. }
  154868. }
  154869. declare module BABYLON {
  154870. /**
  154871. * A cursor which tracks a point on a path
  154872. */
  154873. export class PathCursor {
  154874. private path;
  154875. /**
  154876. * Stores path cursor callbacks for when an onchange event is triggered
  154877. */
  154878. private _onchange;
  154879. /**
  154880. * The value of the path cursor
  154881. */
  154882. value: number;
  154883. /**
  154884. * The animation array of the path cursor
  154885. */
  154886. animations: Animation[];
  154887. /**
  154888. * Initializes the path cursor
  154889. * @param path The path to track
  154890. */
  154891. constructor(path: Path2);
  154892. /**
  154893. * Gets the cursor point on the path
  154894. * @returns A point on the path cursor at the cursor location
  154895. */
  154896. getPoint(): Vector3;
  154897. /**
  154898. * Moves the cursor ahead by the step amount
  154899. * @param step The amount to move the cursor forward
  154900. * @returns This path cursor
  154901. */
  154902. moveAhead(step?: number): PathCursor;
  154903. /**
  154904. * Moves the cursor behind by the step amount
  154905. * @param step The amount to move the cursor back
  154906. * @returns This path cursor
  154907. */
  154908. moveBack(step?: number): PathCursor;
  154909. /**
  154910. * Moves the cursor by the step amount
  154911. * If the step amount is greater than one, an exception is thrown
  154912. * @param step The amount to move the cursor
  154913. * @returns This path cursor
  154914. */
  154915. move(step: number): PathCursor;
  154916. /**
  154917. * Ensures that the value is limited between zero and one
  154918. * @returns This path cursor
  154919. */
  154920. private ensureLimits;
  154921. /**
  154922. * Runs onchange callbacks on change (used by the animation engine)
  154923. * @returns This path cursor
  154924. */
  154925. private raiseOnChange;
  154926. /**
  154927. * Executes a function on change
  154928. * @param f A path cursor onchange callback
  154929. * @returns This path cursor
  154930. */
  154931. onchange(f: (cursor: PathCursor) => void): PathCursor;
  154932. }
  154933. }
  154934. declare module BABYLON {
  154935. /** @hidden */
  154936. export var blurPixelShader: {
  154937. name: string;
  154938. shader: string;
  154939. };
  154940. }
  154941. declare module BABYLON {
  154942. /** @hidden */
  154943. export var pointCloudVertexDeclaration: {
  154944. name: string;
  154945. shader: string;
  154946. };
  154947. }
  154948. // Mixins
  154949. interface Window {
  154950. mozIndexedDB: IDBFactory;
  154951. webkitIndexedDB: IDBFactory;
  154952. msIndexedDB: IDBFactory;
  154953. webkitURL: typeof URL;
  154954. mozRequestAnimationFrame(callback: FrameRequestCallback): number;
  154955. oRequestAnimationFrame(callback: FrameRequestCallback): number;
  154956. WebGLRenderingContext: WebGLRenderingContext;
  154957. MSGesture: MSGesture;
  154958. CANNON: any;
  154959. AudioContext: AudioContext;
  154960. webkitAudioContext: AudioContext;
  154961. PointerEvent: any;
  154962. Math: Math;
  154963. Uint8Array: Uint8ArrayConstructor;
  154964. Float32Array: Float32ArrayConstructor;
  154965. mozURL: typeof URL;
  154966. msURL: typeof URL;
  154967. VRFrameData: any; // WebVR, from specs 1.1
  154968. DracoDecoderModule: any;
  154969. setImmediate(handler: (...args: any[]) => void): number;
  154970. }
  154971. interface HTMLCanvasElement {
  154972. requestPointerLock(): void;
  154973. msRequestPointerLock?(): void;
  154974. mozRequestPointerLock?(): void;
  154975. webkitRequestPointerLock?(): void;
  154976. /** Track wether a record is in progress */
  154977. isRecording: boolean;
  154978. /** Capture Stream method defined by some browsers */
  154979. captureStream(fps?: number): MediaStream;
  154980. }
  154981. interface CanvasRenderingContext2D {
  154982. msImageSmoothingEnabled: boolean;
  154983. }
  154984. interface MouseEvent {
  154985. mozMovementX: number;
  154986. mozMovementY: number;
  154987. webkitMovementX: number;
  154988. webkitMovementY: number;
  154989. msMovementX: number;
  154990. msMovementY: number;
  154991. }
  154992. interface Navigator {
  154993. mozGetVRDevices: (any: any) => any;
  154994. webkitGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  154995. mozGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  154996. msGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  154997. webkitGetGamepads(): Gamepad[];
  154998. msGetGamepads(): Gamepad[];
  154999. webkitGamepads(): Gamepad[];
  155000. }
  155001. interface HTMLVideoElement {
  155002. mozSrcObject: any;
  155003. }
  155004. interface Math {
  155005. fround(x: number): number;
  155006. imul(a: number, b: number): number;
  155007. }
  155008. interface WebGLRenderingContext {
  155009. drawArraysInstanced(mode: number, first: number, count: number, primcount: number): void;
  155010. drawElementsInstanced(mode: number, count: number, type: number, offset: number, primcount: number): void;
  155011. vertexAttribDivisor(index: number, divisor: number): void;
  155012. createVertexArray(): any;
  155013. bindVertexArray(vao?: WebGLVertexArrayObject | null): void;
  155014. deleteVertexArray(vao: WebGLVertexArrayObject): void;
  155015. blitFramebuffer(srcX0: number, srcY0: number, srcX1: number, srcY1: number, dstX0: number, dstY0: number, dstX1: number, dstY1: number, mask: number, filter: number): void;
  155016. renderbufferStorageMultisample?(target: number, samples: number, internalformat: number, width: number, height: number): void;
  155017. bindBufferBase(target: number, index: number, buffer: WebGLBuffer | null): void;
  155018. getUniformBlockIndex(program: WebGLProgram, uniformBlockName: string): number;
  155019. uniformBlockBinding(program: WebGLProgram, uniformBlockIndex: number, uniformBlockBinding: number): void;
  155020. // Queries
  155021. createQuery(): WebGLQuery;
  155022. deleteQuery(query: WebGLQuery): void;
  155023. beginQuery(target: number, query: WebGLQuery): void;
  155024. endQuery(target: number): void;
  155025. getQueryParameter(query: WebGLQuery, pname: number): any;
  155026. getQuery(target: number, pname: number): any;
  155027. MAX_SAMPLES: number;
  155028. RGBA8: number;
  155029. READ_FRAMEBUFFER: number;
  155030. DRAW_FRAMEBUFFER: number;
  155031. UNIFORM_BUFFER: number;
  155032. HALF_FLOAT_OES: number;
  155033. RGBA16F: number;
  155034. RGBA32F: number;
  155035. R32F: number;
  155036. RG32F: number;
  155037. RGB32F: number;
  155038. R16F: number;
  155039. RG16F: number;
  155040. RGB16F: number;
  155041. RED: number;
  155042. RG: number;
  155043. R8: number;
  155044. RG8: number;
  155045. UNSIGNED_INT_24_8: number;
  155046. DEPTH24_STENCIL8: number;
  155047. MIN: number;
  155048. MAX: number;
  155049. /* Multiple Render Targets */
  155050. drawBuffers(buffers: number[]): void;
  155051. readBuffer(src: number): void;
  155052. readonly COLOR_ATTACHMENT0: number; // 0x8CE1
  155053. readonly COLOR_ATTACHMENT1: number; // 0x8CE2
  155054. readonly COLOR_ATTACHMENT2: number; // 0x8CE3
  155055. readonly COLOR_ATTACHMENT3: number; // 0x8CE4
  155056. // Occlusion Query
  155057. ANY_SAMPLES_PASSED_CONSERVATIVE: number;
  155058. ANY_SAMPLES_PASSED: number;
  155059. QUERY_RESULT_AVAILABLE: number;
  155060. QUERY_RESULT: number;
  155061. }
  155062. interface WebGLProgram {
  155063. __SPECTOR_rebuildProgram?: ((vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (program: WebGLProgram) => void, onError: (message: string) => void) => void) | null;
  155064. }
  155065. interface EXT_disjoint_timer_query {
  155066. QUERY_COUNTER_BITS_EXT: number;
  155067. TIME_ELAPSED_EXT: number;
  155068. TIMESTAMP_EXT: number;
  155069. GPU_DISJOINT_EXT: number;
  155070. QUERY_RESULT_EXT: number;
  155071. QUERY_RESULT_AVAILABLE_EXT: number;
  155072. queryCounterEXT(query: WebGLQuery, target: number): void;
  155073. createQueryEXT(): WebGLQuery;
  155074. beginQueryEXT(target: number, query: WebGLQuery): void;
  155075. endQueryEXT(target: number): void;
  155076. getQueryObjectEXT(query: WebGLQuery, target: number): any;
  155077. deleteQueryEXT(query: WebGLQuery): void;
  155078. }
  155079. interface WebGLUniformLocation {
  155080. _currentState: any;
  155081. }
  155082. // Type definitions for WebGL 2, Editor's Draft Fri Feb 24 16:10:18 2017 -0800
  155083. // Project: https://www.khronos.org/registry/webgl/specs/latest/2.0/
  155084. // Definitions by: Nico Kemnitz <https://github.com/nkemnitz/>
  155085. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  155086. interface WebGLRenderingContext {
  155087. readonly RASTERIZER_DISCARD: number;
  155088. readonly DEPTH_COMPONENT24: number;
  155089. readonly TEXTURE_3D: number;
  155090. readonly TEXTURE_2D_ARRAY: number;
  155091. readonly TEXTURE_COMPARE_FUNC: number;
  155092. readonly TEXTURE_COMPARE_MODE: number;
  155093. readonly COMPARE_REF_TO_TEXTURE: number;
  155094. readonly TEXTURE_WRAP_R: number;
  155095. readonly HALF_FLOAT: number;
  155096. readonly RGB8: number;
  155097. readonly RED_INTEGER: number;
  155098. readonly RG_INTEGER: number;
  155099. readonly RGB_INTEGER: number;
  155100. readonly RGBA_INTEGER: number;
  155101. readonly R8_SNORM: number;
  155102. readonly RG8_SNORM: number;
  155103. readonly RGB8_SNORM: number;
  155104. readonly RGBA8_SNORM: number;
  155105. readonly R8I: number;
  155106. readonly RG8I: number;
  155107. readonly RGB8I: number;
  155108. readonly RGBA8I: number;
  155109. readonly R8UI: number;
  155110. readonly RG8UI: number;
  155111. readonly RGB8UI: number;
  155112. readonly RGBA8UI: number;
  155113. readonly R16I: number;
  155114. readonly RG16I: number;
  155115. readonly RGB16I: number;
  155116. readonly RGBA16I: number;
  155117. readonly R16UI: number;
  155118. readonly RG16UI: number;
  155119. readonly RGB16UI: number;
  155120. readonly RGBA16UI: number;
  155121. readonly R32I: number;
  155122. readonly RG32I: number;
  155123. readonly RGB32I: number;
  155124. readonly RGBA32I: number;
  155125. readonly R32UI: number;
  155126. readonly RG32UI: number;
  155127. readonly RGB32UI: number;
  155128. readonly RGBA32UI: number;
  155129. readonly RGB10_A2UI: number;
  155130. readonly R11F_G11F_B10F: number;
  155131. readonly RGB9_E5: number;
  155132. readonly RGB10_A2: number;
  155133. readonly UNSIGNED_INT_2_10_10_10_REV: number;
  155134. readonly UNSIGNED_INT_10F_11F_11F_REV: number;
  155135. readonly UNSIGNED_INT_5_9_9_9_REV: number;
  155136. readonly FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  155137. readonly DEPTH_COMPONENT32F: number;
  155138. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView | null): void;
  155139. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView, offset: number): void;
  155140. 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;
  155141. framebufferTextureLayer(target: number, attachment: number, texture: WebGLTexture | null, level: number, layer: number): void;
  155142. compressedTexImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, data: ArrayBufferView, offset?: number, length?: number): void;
  155143. readonly TRANSFORM_FEEDBACK: number;
  155144. readonly INTERLEAVED_ATTRIBS: number;
  155145. readonly TRANSFORM_FEEDBACK_BUFFER: number;
  155146. createTransformFeedback(): WebGLTransformFeedback;
  155147. deleteTransformFeedback(transformFeedbac: WebGLTransformFeedback): void;
  155148. bindTransformFeedback(target: number, transformFeedback: WebGLTransformFeedback | null): void;
  155149. beginTransformFeedback(primitiveMode: number): void;
  155150. endTransformFeedback(): void;
  155151. transformFeedbackVaryings(program: WebGLProgram, varyings: string[], bufferMode: number): void;
  155152. clearBufferfv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  155153. clearBufferiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  155154. clearBufferuiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  155155. clearBufferfi(buffer: number, drawbuffer: number, depth: number, stencil: number): void;
  155156. }
  155157. interface ImageBitmap {
  155158. readonly width: number;
  155159. readonly height: number;
  155160. close(): void;
  155161. }
  155162. interface WebGLQuery extends WebGLObject {
  155163. }
  155164. declare var WebGLQuery: {
  155165. prototype: WebGLQuery;
  155166. new(): WebGLQuery;
  155167. };
  155168. interface WebGLSampler extends WebGLObject {
  155169. }
  155170. declare var WebGLSampler: {
  155171. prototype: WebGLSampler;
  155172. new(): WebGLSampler;
  155173. };
  155174. interface WebGLSync extends WebGLObject {
  155175. }
  155176. declare var WebGLSync: {
  155177. prototype: WebGLSync;
  155178. new(): WebGLSync;
  155179. };
  155180. interface WebGLTransformFeedback extends WebGLObject {
  155181. }
  155182. declare var WebGLTransformFeedback: {
  155183. prototype: WebGLTransformFeedback;
  155184. new(): WebGLTransformFeedback;
  155185. };
  155186. interface WebGLVertexArrayObject extends WebGLObject {
  155187. }
  155188. declare var WebGLVertexArrayObject: {
  155189. prototype: WebGLVertexArrayObject;
  155190. new(): WebGLVertexArrayObject;
  155191. };
  155192. // Type definitions for WebVR API
  155193. // Project: https://w3c.github.io/webvr/
  155194. // Definitions by: six a <https://github.com/lostfictions>
  155195. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  155196. interface VRDisplay extends EventTarget {
  155197. /**
  155198. * Dictionary of capabilities describing the VRDisplay.
  155199. */
  155200. readonly capabilities: VRDisplayCapabilities;
  155201. /**
  155202. * z-depth defining the far plane of the eye view frustum
  155203. * enables mapping of values in the render target depth
  155204. * attachment to scene coordinates. Initially set to 10000.0.
  155205. */
  155206. depthFar: number;
  155207. /**
  155208. * z-depth defining the near plane of the eye view frustum
  155209. * enables mapping of values in the render target depth
  155210. * attachment to scene coordinates. Initially set to 0.01.
  155211. */
  155212. depthNear: number;
  155213. /**
  155214. * An identifier for this distinct VRDisplay. Used as an
  155215. * association point in the Gamepad API.
  155216. */
  155217. readonly displayId: number;
  155218. /**
  155219. * A display name, a user-readable name identifying it.
  155220. */
  155221. readonly displayName: string;
  155222. readonly isConnected: boolean;
  155223. readonly isPresenting: boolean;
  155224. /**
  155225. * If this VRDisplay supports room-scale experiences, the optional
  155226. * stage attribute contains details on the room-scale parameters.
  155227. */
  155228. readonly stageParameters: VRStageParameters | null;
  155229. /**
  155230. * Passing the value returned by `requestAnimationFrame` to
  155231. * `cancelAnimationFrame` will unregister the callback.
  155232. * @param handle Define the hanle of the request to cancel
  155233. */
  155234. cancelAnimationFrame(handle: number): void;
  155235. /**
  155236. * Stops presenting to the VRDisplay.
  155237. * @returns a promise to know when it stopped
  155238. */
  155239. exitPresent(): Promise<void>;
  155240. /**
  155241. * Return the current VREyeParameters for the given eye.
  155242. * @param whichEye Define the eye we want the parameter for
  155243. * @returns the eye parameters
  155244. */
  155245. getEyeParameters(whichEye: string): VREyeParameters;
  155246. /**
  155247. * Populates the passed VRFrameData with the information required to render
  155248. * the current frame.
  155249. * @param frameData Define the data structure to populate
  155250. * @returns true if ok otherwise false
  155251. */
  155252. getFrameData(frameData: VRFrameData): boolean;
  155253. /**
  155254. * Get the layers currently being presented.
  155255. * @returns the list of VR layers
  155256. */
  155257. getLayers(): VRLayer[];
  155258. /**
  155259. * Return a VRPose containing the future predicted pose of the VRDisplay
  155260. * when the current frame will be presented. The value returned will not
  155261. * change until JavaScript has returned control to the browser.
  155262. *
  155263. * The VRPose will contain the position, orientation, velocity,
  155264. * and acceleration of each of these properties.
  155265. * @returns the pose object
  155266. */
  155267. getPose(): VRPose;
  155268. /**
  155269. * Return the current instantaneous pose of the VRDisplay, with no
  155270. * prediction applied.
  155271. * @returns the current instantaneous pose
  155272. */
  155273. getImmediatePose(): VRPose;
  155274. /**
  155275. * The callback passed to `requestAnimationFrame` will be called
  155276. * any time a new frame should be rendered. When the VRDisplay is
  155277. * presenting the callback will be called at the native refresh
  155278. * rate of the HMD. When not presenting this function acts
  155279. * identically to how window.requestAnimationFrame acts. Content should
  155280. * make no assumptions of frame rate or vsync behavior as the HMD runs
  155281. * asynchronously from other displays and at differing refresh rates.
  155282. * @param callback Define the eaction to run next frame
  155283. * @returns the request handle it
  155284. */
  155285. requestAnimationFrame(callback: FrameRequestCallback): number;
  155286. /**
  155287. * Begin presenting to the VRDisplay. Must be called in response to a user gesture.
  155288. * Repeat calls while already presenting will update the VRLayers being displayed.
  155289. * @param layers Define the list of layer to present
  155290. * @returns a promise to know when the request has been fulfilled
  155291. */
  155292. requestPresent(layers: VRLayer[]): Promise<void>;
  155293. /**
  155294. * Reset the pose for this display, treating its current position and
  155295. * orientation as the "origin/zero" values. VRPose.position,
  155296. * VRPose.orientation, and VRStageParameters.sittingToStandingTransform may be
  155297. * updated when calling resetPose(). This should be called in only
  155298. * sitting-space experiences.
  155299. */
  155300. resetPose(): void;
  155301. /**
  155302. * The VRLayer provided to the VRDisplay will be captured and presented
  155303. * in the HMD. Calling this function has the same effect on the source
  155304. * canvas as any other operation that uses its source image, and canvases
  155305. * created without preserveDrawingBuffer set to true will be cleared.
  155306. * @param pose Define the pose to submit
  155307. */
  155308. submitFrame(pose?: VRPose): void;
  155309. }
  155310. declare var VRDisplay: {
  155311. prototype: VRDisplay;
  155312. new(): VRDisplay;
  155313. };
  155314. interface VRLayer {
  155315. leftBounds?: number[] | Float32Array | null;
  155316. rightBounds?: number[] | Float32Array | null;
  155317. source?: HTMLCanvasElement | null;
  155318. }
  155319. interface VRDisplayCapabilities {
  155320. readonly canPresent: boolean;
  155321. readonly hasExternalDisplay: boolean;
  155322. readonly hasOrientation: boolean;
  155323. readonly hasPosition: boolean;
  155324. readonly maxLayers: number;
  155325. }
  155326. interface VREyeParameters {
  155327. /** @deprecated */
  155328. readonly fieldOfView: VRFieldOfView;
  155329. readonly offset: Float32Array;
  155330. readonly renderHeight: number;
  155331. readonly renderWidth: number;
  155332. }
  155333. interface VRFieldOfView {
  155334. readonly downDegrees: number;
  155335. readonly leftDegrees: number;
  155336. readonly rightDegrees: number;
  155337. readonly upDegrees: number;
  155338. }
  155339. interface VRFrameData {
  155340. readonly leftProjectionMatrix: Float32Array;
  155341. readonly leftViewMatrix: Float32Array;
  155342. readonly pose: VRPose;
  155343. readonly rightProjectionMatrix: Float32Array;
  155344. readonly rightViewMatrix: Float32Array;
  155345. readonly timestamp: number;
  155346. }
  155347. interface VRPose {
  155348. readonly angularAcceleration: Float32Array | null;
  155349. readonly angularVelocity: Float32Array | null;
  155350. readonly linearAcceleration: Float32Array | null;
  155351. readonly linearVelocity: Float32Array | null;
  155352. readonly orientation: Float32Array | null;
  155353. readonly position: Float32Array | null;
  155354. readonly timestamp: number;
  155355. }
  155356. interface VRStageParameters {
  155357. sittingToStandingTransform?: Float32Array;
  155358. sizeX?: number;
  155359. sizeY?: number;
  155360. }
  155361. interface Navigator {
  155362. getVRDisplays(): Promise<VRDisplay[]>;
  155363. readonly activeVRDisplays: ReadonlyArray<VRDisplay>;
  155364. }
  155365. interface Window {
  155366. onvrdisplayconnected: ((this: Window, ev: Event) => any) | null;
  155367. onvrdisplaydisconnected: ((this: Window, ev: Event) => any) | null;
  155368. onvrdisplaypresentchange: ((this: Window, ev: Event) => any) | null;
  155369. addEventListener(type: "vrdisplayconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  155370. addEventListener(type: "vrdisplaydisconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  155371. addEventListener(type: "vrdisplaypresentchange", listener: (ev: Event) => any, useCapture?: boolean): void;
  155372. }
  155373. interface Gamepad {
  155374. readonly displayId: number;
  155375. }
  155376. type XRSessionMode = "inline" | "immersive-vr" | "immersive-ar";
  155377. type XRReferenceSpaceType = "viewer" | "local" | "local-floor" | "bounded-floor" | "unbounded";
  155378. type XREnvironmentBlendMode = "opaque" | "additive" | "alpha-blend";
  155379. type XRVisibilityState = "visible" | "visible-blurred" | "hidden";
  155380. type XRHandedness = "none" | "left" | "right";
  155381. type XRTargetRayMode = "gaze" | "tracked-pointer" | "screen";
  155382. type XREye = "none" | "left" | "right";
  155383. type XREventType = "devicechange" | "visibilitychange" | "end" | "inputsourceschange" | "select" | "selectstart" | "selectend" | "squeeze" | "squeezestart" | "squeezeend" | "reset";
  155384. interface XRSpace extends EventTarget {}
  155385. interface XRRenderState {
  155386. depthNear?: number;
  155387. depthFar?: number;
  155388. inlineVerticalFieldOfView?: number;
  155389. baseLayer?: XRWebGLLayer;
  155390. }
  155391. interface XRInputSource {
  155392. handedness: XRHandedness;
  155393. targetRayMode: XRTargetRayMode;
  155394. targetRaySpace: XRSpace;
  155395. gripSpace: XRSpace | undefined;
  155396. gamepad: Gamepad | undefined;
  155397. profiles: Array<string>;
  155398. hand: XRHand | undefined;
  155399. }
  155400. interface XRSessionInit {
  155401. optionalFeatures?: string[];
  155402. requiredFeatures?: string[];
  155403. }
  155404. interface XRSession {
  155405. addEventListener: Function;
  155406. removeEventListener: Function;
  155407. requestReferenceSpace(type: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  155408. updateRenderState(XRRenderStateInit: XRRenderState): Promise<void>;
  155409. requestAnimationFrame: Function;
  155410. end(): Promise<void>;
  155411. renderState: XRRenderState;
  155412. inputSources: Array<XRInputSource>;
  155413. // hit test
  155414. requestHitTestSource(options: XRHitTestOptionsInit): Promise<XRHitTestSource>;
  155415. requestHitTestSourceForTransientInput(options: XRTransientInputHitTestOptionsInit): Promise<XRTransientInputHitTestSource>;
  155416. // legacy AR hit test
  155417. requestHitTest(ray: XRRay, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  155418. // legacy plane detection
  155419. updateWorldTrackingState(options: { planeDetectionState?: { enabled: boolean } }): void;
  155420. }
  155421. interface XRReferenceSpace extends XRSpace {
  155422. getOffsetReferenceSpace(originOffset: XRRigidTransform): XRReferenceSpace;
  155423. onreset: any;
  155424. }
  155425. type XRPlaneSet = Set<XRPlane>;
  155426. type XRAnchorSet = Set<XRAnchor>;
  155427. interface XRFrame {
  155428. session: XRSession;
  155429. getViewerPose(referenceSpace: XRReferenceSpace): XRViewerPose | undefined;
  155430. getPose(space: XRSpace, baseSpace: XRSpace): XRPose | undefined;
  155431. // AR
  155432. getHitTestResults(hitTestSource: XRHitTestSource): Array<XRHitTestResult>;
  155433. getHitTestResultsForTransientInput(hitTestSource: XRTransientInputHitTestSource): Array<XRTransientInputHitTestResult>;
  155434. // Anchors
  155435. trackedAnchors?: XRAnchorSet;
  155436. createAnchor(pose: XRRigidTransform, space: XRSpace): Promise<XRAnchor>;
  155437. // Planes
  155438. worldInformation: {
  155439. detectedPlanes?: XRPlaneSet;
  155440. };
  155441. // Hand tracking
  155442. getJointPose(joint: XRJointSpace, baseSpace: XRSpace): XRJointPose;
  155443. }
  155444. interface XRViewerPose extends XRPose {
  155445. views: Array<XRView>;
  155446. }
  155447. interface XRPose {
  155448. transform: XRRigidTransform;
  155449. emulatedPosition: boolean;
  155450. }
  155451. interface XRWebGLLayerOptions {
  155452. antialias?: boolean;
  155453. depth?: boolean;
  155454. stencil?: boolean;
  155455. alpha?: boolean;
  155456. multiview?: boolean;
  155457. framebufferScaleFactor?: number;
  155458. }
  155459. declare var XRWebGLLayer: {
  155460. prototype: XRWebGLLayer;
  155461. new (session: XRSession, context: WebGLRenderingContext | undefined, options?: XRWebGLLayerOptions): XRWebGLLayer;
  155462. };
  155463. interface XRWebGLLayer {
  155464. framebuffer: WebGLFramebuffer;
  155465. framebufferWidth: number;
  155466. framebufferHeight: number;
  155467. getViewport: Function;
  155468. }
  155469. declare class XRRigidTransform {
  155470. constructor(matrix: Float32Array | DOMPointInit, direction?: DOMPointInit);
  155471. position: DOMPointReadOnly;
  155472. orientation: DOMPointReadOnly;
  155473. matrix: Float32Array;
  155474. inverse: XRRigidTransform;
  155475. }
  155476. interface XRView {
  155477. eye: XREye;
  155478. projectionMatrix: Float32Array;
  155479. transform: XRRigidTransform;
  155480. }
  155481. interface XRInputSourceChangeEvent {
  155482. session: XRSession;
  155483. removed: Array<XRInputSource>;
  155484. added: Array<XRInputSource>;
  155485. }
  155486. interface XRInputSourceEvent extends Event {
  155487. readonly frame: XRFrame;
  155488. readonly inputSource: XRInputSource;
  155489. }
  155490. // Experimental(er) features
  155491. declare class XRRay {
  155492. constructor(transformOrOrigin: XRRigidTransform | DOMPointInit, direction?: DOMPointInit);
  155493. origin: DOMPointReadOnly;
  155494. direction: DOMPointReadOnly;
  155495. matrix: Float32Array;
  155496. }
  155497. declare enum XRHitTestTrackableType {
  155498. "point",
  155499. "plane",
  155500. "mesh",
  155501. }
  155502. interface XRHitResult {
  155503. hitMatrix: Float32Array;
  155504. }
  155505. interface XRTransientInputHitTestResult {
  155506. readonly inputSource: XRInputSource;
  155507. readonly results: Array<XRHitTestResult>;
  155508. }
  155509. interface XRHitTestResult {
  155510. getPose(baseSpace: XRSpace): XRPose | undefined;
  155511. // When anchor system is enabled
  155512. createAnchor?(pose: XRRigidTransform): Promise<XRAnchor>;
  155513. }
  155514. interface XRHitTestSource {
  155515. cancel(): void;
  155516. }
  155517. interface XRTransientInputHitTestSource {
  155518. cancel(): void;
  155519. }
  155520. interface XRHitTestOptionsInit {
  155521. space: XRSpace;
  155522. entityTypes?: Array<XRHitTestTrackableType>;
  155523. offsetRay?: XRRay;
  155524. }
  155525. interface XRTransientInputHitTestOptionsInit {
  155526. profile: string;
  155527. entityTypes?: Array<XRHitTestTrackableType>;
  155528. offsetRay?: XRRay;
  155529. }
  155530. interface XRAnchor {
  155531. anchorSpace: XRSpace;
  155532. delete(): void;
  155533. }
  155534. interface XRPlane {
  155535. orientation: "Horizontal" | "Vertical";
  155536. planeSpace: XRSpace;
  155537. polygon: Array<DOMPointReadOnly>;
  155538. lastChangedTime: number;
  155539. }
  155540. interface XRJointSpace extends XRSpace {}
  155541. interface XRJointPose extends XRPose {
  155542. radius: number | undefined;
  155543. }
  155544. declare class XRHand extends Array<XRJointSpace> {
  155545. readonly length: number;
  155546. static readonly WRIST = 0;
  155547. static readonly THUMB_METACARPAL = 1;
  155548. static readonly THUMB_PHALANX_PROXIMAL = 2;
  155549. static readonly THUMB_PHALANX_DISTAL = 3;
  155550. static readonly THUMB_PHALANX_TIP = 4;
  155551. static readonly INDEX_METACARPAL = 5;
  155552. static readonly INDEX_PHALANX_PROXIMAL = 6;
  155553. static readonly INDEX_PHALANX_INTERMEDIATE = 7;
  155554. static readonly INDEX_PHALANX_DISTAL = 8;
  155555. static readonly INDEX_PHALANX_TIP = 9;
  155556. static readonly MIDDLE_METACARPAL = 10;
  155557. static readonly MIDDLE_PHALANX_PROXIMAL = 11;
  155558. static readonly MIDDLE_PHALANX_INTERMEDIATE = 12;
  155559. static readonly MIDDLE_PHALANX_DISTAL = 13;
  155560. static readonly MIDDLE_PHALANX_TIP = 14;
  155561. static readonly RING_METACARPAL = 15;
  155562. static readonly RING_PHALANX_PROXIMAL = 16;
  155563. static readonly RING_PHALANX_INTERMEDIATE = 17;
  155564. static readonly RING_PHALANX_DISTAL = 18;
  155565. static readonly RING_PHALANX_TIP = 19;
  155566. static readonly LITTLE_METACARPAL = 20;
  155567. static readonly LITTLE_PHALANX_PROXIMAL = 21;
  155568. static readonly LITTLE_PHALANX_INTERMEDIATE = 22;
  155569. static readonly LITTLE_PHALANX_DISTAL = 23;
  155570. static readonly LITTLE_PHALANX_TIP = 24;
  155571. }
  155572. // This file contains native only extensions for WebXR These APIs are not supported in the browser yet.
  155573. // They are intended for use with either Babylon Native https://github.com/BabylonJS/BabylonNative or
  155574. // Babylon React Native: https://github.com/BabylonJS/BabylonReactNative
  155575. interface XRSession {
  155576. trySetFeaturePointCloudEnabled(enabled: boolean): boolean;
  155577. }
  155578. interface XRFrame {
  155579. featurePointCloud? : Array<number>;
  155580. }